Zebra Managed Configurations

OEMConfig 10.5

Terms in this Guide

Concepts

Define - Used when referring to the definition in the OEMConfig schema that determines what the administrator is permitted to do as opposed to what an admin might elect to do. For example, within a Step, an admin is permitted to include one of every defined Managed Configuration Group but in most cases would only elect to include only one or a few.

Include - Used when referring to a decision by an administrator to elect to perform some Action or configuration as opposed to what the administrator is permitted to do, but may or may not elect to do. For example, an admin would be permitted to include one of everything, but likely would elect to include only one or a few.

Instance - A SINGLE occurrence or use of something (such as a Step, MC, Group, Sub-group, or Sub-array). An Instance might refer to the inclusion of a Step in a Transaction; an MC or Group in a Step; an MC, Sub-group, or Sub-array in a Group; or a Sub-group as an element of a Sub-array.

Elements

Transaction - An ordered list of Steps, each of which specifies one or more Actions to be performed or settings to be configured on a Zebra device. Steps are executed in the exact order specified within the Transaction, but the order of execution within a Step is controlled by the system. The recommended means of controlling the order of execution, if required, is to use separate Steps within a Transaction.

Step - A collection of Actions to be performed or settings to be configured at a specific point within a Transaction. Within a Step, some MCs are defined directly (such as for entering an Explanation or selecting an Error Mode), but most are organized into Managed Configuration Groups. An instance of a Step can include no more than one instance of any MC or Group that is defined for a Step. Within a Step, all included MCs and Groups, and anything included within any Groups, are executed in an order determined by the system to afford the greatest likelihood of success. For example, the system might execute a Bluetooth configuration after an Action to enable Bluetooth because configuring Bluetooth might fail if attempted when Bluetooth was disabled.

Group - See Managed Configuration Group.

Managed Configuration Group - A collection of MCs, Sub-groups, or Sub-arrays that are defined to control some aspect of the device (such as Analytics Configuration or Audio Configuration). A Group can include no more than one instance of any MC, Sub-group, or Sub-array that is defined for that Group.

Sub-group - A collection of MCs, Sub-groups, or Sub-arrays that are defined as permitted to control some sub-aspect of the device (such as Send to Cloud Detail in Bug Reporting Configuration). 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 - 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 Step is when it appears within different elements of a Sub-array. For example, the Key Mapping Configuration Group defines a Sub-array Add Mapping Behaviors that can be used to configure multiple behaviors for a single key in different modifier states (orange, green, blue, etc.). A single Step can include multiple instances of the MCs defined for the Behaviors Sub-group, by including them in different elements in the Add Mapping Behaviors Sub-array.

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 Audio Configuration Group or the State Managed Configuration.
  • Italic type indicates defined terms, such as Transaction and Step.

   NOTE: Defined terms are Capitalized to differentiate from italics used for emphasis.

Transaction Overview

This section of the OEMConfig documentation describes all supported Managed Configurations (MCs), which can be used to define an ordered list of Steps for defining one or more Actions to be performed or settings to be configured on a Zebra device as part of an overall Transaction. Before attempting to configure a Transaction, it's important to understand the concept of Managed Configuration Groups, Sub-groups, Sub-arrays. A Transaction can contain one or many of these elements, and can be nested multiple levels deep.


Application Configuration

Use this Group to configure Device Central, CSP Function Groups, and Packages.

Detail Information:

  • Key = appConfig

  • Type = bundle


License Configuration

Use this Group to configure Licenses, Custom Servers, and Features.

Detail Information:

  • Key = licenseConfig

  • Type = bundle


Security and Privacy Configuration

Use this Group to configure Encryption, Screen Lock, and Threat.

Detail Information:

  • Key = securityAndPrivacyConfig

  • Type = bundle


System Configuration

Use this Group to configure Analytics, Clock, Files, GMS, Lifeguard, Power, Remote Scanner, Pass-Through Command, and Logs.

Detail Information:

  • Key = systemConfig

  • Type = bundle


UI Configuration

Use this Group to configure Audio, Camera, DataWedge, Display, Enterprise Keyboard, General UI, Keyboard, Settings UI, and Touch Panel.

Detail Information:

  • Key = uiConfig

  • Type = bundle


Wireless and Network Configuration

Use this Group to configure Bluetooth, DHCP, Enterprise NFC, Ethernet, Host Name, RFID, Wireless General, Wireless LAN, Wireless WAN, and Worry Free WiFi.

Detail Information:

  • Key = wirelessAndNetworkConfig

  • Type = bundle

Transaction Steps

Specify an ordered list of Transaction Steps that define the Actions or configurations that you wish to perform on a device as part of an overall Transaction.

Detail Information:

  • Key = steps

  • Type = bundle_array

Transaction Step

   Transaction Steps

Specify a single Transaction Step that defines one or more Actions or configurations that you wish to perform on a device at a specific point in an an overall Transaction.

Detail Information:

  • Key = step

  • Type = bundle

Explanation

   Transaction Steps  >  Transaction Step

Enter an optional Explanation that describes the purpose or intended behavior of a Transaction Step.

Since a Transaction may include many Transaction Steps and each Transaction Step could include one or more configurations, describing the Transaction Step can be beneficial when later reviewing the Transaction and/or when editing a Transaction, and especially when reordering the Transaction Steps within the Transaction.

Detail Information:

  • Key = stepExplanation

  • Type = string

Error Mode

   Transaction Steps  >  Transaction Step

Select an Error Mode that determines how errors that occur during the execution of a Transaction Step should be handled.

Since a Transaction may include multiple Transaction Steps, there may be cases where one Transaction Step within a Transaction is dependent on configuration performed by one or more preceding Transaction Steps in the same Transaction. In such cases, it may be desirable to terminate a Transaction if the processing of a Transaction Step results in an error to avoid propagating the results of that error into subsequent Transaction Steps.

By default, execution will continue with the next Transaction Step once execution of the current Transaction Step is completed. A decision to override this default behavior can be made independently for each Transaction Step within a Transaction by supplying an Error Mode value:

  • If the value Continue is selected, the default behavior will be used and hence any errors that occur during the execution of the current Transaction Step will NOT terminate execution of subsequent Transaction Steps in the same Transaction. Execution will thus always continue with the next Transaction Step once execution of the current Transaction Step is completed.
  • If the value Stop is selected, the default behavior will be overridden and hence any errors that occur during the execution of the current Transaction Step will terminate execution of subsequent Transaction Steps in the same Transaction. Execution will continue with the next Transaction Step only if execution of the current Transaction Step completes with NO errors.

Detail Information:

  • Key = stepErrorMode

  • Type = string

 UI Choice  JSON Value 
 Stop  Stop 
 Continue  Continue 

Managed Configuration Groups

A Step can include one or more of the following Managed Configuration Groups.


Analytics Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure State, and User Control of State.

Detail Information:

  • Key = analyticsStep

  • Type = bundle

State

   Transaction Steps  >  Transaction Step  >  Analytics Configuration

Select whether the Analytics Client on a device is turned on (enabled) or turned off (disabled).

The Analytics Client is turned on (enabled) by default on all devices:

  • If the value Off is selected, the Analytics Client will be turned off (disabled), and hence it will not collect any machine data during the operation of the device and will not deliver any machine data regardless of whether connectivity is available.
  • If the value On is selected, the Analytics Client will be turned on (enabled), and hence it will automatically collect machine data during the operation of the device and deliver it, when connectivity is available, to the Zebra Analytics Cloud Server.

On some devices, the ability to turn off (disable) the Analytics Client may not be supported.

Detail Information:

  • Key = analyticsState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.3.

User Control of State

   Transaction Steps  >  Transaction Step  >  Analytics Configuration

Select whether the the Device User will be allowed to control whether the Analytics Client on a device is turned on (enabled) or turned off (disabled).

The Analytics Client is turned on (enabled) by default on all devices:

  • If the value Off is selected, the Device User will not be allowed to change whether the Analytics Client is turned off (disabled) or on (enabled), and hence whether it will collect or deliver any machine data during the operation of the device.
  • If the value On is selected, the Device User will be allowed to change whether the Analytics Client is turned off (disabled) or on (enabled), and hence whether it will collect or deliver any machine data during the operation of the device.

Detail Information:

  • Key = analyticsUserControlState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 7.2.


App Feature Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure App Feature State, App Feature Name, and App Feature Package Name. .

Detail Information:

  • Key = appFeatureStep

  • Type = bundle

Support Information:

  • Supported on Operating System(s): Pie and Oreo.

  • Supported from: MX 9.3.

App Feature State

   Transaction Steps  >  Transaction Step  >  App Feature Configuration

Select whether a specified Application Feature should be On or Off.

  • If the value Off is selected, the Application Feature will be turned Off.
  • If the value On is selected, the Application Feature will be turned On.

You must also specify App Feature Name to provide the Feature Name that identifies the Application Feature to be turned On or Off and App Feature Package Name to specify the Android Package Name that identifies the application for which the Application Feature will be turned On or Off.

Detail Information:

  • Key = appFeatureState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported on Operating System(s): Pie and Oreo.

  • Supported from: MX 9.3.

App Feature Name

   Transaction Steps  >  Transaction Step  >  App Feature Configuration

Select the Feature Name that identifies the application for which an Application Feature will be turned On or Off when App Feature State is specified. You must also specify App Feature Package Name to identify the application for which the specified Application Feature will be turned On or Off.

Detail Information:

  • Key = appFeatureName

  • Type = string

 UI Choice  JSON Value 
 Background Data  1 

Support Information:

  • Supported on Operating System(s): Pie and Oreo.

  • Supported from: MX 9.3.

App Feature Package Name

   Transaction Steps  >  Transaction Step  >  App Feature Configuration

Select the Android Package Name that identifies the application for which an Application Feature will be turned On or Off when App Feature State is specified. You must also specify App Feature Name to specify the Feature Name that identifies the Application Feature that will be turned On or Off for the specified application.

Detail Information:

  • Key = appFeaturePackageName

  • Type = string

Support Information:

  • Supported on Operating System(s): Pie and Oreo.

  • Supported from: MX 9.3.


AppGallery Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure State, Push Notifications, Credential Type, Custom User Name, Custom Password, and Custom Organization Key.

Detail Information:

  • Key = appgalleryStep

  • Type = bundle

Support Information:

  • Support discontinued from: MX 9.2.

State

   Transaction Steps  >  Transaction Step  >  AppGallery Configuration

This Managed Configuration is deprecated and will be discontinued in a subsequent version.

Detail Information:

  • Key = appgalleryState

  • Type = string

 UI Choice  JSON Value 
 Off  false 
 On  true 

Support Information:

  • Supported from: MX 6.0.

  • Support discontinued from: MX 9.2.

Push Notifications

   Transaction Steps  >  Transaction Step  >  AppGallery Configuration

This Managed Configuration is deprecated and will be discontinued in a subsequent version.

Detail Information:

  • Key = appgalleryPushNotifications

  • Type = string

 UI Choice  JSON Value 
 Off  false 
 On  true 

Support Information:

  • Supported from: MX 6.0.

  • Support discontinued from: MX 9.2.

Credential Type

   Transaction Steps  >  Transaction Step  >  AppGallery Configuration

This Managed Configuration is deprecated and will be discontinued in a subsequent version.

Detail Information:

  • Key = appgalleryCredentialType

  • Type = string

 UI Choice  JSON Value 
 Default  true 
 Custom  false 

Support Information:

  • Supported from: MX 6.0.

  • Support discontinued from: MX 9.2.

Custom User Name

   Transaction Steps  >  Transaction Step  >  AppGallery Configuration

This Managed Configuration is deprecated and will be discontinued in a subsequent version.

Detail Information:

  • Key = appgalleryCredentialTypeCustomUserName

  • Type = string

Support Information:

  • Supported from: MX 6.0.

  • Support discontinued from: MX 9.2.

Custom Password

   Transaction Steps  >  Transaction Step  >  AppGallery Configuration

This Managed Configuration is deprecated and will be discontinued in a subsequent version.

Detail Information:

  • Key = appgalleryCredentialTypeCustomPassword

  • Type = string

Support Information:

  • Supported from: MX 6.0.

  • Support discontinued from: MX 9.2.

Custom Organization Key

   Transaction Steps  >  Transaction Step  >  AppGallery Configuration

This Managed Configuration is deprecated and will be discontinued in a subsequent version.

Detail Information:

  • Key = appgalleryCredentialTypeCustomOrganizationKey

  • Type = string

Support Information:

  • Supported from: MX 6.0.

  • Support discontinued from: MX 9.2.


Audio Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Play AC Detect Sound, Replication Action, and Mute/Vibrate.

Detail Information:

  • Key = audioStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.2.

Play AC Detect Sound

   Transaction Steps  >  Transaction Step  >  Audio Configuration

Select whether a notification sound will be played when the device is connected to AC power.

  • If the value Off is selected, no sound will be played when AC power is connected.
  • If the value On is selected, a chime will play when AC power is connected.

Detail Information:

  • Key = audioPlayACConnectChime

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.3.

Replication Action

   Transaction Steps  >  Transaction Step  >  Audio Configuration

Select the audio replication behavior of of a device.

  • If the value Replicate headset audio on built-in speaker is selected, audio routed to the headset will also be routed to the built-in speaker. This might be desirable in a situation where the Device 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 speaker, the Device User might still hear it.

  • If the value Do not replicate headset audio on built-in speaker is selected, audio routed to the headset will also be routed to the built-in speaker. This might be desirable in a situation where the device is being used in an area where routing audio to the built-in speaker could be disruptive to others in the area.

Detail Information:

  • Key = audioReplicationAction

  • Type = string

 UI Choice  JSON Value 
 Replicate headset audio on built-in speaker  1 
 Do not replicate headset audio on built-in speaker  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.2.

Mute/Vibrate

   Transaction Steps  >  Transaction Step  >  Audio Configuration

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 = audioStepMuteVibrate

  • Type = string

 UI Choice  JSON Value 
 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.


Auto Trigger Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure State, and Range.

Automatic triggering allows a Device User to initiate trigger-activated functions simply by bringing an object within proximity of the device sensor as opposed to requiring the Device User to manually initiate such functions.

Detail Information:

  • Key = autoTriggerStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

State

   Transaction Steps  >  Transaction Step  >  Auto Trigger Configuration

Select whether and how automatic triggering should occur on a device.

  • If the value Off is selected, automatic triggering will never occur and the Device User will be required to manually initiate trigger-activated functions.

  • If the value Auto On is selected, automatic triggering may occur automatically if the device is placed into a suitable holster, holder, or stand allowing the Device 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 Device User to initiate trigger-activated functions simply by bringing an object within proximity to the device sensor.

Detail Information:

  • Key = autoTriggerState

  • 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

   Transaction Steps  >  Transaction Step  >  Auto Trigger Configuration

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 = autoTriggerRange

  • 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.


Blacklist Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Allow System Package Name, and Disallow System Package Name.

Blacklisting applies only to System applications, which are applications built into the device and are therefore always present. It has no effect on user applications, which are installed during staging or at some time after the device is put into service and DO NOT come preinstalled on the device. User apps are controlled using the Whitelist Configuration Group.

WARNING: It is important to understand that an app COULD use the Blacklist Configuration Group to blacklist itself. If an app is blacklisted, then it is prevented from running once the Blacklist Configuration is successfully applied, even if the app being blacklisted was the app that requested the blacklisting to be performed.

Detail Information:

  • Key = blacklistStep

  • Type = bundle

Action

   Transaction Steps  >  Transaction Step  >  Blacklist Configuration

Select an Action to enable or disable a single built-in System Application on a device.

All built-in System Applications are enabled by default on devices.

Allowing a built-in System Application allows it to be freely launched, either by the Device User or programmatically by other Applications.

Disallowing a built-in System Application prevents it from being launched, either by the Device User or programmatically by other Applications.

Since a built-in System Application is built-in, you cannot uninstall it from a device, even if you do not wish it to be used.

To prevent the use of a built-in System Application, you can disable it and thereby prevent its use, even though it remains installed.

  • If the value Allow is selected, you must also specify Allow System Package Name to provide the Android Package Name that identifies the Built-In System Application to be allowed.
  • If the value Disallow is selected, you must also specify Disallow System Package Name to provide the Android Package Name that identifies the Built-In System Application to be disallowed.

Detail Information:

  • Key = blacklistAction

  • Type = string

 UI Choice  JSON Value 
 Disallow  DisableApplication 
 Allow  EnableApplication 

Support Information:

  • Supported from: MX 4.2.

Allow System Package Name

   Transaction Steps  >  Transaction Step  >  Blacklist Configuration

Enter the Android Package Name that identifies a Built-In System Application to be allowed when the Action value Allow is selected for Action.

Detail Information:

  • Key = blacklistActionAllowSystemPackageName

  • Type = string

Support Information:

  • Supported from: MX 4.2.

Disallow System Package Name

   Transaction Steps  >  Transaction Step  >  Blacklist Configuration

Enter the Android Package Name that identifies a Built-In System Application to be disallowed when the Action value Disallow is selected for Action.

Detail Information:

  • Key = blacklistActionDisallowSystemPackageName

  • Type = string

Support Information:

  • Supported from: MX 4.2.


Bluetooth Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Beacon, Discoverability, New Pairings, Paired Device Action, Turn On/Off Silent Pairing, Turn On/Off Single Pairing Category, Action, Add Rule Name, Add Rule MAC Address, Add Rule Device Class, Add Rule Device Upper Address Part, Add Rule Pairing PIN Code, Remove Rule Name, Remove Rule MAC Address, Remove Rule Device Class, Remove Rule Device Upper Address Part, Remove Rule Pairing PIN Code, and BLE.

Detail Information:

  • Key = bluetoothStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.1.

Beacon Configuration

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Use this Sub-group to configure State, Airplane Mode State, Beaconing On Battery Reinsert, Type, Explicit Beacon UUID, AltBeacon, Custom Beacon, Custom Transmit Power Level, Transmit Power Level, Custom Transmit Interval, and Transmit Interval.

Detail Information:

  • Key = btBeaconConfig

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

State

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

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.

Airplane Mode State

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

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 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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

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

Type

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

Select the Type of Beacon to be emitted.

  • If the value AltBeacon is selected, an AltBeacon style Beacon will be emitted. If On is specified for Explicit Beacon UUID, then UUID must also be specified.
  • 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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon 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.

UUID

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration  >  AltBeacon Configuration

Enter the UUID to use when AltBeacon is specified for Type and On is specified for Explicit Beacon UUID.

Detail Information:

  • Key = btAltBeaconUUID

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

ID1

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration  >  AltBeacon Configuration

Enter the 4 hexadecimal characters to use for ID1 when AltBeacon is specified for Type. If no value is entered, the default value of EBEB will be used.

Detail Information:

  • Key = btAltBeaconID1

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

ID2

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration  >  AltBeacon Configuration

Enter the 4 hexadecimal characters to use for ID2 when AltBeacon is specified for Type. If no value is entered, the default value of EBEB will be used.

Detail Information:

  • Key = btAltBeaconID2

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Manufacturing Byte

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration  >  AltBeacon Configuration

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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration  >  AltBeacon Configuration

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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration  >  Custom Beacon Configuration

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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

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 High (1dBm) is selected, the transmit power level of the beacon will be set to 1dBm (maximum power)
  • If Medium (-7dBm) is selected, the transmit power level of the beacon will be set to -7dBm.
  • If Low Power (-15dBm) is selected, the transmit power level of the beacon will be set to -15dBm
  • If Ultra Low Power(-21dBm) is selected, the transmit power level of the beacon will be set to -21dBm
  • If 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

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

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 Interval

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  Beacon Configuration

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 Low Latency (100 ms) is selected, the transmit interval between beacons will be set to 100msec (Low Latency)
  • If Balanced (250 ms) is selected, the transmit interval between beacons will be set to 250msec (Balanced)
  • If Low Power (1000 ms) is selected, the transmit interval between beacons will be set to 1000msec (Low Power)
  • If 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.

Discoverability

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

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 = bluetoothDiscoverability

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

New Pairings

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter whether the device will accept new Bluetooth Pairings.

devices will accept new Bluetooth Pairings by default.

  • If the value Disallow is selected, the default behavior will be overridden and the device will not accept new Bluetooth Pairings.
  • If the value Allow is selected, the default behavior will be in effect and the device will accept new Bluetooth Pairings.

Detail Information:

  • Key = bluetoothNewPairings

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.1.

Paired Device Action

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Select whether the device will clear all paired devices.

  • If the value Do Not Clear All Paired Devices is selected, the no pairings will be cleared.
  • If the value Clear All Paired Devices is selected, all existing pairings will be cleared.

Detail Information:

  • Key = bluetoothPairedDeviceAction

  • Type = string

 UI Choice  JSON Value 
 Do Not Clear All Paired Devices  0 
 Clear All Paired Devices  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

Turn On/Off Silent Pairing

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Select whether the device can silently perform Bluetooth pairings

Devices will silently perform Bluetooth Pairings by default.

  • If the value Disallow is selected, the default behavior will be overridden and the device can not silently perform Bluetooth Pairings.
  • If the value Allow is selected, the default behavior will be in effect and the device can silently perform Bluetooth Pairings.

Note that even when the device CAN silently perform Bluetooth Pairings, it WILL NOT do so unless Action is used to configure specific silent pairing rules that define how silent pairing should occur.

Detail Information:

  • Key = bluetoothSilentPairingsState

  • Type = string

 UI Choice  JSON Value 
 Allow  2 
 Disallow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Turn On/Off Single Pairing Category

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Select the category of device of which only a single pairing will be allowed.

Only one device of the specified category 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 = bluetoothSinglePairingsCategory

  • Type = string

 UI Choice  JSON Value 
 Headset  1 
 Scanner  2 
 Printer  3 
 Payment  4 
 Dex  5 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Action

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Select an Action to manage a list of rules that control Bluetooth Silent Pairing.

Bluetooth Silent Pairing allows new Bluetooth Pairings to be automatically completed without Device User interaction, if permitted by defined rules. By defining the right set of rules, you can allow pairings between certain types of peripheral devices and a device happen automatically. By automatically is meant that if a pairing is established by an application running on a device, or at the request of a peripheral device, that pairing can complete without Device User approval or interaction.

Since the list of rules is empty by default on devices, Bluetooth Silent Pairing is disabled by default, hence all new Bluetooth Pairings will occur manually and thus will require Device User interaction to complete . Once one or more rules are added, new pairings to selected peripheral devices identified by these rules will be allowed to occur automatically while all new other new pairings will continue to occur manually.

  • If the value AddRule is selected:
    • You must also specify Add Rule Name, to provide the name of the new rule to be added or Add Rule MAC Address, to provide the Bluetooth MAC Address of the new rule to be added.
    • You must also specify Add Rule Device Class or Add Rule Device Upper Address Part to provide the criteria that the new rule will use to determine which new Bluetooth Pairings will be allowed.
  • If the value RemoveRule is selected, you must specify at least one of the following to provide the information that will be used to determine which rule or rules, which have matching information, will be removed:
    • Remove Rule Name, to provide the name of the existing rule to be removed or Remove Rule MAC Address to provide the Bluetooth MAC Address of the existing rule to be removed
    • Remove Rule Device Class
    • Remove Rule Device Upper Address Part
  • If the value RemoveAllRules is selected, you do not need to specify any additional information.

Detail Information:

  • Key = bluetoothAction

  • Type = string

 UI Choice  JSON Value 
 AddRule  1 
 RemoveRule  2 
 RemoveAllRules  3 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Add Rule Name

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter a name for a new rule to be added to the list of rules that control the operation of Bluetooth Silent Pairing when the Action value AddRule is selected for Action.

Note that you can specify Add Rule Name or Add Rule MAC Address, but not both.

Detail Information:

  • Key = bluetoothActionAddRuleName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Add Rule MAC Address

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the Bluetooth MAC Address XX:XX:XX:XX:XX:XX for a new rule to be added from the list of rules that control the operation of Bluetooth Silent Pairing when the Action value AddRule is selected for Action.

Note that you can specify Add Rule Name or Add Rule MAC Address, but not both.

Detail Information:

  • Key = bluetoothActionAddRuleMACAddress

  • Type = string

Support Information:

  • Supported on Operating System(s): Pie.

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.3.

Add Rule Device Class

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the Device Class for a new rule to be added to the list of rules that control the operation of Bluetooth Silent Pairing when the Action value AddRule is selected for Action.

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 = bluetoothActionAddRuleDeviceClass

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Add Rule Device Upper Address Part

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the Device Upper Address Part for a new rule to be added to the list of rules that control the operation of Bluetooth Silent Pairing when the Action value AddRule is selected for Action.

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 = bluetoothActionAddRuleUpperAddressPart

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Add Rule Pairing PIN Code

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the Pairing PIN Code for a new rule to be added to the list of rules that control the operation of Bluetooth Silent Pairing when the Action value AddRule is selected for Action.

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 = bluetoothActionAddRulePIN

  • Type = string

Support Information:

  • Supported on Operating System(s): Pie.

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.3.

Remove Rule Name

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the name that identifies an existing rule to be removed from the list of rules that control the operation of Bluetooth Silent Pairing when the Action value RemoveRule is selected for Action.

Any existing rule that has the specified name will be removed.

Note that you can specify Remove Rule Name or Remove Rule MAC Address, but not both.

Detail Information:

  • Key = bluetoothActionRemoveRuleName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Remove Rule MAC Address

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the Bluetooth MAC Address XX:XX:XX:XX:XX:XX that identifies an existing rule to be removed from the list of rules that control the operation of Bluetooth Silent Pairing when the Action value RemoveRule is selected for Action.

Any existing rule that has the specified Bluetooth MAC Address will be removed.

Note that you can specify Remove Rule Name or Remove Rule MAC Address, but not both.

Detail Information:

  • Key = bluetoothActionRemoveRuleMACAddress

  • Type = string

Support Information:

  • Supported on Operating System(s): Pie.

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.3.

Remove Rule Device Class

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the Device Class of an existing rule to be removed from the list of rules that control the operation of Bluetooth Silent Pairing when the Action value RemoveRule is selected for Action

Any existing rule or rules that have the specified Device Class will be removed.

Detail Information:

  • Key = bluetoothActionRemoveRuleDeviceClass

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Remove Rule Device Upper Address Part

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the Device Upper Address Part of an existing rule to be removed from the list of rules that control the operation of Bluetooth Silent Pairing when the Action value RemoveRule is selected for Action.

Any existing rule or rules that have the specified Device Upper Address Part will be removed.

Detail Information:

  • Key = bluetoothActionRemoveRuleUpperAddressPart

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Remove Rule Pairing PIN Code

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Enter the Pairing PIN Code if remote device is prior to BT 2.1, This Feature is available from Android P onward.

Detail Information:

  • Key = bluetoothActionRemoveRulePIN

  • Type = string

Support Information:

  • Supported on Operating System(s): Pie.

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.3.

BLE Configuration

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration

Use this Sub-group to configure Channel Action, Channel Rule, Channel Rule BLE Channel Blocking, and Channel Rule RF Blocking.

Detail Information:

  • Key = bleConfig

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Channel Action

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  BLE Configuration

:broken_heart: CONTENT-TBD

Detail Information:

  • Key = bleChannelAction

  • Type = string

 UI Choice  JSON Value 
 Add Rule  1 
 Remove All Rules  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 11.1.

Channel Rule

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  BLE Configuration

:broken_heart: CONTENT-TBD

Detail Information:

  • Key = bleChannelRule

  • Type = string

 UI Choice  JSON Value 
 Block BLE Channels  0 
 Block RF-Band Based BLE Channels  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 11.1.

Channel Rule BLE Channel Blocking

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  BLE Configuration

:broken_heart: CONTENT-TBD

Detail Information:

  • Key = bleBLEChannelBlocking

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 11.1.

Channel Rule RF Blocking

   Transaction Steps  >  Transaction Step  >  Bluetooth Configuration  >  BLE Configuration

:broken_heart: CONTENT-TBD

Detail Information:

  • Key = bleRFBlocking

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 11.1.


Bug Reporting Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Extensions State, Intent Enable, Screenshot Enable, Show In Power Key Menu, ANR Error Action, Unexpected Error Action, Send to Cloud Detail, Store in Device Detail, Send Via Email Detail, Dialog Elements, and Dialog Time Out.

Detail Information:

  • Key = bugreportStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Extensions State

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Select whether the Standard Android or Zebra Extended Bug Reporting should be used for generation of Bug Reports from a device.

  • If the value Off is selected, Standard Android Bug Reporting will be used, with no Zebra Extensions or Enhancements.
  • If the value On is selected, Zebra Extended Bug Reporting. You may also need to specify additional configuration with the Group to configure the desired behavior and options of Zebra Extended Bug Reporting.

Detail Information:

  • Key = bugreportBugReportProfile

  • Type = string

 UI Choice  JSON Value 
 Off  old 
 On  new 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Intent Enable

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Select whether the Zebra Extended Bug Reporting should allow a Bug Report to be initiated by an application by sending a broadcast intent with an action value of com.symbol.mxmf.intent.START_FOR_BUG_REPORT. This is meaningful only when Zebra Extended Bug Reporting is enabled.

  • If the value Off is selected, Zebra Extended Bug Reporting, if enabled, will not initiate a Bug Report when the defined intent is received.
  • If the value On is selected, Zebra Extended Bug Reporting, if enabled, will initiate a Bug Report when the defined intent is received.

Detail Information:

  • Key = bugreportEnableIntent

  • Type = string

 UI Choice  JSON Value 
 Off  False 
 On  True 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Screenshot Enable

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Select whether the Zebra Extended Bug Reporting should be allowed to capture screenshots and attach them to Bug Reports.

  • If the value Off is selected, Zebra Extended Bug Reporting, if enabled, will not capture Bug Reports nor attach them to Bug Reports.
  • If the value On is selected, Zebra Extended Bug Reporting, if enabled, will capture Bug Reports and attach them to Bug Reports.

Detail Information:

  • Key = bugreportEnableScreenshot

  • Type = string

 UI Choice  JSON Value 
 Off  False 
 On  True 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Show In Power Key Menu

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Select whether Zebra Extended Bug Reporting should display an option to initiate a Bug Report in the menu which appears after long-pressing the power key on the device.

  • If the value Off is selected, Zebra Extended Bug Reporting will NOT add an option to the menu.
  • If the value On is selected, Zebra Extended Bug Reporting, will add an option to the menu.

Detail Information:

  • Key = bugreportEnableBRInPwrMenu

  • Type = string

 UI Choice  JSON Value 
 Off  False 
 On  True 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

ANR Error Action

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Select whether Zebra Extended Bug Reporting should watch for the occurrence of Application Not Responding (ANR) errors and take action when they are detected.

  • If the value Do not capture is selected, Zebra Extended Bug Reporting will NOT watch for the occurrence of ANR errors, and hence will take no action if they occur.
  • If the value Capture bug report is selected, Zebra Extended Bug Reporting will watch for the occurrence of ANR errors, and will automatically initiate a Bug Report each time it detects that one has occurred.
  • If the value Capture logcat log is selected, Zebra Extended Bug Reporting will watch for the occurrence of ANR errors, and will automatically initiate a Logcat capture each time it detects that one has occurred.

Detail Information:

  • Key = bugreportANRErrAction

  • Type = string

 UI Choice  JSON Value 
 Do not capture  NoCapture 
 Capture bug report  CaptureBR 
 Capture logcat log  CaptureLogcat 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.0.

Unexpected Error Action

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Select whether Zebra Extended Bug Reporting should watch for the occurrence of Unexpected Application Errors (UAEs) and take action when they are detected.

  • If the value Do not capture is selected, Zebra Extended Bug Reporting will NOT watch for the occurrence of UAEs, and hence will take no action if they occur.
  • If the value Capture bug report is selected, Zebra Extended Bug Reporting will watch for the occurrence of UAEs, and will automatically initiate a Bug Report each time it detects that one has occurred.
  • If the value Capture logcat log is selected, Zebra Extended Bug Reporting will watch for the occurrence of UAEs, and will automatically initiate a Logcat capture each time it detects that one has occurred.

Detail Information:

  • Key = bugreportUnexpectedErrAction

  • Type = string

 UI Choice  JSON Value 
 Do not capture  NoCapture 
 Capture bug report  CaptureBR 
 Capture logcat log  CaptureLogcat 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.0.

Send to Cloud Detail

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Use this Sub-group to configure State, and Time to Live.

Detail Information:

  • Key = bugreportCloudDetails

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

State

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send to Cloud Detail

Select whether Zebra Extended Bug Reporting should automatically send copies of generated Bug Reports to the Zebra Cloud Server.

  • If the value Off is selected, Zebra Extended Bug Reporting will NOT send copies of generated Bug Reports to the Zebra Cloud Server.
  • If the value On is selected, Zebra Extended Bug Reporting, if enabled, will send copies of all generated Bug Reports to the Zebra Cloud Server.

Detail Information:

  • Key = bugreportCloudEnable

  • Type = string

 UI Choice  JSON Value 
 Off  False 
 On  True 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Time to Live

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send to Cloud Detail

Select a timeout value, the expiration of which will cause the sending Bug Reports to the Zebra Cloud Server to automatically cease.

  • If the value Never Expire is selected, and Zebra Extended Bug Reporting is configured to send Bug Reports to the Zebra Cloud Server via the Group Send to Cloud Detail, Zebra Extended Bug Reporting will continue to send Bug Reports to the Zebra Cloud Server, until the configuration is explicitly changed again.
  • If any other value is selected, at the time Zebra Extended Bug Reporting is configured to send Bug Reports to the Zebra Cloud Server via the Group Send to Cloud Detail, Zebra Extended Bug Reporting will start a timer from the specified timeout value and will cease sending Bug Reports to the Zebra Cloud Server when the timer expires, until the configuration is explicitly changed again.

Detail Information:

  • Key = bugreportCloudTTL

  • Type = string

 UI Choice  JSON Value 
 Never Expire  0 
 1 Day  1 
 1 Week  7 
 2 Weeks  14 
 1 Month  30 
 3 Months  90 
 6 Months  180 
 1 Year  365 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Store in Device Detail

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Use this Sub-group to configure State, File Path, and Time to Live.

Detail Information:

  • Key = bugreportStorageDetails

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

State

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Store in Device Detail

Select whether Zebra Extended Bug Reporting should automatically store copies of generated Bug Reports in the device.

  • If the value Off is selected, Zebra Extended Bug Reporting will NOT store copies of generated Bug Reports in the device.
  • If the value On is selected, Zebra Extended Bug Reporting, if enabled, will store copies of generated Bug Reports in the device.

Detail Information:

  • Key = bugreportStorageEnable

  • Type = string

 UI Choice  JSON Value 
 Off  False 
 On  True 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

File Path

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Store in Device Detail

Enter the path where Zebra Extended Bug Reporting should automatically store copies of generated Bug Reports in the device when the value On is selected for State.

Note that either fixed or removable storage are supported, but the specified path must be valid at the time Bug Report is generated. If no path is specified, bug reports are stored in /storage/sdcard0/BugReports/, which will always be a valid path for storage of Bug Reports on all devices.

Detail Information:

  • Key = bugreportBugReportFilePath

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Time to Live

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Store in Device Detail

Select a timeout value, the expiration of which will cause the storing of Bug Reports in the device to automatically cease.

  • If the value Never Expire is selected, and when Zebra Extended Bug Reporting is configured to store Bug Reports in the device via the Group Store in Device Detail, Zebra Extended Bug Reporting will continue to store Bug Reports in the device until the configuration is explicitly changed again.
  • If any other value is selected, at the time Zebra Extended Bug Reporting is configured to store Bug Reports in the device via the Group Store in Device Detail, a timer will be started for the specified timeout value and when that timer expires, Zebra Extended Bug Reporting will cease storing Bug Reports in the device, until the configuration is explicitly changed again.

Detail Information:

  • Key = bugreportStorageTTL

  • Type = string

 UI Choice  JSON Value 
 Never Expire  0 
 1 Day  1 
 1 Week  7 
 2 Weeks  14 
 1 Month  30 
 3 Months  90 
 6 Months  180 
 1 Year  365 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Send Via Email Detail

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Use this Sub-group to configure State, SMTP Host, SMTP Port, Sender ID, Sender Password, Send To Address, and Time to Live.

Detail Information:

  • Key = bugreportEmailDetails

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

State

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send Via Email Detail

Select whether Zebra Extended Bug Reporting should automatically send copies of generated Bug Reports via email.

  • If the value Off is selected, Zebra Extended Bug Reporting will NOT send copies of generated Bug Reports via email.
  • If the value On is selected, Zebra Extended Bug Reporting, if enabled, will send copies of generated Bug Reports via email. You should also specify additional information to provide the details of the email to be sent.

Detail Information:

  • Key = bugreportEmailEnable

  • Type = string

 UI Choice  JSON Value 
 Off  False 
 On  True 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

SMTP Host

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send Via Email Detail

Enter the address or host name of the SMTP (email) Server via which emails will be sent to deliver generated Bug Reports, and should be specified when the value On is selected for State.

Note that you must have access to an email account on the selected SMTP Server and you must specify additional configuration within the Group to configure Zebra Extended Bug Reporting to send emails via that SMTP Server. In addition, you must have access to a valid email account to use as the destination of the emails, which is NOT required to be on the same SMTP Server, and must specify details of the email address within the Group, to configure Zebra Extended Bug Reporting to send the emails to that destination.

Detail Information:

  • Key = bugreportEmailSMTPHost

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

SMTP Port

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send Via Email Detail

Enter the TCP port number of the SMTP (email) Server via which emails will be sent to deliver generated Bug Reports when SMTP Host is specified.

Detail Information:

  • Key = bugreportEmailSMTPPort

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Sender ID

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send Via Email Detail

Enter the ID of the email account that will be used as the source (from address) of emails that will be sent to deliver generated Bug Reports, and should be specified when the value On is selected for State and when a valid SMTP (email) Server is specified via SMTP Host.

Note that you must have access to a valid email account on the configured SMTP (email) Server and must specify additional information in the Group, such as Sender Password to enable Zebra Extended Bug Reporting to successfully send the emails using that account via that server.

Detail Information:

  • Key = bugreportEmailSendersID

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Sender Password

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send Via Email Detail

Enter the password of the email account that will be used as the source (from address) of emails that will be sent to deliver generated Bug Reports, and should be specified when the value On is selected for State and a valid SMTP (email) Server is specified via SMTP Host and a valid email address is specified via Sender ID.

Detail Information:

  • Key = bugreportEmailSendersPassword

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Send To Address

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send Via Email Detail

Enter the email address of the email account that will be used as the destination (to address) of emails that will be sent to deliver generated Bug Reports, and should be specified when the value On is selected for State.

Detail Information:

  • Key = bugreportEmailSendTo

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Time to Live

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Send Via Email Detail

Select a timeout value, the expiration of which will cause the sending of Bug Reports via email to automatically cease.

  • If the value Never Expire is selected, and Zebra Extended Bug Reporting is configured to send Bug Reports to the Zebra Cloud Server via the Group Send Via Email Detail, Zebra Extended Bug Reporting will continue to send Bug Reports via email, until the configuration is explicitly changed again.
  • If any other value is selected, at the time Zebra Extended Bug Reporting is configured to send Bug Reports via email via the Group Send Via Email Detail, Zebra Extended Bug Reporting will start a timer from the specified timeout value and will cease sending Bug Reports via email when the timer expires, until the configuration is explicitly changed again.

Detail Information:

  • Key = bugreportEmailTTL

  • Type = string

 UI Choice  JSON Value 
 Never Expire  0 
 1 Day  1 
 1 Week  7 
 2 Weeks  14 
 1 Month  30 
 3 Months  90 
 6 Months  180 
 1 Year  365 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Dialog Elements

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Use this Sub-array to configure one or more Element Detail(s).

Detail Information:

  • Key = bugreportDialogElements

  • Type = bundle_array

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Element Detail

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Dialog Elements

Use this Sub-group to configure Type, Error Name Text Box Text, Label Text, and Text Box Text.

Detail Information:

  • Key = bugreportDialogElement

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Type

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Dialog Elements  >  Element Detail

Select the type of a single dialog element being included in the dialog that will be presented to the Device User to collect information that will be included in generated Bug Reports.

  • If the value ErrorNameTextBox is selected, a text box will be added to the dialog presented to the Device User in which the name to be assigned to the Bug Report being generated can be entered. You must also specify Error Name Text Box Text to provide a text to be pre-populated into the text box.
  • If the value Label is selected, a text label will be added to the dialog presented to the Device User. You must also specify Label Text to provide the text to be populated into the label.
  • If the value TextBox is selected, a text box will be added to the dialog presented to the Device User in which generic text can be entered. You must also specify Text Box Text to provide the text to be pre-populated into the text box. The specified text will to provide guidance to the Device User about the expected value and will disappear when the user begins typing into the text box.
  • If the value VoiceRecordButton is selected, a voice record button will be added to the dialog presented to the Device User. Clicking this button will allow the Device User to record a verbal explanation of the bug to be attached to the generated Bug Report.

Detail Information:

  • Key = bugreportDialogElementType

  • Type = string

 UI Choice  JSON Value 
 ErrorNameTextBox  AddErrorNameTextBox 
 Label  AddLabel 
 TextBox  AddTextBox 
 VoiceRecordButton  AddVoiceRecordButton 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Error Name Text Box Text

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Dialog Elements  >  Element Detail

Enter the text to be pre-populated into a text box that will be added to the dialog presented to the Device User in which the name to be assigned to the Bug Report being generated can be entered and should be specified when the value ErrorNameTextBox is selected for Type.

Detail Information:

  • Key = bugreportDialogElementTypeErrorNameTextBoxText

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Label Text

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Dialog Elements  >  Element Detail

Enter the text of a label that will be added to the dialog presented to the Device User when the value Label is selected for Type.

Detail Information:

  • Key = bugreportDialogElementTypeLabelText

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Text Box Text

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration  >  Dialog Elements  >  Element Detail

Enter the text that be pre-populated into a text box added to the dialog presented to the Device User into which generic text can be entered and should be specified when the value TextBox is selected for Type. The specified text should provide guidance to the Device User about the value they should enter and will be overwritted by the value entered into the text box.

Detail Information:

  • Key = bugreportDialogElementTypeTextBoxText

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Dialog Time Out

   Transaction Steps  >  Transaction Step  >  Bug Reporting Configuration

Enter the amount of inactivity time (time in milliseconds with no Device User activity), after which the dialog presented to the Device User will automatically be dismissed, causing the Bug Report to be completed as if the Device User had explicitly clicked the Submit Button.

Detail Information:

  • Key = bugreportDialogTimeout

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.


Camera Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Use Of Back Camera, Use Of Front Camera, and Use Of Imager.

Detail Information:

  • Key = cameraStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Use Of Back Camera

   Transaction Steps  >  Transaction Step  >  Camera Configuration

Select whether the Rear Facing Camera, if present on a device, can be used to take pictures.

  • If the value Off is selected, no applications or services running on the device will be allowed to take pictures using the Rear Facing Camera.
  • If the value On is selected, any applications or services running on the device will be allowed to take pictures using the Rear Facing Camera.

Detail Information:

  • Key = cameraUseOfBack

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Use Of Front Camera

   Transaction Steps  >  Transaction Step  >  Camera Configuration

Select whether the Front Facing (selfie) Camera, if present on a device, can be used to take pictures.

  • If the value Off is selected, no applications or services running on the device will be allowed to take pictures using the Front Facing (selfie) Camera.
  • If the value On is selected, any applications or services running on the device will be allowed to take pictures using the Front Facing (selfie) Camera.

Detail Information:

  • Key = cameraUseOfFront

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Use Of Imager

   Transaction Steps  >  Transaction Step  >  Camera Configuration

Select whether the Imager (special-purpose image capture device), if present on a device, can be used to take pictures.

  • If the value Off is selected, no applications or services running on the device will be allowed to take pictures using the Imager (special-purpose image capture device) Camera.
  • If the value On is selected, any applications or services running on the device will be allowed to take pictures using the Imager (special-purpose image capture device) Camera.

Detail Information:

  • Key = cameraUseOfImager

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.1.


Clock Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Time Mode, Manual Date, Manual Time, Manual UTC Date, Manual UTC Time, Auto NTP Server Address, Auto NTP Sync Interval, Time Zone Mode, Zone, and Time Format.

Detail Information:

  • Key = clockStep

  • Type = bundle

Time Mode

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Select whether time and date configuration will be performed explicitly, through configuration, or automatically, by connecting to a Network Time Protocol (NTP) Server.

Detail Information:

  • Key = clockTimeMode

  • Type = string

 UI Choice  JSON Value 
 Manual  false 
 Auto  true 

Support Information:

  • Supported from: MX 4.2.

Manual Date

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Enter the date to be set on a device when the value Manual is selected for Time Mode.

Detail Information:

  • Key = clockManualDate

  • Type = string

Support Information:

  • Supported from: MX 4.1.

Manual Time

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Enter the time to be set on a device when the value Manual is selected for Time Mode.

Detail Information:

  • Key = clockManualTime

  • Type = string

Support Information:

  • Supported from: MX 4.1.

Manual UTC Date

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Enter the date to be set on a device normalized to universal time (UTC) when the value Manual is selected for Time Mode.

Detail Information:

  • Key = clockManualDateUTC

  • Type = string

Support Information:

  • Supported from: MX 10.2.

Manual UTC Time

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Enter the time to be set on a device normalized to universal time (UTC) when the value Manual is selected for Time Mode.

Detail Information:

  • Key = clockManualTimeUTC

  • Type = string

Support Information:

  • Supported from: MX 10.2.

Auto NTP Server Address

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Enter the address of the Network Time Protocol (NTP) Server to be used to perform automatic date and time configuration on a device when the value Auto is selected for Time Mode.

Detail Information:

  • Key = clockAutoNtpServer

  • Type = string

Support Information:

  • Supported from: MX 4.2.

Auto NTP Sync Interval

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Enter the interval at which automatic date and time configuration will be performed on a device when the value Auto is selected for Time Mode.

Detail Information:

  • Key = clockAutoNtpSyncInterval

  • Type = string

 UI Choice  JSON Value 
 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

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Select whether time zone configuration will be performed explicitly, using other configurations in the Group, or automatically, by connecting to a Network Identity and Time Zone (NITZ) source.

Detail Information:

  • Key = clockTimeZoneMode

  • Type = string

 UI Choice  JSON Value 
 Manual  false 
 Auto  true 

Support Information:

  • Supported from: MX 6.0.

Zone

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Enter the time zone to be set on a device when the value Manual is selected for Time Zone Mode.

Detail Information:

  • Key = clockManualTimeZone

  • Type = string

Support Information:

  • Supported from: MX 4.1.

Time Format

   Transaction Steps  >  Transaction Step  >  Clock Configuration

Select whether the format in which time will be displayed on the device will be in 12 hour (AM/PM) or 24 hour (military) format.

Detail Information:

  • Key = clockTimeFormat

  • Type = string

 UI Choice  JSON Value 
 12  2 
 24  1 

Support Information:

  • Supported from: MX 6.0.


DataWedge Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Database File, NG Simulscan Template File, Automatic Database Import, Intent Access Control of Configuration APIs, Intent Access Control of Notification APIs, Intent Access Control of Query APIs, Intent Access Control of Runtime APIs, Manual, and Programmatic Import.

Detail Information:

  • Key = dataWedgeStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Database File

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Enter the device path and file name of a DataWedge Database file (full or partial) to replace or be merged to modify 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.

NG Simulscan Template File

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Enter the device path and file name of a valid Simulscan template file to be imported to replace or add to 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

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Select whether DataWedge Database Files deployed to the DataWedge autoimport folder on the device will automatically trigger importing of the file.

Detail Information:

  • Key = dataWedgeAutoImport

  • Type = string

 UI Choice  JSON Value 
 Off  0 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Intent Access Control of Configuration APIs

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Select the Access Control to be used by DataWedge Configuration Intent APIs.

Detail Information:

  • Key = dataWedgeIntentAccessControlConfigurationAPIs

  • Type = string

 UI Choice  JSON Value 
 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.

Intent Access Control of Notification APIs

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Select the Access Control to be used by DataWedge Notification Intent APIs.

Detail Information:

  • Key = dataWedgeIntentAccessControlNotificationAPIs

  • Type = string

 UI Choice  JSON Value 
 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.

Intent Access Control of Query APIs

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Select the Access Control to be used by DataWedge Query Intent APIs.

Detail Information:

  • Key = dataWedgeIntentAccessControlQueryAPIs

  • Type = string

 UI Choice  JSON Value 
 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.

Intent Access Control of Runtime APIs

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Select the Access Control to be used by DataWedge Runtime Intent APIs.

Detail Information:

  • Key = dataWedgeIntentAccessControlRuntimeAPIs

  • Type = string

 UI Choice  JSON Value 
 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.

Manual Configuration

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Select whether Device Users will be allowed to manually alter the configuration of DataWedge from the DataWedge configuration UI.API.

Detail Information:

  • Key = dataWedgeManualConfiguration

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Programmatic Import

   Transaction Steps  >  Transaction Step  >  DataWedge Configuration

Select whether whether applications will be allowed to programmatically import DataWedge Configuration Files using the DataWedge Intent API.

Detail Information:

  • Key = dataWedgeApiImport

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.


Device Administration Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Allow Submit XML Package Name, Disallow Submit XML Package Name, Submit XML, Allow Package Update Package Name, Disallow Package Update Package Name, Reserve User ID Package Name, Reserve User ID Package Signature, Unreserve User ID Package Name, Lock Screen Wallpaper, Custom Lock Screen Wallpaper, App Management Notifications, Notifications on Lock Screen, Secure Start-up Selection by Device User, and Alert Button.

Detail Information:

  • Key = devadminStep

  • Type = bundle

Action

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Select an Action to control access to or utilize the Zebra MX Management System on a device.

  • If the value Allow App To Submit Xml is selected, a single application or service is allowed to submit XML for processing by the Zebra MX Management System. You must also specify Allow Submit XML Package Name to provide the Android Package Name that identifies the application or service is to be allowed.
  • If the value Disallow App From Submitting Xml is selected, a single application service is disallowed from submitting XML for processing by the Zebra MX Management System. You must also specify Disallow Submit XML Package Name to provide the Android Package Name that identifies the application or service is to be disallowed.
  • If the value Submit Xml is selected, you must also specify Submit XML to provide the XML string that will be submitted for processing by the .Zebra MX Management System.
  • If the value Reserve UID for App is selected, you must also specify Reserve User ID Package Name to identify the particular package to which the User ID is reserved.
  • You must also specify Reserve User ID Package Signature to assure that the package to which the User ID is reserved is the right one.
  • If the value Unreserve UID for App is selected, you must also specify Unreserve User ID Package Name to identify the particular package to which the User ID is reserved.
  • If the value Allow App To Update is selected, you must also specify Allow Package Update Package Name to identify the particular package allowed to be updated. This is only necessary for applications that were previously disallowed using Disallow App From Update
  • If the value Disallow App From Update is selected, you must also specify Disallow Package Update Package Name to identify the particular package to be prevented from being updated.

Detail Information:

  • Key = devadminAction

  • Type = string

 UI Choice  JSON Value 
 Allow App To Submit Xml  AllowSubmitXml 
 Disallow App From Submitting Xml  DisallowSubmitXml 
 Submit Xml  SubmitXml 
 Reserve UID for App  ReserveUID 
 Unreserve UID for App  UnreserveUID 
 Allow App To Update  AllowApplicationUpgrade 
 Disallow App From Update  DisallowApplicationUpgrade 

Support Information:

  • Supported from: MX 9.2.

Allow Submit XML Package Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter the Android Package Name that identifies the application or service is to be allowed when the value Allow App To Submit Xml is selected for Action.

Detail Information:

  • Key = devadminActionAllowSubmitXmlPackageName

  • Type = string

Support Information:

  • Supported from: MX 4.2.

Disallow Submit XML Package Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter the Android Package Name that identifies the application or service is to be disallowed when the value Disallow App From Submitting Xml is selected for Action.

Detail Information:

  • Key = devadminActionDisallowSubmitXmlPackageName

  • Type = string

Support Information:

  • Supported from: MX 4.2.

Submit XML

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter an XML string to be submitted for processing by the .Zebra MX Management System, when the value Submit Xml is selected for Action.

Detail Information:

  • Key = devadminActionSubmitXml

  • Type = string

Allow Package Update Package Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter the Android Package Name of the application allowed to be updated, when the value Allow App To Update is selected for Action.

Detail Information:

  • Key = devadminActionAllowUpdatePackageName

  • Type = string

Support Information:

  • Supported from: MX 10.3.

Disallow Package Update Package Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter the Android Package Name of the application not allowed to be updated, when the value Disallow App From Update is selected for Action.

Detail Information:

  • Key = devadminActionDisallowUpdatePackageName

  • Type = string

Support Information:

  • Supported from: MX 10.3.

Reserve User ID Package Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter the Android Package Name of the application needing a reserved UID, when the value Reserve UID for App is selected for Action.

Detail Information:

  • Key = devadminActionReserveUIDPackageName

  • Type = string

Support Information:

  • Supported from: MX 9.2.

Reserve User ID Package Signature

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter the Android Package Signature of the application needing a reserved UID, when the value Reserve UID for App is selected for Action. The value entered must be the Base 64 encoded content of the DER format certificate used to sign the application. The DER-format certificate can be obtained from the application author or can be extracted from the APK file if necessary. Base 64 encoding must be performed to ensure that the value is suitable for transmission as a Managed Configuration.

Detail Information:

  • Key = devadminActionReserveUIDPackageSignature

  • Type = string

Support Information:

  • Supported from: MX 9.2.

Unreserve User ID Package Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter the Android Package Name of the application whose user ID can be released (unreserved), when the value Unreserve UID for App is selected for Action.

Detail Information:

  • Key = devadminActionUnreserveUIDPackageName

  • Type = string

Support Information:

  • Supported from: MX 9.2.

Lock Screen Wallpaper

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

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 Custom Lock Screen Wallpaper will be used on the lock screen.

Detail Information:

  • Key = daLockScreenWallpaper

  • Type = string

 UI Choice  JSON Value 
 Restore to default  1 
 Custom  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.5.

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

Custom Lock Screen Wallpaper

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Enter the path and file name of an image file on the device (.jpg or .png)

Detail Information:

  • Key = daCustomLockWallpaper

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.5.

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

App Management Notifications

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Select whether the device user receives 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, no notifications will be shown to the user when the Device Owner installs, uninstalls, or upgrades applications. s

Detail Information:

  • Key = daSilentAppInstall

  • Type = string

 UI Choice  JSON Value 
 Show  1 
 Hide  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.5.

Notifications on Lock Screen

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

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 = daNotificationsOnLockScreen

  • Type = string

 UI Choice  JSON Value 
 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.

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

Secure Start-up Selection by Device User

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Select whether Device User will be allowed to Select Secure Start-up when changing pin/password/pattern.

Detail Information:

  • Key = secureStartupDialog

  • Type = string

 UI Choice  JSON Value 
 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.

Alert Button

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration

Use this Sub-group to configure Mode, Action, Keep Device Awake, Key Identifier, Intent Action, Intent Category, Intent Class, Intent Package Name, Intent Data URI, Intent File, Intent MIME Type, Intent Extras, Sensor Identifier, and Sensor Parameter.

Detail Information:

  • Key = alertButton

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

Mode

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Select the mode used by the Alert Button on a device.

  • If the value Schedule sending of Intent on key presses is selected, the action specified in Action will be performed when the configured button is pressed. You must also specify Action to provide the action to be done along with Key Identifier to define the key identifier to be used to trigger the alert.
  • If the value Cancel sending of Intent on key presses is selected, the previously configured action is canceled.
  • If the value Schedule sending of Intent on sensor trigger is selected, the action specified in Action will be performed when the sensor specified in Sensor Identifier is triggered. You must also specify the parameter Sensor Parameter
  • If the value Cancel sending of Intent on sensor trigger is selected, the previously configured action for sensor trigger is canceled.

Detail Information:

  • Key = alertButtonMode

  • Type = string

 UI Choice  JSON Value 
 Schedule sending of Intent on key presses  2 
 Cancel sending of Intent on key presses  3 
 Schedule sending of Intent on sensor trigger  4 
 Cancel sending of Intent on sensor trigger  5 

Support Information:

  • Supported from: MX 10.2.

Action

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Select the Action to be taken when the Alert Button is pressed, when the value of Schedule sending of Intent on key presses is selected for Mode.

Detail Information:

  • Key = alertButtonModeAction

  • Type = string

 UI Choice  JSON Value 
 StartActivity  StartActivity 
 StartService  StartService 
 Broadcast  Broadcast 

Support Information:

  • Supported from: MX 10.2.

Keep Device Awake

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Select whether the device should stay awake when the Alert Button is configured, when the value Schedule sending of Intent on key presses is selected for Mode.

Detail Information:

  • Key = alertButtonModeKeepAwake

  • Type = boolean

Support Information:

  • Supported from: MX 10.2.

Key Identifier

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Select the Key Identifier to be used for the Alert Button, when the value Schedule sending of Intent on key presses is selected for Mode.

Detail Information:

  • Key = alertButtonModeKeyIdentifier

  • 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 
 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

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Enter the action value of an Android Intent to be sent when the Alert Button is activated.

An action value is NOT mandatory to specify for an Android Intent. But an action value is commonly used to identify the purpose of an Android Intent. This can be especially when the application or service to be invoked supports multiple functions, in which case the action value is commonly used to identify which function to perform when invoking that application or service. You will need to consult the documentation or developer of a given application or service to determine whether an action value is needed and, if so, which value will invoke the desired behavior.

Detail Information:

  • Key = alertButtonModeIntentAction

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Intent Category

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Enter the category value of an Android Intent to be sent to invoke the alert button is activated.

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 = alertButtonModeIntentCategory

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Intent Class

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Enter the Android Class that identifies an Android Component within an application or service to invoke when the Alert Button is activated.

Detail Information:

  • Key = alertButtonModeIntentClass

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Intent Package Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Enter the Android Package Name of the application to invoke when the Alert Button is activated.

It is not mandatory to specify the Android Package Name when sending an Android Intent, but is is often advisable.

  • When an Android Package Name is specified, the intent becomes an Explicit Intent and the intent can ONLY be sent to an application or service with that Android Package Name and no other. This can increase security and is often used when the intent being sent requires any sensitive data. You must also specify Class whenever an Android Package Name is specified, since an Explicit Intent is always sent to an Android Component, which is identified by a Android Package Name and a Class within that Package.
  • When no Android Package Name is specified, the intent becomes an Implicit Intent and the intent may be sent to any application or service that has registered its ability to handle that intent. This can increase flexibility 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 that intent.

Detail Information:

  • Key = alertButtonModeIntentPackageName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Intent Data URI

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Enter a Uniform Resource Identifier (URI) that identifies some data, in the form of a resource on the device (e.g. a file in the device file system) or off the device (e.g. a resource available via a network) that should be utilized by the application or service invoked when the Alert Button is pressed

Whether the intended recipient of 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.

Detail Information:

  • Key = alertButtonModeIntentDataUri

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Intent File

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Enter intent file to be set for the intent to be sent.

Detail Information:

  • Key = alertButtonModeIntentFile

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Intent MIME Type

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Enter a Multipurpose Internet Mail Extensions (MIME) type to use when processing the intent data and when the Alert Button is activated.

Normally the type would be inferred from the data itself. Setting a MIME type explicitly, disables automatic type detection and and forces handling according to the specified type.

Detail Information:

  • Key = alertButtonModeIntentMimeType

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Intent Extras

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Open to configure up to 5 intent extras to be included in the intent triggered when the Alert Button is pressed.

Detail Information:

  • Key = alertButtonModeIntentExtras

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

Extra #1 Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra name 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. Exactly one value whose data type must be string can be specified. When Extra #1 Name is specified, you must also specify Extra #1 Value to provide the corresponding value to be attached for the string extra.

Detail Information:

  • Key = extraName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #1 Type

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Select the intent extra value type 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. The value specified in Extra #1 Value must be correspond to the data type specified in Extra #1 Type

Detail Information:

  • Key = extraType

  • Type = string

 UI Choice  JSON Value 
 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.

Extra #1 Value

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra value 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. Enter the value associated with Extra #1 Name corresponding to the type specified in Extra #1 Type

Detail Information:

  • Key = extraValue

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #2 Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra name 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. Exactly one value whose data type must be string can be specified. When Extra #2 Name is specified, you must also specify Extra #2 Value to provide the corresponding value to be attached for the string extra.

Detail Information:

  • Key = extra1Name

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #2 Type

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Select the intent extra value type 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. The value specified in Extra #2 Value must be correspond to the data type specified in Extra #2 Type

Detail Information:

  • Key = extra1Type

  • Type = string

 UI Choice  JSON Value 
 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.

Extra #2 Value

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra value 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. Enter the value associated with Extra #2 Name corresponding to the type specified in Extra #2 Type

Detail Information:

  • Key = extra1Value

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #3 Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra name 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. Exactly one value whose data type must be string can be specified. When Extra #3 Name is specified, you must also specify Extra #3 Value to provide the corresponding value to be attached for the string extra.

Detail Information:

  • Key = extra2Name

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #3 Type

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Select the intent extra value type 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. The value specified in Extra #3 Value must be correspond to the data type specified in Extra #3 Type

Detail Information:

  • Key = extra2Type

  • Type = string

 UI Choice  JSON Value 
 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.

Extra #3 Value

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra value 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. Enter the value associated with Extra #3 Name corresponding to the type specified in Extra #3 Type

Detail Information:

  • Key = extra2Value

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #4 Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra name 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. Exactly one value whose data type must be string can be specified. When Extra #4 Name is specified, you must also specify Extra #4 Value to provide the corresponding value to be attached for the string extra.

Detail Information:

  • Key = extra3Name

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #4 Type

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Select the intent extra value type 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. The value specified in Extra #4 Value must be correspond to the data type specified in Extra #4 Type

Detail Information:

  • Key = extra3Type

  • Type = string

 UI Choice  JSON Value 
 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.

Extra #4 Value

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra value 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. Enter the value associated with Extra #4 Name corresponding to the type specified in Extra #4 Type

Detail Information:

  • Key = extra3Value

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #5 Name

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra name 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. Exactly one value whose data type must be string can be specified. When Extra #5 Name is specified, you must also specify Extra #5 Value to provide the corresponding value to be attached for the string extra.

Detail Information:

  • Key = extra4Name

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Extra #5 Type

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Select the intent extra value type 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. The value specified in Extra #5 Value must be correspond to the data type specified in Extra #5 Type

Detail Information:

  • Key = extra4Type

  • Type = string

 UI Choice  JSON Value 
 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.

Extra #5 Value

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button  >  Intent Extras

Enter the intent extra value 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. Enter the value associated with Extra #5 Name corresponding to the type specified in Extra #5 Type

Detail Information:

  • Key = extra4Value

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Sensor Identifier

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Select the sensor in the device that will be used to trigger or cancel the intent, when the value Schedule sending of Intent on sensor trigger or Cancel sending of Intent on sensor trigger is selected for Mode.

Detail Information:

  • Key = alertButtonModeSensorIdentifier

  • Type = string

 UI Choice  JSON Value 
 Free Fall Detection  1 

Support Information:

  • Supported from: MX 10.5.

Sensor Parameter

   Transaction Steps  >  Transaction Step  >  Device Administration Configuration  >  Alert Button

Enter name of the extra to send in the intent that is sent for sensor status when the value Schedule sending of Intent on sensor trigger is selected for Mode and StartActivity, or StartService, or Broadcast is selected for Action.

Detail Information:

  • Key = alertButtonModeSensorParameter

  • Type = string

Support Information:

  • Supported from: MX 10.5.


Device Central Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Bluetooth On/Off Control, Bluetooth Pairing Control, Firmware Update Button, and Smart Leash.

Detail Information:

  • Key = deviceCentralStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Bluetooth On/Off Control

   Transaction Steps  >  Transaction Step  >  Device Central Configuration

Select whether the Device User should be allowed to use the Device Central UI to control Bluetooth Power.

  • If the value Disallow is selected, Device Central will NOT provide UI that allows the Device User to control the Bluetooth power state.

  • If the value Allow is selected, Device Central will provide UI that allows the Device User to control the Bluetooth power state.

Detail Information:

  • Key = deviceCentralBluetoothOnOffControl

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Bluetooth Pairing Control

   Transaction Steps  >  Transaction Step  >  Device Central Configuration

Select whether Device Central system should allow multiple pairings to the same Device Class. This feature has been deprecated in Device Central. Look in the Bluetooth Configuration

  • 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 = deviceCentralBluetoothPairingControl

  • Type = string

 UI Choice  JSON Value 
 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.

Firmware Update Button

   Transaction Steps  >  Transaction Step  >  Device Central Configuration

Select whether the Device User should be allowed to use the Device Central UI to initiate a Firmware Update.

  • If the value Disallow is selected, Device Central will NOT provide UI that allows the Device User to initiate a Firmware Update.
  • If the value Allow is selected, Device Central will provide UI that allows the Device User to initiate a Firmware Update.

Detail Information:

  • Key = deviceCentralFirmwareUpdateButton

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Smart Leash

   Transaction Steps  >  Transaction Step  >  Device Central Configuration

Use this Sub-group to configure Audio Feedback Repeat Count, Audio Feedback Sound, Audio Feedback State, Audio Feedback Volume, Haptic Feedback State, Haptic Feedback Time, Settings UI, and State.

Detail Information:

  • Key = deviceCentralSmartLeash

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

Audio Feedback Repeat Count

   Transaction Steps  >  Transaction Step  >  Device Central Configuration  >  Smart Leash

Enter the number of times the sound should be repeated when Audio Feedback State is set to Turn On. Supported values range between 0 and 100.

Detail Information:

  • Key = SmartLeashAudioFeedbackRepeatCount

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Audio Feedback Sound

   Transaction Steps  >  Transaction Step  >  Device Central Configuration  >  Smart Leash

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 = SmartLeashAudioFeedbackSound

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Audio Feedback State

   Transaction Steps  >  Transaction Step  >  Device Central Configuration  >  Smart Leash

Select whether the Smart Leash Audio Feedback is active (on) or inactive (off).

  • If the value Turn Off is selected, Device Central will turn on Audio Feedback in Smart Leash.
  • If the value Turn On is selected, Device Central will turn off Audio Feedback in Smart Leash.

Detail Information:

  • Key = SmartLeashAudioFeedbackState

  • Type = string

 UI Choice  JSON Value 
 Turn Off  2 
 Turn On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Audio Feedback Volume

   Transaction Steps  >  Transaction Step  >  Device Central Configuration  >  Smart Leash

Enter the percentage of volume that should be used when Audio Feedback State is set to Turn On. Supported values range between 1 and 100.

Detail Information:

  • Key = SmartLeashAudioFeedbackVolume

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Haptic Feedback State

   Transaction Steps  >  Transaction Step  >  Device Central Configuration  >  Smart Leash

Select whether the Smart Leash Haptic Feedback is active (on) or inactive (off).

  • If the value Turn Off is selected, Device Central will turn on Audio Feedback in Smart Leash.
  • If the value Turn On is selected, Device Central will turn off Audio Feedback in Smart Leash.

Detail Information:

  • Key = SmartLeashHapticFeedbackState

  • Type = string

 UI Choice  JSON Value 
 Turn Off  2 
 Turn On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Haptic Feedback Time

   Transaction Steps  >  Transaction Step  >  Device Central Configuration  >  Smart Leash

Enter the duration of vibration when the Haptic Feedback State is set to Turn On

Detail Information:

  • Key = SmartLeashHapticFeedbackDuration

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Settings UI

   Transaction Steps  >  Transaction Step  >  Device Central Configuration  >  Smart Leash

Select whether the Device User should be allowed to use the Device Central UI to configure Smart Leash.

  • If the value Disallow is selected, Device Central will NOT provide UI that allows the Device User to configure Smart Leash.
  • If the value Allow is selected, Device Central will provide UI that allows the Device User to configure Smart Leash.

Detail Information:

  • Key = SmartLeashSettingsUI

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

State

   Transaction Steps  >  Transaction Step  >  Device Central Configuration  >  Smart Leash

Select whether the Smart Leash active (on) or inactive (off).

  • If the value Turn Off is selected, Device Central will turn on Smart Leash.
  • If the value Turn On is selected, Device Central will turn off Smart Leash.

Detail Information:

  • Key = SmartLeashState

  • Type = string

 UI Choice  JSON Value 
 Turn Off  2 
 Turn On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.


DHCP Option Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Request Boot File Name (Option 67), Request Broadcast Address (Option 28), Request NTP Server (Option 42), Request TFTP Server Address (Option 66), Request Vendor Encapsulated Options (Option 43), Request Domain Search List (Option 119), Request TFTP Server Names (Option 150), Request Vendor Specific Option#1 (Option 186), Request Vendor Specific Option#2 (Option 188), Request Vendor Specific Option#3 (Option 230), Send Client Identifier State (Option 61), Send Client Identifier Value (Option 61), Send Host Name State (Option 12), Send Host Name Value (Option 12), Send User Class State (Option 77), Send User Class Value (Option 77), Send Vendor Class State (Option 60), Send Vendor Class Value (Option 60), Send FQDN State (Option 81), Send FQDN Value (Option 81), Send FQDN Flag (Option 81), Request Custom Option Number, Request Custom Option State, Send Custom Option Number, Send Custom Option State, and Send Custom Option Value.

The DHCP Client on the device sends a DHCP Request to a DHCP Server and receives back a DHCP Acknowledgment. A DHCP Request sent by a device can contain information about the device or the DHCP Client, and can contain requests for additional information from the DHCP Server. A DHCP Acknowledgment sent by the DHCP Server contains the IP Address assigned to the device by the DHCP Server along with other related information and any additional information requested by the device in the DHCP Request.

DHCP Options are variable-length strings that are identified by DHCP Options Numbers that can be included in a DHCP Request or a DHCP Acknowledgment to convey information between a DHCP Client and a DHCP Server. From the point of view of the device where the DHCP Client is running, a DHCP Option can allow the DHCP Client to Send information to the DHCP Server or can allow the DHCP Client to Request the DHCP Server to return information to the DHCP Client.

Detail Information:

  • Key = dhcpStep

  • Type = bundle

Request Boot File Name (Option 67)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the Boot File Name and return it using DHCP Option 67 along with the IP Address.

Detail Information:

  • Key = dhcpRequestBootFileName

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.4.

Request Broadcast Address (Option 28)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the Broadcast Address and return it using DHCP Option 28 along with the IP Address.

Detail Information:

  • Key = dhcpRequestBroadcastAddress

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.4.

Request NTP Server (Option 42)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the NTP Server and return it using DHCP Option 42 along with the IP Address.

Detail Information:

  • Key = dhcpRequestNtpServer

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.4.

Request TFTP Server Address (Option 66)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the TFTP Server Address and return it using DHCP Option 66 along with the IP Address.

Detail Information:

  • Key = dhcpRequestTftpServerAddress

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.4.

Request Vendor Encapsulated Options (Option 43)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the Vendor Encapsulated Options and return whatever is acquired using DHCP Option 43 along with the IP Address.

Detail Information:

  • Key = dhcpRequestVendorEncapsulated

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.5.

Request Domain Search List (Option 119)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the Domain Search List and return it using DHCP Option 119 along with the IP Address.

Detail Information:

  • Key = dhcpRequestDomainSearchList

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.4.

Request TFTP Server Names (Option 150)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the TFTP Server Name(s) and return it using DHCP Option 150 along with the IP Address.

Detail Information:

  • Key = dhcpRequestTftpServerNames

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.4.

Request Vendor Specific Option#1 (Option 186)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the First Vendor Specific Option and return it using DHCP Option 186 along with the IP Address.

Detail Information:

  • Key = dhcpRequestVendorSpecific1

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.5.

Request Vendor Specific Option#2 (Option 188)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the Second Vendor Specific Option and return it using DHCP Option 188 along with the IP Address.

Detail Information:

  • Key = dhcpRequestVendorSpecific2

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.5.

Request Vendor Specific Option#3 (Option 230)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire the Third Vendor Specific Option and return it using DHCP Option 230 along with the IP Address.

Detail Information:

  • Key = dhcpRequestVendorSpecific3

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 6.3.

Send Client Identifier State (Option 61)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will send a Client Identifier to the DHCP Server using DHCP Option 61 when requesting an IP Address.

  • If the value Off is selected, you do not need to specify any additional information.
  • If the value On is selected, you must also specify Send Client Identifier State (Option 61) to provide the value of the Client Identifier to be sent.

Detail Information:

  • Key = dhcpSendClientIdentifierState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 6.3.

Send Client Identifier Value (Option 61)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the Client Identifier that the DHCP Client on a device will send to the DHCP Server using DHCP Option 12 when requesting an IP Address when the value On is selected for Send Client Identifier State (Option 61).

Detail Information:

  • Key = dhcpSendClientIdentifierValue

  • Type = string

Support Information:

  • Supported from: MX 6.3.

Send Host Name State (Option 12)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will send a Host Name to the DHCP Server using DHCP Option 12 when requesting an IP Address.

  • If the value Off is selected, you do not need to specify any additional information.
  • If the value On is selected, you must also specify Send Host Name Value (Option 12) to provide the value of the Host Name to be sent.

Detail Information:

  • Key = dhcpSendHostNameState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.4.

Send Host Name Value (Option 12)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the Host Name that the DHCP Client on a device will send to the DHCP Server using DHCP Option 12 when requesting an IP Address when the value On is selected for Send Host Name State (Option 12).

Detail Information:

  • Key = dhcpSendHostNameValue

  • Type = string

Support Information:

  • Supported from: MX 4.4.

Send User Class State (Option 77)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will send a User Class to the DHCP Server using DHCP Option 77 when requesting an IP Address.

  • If the value Off is selected, you do not need to specify any additional information.
  • If the value On is selected, you must also specify Send User Class Value (Option 77) to provide the value of the User Class to be sent.

Detail Information:

  • Key = dhcpSendUserClassState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.4.

Send User Class Value (Option 77)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the User Class that the DHCP Client on a device will send to the DHCP Server using DHCP Option 77 when requesting an IP Address when the value On is selected for Send User Class State (Option 77).

Detail Information:

  • Key = dhcpSendUserClassValue

  • Type = string

Support Information:

  • Supported from: MX 4.4.

Send Vendor Class State (Option 60)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will send a Vendor Class to the DHCP Server using DHCP Option 60 when requesting an IP Address.

  • If the value Off is selected, you do not need to specify any additional information.
  • If the value On is selected, you must also specify Send Vendor Class Value (Option 60) to provide the value of the Vendor Class to be sent.

Detail Information:

  • Key = dhcpSendVendorClassState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.5.

Send Vendor Class Value (Option 60)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the Vendor Class that the DHCP Client on a device will send to the DHCP Server using DHCP Option 60 when requesting an IP Address when the value On is selected for Send Vendor Class State (Option 60).

Detail Information:

  • Key = dhcpSendVendorClassValue

  • Type = string

Support Information:

  • Supported from: MX 4.5.

Send FQDN State (Option 81)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will send a Fully Qualified Domain Name (FQDN) to the DHCP Server using DHCP Option 81 when requesting an IP Address.

  • If the value Off is selected, you do not need to specify any additional information.
  • If the value On is selected, you must also specify Send FQDN Value (Option 81) and Send FQDN Flag (Option 81) to provide the value of the FQDN value and the associated flags to be sent.

Detail Information:

  • Key = dhcpSendFqdnState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 6.3.

Send FQDN Value (Option 81)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the Fully Qualified Domain Name (FQDN) that will be sent to the DHCP Server using DHCP Option 81 when requesting an IP Address when the value On is selected for Send FQDN State (Option 81). You must also specify Send FQDN Flag (Option 81) to provide the flags to be sent along with the FQDN value.

Detail Information:

  • Key = dhcpSendFqdnValue

  • Type = string

Support Information:

  • Supported from: MX 6.3.

Send FQDN Flag (Option 81)

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the flags to be sent along with the Fully Qualified Domain Name (FQDN) that will be sent to the DHCP Server using DHCP Option 81 when requesting an IP Address when the value On is selected for Send FQDN State (Option 81) and when Send FQDN Value (Option 81) is specified.

Detail Information:

  • Key = dhcpSendFqdnFlag

  • Type = string

Support Information:

  • Supported from: MX 6.3.

Request Custom Option Number

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the option number of a custom DHCP Option that the DHCP Client on a device should request from DHCP Server and return along with the IP Address when the value On is selected for Request Custom Option State.

Detail Information:

  • Key = dhcpRequestCustomOptionNumber

  • Type = string

Support Information:

  • Supported from: MX 8.1.

Request Custom Option State

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server acquire a custom DHCP option and return it along with the IP Address.

  • If the value Off is selected, no custom DHCP Option will be requested and you do not need to specify any additional information.
  • If the value On is selected, a custom DHCP Option will be requested and you must also specify Request Custom Option Number to provide the custom option number to be requested.

Detail Information:

  • Key = dhcpRequestCustomOptionState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 8.1.

Send Custom Option Number

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the option number of a custom DHCP Option that the DHCP Client on a device should send when requesting an IP Address when the value On is selected for Send Custom Option State.

Detail Information:

  • Key = dhcpSendCustomOptionNumber

  • Type = string

Support Information:

  • Supported from: MX 8.1.

Send Custom Option State

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Select whether the DHCP Client on a device will request that the DHCP Server send a custom DHCP option when requesting an IP Address.

  • If the value Off is selected, no custom DHCP Option will be sent you do not need to specify any additional information.
  • If the value On is selected, a custom DHCP Option will be sent and you must also specify Send Custom Option Number to provide the custom option number to be sent and Send Custom Option Value to provide the custom option value to be sent.

Detail Information:

  • Key = dhcpSendCustomOptionState

  • Type = string

 UI Choice  JSON Value 
 On  1 
 Off  2 

Support Information:

  • Supported from: MX 8.1.

Send Custom Option Value

   Transaction Steps  >  Transaction Step  >  DHCP Option Configuration

Enter the option value for a custom DHCP Option that the DHCP Client on a device should send when requesting an IP Address when the value On is selected for Send Custom Option State and when Send Custom Option Number is specified.

Detail Information:

  • Key = dhcpSendCustomOptionValue

  • Type = string

Support Information:

  • Supported from: MX 8.1.


Display Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Force Activities Resizable, Resizable Windows, Secondary Display Mode, Secondary Display Remote Control, Timeout, Blanking Mode, Stay Awake, Signal, Polarity, Debounce Delay, Allowed Orientations, Deprecated Rotation Mode, Lock Override Button, Locked Orientation Positions, Rotation Mode, Set Display Size, Set Font Size, Backlight Adaptive Brightness, and Brightness.

Detail Information:

  • Key = displayStep

  • Type = bundle

Force Activities Resizable

   Transaction Steps  >  Transaction Step  >  Display Configuration

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.

  • If Follow Application Manifest is selected, activities will be treated as resizable only if declared to be resizable in the application manifest.

Detail Information:

  • Key = displayForceActivitiesResizable

  • Type = string

 UI Choice  JSON Value 
 All Activities Resizable  1 
 Follow Application Manifest  2 

Support Information:

  • Supported from: MX 10.5.

Resizable Windows

   Transaction Steps  >  Transaction Step  >  Display Configuration

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 = displayResizableWindows

  • Type = string

 UI Choice  JSON Value 
 Turn On  1 
 Turn Off  2 

Support Information:

  • Supported from: MX 10.5.

Secondary Display Mode

   Transaction Steps  >  Transaction Step  >  Display Configuration

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 = secondaryDisplayMode

  • Type = string

 UI Choice  JSON Value 
 Present Independent Desktop  1 
 Mirror Device Screen  2 

Support Information:

  • Supported from: MX 10.5.

Secondary Display Remote Control

   Transaction Steps  >  Transaction Step  >  Display Configuration

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 = secondaryDisplayRemoteControl

  • Type = string

 UI Choice  JSON Value 
 Primary (Mobile)  0 
 Secondary (Desktop)  1 

Support Information:

  • Supported from: MX 11.1.

Timeout

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select the amount of inactivity, in seconds, after which the device will timeout and automatically turn the Display Screen off.

A given device may not support all available values. In the event that a selected value 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 = displayTimeout

  • Type = string

 UI Choice  JSON Value 
 15 seconds  15 
 30 seconds  30 
 1 minute  60 
 2 minutes  120 
 5 minutes  300 
 10 minutes  600 
 30 minutes  1800 

Support Information:

  • Supported from: MX 4.3.

Blanking Mode

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select whether the Display will automatically Blank (display nothing) on a device.

When a Device User is operating a vehicle with a vehicle-mounted device, it is often advisable, for safety or regulatory reasons, to prevent the Device User from interacting with the device or being distracted by the Display of the device, while the vehicle is in motion. Display Blanking Mode provides the ability to configure the device such that the Display Screen will automatically be Blanked (display nothing) when an electrical signal (such as one attached to the accelerator) is detected that indicates that the vehicle is in motion.

At present, Display Blanking Mode is supported only on VC8x and similarly equipped vehicle-mounted Zebra mobile computers running Android.

  • If the value Never Blank is selected, Display Blanking Mode will be turned off and hence automatic Display Blanking will never occur.

  • If the value Blank When Triggered by Signal is selected, Display Blanking Mode will be turned on and hence the Display will be automatically Blanked and you must also specify all of the following:

    • 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 = displayBlankingMode

  • Type = string

 UI Choice  JSON Value 
 Never Blank  1 
 Blank When Triggered by Signal  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Stay Awake

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select whether the Display will Stay Awake (prevent automatic time out that turns the Display Screen off) when the device is connected to external power.

When a Device User is operating a vehicle with a vehicle-mounted device, the device may be continuously receiving power from the vehicle power supply, rather than running off its own internal battery. The Display Screen timeout, configured via Timeout, which is generally used to increase battery life, may add little value in such situations. It may therefore be desirable to configure the device to Stay Awake and thus prevent it from timing out and turning the Display Screen off, so long as the device is connected to external power.

  • If the value Off is selected, the Display will NOT Stay Awake and hence the device will time out and automatically turn the Display Screen off, when the Display Screen timeout, configured via Timeout expires, even if the device is connected to external power.
  • If the value On is selected, the Display will Stay Awake and hence the device will not time out and will not automatically turn the Display Screen off, so long as the device is connected to external power, even if the Display Screen timeout, configured via Timeout expires.

Detail Information:

  • Key = displayStayAwake

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.2.

Signal

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select the Signal that will be used to trigger automatic Display Blanking when the value Blank When Triggered by Signal is selected for Blanking 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 = displayBlankingModeSignal

  • Type = string

 UI Choice  JSON Value 
 Input 1  1 
 Input 2  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Polarity

   Transaction Steps  >  Transaction Step  >  Display Configuration

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 Blanking 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 = displayBlankingModeSignalPolarity

  • Type = string

 UI Choice  JSON Value 
 Blank screen when signal goes inactive (OFF)  2 
 Blank screen when signal goes active (ON)  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Debounce Delay

   Transaction Steps  >  Transaction Step  >  Display Configuration

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 Blanking 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.

Detail Information:

  • Key = displayBlankingModeSignalDebounceDelay

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Allowed Orientations

   Transaction Steps  >  Transaction Step  >  Display Configuration

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 
 All (0 90 180 270 degrees)  1 
 All except portrait inverted (180 degrees)  2 

Support Information:

  • Supported from: MX 10.5.

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

Deprecated Rotation Mode

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select whether the content presented on the device display will be automatically rotated, based on the accelerometer, to match the physical orientation of the device.

This managed configuration is deprecated.

It is recommended to use Rotation Mode instead to control device display rotation.

Detail Information:

  • Key = setMirrorAutorotate

  • Type = string

 UI Choice  JSON Value 
 Lock to Current  0 
 Automatic  1 

Support Information:

  • Supported on Operating System(s): Pie.

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

Lock Override Button

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select whether the device user is allowed to override the locked screen orientation.

  • If Enable is selected, the device user is allowed to override the locked screen orientation.

  • if Disable is selected, the device user is not allowed to override the locked screen orientation.

Detail Information:

  • Key = displayLockOverrideButton

  • Type = string

 UI Choice  JSON Value 
 Enable  1 
 Disable  2 

Support Information:

  • Supported from: MX 10.5.

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

Locked Orientation Positions

   Transaction Steps  >  Transaction Step  >  Display Configuration

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

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

Rotation Mode

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select whether the content presented on the device display will be automatically rotated, based on the accelerometer, to match the physical orientation of the device.

  • If Lock to Current is selected, the content presented on the device display will remain locked in whatever orientation it was in at the time this setting was changed from Automatic to Lock to Current.

  • If Automatic is selected, the content presented on the device display will be automatically rotated, based on the accelerometer, to match the physical orientation of the device.

Notes:

  • No method is currently provided to set the orientation when a device is locked or being locked. Locking results are unpredictable if performed in conditions under which the physical orientation of the device is not known (e.g. while the device is in use). For best results, locking should be performed when the device is in a known orientation (such as when docked or in a charging cradle).

  • The Lock to Current setting can be overridden by an application that's coded to do so. This can be useful if the app functions only in a particular orientation or if that orientation provides a better user experience.

Detail Information:

  • Key = displayRotationMode

  • Type = string

 UI Choice  JSON Value 
 Lock to Current  Turn Off 
 Automatic  Turn On 

Support Information:

  • Supported from: MX 10.1.

Set Display Size

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select the system display size to one of several pre-defined sizes.

Detail Information:

  • Key = setDisplaySize

  • Type = string

 UI Choice  JSON Value 
 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.

Set Font Size

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select the system font size

Detail Information:

  • Key = setFontSize

  • Type = string

 UI Choice  JSON Value 
 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.

Backlight Adaptive Brightness

   Transaction Steps  >  Transaction Step  >  Display Configuration

Select whether the screen brightness will be set automatically based on the environment. This setting is equivalent to the adaptive brightness check box found in the settings app.

Detail Information:

  • Key = displayBacklightAdaptiveBrightness

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 10.2.

Brightness

   Transaction Steps  >  Transaction Step  >  Display Configuration

Enter the Backlight Brightness when the value Off is selected for Backlight Adaptive Brightness.

Detail Information:

  • Key = displayBacklightBrightness

  • Type = integer


Enterprise Keyboard Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Auto Capitalization, Auto Correction, Block Offensive Words, Double Space Period, Flick for Alternate Chars, Key Long Press Delay, Language Action, Language, Custom, Navigation Mode, Numeric Layout Mode, Show Alphanumeric Tab, Show Numeric Tab, Show Scan Tab, Show Symbol Tab, Show Voice Input Key, System Language Support, Preferred Tab, Suggest Contact Names, Suggest Misspelling Corrections, Popup on Keypress, Sound on Keypress, Mode, Volume, Vibrate on Keypress, Mode, Duration, Remap Alpha P1, Remap Numeric P1, Remap Numeric P2, Remap Numeric P3, Remap Numeric P4, and Remap Symbol P1.

Detail Information:

  • Key = ekbStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Auto Capitalization

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will have automatic capitalization turned on (enabled) or turned off (disabled) for the first letter of each sentence.

  • If the value Off is selected, automatic capitalization will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, automatic capitalization will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbAutoCaps

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Auto Correction

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will have automatic correction of misspelled words turned on (enabled) or turned off (disabled), wherein the space and punctuation keys initiate automatic correction of misspelled words.

  • If the value Off is selected, automatic correction of misspelled words will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, automatic correction of misspelled words will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbAutoCorrection

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Block Offensive Words

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will have automatic blocking of offensive words turned on (enabled) or turned off (disabled).

  • If the value Off is selected, automatic offensive word blocking will be turned off (disabled).
  • If the value On is selected, automatic offensive word blocking will be turned on (enabled).

Detail Information:

  • Key = ekbBlockOffensiveWords

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Double Space Period

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will have automatic sentence ending turned on (enabled) or turned off (disabled) wherein a double tap on the space key causes the entry of a period followed by two spaces.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbDoubleSpacePeriod

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Flick for Alternate Chars

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will show alternate characters when a flick gesture is performed.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbFlickForAlternateChars

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.1.

Key Long Press Delay

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter the length of time (in milliseconds) that a key within the Enterprise Keyboard on a device need to be held pressed to be detected as a long press.

Detail Information:

  • Key = ekbKeyLongPressDelay

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Language Action

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select the action to take for the selected language

Detail Information:

  • Key = ekbLanguageAction

  • Type = string

 UI Choice  JSON Value 
 Enable  1 
 Disable  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

Language

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select the language acted upon

Detail Information:

  • Key = ekbLanguageActionLanguage

  • Type = string

 UI Choice  JSON Value 
 English_US  English_US 
 English_UK  English_UK 
 Polish  Polish 
 Slovak  Slovak 
 Romanian  Romanian 
 Czech  Czech 
 Russian  Russian 
 ALL  ALL 
 CUSTOM  CUSTOM 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

Custom

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter the custom language

Detail Information:

  • Key = ekbLanguageActionLanguageCustom

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select the navigation mode the Enterprise Keyboard on a device will use to provide its user experience.

  • If the value Tab-based (new) is selected, the Enterprise Keyboard will use the new user experience wherein different tabs can be used to select the desired keyboard.
  • If the value Key-based (legacy) is selected, the Enterprise Keyboard will use the legacy user experience wherein keys can be used to select the desired keyboard.

Detail Information:

  • Key = ekbNavigationMode

  • Type = string

 UI Choice  JSON Value 
 Tab-based (new)  1 
 Key-based (legacy)  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Numeric Layout Mode

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select the numeric layout mode the Enterprise Keyboard on a device will use when it determines that a numeric keyboard should be displayed.

  • If the value Telephone Mode is selected, the Enterprise Keyboard will display a numeric keyboard in telephone mode (e.g. 123, 456, 789).
  • If the value Calculator Mode is selected, the Enterprise Keyboard will display a numeric keyboard in calculator mode (e.g. 789, 456, 123).

Detail Information:

  • Key = ekbNumericLayoutMode

  • Type = string

 UI Choice  JSON Value 
 Telephone Mode  1 
 Calculator Mode  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.1.

Show Alphanumeric Tab

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will show the alphanumeric tab to allow selection of the alphanumeric keyboard.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbShowAlphaNumericTab

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Show Numeric Tab

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will show the numeric tab to allow selection of the numeric keyboard.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbShowNumericTab

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Show Scan Tab

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will show the scan tab to allow control of barcode scanning.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbShowScanTab

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Show Symbol Tab

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will show the symbol tab to allow selection of the special symbols keyboard.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbShowSymbolTab

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Show Voice Input Key

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will show a key to invoke voice input (if supported).

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbShowVoiceInputKey

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

System Language Support

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether to use the standard Android Languages or the built-in Enterprise Keyboard languages.

Detail Information:

  • Key = ekbUseSystemLanguages

  • Type = string

 UI Choice  JSON Value 
 Android System  1 
 Enterprise Keyboard  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

Preferred Tab

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select the preferred tab the Enterprise Keyboard on a device will select by default when textual data is being entered.

  • If the value Numeric is selected, the Enterprise Keyboard will select the Numeric tab by default when textual data is being entered.
  • If the value Alphanumeric is selected, the Enterprise Keyboard will show the Alphanumeric tab by default when textual data is being entered.
  • If the value Symbol is selected, the Enterprise Keyboard will show the Symbol tab by default when textual data is being entered.
  • If the value Scan is selected, the Enterprise Keyboard will show the Scan tab by default when textual data is being entered.

Detail Information:

  • Key = ekbSelectPreferredTab

  • Type = string

 UI Choice  JSON Value 
 Numeric  1 
 Alphanumeric  2 
 Symbol  3 
 Scan  4 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Suggest Contact Names

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device showing contact name suggestions while typing based on past actions will be turned on (enabled) or turned off (disabled).

  • If the value Off is selected, contact name suggestions will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, contact name suggestions will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbShowContactNamesSuggestions

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Suggest Misspelling Corrections

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device showing suggestions for corrections of misspelled words while typing will be turned on (enabled) or turned off (disabled).

  • If the value Off is selected, correction suggestions will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, correction suggestions will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbShowCorrectionSuggestions

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Popup on Keypress

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will have key popup on each keypress turned on (enabled) or turned off (disabled) wherein a visible indication that thekey was pressed occurs.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbPopupOnKeypress

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Sound on Keypress

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will have sound on each keypress turned on (enabled) or turned off (disabled) wherein an audible indication that the key was pressed occurs.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbSoundOnKeypress

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Mode

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select the volume mode that will be used by the Enterprise Keyboard on a device when sound occurs on each keypress.

  • If the value System Default Volume is selected, the System Default Volume for keypress sounds will be used.
  • If the value Specified Volume is selected, a specified volume will be used and you must also specify Volume to provide that volume.

Detail Information:

  • Key = ekbSoundOnKeypressVolumeMode

  • Type = string

 UI Choice  JSON Value 
 System Default Volume  2 
 Specified Volume  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Volume

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter the volume (from 0 to 100) that will be used by the Enterprise Keyboard on a device when sound occurs on each keypress, when the value On is selected for Sound on Keypress and the value System Default Volume is selected for Mode.

Detail Information:

  • Key = ekbSoundOnKeypressVolume

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Vibrate on Keypress

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select whether the Enterprise Keyboard on a device will have vibration on each keypress turned on (enabled) or turned off (disabled) wherein a tactile indication that the key was pressed occurs.

  • If the value Off is selected, this feature will be turned off (disabled), and hence it will not be available for use in entering data using the Enterprise Keyboard.
  • If the value On is selected, this feature will be turned on (enabled), and hence it will be available for use in entering data using the Enterprise Keyboard.

Detail Information:

  • Key = ekbVibrateOnKeypress

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Mode

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Select the duration mode that will be used by the Enterprise Keyboard on a device when vibrate occurs on each keypress.

  • If the value System Default Duration is selected, the System Default Duration for keypress vibrate will be used.
  • If the value Specified Duration is selected, a specified duration will be used and you must also specify Duration to provide that duration.

Detail Information:

  • Key = ekbVibrateOnKeypressDurationMode

  • Type = string

 UI Choice  JSON Value 
 System Default Duration  2 
 Specified Duration  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Duration

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter the duration (from 0 to 100 milliseconds) that will be used by the Enterprise Keyboard on a device when a vibrate occurs on each keypress, when the value On is selected for Vibrate on Keypress and the value System Default Duration is selected for Mode.

Detail Information:

  • Key = ekbVibrateOnKeypressDuration

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Remap Alpha P1

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter a value that defines the behavior the Enterprise Keyboard on a device will perform when the Alpha P1 Key (located on the Alpha keyboard at Row 1, Column 1) is pressed.

Possible values can be:

  • A single character value (e.g. the letter "A" or the symbol "@") causes that character value to be sent as the behavior for the remapped key.
  • A hexadecimal value in the format \uXXXXXX (e.g. \u000001) causes the specified key code to be sent as the behavior for the remapped key. Allowable values can be determined from the Android documentation: https://developer.android.com/reference/android/view/KeyEvent.
  • The value \EMOJI causes the remapped key to switch to the EMOJI keyboard.

Detail Information:

  • Key = ekbRemapAlphaP1

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Remap Numeric P1

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter a value that defines the behavior the Enterprise Keyboard on a device will perform when the Numeric P1 Key (located on the Numeric keyboard at Row 1, Column 1) is pressed.

Possible values can be: - A single character value (e.g. the letter "A" or the symbol "@") causes that character value to be sent as the behavior for the remapped key.

  • A hexadecimal value in the format \uXXXXXX (e.g. \u000001) causes the specified key code to be sent as the behavior for the remapped key. Allowable values can be determined from the Android documentation: https://developer.android.com/reference/android/view/KeyEvent.
  • The value \EMOJI causes the remapped key to switch to the EMOJI keyboard.

Detail Information:

  • Key = ekbRemapNumericP1

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Remap Numeric P2

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter a value that defines the behavior the Enterprise Keyboard on a device will perform when the Numeric P2 Key (located on the Numeric keyboard at Row 2, Column 1) is pressed.

Possible values can be: - A single character value (e.g. the letter "A" or the symbol "@") causes that character value to be sent as the behavior for the remapped key.

  • A hexadecimal value in the format \uXXXXXX (e.g. \u000001) causes the specified key code to be sent as the behavior for the remapped key. Allowable values can be determined from the Android documentation: https://developer.android.com/reference/android/view/KeyEvent.
  • The value \EMOJI causes the remapped key to switch to the EMOJI keyboard.

Detail Information:

  • Key = ekbRemapNumericP2

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Remap Numeric P3

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter a value that defines the behavior the Enterprise Keyboard on a device will perform when the Numeric P3 Key (located on the Numeric keyboard at Row 3, Column 1) is pressed.

Possible values can be: - A single character value (e.g. the letter "A" or the symbol "@") causes that character value to be sent as the behavior for the remapped key.

  • A hexadecimal value in the format \uXXXXXX (e.g. \u000001) causes the specified key code to be sent as the behavior for the remapped key. Allowable values can be determined from the Android documentation: https://developer.android.com/reference/android/view/KeyEvent.
  • The value \EMOJI causes the remapped key to switch to the EMOJI keyboard.

Detail Information:

  • Key = ekbRemapNumericP3

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Remap Numeric P4

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter a value that defines the behavior the Enterprise Keyboard on a device will perform when the Numeric P4 Key (located on the Numeric keyboard at Row 4, Column 1) is pressed.

Possible values can be: - A single character value (e.g. the letter "A" or the symbol "@") causes that character value to be sent as the behavior for the remapped key.

  • A hexadecimal value in the format \uXXXXXX (e.g. \u000001) causes the specified key code to be sent as the behavior for the remapped key. Allowable values can be determined from the Android documentation: https://developer.android.com/reference/android/view/KeyEvent.
  • The value \EMOJI causes the remapped key to switch to the EMOJI keyboard.

Detail Information:

  • Key = ekbRemapNumericP4

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.

Remap Symbol P1

   Transaction Steps  >  Transaction Step  >  Enterprise Keyboard Configuration

Enter a value that defines the behavior the Enterprise Keyboard on a device will perform when the Symbol P1 Key (located on the Symbol keyboard at Row 4, Column 1) is pressed.

Possible values can be: - A single character value (e.g. the letter "A" or the symbol "@") causes that character value to be sent as the behavior for the remapped key.

  • A hexadecimal value in the format \uXXXXXX (e.g. \u000001) causes the specified key code to be sent as the behavior for the remapped key. Allowable values can be determined from the Android documentation: https://developer.android.com/reference/android/view/KeyEvent.
  • The value \EMOJI causes the remapped key to switch to the EMOJI keyboard.

Detail Information:

  • Key = ekbRemapSymbolP1

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.0.


Enterprise NFC Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Reset to Defaults, Logging, Type A Tags, Type B Tags, Type F Tags, Type V Tags, Use NFC Data Exchange Format (NDEF), Polling Mode, CPU Boost, Type A Tag Baud Rate, Type B Tag Baud Rate, Peer to Peer Mode, Card Emulation Mode, Power, and Use on Lock Screen.

Detail Information:

  • Key = nfcStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Reset to Defaults

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

Select whether the Enterprise NFC settings should all be reset to their default values.

Detail Information:

  • Key = nfcResetToDefaults

  • Type = string

 UI Choice  JSON Value 
 Do Not Reset  false 
 Reset  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Logging

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcDebugLogging

  • 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.

Type A Tags

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcReadTypeATags

  • Type = string

 UI Choice  JSON Value 
 Do Not Read  false 
 Read  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Type B Tags

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcReadTypeBTags

  • Type = string

 UI Choice  JSON Value 
 Do Not Read  false 
 Read  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Type F Tags

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcReadTypeFTags

  • Type = string

 UI Choice  JSON Value 
 Do Not Read  false 
 Read  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Type V Tags

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcReadTypeVTags

  • Type = string

 UI Choice  JSON Value 
 Do Not Read  false 
 Read  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Use NFC Data Exchange Format (NDEF)

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcUseNDEF

  • Type = string

 UI Choice  JSON Value 
 Do Not Use  false 
 Use  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Polling Mode

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcPollingMode

  • Type = string

 UI Choice  JSON Value 
 Hybrid  2 
 Standard  1 
 Low Power  0 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

CPU Boost

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcCpuBoost

  • Type = string

 UI Choice  JSON Value 
 Do Not Boost  false 
 Boost  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Type A Tag Baud Rate

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcTypeABaudRate

  • 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.

  • Supported from: MX 8.3.

Type B Tag Baud Rate

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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 = nfcTypeBBaudRate

  • 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.

  • Supported from: MX 8.3.

Peer to Peer Mode

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

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. Starting in Android 11, support for Peer-to-Peer Mode is deprecated.

Detail Information:

  • Key = nfcPeerToPeerMode

  • Type = string

 UI Choice  JSON Value 
 Do Not Use  false 
 Use  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Card Emulation Mode

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

Select whether the Enterprise NFC should use Card Emulation Mode.

  • 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 = nfcCardEmulationMode

  • Type = string

 UI Choice  JSON Value 
 Do Not Use  false 
 Use  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Power

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

Select whether the Enterprise NFC should be turned on or turned off

  • If the value Turn Off is selected, Enterprise NFC will be turned off.

  • If the value Turn On is selected, Enterprise NFC will be turned on.

Detail Information:

  • Key = nfcPower

  • Type = string

 UI Choice  JSON Value 
 Turn On  1 
 Turn Off  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

Use on Lock Screen

   Transaction Steps  >  Transaction Step  >  Enterprise NFC Configuration

Select whether the Enterprise NFC should be allowed to be used from the Lock Screen.

  • If the value Disallow is selected, Enterprise NFC will NOT allow NFC operations to be performed when the device is at the lock screen.

  • If the value Allow is selected, Enterprise NFC will allow NFC operations to be performed when the device is at the lock screen.

Detail Information:

  • Key = nfcUseOnLockScreen

  • Type = string

 UI Choice  JSON Value 
 Disallow  false 
 Allow  true 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.


Ethernet Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Power, Control by User, Use Proxy Server, Proxy Server, Port, Bypass List, IP Address Type, IP Address, Gateway Address, Network Mask, Primary DNS, and Secondary DNS.

Detail Information:

  • Key = ethernetStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Power

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

Select the Power State of 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 = ethernetPower

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Control by User

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

Select whether Ethernet Power control by the Device User will be allowed or not.

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 = ethernetPowerControlByUser

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Use Proxy Server

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetUseProxyServer

  • Type = string

 UI Choice  JSON Value 
 Use a Proxy Server  2 
 Do NOT Use a Proxy Server  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Proxy Server

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetProxyServer

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Port

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetProxyServerPort

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Bypass List

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetProxyServerBypassList

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

IP Address Type

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

Select how an IP Address will be assigned to the Ethernet adapter.

  • If the value Dynamic (DHCP) is selected, an IP Address for the Ethernet adapter will be automatically acquired by the DHCP Client from the DHCP Server.
  • If the value Static (Manual) 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.

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 = ethernetIpAddrType

  • Type = string

 UI Choice  JSON Value 
 Dynamic (DHCP)  0 
 Static (Manual)  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

IP Address

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetIpAddress

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Gateway Address

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetGatewayAddress

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Network Mask

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetNetMask

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Primary DNS

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetDNS1

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Secondary DNS

   Transaction Steps  >  Transaction Step  >  Ethernet Configuration

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 = ethernetDNS2

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.


File Management

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Download File Source URI, Download Destination Path and File Name, Delete Path and File Name, Upload Source Path and File Name, Upload File Destination URI, Upload File Target File Name Pattern, Upload Order, Upload Duplicate Handling, and Upload Delete Source After Upload.

Detail Information:

  • Key = filesStep

  • Type = bundle

Support Information:

  • Supported from: MX 5.0.

Download File Source URI

   Transaction Steps  >  Transaction Step  >  File Management

Enter the Source URI of a File on a Server to be Downloaded to the Device File System. You must also specify Download Destination Path and File Name to identify the Path and File Name in the Device File System to which the File will be stored once it has been Downloaded.

Detail Information:

  • Key = filesDownloadSourceURI

  • Type = string

Support Information:

  • Supported from: MX 5.0.

Download Destination Path and File Name

   Transaction Steps  >  Transaction Step  >  File Management

Enter the Destination Path and File Name of a File to be Downloaded from a Server to the Device File System when Download File Source URI is specified.

Detail Information:

  • Key = fileDownloadDestPathAndFileName

  • Type = string

Support Information:

  • Supported from: MX 5.0.

Delete Path and File Name

   Transaction Steps  >  Transaction Step  >  File Management

Enter the Path and optionally the File Name of a Folder or File to be Deleted from the Device File System.

  • To Delete a Folder, specify a value that ends in a forward slash (/) character and that specifies the full Path in the Device File System to the Folder to be Deleted.

  • To Delete a File, specify a value that ends with the File Name and Extension and that specifies the full Path in the Device File System to the File to be Deleted.

Detail Information:

  • Key = fileDeletePathAndFileName

  • Type = string

Support Information:

  • Supported from: MX 5.0.

Upload Source Path and File Name

   Transaction Steps  >  Transaction Step  >  File Management

Enter the Source Path and File Name (which may include wildcard characters), which identifies one or more Files to be Uploaded to a Server from the Device File System when Upload File Destination URI is specified.

Detail Information:

  • Key = filesUploadSourcePathAndFileName

  • Type = string

Support Information:

  • Supported from: MX 10.1.

Upload File Destination URI

   Transaction Steps  >  Transaction Step  >  File Management

Enter the Destination URI on a Server to which Files should be Uploaded from the Device File System. You must also specify Upload Source Path and File Name to identify the Source Path and File Name of the Files to be Uploaded.

Detail Information:

  • Key = filesUploadDestinationURI

  • Type = string

Support Information:

  • Supported from: MX 10.1.

Upload File Target File Name Pattern

   Transaction Steps  >  Transaction Step  >  File Management

Enter a Pattern to be used to construct the Target File Names of Files to be Uploaded to a Server from the Device File System when Upload File Destination URI is specified. 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 on the device at 11:23 AM on April 15, 2020.

Detail Information:

  • Key = filesUploadTargetFileNamePattern

  • Type = string

Support Information:

  • Supported from: MX 10.1.

Upload Order

   Transaction Steps  >  Transaction Step  >  File Management

Select the order in which Files will be Uploaded when Upload Source Path and File Name and Upload File Destination URI are specified.

  • If the value Newest files first is selected, then the File with the newest creation date and time in the Device File System will be uploaded first, followed by the next newest, and so on.
  • If the value Oldest files first is selected, then the File with the oldest creation date and time in the Device File System will be uploaded first, followed by the next oldest, and so on.
  • If the value Sorted by filename is selected, then the File with the lowest alphabetically sorted File Name in the Device File System will be uploaded first, followed by the next lowest, and so on.

Note that for for best results, when Uploading multiple Files, the value Yes should be specified for Upload Delete Source After Upload. By Deleting Files from the Device File System as they are successfully Uploaded to the Server, errors can be more smoothly handled. For example, if a communications failure occurs during an Upload operation, causing it to terminate before sending all Files, then a subsequent Upload operation can pick up with the next File in the specified order. This is possible because Files that were previously Uploaded are no longer present to affect the Upload order.

Detail Information:

  • Key = filesUploadUploadOrder

  • Type = string

 UI Choice  JSON Value 
 Newest files first  1 
 Oldest files first  2 
 Sorted by filename  3 

Support Information:

  • Supported from: MX 10.1.

Upload Duplicate Handling

   Transaction Steps  >  Transaction Step  >  File Management

Select how to handle the situation where an attempt is made to Upload a File to a Server when Upload File Destination URI is specified and the File Name to be Uploaded already exists on the Server.

  • If the value Replace the file in the destination is selected, then the File will be Uploaded from the Device File System to the Server and will replace the existing File on the Server and the File WILL be deleted from Device File System if the value Yes is specified for Upload Delete Source After Upload.
  • If the value Skip the file and remove from the source is selected, then the file will NOT be Uploaded from the Device File System to the Server and hence the original File will remain on the Server. Even though it was NOT Uploaded, the File WILL be deleted from Device File System if the value Yes is specified for Upload Delete Source After Upload.
  • If the value Skip the file and keep it at the source is selected, then the file will NOT be Uploaded from the Device File System to the Server and hence the original File will remain on the Server and the File will NOT be deleted from Device File System even if the value Yes is specified for Upload Delete Source After Upload.

Detail Information:

  • Key = filesUploadIfDuplicate

  • Type = string

 UI Choice  JSON Value 
 Replace the file in the destination  1 
 Skip the file and remove from the source  2 
 Skip the file and keep it at the source  3 

Support Information:

  • Supported from: MX 10.1.

Upload Delete Source After Upload

   Transaction Steps  >  Transaction Step  >  File Management

Select whether Files will be automatically Deleted from the Device File System after they have been successfully Uploaded to the Server.

  • If the value No is selected, then Files will NOT be automatically Deleted from the Device File System after they have been successfully Uploaded to the Server.
  • If the value Yes is selected, then Files will be automatically Deleted from the Device File System after they have been successfully Uploaded to the Server.

Detail Information:

  • Key = filesUploadDeleteAfterUpload

  • Type = string

 UI Choice  JSON Value 
 No  0 
 Yes  1 

Support Information:

  • Supported from: MX 10.1.


Firmware Over The Air Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Device User Control Mode, LifeGuard OTA Auto Update, LifeGuard OTA Options, Mode, Mode Manual Action, Enterprise Reset SUW Bypass, OS Streaming - Authorization Type, OS Upgrade Suppress Reboot, OS Streaming - Custom Authentication Header, OS Streaming - Password, OS Streaming - Username, OS Streaming - Zebra Authentication Token, OS Streaming File URL, OS Update/Upgrade/Downgrade File, and Verify Manifest File.

Detail Information:

  • Key = fotaStep

  • Type = bundle

Support Information:

  • Supported from: MX 9.1.

Device User Control Mode

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Select whether the Device User should be allowed to control the Mode of the LifeGuard Over The Air Client via the in-device Client UI.

Detail Information:

  • Key = fotaUserControlMode

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • Supported from: MX 9.1.

LifeGuard OTA Auto Update

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Select the state used to perform automatic updates on the device

  • If the Mode value Turn On is selected, OS update operations will be performed automatically as soon as new software is available.
  • If the Mode value Turn Off is selected, OS update operations will not be performed automatically even if new software is available.

Detail Information:

  • Key = OsAutoUpdate

  • Type = string

 UI Choice  JSON Value 
 Turn On  1 
 Turn Off  2 

Support Information:

  • Supported from: MX 11.1.

LifeGuard OTA Options

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Enter one or more optional parameters to determine LifeGuard OTA behavior. See techdocs.zebra.com/mx/fotamgr/lifeguardotaoptions for options.

Detail Information:

  • Key = LifeGuardOTAOptions

  • Type = string

Support Information:

  • Supported from: MX 11.1.

Mode

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Select the mode used to perform Firmware Over The Air (FOTA) operations on a device.

  • If the Mode value Manual is selected, Firmware Over The Air (FOTA) operations will be performed in Manual Mode only when Mode Manual Action is specified and when one or more of the following are specified: Enterprise Reset SUW Bypass, OS Upgrade Suppress Reboot, OS Update/Upgrade/Downgrade File, Verify Manifest File.
  • If the Mode value Automatic is selected, Firmware Over The Air (FOTA) operations will be performed in Automatic Mode you do not need to specify any additional information.

Detail Information:

  • Key = fotaMode

  • Type = string

 UI Choice  JSON Value 
 Manual  2 
 Automatic  1 

Support Information:

  • Supported from: MX 9.1.

Mode Manual Action

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Select an Action to perform in Manual Mode to explicitly perform a Firmware Over The Air (FOTA) operation on a device when the value Manual is selected for Mode.

  • If the value Enterprise Reset is selected, you may also specify Enterprise Reset SUW Bypass to control whether the Setup Wizard (SUW) will be bypassed on GMS devices following the Enterprise Reset.
  • If the value Factory Reset is selected, you do not need to specify any additional information.
  • If the value Full Device Wipe is selected, you do not need to specify any additional information.
  • If the value OS Update is selected, you must also specify OS Update/Upgrade/Downgrade File to provide the path and file name of the image file (which must already be in the device file system at the specified location with the specified name) to be used to perform the operation.

Note that the Action value OS Update can be used to perform either an Upgrade or Downgrade operation on devices with Android versions < 8.0 but can only be used to perform an Upgrade operation on devices with Android versions >= 8.0. Furthermore, if the provided ZIP file attempts to do a Downgrade, the Downgrade will NOT occur on devices with Android versions >= 8.0.

  • If the value Verify Manifest is selected, you must also specify Verify Manifest File to provide the path and file name of the Manifest file (which must already be in the device file system at the specified location with the specified name) to be used to perform the verification.
  • If the value OS Upgrade is selected, you must also specify OS Update/Upgrade/Downgrade File to provide the path and file name of the image file (which must already be in the device file system at the specified location with the specified name) to be used to perform the operation. You may also specify OS Upgrade Suppress Reboot to control whether a reboot should automatically be performed following an A/B upgrade.

Note that the Action value OS Upgrade can only be used to perform an Upgrade operation on devices with Android versions >= 8.0. Furthermore, if the provided ZIP file attempts to do a Downgrade, the Downgrade will NOT occur.

  • If the value OS Downgrade is selected, you must also specify OS Update/Upgrade/Downgrade File to provide the path and file name of the image file (which must already be in the device file system at the specified location with the specified name) to be used to perform the operation.

Note that the Action value OS Downgrade can only be used to perform a Downgrade operation on devices with Android versions >= 8.0. Furthermore, if the provided ZIP file attempts to do an Upgrade, the Upgrade will NOT occur.

  • If the value OS Upgrade Streaming or OS Downgrade Streaming is selected, you must also specify OS Streaming File URL to provide the URL of the image file to be used to perform the operation.
  • If the value Cancel is selected, if possible, the current operation is canceled.

Note that the Action value OS Upgrade Streaming or OS Downgrade Streaming can only be used to perform a streaming upgrade operation on devices with Android version >= 8.0

Detail Information:

  • Key = fotaAction

  • Type = string

 UI Choice  JSON Value 
 Enterprise Reset  5 
 Factory Reset  6 
 Full Device Wipe  7 
 OS Update  8 
 Verify Manifest  9 
 OS Upgrade  10 
 OS Downgrade  11 
 OS Upgrade Streaming  12 
 OS Downgrade Streaming  13 
 Cancel  14 

Support Information:

  • Supported from: MX 8.1.

Enterprise Reset SUW Bypass

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Select whether the Setup Wizard (SUW) will be bypassed on GMS devices when performing an Enterprise Reset, when the Action value Enterprise Reset is selected for Mode Manual Action.

Detail Information:

  • Key = fotaActionEnterpriseResetSuwBypass

  • Type = string

 UI Choice  JSON Value 
 Bypass  1 
 Do NOT Bypass  2 

Support Information:

  • Supported from: MX 7.1.

OS Streaming - Authorization Type

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Select the authentication type to use in Manual Mode to reach the remote URL holding the file needed to perform a Firmware Over The Air (FOTA) operation on a device when the value is selected.

  • If the value No Authorization is selected, no authorization will be used to reach the URL and you do not need to specify any additional information.
  • If the value Zebra Authentication Token is selected, you must also specify OS Streaming - Zebra Authentication Token to provide the token to use to authenticate to the server.
  • If the value Basic Authentication is selected, you must also specify OS Streaming - Username and OS Streaming - Password to provide the username and password needed to authenticate to the server.
  • If the value Custom Authorization Header is selected, you must also specify OS Streaming - Custom Authentication Header to provide any custom information necessary to authenticate to the server.

Detail Information:

  • Key = fotaActionOsUpdateStreamingAuthType

  • Type = string

 UI Choice  JSON Value 
 No Authorization  0 
 Zebra Authentication Token  1 
 Basic Authentication  2 
 Custom Authorization Header  3 

Support Information:

  • Supported from: MX 10.0.

OS Upgrade Suppress Reboot

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Select whether the automatic reboot that would normally be performed following the successful completion of an A/B Upgrade should be suppressed, when the Action value OS Upgrade is selected for Mode Manual Action. Note that if the automatic reboot is suppressed, the reboot will still be required to activate the new OS following the A/B Upgrade, and the later performance of that reboot, at a suitable time, will become the responsibility of the EMM choosing to suppress the automatic reboot.

Detail Information:

  • Key = fotaActionOsUpdateSuppressReboot

  • Type = string

 UI Choice  JSON Value 
 Suppress  1 
 Do NOT Suppress  2 

Support Information:

  • Supported from: MX 8.1.

OS Streaming - Custom Authentication Header

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Enter all custom information to authenticate to the server to get access to the URL holding the OS or Patch image file to be used to perform a streaming update on a device when the Action value OS Upgrade Streaming is selected for Mode Manual Action.

Detail Information:

  • Key = fotaActionOsUpdateStreamingCustomAuthHeader

  • Type = string

Support Information:

  • Supported from: MX 10.0.

OS Streaming - Password

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Enter the password associated with OS Streaming - Username to authenticate to the server to get access to the URL holding the OS or Patch image file to be used to perform a streaming update on a device when the Action value OS Upgrade Streaming is selected for Mode Manual Action.

Detail Information:

  • Key = fotaActionOsUpdateStreamingPassword

  • Type = string

Support Information:

  • Supported from: MX 10.0.

OS Streaming - Username

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Enter the username to authenticate to the server to get access to the URL holding the OS or Patch image file to be used to perform a streaming update on a device when the Action value OS Upgrade Streaming is selected for Mode Manual Action.

Detail Information:

  • Key = fotaActionOsUpdateStreamingUserName

  • Type = string

Support Information:

  • Supported from: MX 10.0.

OS Streaming - Zebra Authentication Token

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Enter the token to use to authenticate to Zebra Support Central to get access to the URL holding the OS or Patch image file to be used to perform a streaming update on a device when the Action value OS Upgrade Streaming is selected for Mode Manual Action.

Detail Information:

  • Key = fotaActionOsUpdateStreamingZebraAuthToken

  • Type = string

Support Information:

  • Supported from: MX 10.0.

OS Streaming File URL

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Enter the URL of an OS or Patch image file to be used to perform a streaming update on a device when the Action value OS Upgrade Streaming is selected for Mode Manual Action.

Detail Information:

  • Key = fotaActionOsUpdateStreamingFile

  • Type = string

Support Information:

  • Supported from: MX 10.0.

OS Update/Upgrade/Downgrade File

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Enter the path and file name of an OS Update or Patch image file, which must already exist at the specified location in the device file system, to be used to update a device when one of the Action values OS Update, OS Upgrade, or OS Downgrade is selected for Mode Manual Action.

Detail Information:

  • Key = fotaActionOsUpdateFile

  • Type = string

Support Information:

  • Supported from: MX 8.1.

Verify Manifest File

   Transaction Steps  >  Transaction Step  >  Firmware Over The Air Configuration

Enter the path and file name of a Manifest file, which must already exist at the specified location in the device file system, to be used to verify support on a device when the Action value Verify Manifest is selected for Mode Manual Action.

Detail Information:

  • Key = fotaActionVerifyManifestFile

  • Type = string

Support Information:

  • Supported from: MX 8.1.


General UI Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Clear Application Cache Package, Clear Application Data Package, Allow Device User Control of Do Not Disturb Mode, App Info Icon on Long Press on Recent App Header, Auto Correct, Battery Charging LED, Battery Swap UI Popup, Display of Navigation Bar, External Keyboard, Launcher Package Name, Locale, Long Press on Home Key to Launch Google Assistant, Network Notification Popup, On-Screen Power Button, Pull Down Notification Bar, Show Airplane Mode in Power Key Menu, Show Battery Percentage In Notification Bar, Show Pairing Popup, Show Passwords, Show Touch Mode in Power Key Menu, Show Virtual Keyboard when Physical Keyboard is Active, Status Bar, Use Of Clipboard, Sharing, Use of Date in Notification Panel to Access Clock Application, Use of Home Key, Use of Magnification Gestures, Use of Recent Apps Key, Use of Split Screen Mode, User Control of Multi User, Touch Mode, Screen Protector, Turn on/off the Large Key Indicator feature, Device user control of Large Key Indicator, Assistant App, Custom Assistant App, Home Screen Wallpaper, and Custom Home Screen Wallpaper.

Detail Information:

  • Key = uiStep

  • Type = bundle

Support Information:

  • Supported from: MX 9.1.

Action

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select an Action to perform miscellaneous UI behavior on a device: - If the Action value Clear Clipboard is selected, any data currently in the clipboard of the device will be discarded, This will cause the data to no longer be available to paste.

  • If the Action value Clear Recently Used Apps List is selected, the list of previously used (launched) applications will be cleared. This can be used to prevent the device user from accessing previously used applications or control their behavior or configuration from the list presented when the Recent button is pressed.
  • If the Action value Clear Application Cache is selected, the cache of a specified application will be cleared. The most common use of this would be to delete cached information, such as login credentials or state, and thereby return the application to its default behavior. The use of this Action value requires that you must also specify Clear Application Cache Package to identify the application whose cache is to be cleared.
  • If the Action value Turn On All GMS Applications is selected, all GMS applications that are considered Safe to Disable will be enabled.
  • If the Action value Turn Off All GMS Applications is selected, all GMS applications that are considered Safe to Disable will be disabled.

Note: Since it is possible to turn GMS Applications on or off individually, using the values Turn On All GMS Applications and Turn Off All GMS Applications will guarantee only that all GMS Applications are On or Off immediately after the requested Action is completed. Subsequent Actions could result in any mixture of GMS Applications being turned On or Off. The behavior of the system or any GMS applications under such conditions is not guaranteed.

Detail Information:

  • Key = uiAction

  • Type = string

 UI Choice  JSON Value 
 Clear Clipboard  1 
 Clear Recently Used Apps List  2 
 Clear Application Cache  3 
 Turn On All GMS Applications  4 
 Turn Off All GMS Applications  5 
 Clear Application User Data  10 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.1.

Clear Application Cache Package

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Enter the Android Package Name for which the cache should be cleared by a Clear Application Cache Action when the value Clear Application Cache is selected for Action.

Detail Information:

  • Key = uiActionClearApplicationCachePackage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.0.

Clear Application Data Package

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Enter the Android Package Name for which all user data should be cleared when performing a Clear Application User Data Action when the value Clear Application User Data is selected for Action.

Detail Information:

  • Key = uiActionClearApplicationUserDataPackage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.1.

Allow Device User Control of Do Not Disturb Mode

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User will be presented with the option to control the state of Do Not Disturb Mode from the Menu presented when the power key is held down on a device.

Detail Information:

  • Key = uiUserControlDoNotDisturbMode

  • Type = string

 UI Choice  JSON Value 
 Hide  2 
 Show  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

App Info Icon on Long Press on Recent App Header

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether a Long Press on the Home Key will Launch the Google Assistant.

  • If the value Show is selected, an App Info Icon will be shown on Long Press on Recent App Header
  • If the value Hide is selected, an App Info Icon will NOT be shown on Long Press on Recent App Header

Detail Information:

  • Key = uiAppInfoOnLongPressRecentAppHeader

  • Type = string

 UI Choice  JSON Value 
 Show  1 
 Hide  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.2.

Auto Correct

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User prompted for corrections to potential mistakes made during entry of data on a device.

  • If the value Off is selected, the Device User will NOT be prompted to correct potential mistakes during data entry.

  • If the value On is selected, the Device User will be prompted to correct potential mistakes during data entry.

Detail Information:

  • Key = uiAutoCorrect

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Battery Charging LED

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the charging system be allowed to display the battery charging state using the charging LED when a device is in operating mode.

  • If the value Disable is selected, the charging system will be prevented from using the charging LED to display the battery charging state, which may reduce distractions in environments where many devices are charging.
  • If the value Enable is selected, the charging system will be allowed to use the charging LED to display the battery charging state, which may make it easier to distinguish a fully charged device from a partially charged device.

Detail Information:

  • Key = uiBatteryChargingLED

  • Type = string

 UI Choice  JSON Value 
 Disable  2 
 Enable  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Battery Swap UI Popup

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User will automatically be presented with the Battery Swap UI when the device battery level drops below a fixed threshold.

  • If the value Disable is selected, the Device User will NOT automatically be presented with the Battery Swap UI when the device battery level drops below a fixed threshold.
  • If the value Enable is selected, the Device User will automatically be presented with the Battery Swap UI when the device battery level drops below a fixed threshold, perhaps helping to avoid emergency shutdown and potential loss of data as a result.

Detail Information:

  • Key = uiBatterySwapPopup

  • Type = string

 UI Choice  JSON Value 
 Disable  2 
 Enable  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Display of Navigation Bar

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the on-screen Navigation Bar will be displayed and hence whether it will take up screen real estate and can be used to navigate the device UI.

  • If the value Off is selected, the on-screen Navigation Bar will NOT be displayed and hence whether it will NOT take up any screen real estate, and hence cannot be used to navigate the device UI.
  • If the value On is selected, the on-screen Navigation Bar will be displayed and hence whether it will take up any screen real estate, and hence be used to navigate the device UI.

Detail Information:

  • Key = uiDisplayNavigationBar

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 7.1.

External Keyboard Configuration

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Use this Sub-group to configure Action, Keyboard Name, Keyboard to remove, and Layout Name.

Detail Information:

  • Key = uiExternalKeyboardConfig

  • Type = bundle

Action

   Transaction Steps  >  Transaction Step  >  General UI Configuration  >  External Keyboard Configuration

Select the External Keyboard Layout Mapping action to take.

  • If the value Add/Replace Keyboard Layout Mapping is selected, the external keyboard layout specified in Layout Name will be added or replaced for the keyboard name entered for Add/Replace Keyboard Name

  • If the value Remove Keyboard Layout Mapping is selected, the external keyboard layout associated with keyboard name Keyboard Name will be removed.

  • If the value Remove All Keyboard Layout Mappings is selected, all external keyboard layouts will be removed.

Detail Information:

  • Key = uiEKCAction

  • Type = string

 UI Choice  JSON Value 
 Add/Replace Keyboard Layout Mapping  1 
 Remove Keyboard Layout Mapping  2 
 Remove All Keyboard Layout Mappings  3 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.5.

Keyboard Name

   Transaction Steps  >  Transaction Step  >  General UI Configuration  >  External Keyboard Configuration

Enter 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.

Keyboard to remove

   Transaction Steps  >  Transaction Step  >  General UI Configuration  >  External Keyboard Configuration

Enter the external keyboard name to associate the layout being added or replaced. This item is optional.

Detail Information:

  • Key = uiEKCOptionalName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.5.

Layout Name

   Transaction Steps  >  Transaction Step  >  General UI Configuration  >  External Keyboard Configuration

Enter 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.

Launcher Package Name

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Enter the Android Package Name of the default launcher application. This would typically be used when installing an new launcher (home screen) application as a replacement for the default Android launcher.

Detail Information:

  • Key = uiLauncherPackageName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.1.

Locale

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select the Locale to be used on a device.

A Locale is typically specified by selecting a Language (e.g. English) and optionally a Region (e.g. the United States).

Values MUST specify a Language, and optionally a Region.

  • When only a Language is to be specified, the identifier will be the name of the Language (e.g. CHINA).
  • When both a Language and a Region are to be specified, the identifier will be the name of the Region followed by the name of the Language, separated by an underscore (e.g. CANADA_FRENCH).

Detail Information:

  • Key = uiLocale

  • Type = string

 UI Choice  JSON Value 
 CANADA  en_CA 
 CANADA_FRENCH  fr_CA 
 CHINA  zh_CN 
 CHINESE  zh 
 ENGLISH  en 
 FRANCE  fr_FR 
 FRENCH  fr 
 GERMAN  de 
 GERMANY  de_DE 
 ITALIAN  it 
 ITALY  it_IT 
 JAPAN  ja_JP 
 JAPANESE  ja 
 KOREA  ko_KR 
 KOREAN  ko 
 PRC  zh_CN 
 SIMPLIFIED_CHINESE  zh_CN 
 TAIWAN  zh_TW 
 TRADITIONAL_CHINESE  zh_TW 
 UK  en_GB 
 US  en_US 
 SPANISH  es_ES 
 US_SPANISH  es_US 
 BRAZIL_PORTUGUESE  pt_BR 
 PORTUGUESE  pt_PT 
 AUSTRALIA_ENGLISH  en_AU 
 INDIA_ENGLISH  en_IN 
 SWEDEN_SWEDISH  sv_SE 
 NORWAY_NORWEGIAN-BOKMAL  nb_NO 
 FINLAND_FINISH  fi_FI 
 DENMARK_DANISH  da_DK 

Support Information:

  • Supported from: MX 5.1.

Long Press on Home Key to Launch Google Assistant

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether a Long Press on the Home Key will Launch the Google Assistant.

  • If the value Allow is selected, a Long Press on the Home Key will Launch the Google Assistant.
  • If the value Disallow is selected, a Long Press on the Home Key will NOT Launch the Google Assistant.

Detail Information:

  • Key = uiLongPressHomeLaunchesGoogleAssistant

  • Type = string

 UI Choice  JSON Value 
 Allow  1 
 Disallow  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.2.

Network Notification Popup

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Network Notification Popup will be presented to inform the Device User that their network may be monitored.

  • If the value Off is selected, the Network Notification Popup will NOT be presented, and hence the Device User will NOT be notified that their network may be monitored, even if circumstances warrant such notification.
  • If the value On is selected, the Network Notification Popup may be presented, and hence the Device User may be notified that their network may be monitored, if circumstances warrant such notification.

Detail Information:

  • Key = uiNetworkNotificationPopup

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.1.

On-Screen Power Button

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the On Screen Power Button feature will be turned ON or OFF. the On Screen Power Button feature allows a button to be displayed which allows the Device User to turn the device off, similar to the operation of the physical power button (if any) 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 Device User is wearing gloves.

  • If the value Disable is selected, the On Screen Power Button feature will be turned OFF and hence the on-screen power button will NOT be displayed.
  • If the value Enable is selected, the On Screen Power Button feature will be turned ON and hence the on-screen power button WILL be displayed.

Detail Information:

  • Key = uiOnScreenPowerButton

  • Type = string

 UI Choice  JSON Value 
 Disable  2 
 Enable  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Pull Down Notification Bar

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User is allowed to Pull Down the Notification Bar to interact with notifications in the Notifications Panel.

  • If the value Off is selected, the Device User will NOT be allowed to Pull Down the Notification Bar, and hence will not be allowed to interact with notifications in the Notifications Panel.
  • If the value On is selected, the Device User will be allowed to Pull Down the Notification Bar, and hence will be allowed to interact with notifications in the Notifications Panel.

Detail Information:

  • Key = uiPullDownNotificationBar

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.1.

Show Airplane Mode in Power Key Menu

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User will be presented with the option to control the state of Airplane Mode from the Menu presented when the power key is held down on a device.

Detail Information:

  • Key = uiShowAirplaneModeInPwrKeyMenu

  • Type = string

 UI Choice  JSON Value 
 Hide  2 
 Show  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Show Battery Percentage In Notification Bar

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the battery percentage will be displayed in the notification bar.

Detail Information:

  • Key = uiShowBatteryPercentage

  • Type = string

 UI Choice  JSON Value 
 Turn Off  2 
 Turn On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

Show Pairing Popup

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether a New Pairing Popup will be presented when an unpaired peripheral device attempts to establish a new Bluetooth pairing with a device.

  • This option has no effect on existing pairings.
  • This option does not prevent new pairings that are initiated from the device to the peripheral.
  • This option does not prevent new pairings from being established based on configured Silent Pairing rules.

Detail Information:

  • Key = uiPairingPopup

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Show Passwords

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether passwords should be shown (displayed) when entered on the device or hidden (masked).

  • If the value Off is selected, passwords will globally be hidden (masked) whenever they are being entered on the device.
  • If the value On is selected, passwords will globally be shown (displayed) whenever they are being entered on the device.

Detail Information:

  • Key = uiShowPasswords

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.1.

Show Touch Mode in Power Key Menu

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User will be presented with the option to control the state of the Touch Mode from the Menu presented when the power key is held down on a device.

Detail Information:

  • Key = uiShowTouchModeInPwrKeyMenu

  • Type = string

 UI Choice  JSON Value 
 Hide  2 
 Show  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.2.

Show Virtual Keyboard when Physical Keyboard is Active

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Virtual Keyboard will be shown when the Physical Keyboard is Active.

  • If the value Off is selected, the Virtual Keyboard will NOT be shown if the device has a Physical Keyboard that is Active. This can help avoid the annoyance and confusing of using up screen real-estate to display an on-screen keyboard when the Device User is using a Physical Keyboard to enter data.
  • If the value On is selected, the Virtual Keyboard will be shown when data entry is in progress regardless of whether the device has an Active Physical Keyboard.

Detail Information:

  • Key = uiShowVirtualKeyboard

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.0.

Status Bar

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Android Status Bar should be displayed.

  • If the value Hide is selected, the Android Status Bar will not be displayed, which also means that the Device User will not be allowed to interact with notifications in the Notifications Panel.
  • If the value Show is selected, the Android Status Bar will be displayed, which also means that the Device User might be allowed to interact with notifications in the Notifications Panel.

Detail Information:

  • Key = uIStatusBar

  • Type = string

 UI Choice  JSON Value 
 Hide  2 
 Show  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.4.

Use Of Clipboard

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User will be allowed to utilize the clipboard on a device to cut, copy, and paste text between applications.

Detail Information:

  • Key = uiUseOfClipboard

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.2.

Sharing

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User will be allowed to utilize the clipboard Sharing on a device to share the contents of the clipboard.

Detail Information:

  • Key = uiUseOfClipboardSharing

  • Type = string

 UI Choice  JSON Value 
 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.

  • Support resumed from: MX 11.2.

Use of Date in Notification Panel to Access Clock Application

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Date in the Notification Panel can be used to invoke the Clock Application.

  • If the value Allow is selected, clicking the Date in the Notification Panel will invoke the Clock Application.
  • If the value Disallow is selected, clicking the Date in the Notification Panel will NOT invoke the Clock Application.

Detail Information:

  • Key = uiDateInNotificationAccessClock

  • Type = string

 UI Choice  JSON Value 
 Allow  1 
 Disallow  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.2.

Use of Home Key

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device 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 Off is selected, the Home key will be ignored and will cause no action if it is pressed.
  • If the value On is selected, the Home key will be honored and will cause device to go to the Home/Launcher screen when if it is pressed.

Detail Information:

  • Key = uiUseOfHomeKey

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Use of Magnification Gestures

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User is allowed to Use Magnification Gestures.

  • If the value Off is selected, the Magnification Gestures will be ignored and no action will be taken if they are used by the Device User.
  • If the value On is selected, the Magnification Gestures will be honored and appropriate action will be taken if they are used by the Device User.

Detail Information:

  • Key = uiUseOfMagnificationGestures

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 8.0.

Use of Recent Apps Key

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User is allowed to Use the Recent Apps Key to access recently launched applications.

  • If the value Off is selected, the Recent Apps Key will be ignored, and hence the Device User will not be allowed to access recently launched applications.
  • If the value On is selected, the Recent Apps Key will be honored, and hence the Device User will be allowed to access recently launched applications.

Detail Information:

  • Key = uiUseOfRecentAppsKey

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 7.1.

Use of Split Screen Mode

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether Split Screen Mode is allowed to be used on the device.

  • If the value Disallow is selected, the use of Split Screen Mode will be blocked on the device.
  • If the value Allow is selected, the use of Split Screen Mode will be allowed on the device.

Detail Information:

  • Key = uiSplitScreenMode

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

User Control of Multi User

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether Primary Device User is allowed to invoke UI to manage Multi User, including the ability to Create, Delete, and limit the actions of Secondary Users.

  • If the value Disallow is selected, the Primary Device User will not be allowed to manage Secondary Users, even if the device supports multiple users.
  • If the value Allow is selected, the Primary Device User will be allowed to manage Secondary Users, if the device supports multiple users.

Detail Information:

  • Key = uiUserControlMultiUser

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Touch Mode

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select the operational mode of the Touch Panel in selected devices: - 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 = uiTouchMode

  • Type = string

 UI Choice  JSON Value 
 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

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether Touch Panel should be optimized for use with a Screen Protector. - If selected, the Touch Panel will be configured to optimize use with a screen Protector.

  • If unselected, the Touch Panel will be configured to optimize use without 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 = uiTouchScreenProtector

  • Type = boolean

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.1.

Turn on/off the Large Key Indicator feature

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Large Key Indicator feature, which allows a large on-screen indicator to be displayed to indicate the state physical keypad on the device (if any) and which can assist the Device User in cases where multiple key sequences are required.

  • If the value Turn Off is selected, the Large Key Indicator feature will be turned OFF and hence the on-screen indicator will NOT be displayed.
  • If the value Turn On is selected, the Large Key Indicator feature will be turned ON and hence the on-screen indicator WILL be displayed.

Detail Information:

  • Key = uiSetLKI

  • Type = string

 UI Choice  JSON Value 
 Turn On  1 
 Turn Off  2 

Support Information:

  • Supported from: MX 9.0.

Device user control of Large Key Indicator

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Select whether the Device User will be allowed to turn the Large Key Indicator feature ON or OFF.

  • If the value Enable is selected, the Device User WILL be allowed to turn the Large Key Indicator feature ON or OFF.
  • If the value Disable is selected, the Device User will NOT be allowed to turn the Large Key Indicator feature ON or OFF.

Detail Information:

  • Key = uiUserControlLKI

  • Type = string

 UI Choice  JSON Value 
 Enable  1 
 Disable  2 

Support Information:

  • Supported from: MX 9.0.

Assistant App

   Transaction Steps  >  Transaction Step  >  General UI Configuration

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 Custom Assistant App will be used.
  • If the value None is selected, no assistant app will be used.

Detail Information:

  • Key = uiAssistantApp

  • Type = string

 UI Choice  JSON Value 
 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.

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

Custom Assistant App

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Enter the package name of the assistant application to be used on the device.

Detail Information:

  • Key = uiCustomAssistantApp

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.5.

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

Home Screen Wallpaper

   Transaction Steps  >  Transaction Step  >  General UI Configuration

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 Custom Home Screen Wallpaper will be used.

Detail Information:

  • Key = uiHomeScreenWallpaper

  • Type = string

 UI Choice  JSON Value 
 Restore to default  1 
 Custom  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.5.

  • Support discontinued from: MX 11.0.

  • Support resumed from: MX 11.2.

Custom Home Screen Wallpaper

   Transaction Steps  >  Transaction Step  >  General UI Configuration

Enter the path and file name of an image file on the device (.jpg or .png)

Detail Information:

  • Key = uiCustomHomeWallpaper

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.5.


GMS Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure GMS Feature Set, and GMS Profile.

Detail Information:

  • Key = gmsStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

GMS Feature Set

   Transaction Steps  >  Transaction Step  >  GMS Configuration

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 = gmsFeatureSet

  • Type = string

 UI Choice  JSON Value 
 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.

  • Supported from: MX 8.3.

GMS Profile

   Transaction Steps  >  Transaction Step  >  GMS Configuration

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 = gmsProfile

  • Type = string

 UI Choice  JSON Value 
 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.


GPRS Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Add APN Name, Add APN Replace If Existing, Add APN Make Default, Add APN Access Point, Add APN User Name, Add APN Password, Add APN Port, Add APN Proxy, Add APN MMS Port, Add APN MMS Proxy, Add APN Server, Add APN MMSC, Add APN Type, Add APN MCC, Add APN MNC, Add APN Protocol, Add APN Roaming Protocol, Add Authentication Type, Add MVNO Type, Add MVNO Match Data, and Remove APN Name.

Detail Information:

  • Key = gprsStep

  • Type = bundle

Support Information:

  • Supported from: MX 8.4.

Action

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Select an Action to manage the GPRS APNs on a device:

  • If the value AddApn is selected, a new APN will be added, or an existing APN will be overwritten with a new APN. You must also specify Add APN Name to provide the name of the new APN to be added or the name of the existing APN to be replaced. In addition, you must also specify some or all of the following to provide the APN definition:
  • Add APN Replace If Existing
  • Add APN Make Default
  • Add APN Access Point
  • Add APN User Name
  • Add APN Password
  • Add APN Port
  • Add APN Proxy
  • Add APN MMS Port
  • Add APN MMS Proxy
  • Add APN Server
  • Add APN MMSC
  • Add APN Type
  • Add APN MCC
  • Add APN MNC
  • If the value RemoveApn is selected, an existing APN will be removed. You must also specify Remove APN Name to provide the name of the APN to be removed.
  • If the value RemoveAllApns is selected, all existing APNs will be removed and you do not need to specify any additional information.

Detail Information:

  • Key = gprsAction

  • Type = string

 UI Choice  JSON Value 
 AddApn  1 
 RemoveApn  2 
 RemoveAllApns  3 

Support Information:

  • Supported from: MX 8.4.

Add APN Name

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the name of an APN to be added when the value AddApn is selected for Action.

Detail Information:

  • Key = gprsActionAddApnName

  • Type = string

Support Information:

  • Supported from: MX 4.2.

Add APN Replace If Existing

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Select what happens when an APN already exists with the APN name being added when the value AddApn is selected for Action.

  • If the value Replace Existing is selected, if an APN with the name specified via Add APN Name already exists, it will be replaced by the definition of the APN being added.
  • If the value Keep Existing is selected, if an APN with the name specified via Add APN Name already exists, it will NOT be replaced. The existing APN will be preserved and the new APN will NOT be added.

Detail Information:

  • Key = gprsActionAddApnReplaceIfExisting

  • Type = string

 UI Choice  JSON Value 
 Replace Existing  1 
 Keep Existing  0 

Support Information:

  • Supported from: MX 4.2.

Add APN Make Default

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Select whether a new APN being added should become the new default APN when the value AddApn is selected for Action. - If the value Yes is selected, the new APN being added will become the new default APN and will be preferred over other APNs when establishing a cellular data connection.

  • If the value No is selected, the new APN will not become the new default APN and whatever APN was previously the default will remain the default.

Detail Information:

  • Key = gprsActionAddApnMakeDefault

  • Type = string

 UI Choice  JSON Value 
 Yes  1 
 No  0 

Support Information:

  • Supported from: MX 4.2.

Add APN Access Point

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter a value that uniquely identifies an APN on the network when the value AddApn is selected for Action.

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 = gprsActionAddApnAccessPoint

  • Type = string

Support Information:

  • Supported from: MX 4.2.

Add APN User Name

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter a user name that can be used to authenticate to an APN when the value AddApn is selected for Action.

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 = gprsActionAddApnUserName

  • Type = string

Support Information:

  • Supported from: MX 4.2.

Add APN Password

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter a password that can be used to authenticate to an APN when the value AddApn is selected for Action.

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 = gprsActionAddApnPassword

  • Type = string

Support Information:

  • Supported from: MX 4.2.

Add APN Port

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the port number of an HTTP proxy to use for all traffic over the network accessed via an APN when the value AddApn is selected for Action.

If a Proxy is required, a Port is also generally always required.

Detail Information:

  • Key = gprsActionAddApnPort

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN Proxy

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the address or name of an HTTP proxy to use for all traffic over the network accessed via an APN when the value AddApn is selected for Action.

  • If a Proxy is required, a Port is also generally always required.

Detail Information:

  • Key = gprsActionAddApnProxy

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN MMS Port

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the port number of an HTTP proxy to use ONLY for (Multimedia Messaging Service) MMS traffic over the network accessed via an APN when the value AddApn is selected for Action.

  • If an MMS Proxy is required, an MMS Port is also generally always required.

Detail Information:

  • Key = gprsActionAddApnMmsPort

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN MMS Proxy

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

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 when the value AddApn is selected for Action.

  • If an MMS Proxy is required, an MMS Port is also generally always required.

Detail Information:

  • Key = gprsActionAddApnMmsProxy

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN Server

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter a WAP Gateway Server address that should be used for an APN when the value AddApn is selected for Action.

WAP Gateways are rarely, if ever, used on or supported by modern cellular carrier networks.

Detail Information:

  • Key = gprsActionAddApnServer

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN MMSC

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the Multimedia Messaging Service Center (MMSC) address required to route MMS traffic over the network accessed via an APN when the value AddApn is selected for Action.

Detail Information:

  • Key = gprsActionAddApnMmsc

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN Type

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the Type of APN to be added when the value AddApn is selected for Action.

The value to specify for Type should be obtained from the cellular carrier whose network is to be accessed via the APN.

Detail Information:

  • Key = gprsActionAddApnType

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN MCC

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the Mobile Country Code (MCC) of the APN to be added when the value AddApn is selected for Action.

The MCC generally match the SIM Card being used or the APN will not be usable.

Detail Information:

  • Key = gprsActionAddApnMcc

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN MNC

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the Mobile Network Code (MNC) of the APN to be added when the value AddApn is selected for Action.

The MNC generally match the SIM Card being used or the APN will not be usable.

Detail Information:

  • Key = gprsActionAddApnMnc

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Add APN Protocol

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Select the APN 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 = gprsActionAddApnProtocol

  • Type = string

 UI Choice  JSON Value 
 IPv4  1 
 IPv6  2 
 IPv4/IPv6  3 

Support Information:

  • Supported from: MX 9.3.

Add APN Roaming Protocol

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

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 = gprsActionAddApnProtocolRoaming

  • Type = string

 UI Choice  JSON Value 
 IPv4  1 
 IPv6  2 
 IPv4/IPv6  3 

Support Information:

  • Supported from: MX 9.3.

Add Authentication Type

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Select the Type of Authentication to be used for APN to be added when the value AddApn is selected for Action.

  • 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 = gprsActionAddApnAuthenticationType

  • Type = string

 UI Choice  JSON Value 
 None  1 
 PAP  2 
 CHAP  3 

Support Information:

  • Supported from: MX 8.3.

Add MVNO Type

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Select the MVNO (Mobile Virtual Network Operator) Type to be used for APN to be added when the value AddApn is selected for Action.

  • 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 Add 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 Add 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 Add 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 Add MVNO Match Data.

Detail Information:

  • Key = gprsActionAddApnMvnoType

  • Type = string

 UI Choice  JSON Value 
 None  1 
 SPN  2 
 IMSI  3 
 GID  4 
 ICCID  5 

Support Information:

  • Supported from: MX 8.4.

Add MVNO Match Data

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the MVNO (Mobile Virtual Network Operator) Match Data to be used for APN to be added when the value AddApn is selected for Action and if a value other than None is selected for Add 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 = gprsActionAddApnMvnoMatchData

  • Type = string

Support Information:

  • Supported from: MX 8.4.

Remove APN Name

   Transaction Steps  >  Transaction Step  >  GPRS Configuration

Enter the name of an APN to be removed when the value RemoveApn is selected for Action.

Detail Information:

  • Key = gprsActionRemoveApnName

  • Type = string

Support Information:

  • Supported from: MX 4.1.1.


Host Name Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Device Name.

Detail Information:

  • Key = hostStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.1.

Device Name

   Transaction Steps  >  Transaction Step  >  Host Name Configuration

Enter the name by which a device will be known on the network.

Detail Information:

  • Key = hostDeviceName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.1.


Key Mapping Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Add Mapping Key ID, and Add Mapping Behaviors.

Detail Information:

  • Key = keymapStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Action

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration

Select an Action to affect the behaviors mapped to the keys on the physical keyboard (if any) of a device:

  • If the value Add Mapping is selected, a new mapping for a single physical key is added to the mapping tables for one or more keyboard states. You must also specify Add Mapping Key ID to provide the physical key for which mappings are to be added or replaced. In addition, you must also specify the Sub-array Add Mapping Behaviors to define the behavior(s) to be mapped to the identified physical key. If any prior mappings were applied to specify the behaviors of the identified physical key, they will all be replaced by the new specified behaviors.
  • If the value Reset All Mappings is selected, the mapping tables are reset to their defaults. This effectively removes all mappings that have previously been added and returns the behaviors of all keys to their default out-of-box state.

Detail Information:

  • Key = keymapAction

  • Type = string

 UI Choice  JSON Value 
 Add Mapping  1 
 Reset All Mappings  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Add Mapping Key ID

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration

Select a value that uniquely identifies a physical key on the physical keyboard of a device for which one or more behaviors are to be specified when the value Add Mapping is selected for Action.

Detail Information:

  • Key = keymapActionAddMappingKeyId

  • 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 
 - (Minus)  MINUS 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Add Mapping Behaviors

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration

Use this Sub-array to configure one or more Behavior(s).

Detail Information:

  • Key = keymapActionAddMappingBehaviors

  • Type = bundle_array

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Behavior

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors

Use this Sub-group to configure Table Name, Type, Send Key Code, Alt, Ctrl, Fn, Shift, Send Trigger, Send Intent, Type, Action, Category, Package Name, Class, Data URI, Flags, MIME Type, Extra Name, Extra Value, Launch Application Name, and Add Key Event.

Detail Information:

  • Key = keymapBehavior

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Table Name

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select the name of the table into which a specific behavior will be stored. Mapping tables are associated with keyboard states and are named based on the state key on the physical keyboard of a device that causes that keyboard state to be activated or deactivated.

Note that due to variations in keyboard size and layout, not all keyboard states may be supported on all devices or on all keyboard possible on any given device. Some or all of the following may values may be supported:

  • If the value Base is selected, the Base Mapping table will be selected. The Base Mapping table defines the behavior that will be performed for a physical key when it is pressed while no special keyboard state is active.

  • If the value Blue is selected, the Blue Mapping table will be selected. The Blue Mapping table defines the behavior that will be performed for a physical key when it is pressed in conditions where the Blue key has been used to activate the Blue keyboard state.

  • If the value Orange is selected, the Orange Mapping table will be selected. The Orange Mapping table defines the behavior that will be performed for a physical key when it is pressed in conditions where the Orange key has been used to activate the Orange keyboard state.

  • If the value Grey is selected, the Grey Mapping table will be selected. The Grey Mapping table defines the behavior that will be performed for a physical key when it is pressed in conditions where the Grey key has been used to activate the Grey keyboard state.

  • If the value Shift is selected, the Shift Mapping table will be selected. The Shift Mapping table defines the behavior that will be performed for a physical key when it is pressed in conditions where the Shift key has been used to activate the Shift keyboard state.

  • If the value Control is selected, the Control Mapping table will be selected. The Control Mapping table defines the behavior that will be performed for a physical key when it is pressed in conditions where the Control key has been used to activate the Control keyboard state.

Detail Information:

  • Key = keymapBehaviorTableName

  • 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.

  • Supported from: MX 4.4.

Type

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select the type of behavior that will be performed when a specified key is pressed while the keyboard state associated with the specified Mapping table is active.The following may values are supported:

  • If the value Send Key Code is selected, the behavior performed when the specified key is pressed while the keyboard state associated with the specified Mapping table is active will be to send a specified key code. This performs Classic Keyboard Remapping, where the behavior of a key is changed to be the behavior of some other key, which may or may not be present on the physical keyboard. You must also specify Send Key Code to provide the key code that will be sent.
  • If the value Send Trigger is selected, the behavior performed when the specified key is pressed while the keyboard state associated with the specified Mapping table is active will be to send a trigger signal. Trigger signals may be used to initiate various activities, such as barcode scanning, RFID reading, push to talk, etc. You must also specify Send Trigger to select which trigger signal will be sent,
  • If the value Launch Application is selected, the behavior performed when the specified key is pressed while the keyboard state associated with the specified Mapping table is active 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 used.
  • If the value Send Intent is selected, the behavior performed when the specified key is pressed while the keyboard state associated with the specified Mapping table is active will be to send and Android Intent, which 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:
  • Type
  • Action
  • Category
  • Package Name
  • Class
  • Data URI
  • Flags
  • MIME Type
  • Extra Name
  • Extra Value

Sending an Android Intent provides a very flexible way to specify the behavior to be performed for a key by invoking an application or service. As such, 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 behavior. In many cases, the application or service to be invoked will define the nature of the intent is wishes to received and that definition can be used to drive the configuration.

  • If the value Suppress Key is selected, NO behavior will be performed when the specified key is pressed while the keyboard state associated with the specified Mapping table is active. This provides a method to remap a key to do nothing.
  • If the value Reset To Default is selected, the behavior performed when the specified key is pressed while the keyboard state associated with the specified Mapping table is active be reset back to its defaults. This will effectively remove any prior mapping of that key in that state and return the key to its standard behavior in that state.

Detail Information:

  • Key = keymapBehaviorType

  • 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.

  • Supported from: MX 4.4.

Send Key Code

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select the key code that will be sent as the behavior for a specified key a specified state when the value Send Key Code is selected for Type.

Detail Information:

  • Key = keymapBehaviorTypeSendKeyCode

  • 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 4.4.

Alt

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select how a key code will be sent as the behavior for a specified key a specified state when the value Send Key Code is selected for Type and when Send Key Code is specified.

  • If the value Off is selected, when the key code is sent, it will be sent with the Alt keyboard state inactive. This will ensure that the key code is 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 active. This will ensure that the key code is interpreted as an Alt key.
  • If no value is specified, when the key code is sent, the Alt keyboard state will not be changed. This will cause the key to be interpreted as an Alt key or not based on the existing state.

Detail Information:

  • Key = keymapBehaviorTypeSendKeyCodeAlt

  • Type = string

 UI Choice  JSON Value 
 On  1 
 Off  0 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Ctrl

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select how a key code will be sent as the behavior for a specified key a specified state when the value Send Key Code is selected for Type and when Send Key Code is specified.

  • If the value Off is selected, when the key code is sent, it will be sent with the Ctrl keyboard state inactive. This will ensure that the key code is 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 active. This will ensure that the key code is interpreted as an Ctrl key.
  • If no value is specified, when the key code is sent, the Ctrl keyboard state will not be changed. This will cause the key to be interpreted as an Ctrl key or not based on the existing state.

Detail Information:

  • Key = keymapBehaviorTypeSendKeyCodeCtrl

  • Type = string

 UI Choice  JSON Value 
 On  1 
 Off  0 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Fn

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select how a key code will be sent as the behavior for a specified key a specified state when the value Send Key Code is selected for Type and when Send Key Code is specified.

  • If the value Off is selected, when the key code is sent, it will be sent with the Fn keyboard state inactive. This will ensure that the key code is 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 active. This will ensure that the key code is interpreted as an Fn key.
  • If no value is specified, when the key code is sent, the Fn keyboard state will not be changed. This will cause the key to be interpreted as an Fn key or not based on the existing state.

Detail Information:

  • Key = keymapBehaviorTypeSendKeyCodeFn

  • Type = string

 UI Choice  JSON Value 
 On  1 
 Off  0 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Shift

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select how a key code will be sent as the behavior for a specified key a specified state when the value Send Key Code is selected for Type and when Send Key Code is specified.

  • If the value Off is selected, when the key code is sent, it will be sent with the Shift keyboard state inactive. This will ensure that the key code is 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 active. This will ensure that the key code is interpreted as an Shift key.
  • If no value is specified, when the key code is sent, the Shift keyboard state will not be changed. This will cause the key to be interpreted as an Shift key or not based on the existing state.

Detail Information:

  • Key = keymapBehaviorTypeSendKeyCodeShift

  • Type = string

 UI Choice  JSON Value 
 On  1 
 Off  0 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Send Trigger

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select the trigger signal that will be sent as the behavior for a specified key a specified state when the value Send Trigger is selected for Type.

Eight trigger signals are defined, but not all may be supported on all devices. All devices generally support at least Trigger 1 and generally default to using this trigger signal to activate the barcode scanner. Some devices may support additional trigger signals and some devices might be reconfigured to use Trigger 1 for some purpose other than barcode scanning. To determine which trigger signals are supported on a given device, consult the documentation for that specific device.

Detail Information:

  • Key = keymapBehaviorTypeSendTrigger

  • 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.

  • Supported from: MX 4.4.

Send Intent

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select when an intent should be sent as the behavior for a remapped key.

  • If the value On Key Down is selected, the intent will be sent immediately when the key is first detected as being pressed.
  • If the value On Key Up is selected, the intent will not be sent until the key is detected as being released after being being pressed.
  • If the value On Both Key Up and Down is selected, the intent will be sent immediately when the key is first detected as being pressed and then again when the key is detected as being released.

Detail Information:

  • Key = keymapBehaviorTypeSendIntent

  • 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.

  • Supported from: MX 4.4.

Type

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter the method in which an Android Intent should be sent to invoke an application or service when the value Send Intent is selected for Type.

Depending on the application or service to be invoked, there is likely only one method that can be used successfully to invoke a desired behavior in that application or service. 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. The possible values are.

  • If the value StartActivity is selected, the Android Intent will be sent using the startActivity() method. This method is suitable for invoking Activities, which are components that perform user interactions. If the behavior to be invoked involves interacting with the Device User, this method will most likely be used.
  • If the value Broadcast is selected, the Android Intent will be sent using the sendBroadcast() method. This method is suitable for invoking Services, which are components that implement background operations. If the behavior to be invoked does not involves interacting with the Device User, this method will most likely be used.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentType

  • Type = string

 UI Choice  JSON Value 
 StartActivity  StartActivity 
 Broadcast  Broadcast 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Action

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter the action value of an Android Intent to be sent to invoke an application or service when the value Send Intent is selected for Type.

An action value is NOT mandatory to specify for an Android Intent. But an action value is commonly used to identify the purpose of an Android Intent. This can be especially when the application or service to be invoked supports multiple functions, in which case the action value is commonly used to identify which function to perform when invoking that application or service. You will need to consult the documentation or developer of a given application or service to determine whether an action value is needed and, if so, which value will invoke the desired behavior.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentAction

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Category

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter the category value of an Android Intent to be sent to invoke an application or service when the value Send Intent is selected for Type.

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 = keymapBehaviorTypeSendIntentCategory

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Package Name

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter the Android Package Name of the application or service to invoke when the value Send Intent is selected for Type.

It is not mandatory to specify the Android Package Name when sending an Android Intent, but is is often advisable.

  • When an Android Package Name is specified, the intent becomes an Explicit Intent and the intent can ONLY be sent to an application or service with that Android Package Name and no other. This can increase security and is often used when the intent being sent requires any sensitive data. You must also specify Class whenever an Android Package Name is specified, since an Explicit Intent is always sent to an Android Component, which is identified by a Android Package Name and a Class within that Package.
  • When no Android Package Name is specified, the intent becomes an Implicit Intent and the intent may be sent to any application or service that has registered its ability to handle that intent. This can increase flexibility 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 that intent.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentPackageName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Class

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter the Android Class that identifies an Android Component within an application or service to invoke when the value Send Intent is selected for Type and when Package Name is specified.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentClass

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Data URI

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter a Uniform Resource Identifier (URI) that identifies some data, in the form of a resource on the device (e.g. a file in the device file system) or off the device (e.g. a resource available via a network) that should be utilized by the application or service invoked by the intent.

Whether the intended recipient of 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.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentDataUri

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Flags

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter intent flags to be set for the intent to be sent.

Intent flags control how the intent is handled by Android. Some intent flags are specific to the type of component that will be invoked by the Intent (e.g. activity vs service). Whether certain intent flags are needed to produce the desired result when the intended recipient of the intent is invoked is up to that recipient and/or the definition of the intent that recipient is designed to consume. 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 = keymapBehaviorTypeSendIntentFlags

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

MIME Type

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter a Multipurpose Internet Mail Extensions (MIME) type to use when processing the intent data and when Data URI is specified.

Normally the type would be inferred from the data itself. Setting a MIME type explicitly, disables automatic type detection and and forces handling according to the specified type.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentMimeType

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Extra Name

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter the name of a single extra named string value 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. Exactly one value whose data type must be string can be specified. When a name is specified, you must also specify Extra Value to provide the corresponding value to be attached for the string extra.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentExtraName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Extra Value

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter the value of the String Extra to be attached to the intent to be sent and whose name is specified via Extra Name.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentExtraValue

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Launch Application Name

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Enter the Friendly Name of an application to be launched when the value Launch Application is selected for Type.

Note that the application Friendly Name is NOT the same as Android Package Name. The application Friendly Name is generally the name by which the application is identified in in-device UI, such as the application Launcher, the application's Title Bar, and the list of application names display in the Recent Application list and the AppInfo section of the Settings UI. To launch an application based on its Android Package Name, the value Send Intent should be selected for Type instead.

Detail Information:

  • Key = keymapBehaviorTypeLaunchApplicationName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Add Key Event

   Transaction Steps  >  Transaction Step  >  Key Mapping Configuration  >  Add Mapping Behaviors  >  Behavior

Select whether the key event should be added to the intent when the value Send Intent is selected for Type.

Detail Information:

  • Key = keymapBehaviorTypeSendIntentAddKeyEvent

  • Type = string

 UI Choice  JSON Value 
 No  0 
 Yes  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.


Log Management

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Log Action, Upload Snapshots URI, and Collection.

Detail Information:

  • Key = logStep

  • Type = bundle

Log Action

   Transaction Steps  >  Transaction Step  >  Log Management

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.

  • If the value Create Snapshot is selected, then the Log Management subsystem will Create a Snapshot of all available Log data up to the point when the Snapshot was Created. Since the Log Management subsystem has limits on the amount of Log data that can be Collected in the Background and will begin discarding older Log data in favor or newer Log data once those limits have been reached, the amount of history a Snapshot can contain will be limited. To avoid missing Log data, a Snapshot would need to be Created at least as frequently as the limits are reached. Multiple Snapshots could be Created and Uploaded at a later time, subject to the storage capacity of the device.

Detail Information:

  • Key = logAction

  • Type = string

 UI Choice  JSON Value 
 Start Background Collection  ENABLE 
 Stop Background Collection  DISABLE 
 Create Snapshot  BACKUP_NOW 

Support Information:

  • Supported from: MX 4.1.

Upload Snapshots URI

   Transaction Steps  >  Transaction Step  >  Log Management

Enter the URI of a location on a Remote Server to which all Snapshot Files previously Created on the 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 the 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 = logUploadSnapshotsUri

  • Type = string

Support Information:

  • Supported from: MX 10.1.

Collection Configuration

   Transaction Steps  >  Transaction Step  >  Log Management

Use this Sub-group to configure Logging Level.

Detail Information:

  • Key = logCollectionConfiguration

  • Type = bundle

Logging Level

   Transaction Steps  >  Transaction Step  >  Log Management  >  Collection Configuration

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 = logLogcatLevel

  • Type = string

 UI Choice  JSON Value 
 Basic  [binary data] 
 Basic+Qxdm  [binary data] 
 Basic+TCP Dump  [binary data] 

Support Information:

  • Supported from: MX 10.1.


Permission Access Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Permission Access Action, Grant Permission, Grant Application Package, Grant Application Signature, Revoke Permission, Revoke Application Package, Revoke Application Signature, Ask Permission, Ask Application Package, and Ask Application Signature.

Detail Information:

  • Key = permissionAccessStep

  • Type = bundle

Support Information:

  • Supported from: MX 10.4.

Permission Access Action

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Select an Action to be performed to manage which Sensitive Android Permissions are allowed to be used by which applications.

  • If the value Grant is selected, then a Sensitive Android Permission will be Granted to a selected Application and you must also specify Grant Permission to identify the Permission to be Granted and you must specify Grant Application Package and Grant Application Signature to identify the Application to which the Permission will be Granted.

  • If the value Revoke is selected, then a Sensitive Android Permission will be Revoked from a selected Application and you must also specify Revoke Permission to identify the Permission to be Revoked and you must specify Revoke Application Package and Revoke Application Signature to identify the Application from which the Permission will be Revoked.

  • If the value Ask is selected, then the Device User will be Asked whether a Sensitive Android Permission will be Granted or Denied to a selected Application and you must also specify Ask Permission to identify the Permission for which the Device User will be Asked and you must specify Ask Application Package and Ask Application Signature to identify the Application for which the Device User will be Asked.

Detail Information:

  • Key = permissionAccessAction

  • Type = string

 UI Choice  JSON Value 
 Grant  1 
 Revoke  2 
 Ask  3 

Support Information:

  • Supported from: MX 10.4.

Grant Permission

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Select the name of a Sensitive Android Permission to be Granted to a specified Application when the value Grant is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionGrantPermission

  • 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 

Support Information:

  • Supported from: MX 10.4.

Grant Application Package

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Enter the Android Package Name of an Application to which a Sensitive Android Permission should be Granted when the value Grant is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionGrantApplicationPackage

  • Type = string

Support Information:

  • Supported from: MX 10.4.

Grant Application Signature

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Enter the Android Package Signature of an Application to which a Sensitive Android Permission should be Granted when the value Grant is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionGrantApplicationSignature

  • Type = string

Support Information:

  • Supported from: MX 10.4.

Revoke Permission

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Select the name of a Sensitive Android Permission to be Revoked from a specified Application when the value Revoke is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionRevokePermission

  • 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 

Support Information:

  • Supported from: MX 10.4.

Revoke Application Package

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Enter the Android Package Name of an Application from which a Sensitive Android Permission should be Revoked when the value Revoke is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionRevokeApplicationPackage

  • Type = string

Support Information:

  • Supported from: MX 10.4.

Revoke Application Signature

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Enter the Android Package Signature of an Application from which a Sensitive Android Permission should be Revoked when the value Revoke is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionRevokeApplicationSignature

  • Type = string

Support Information:

  • Supported from: MX 10.4.

Ask Permission

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Select the name of a Sensitive Android Permission for which the Device User will be Asked whether to Grant or Deny to a specified Application when the value Ask is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionAskPermission

  • 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 

Support Information:

  • Supported from: MX 10.4.

Ask Application Package

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Enter the Android Package Name of an Application for which the Device User will be Asked whether to Grant or Deny a Sensitive Android Permission when the value Ask is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionAskApplicationPackage

  • Type = string

Support Information:

  • Supported from: MX 10.4.

Ask Application Signature

   Transaction Steps  >  Transaction Step  >  Permission Access Configuration

Enter the Android Package Signature of an Application for which the Device User will be Asked whether to Grant or Deny a Sensitive Android Permission when the value Ask is selected for Permission Access Action.

Detail Information:

  • Key = permissionAccessActionAskApplicationSignature

  • Type = string

Support Information:

  • Supported from: MX 10.4.


Power Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Power Action, Battery Percentage Decommission Threshold, Battery Usage Decommission Threshold, Battery Critical Low Threshold, Battery Optimization Action, Add Package Names, Remove Package Names, Port Action, Port Select, Auto Power Control, Auto Power Off, Timeout, Auto Power On, Heater Action, Heater Select, Off Threshold, On Threshold, All Wake-up Sources State, Battery Saver Control Mode, Battery Saver Control Mode Automatic Percentage Threshold, Battery Saver Mode, Doze Mode State, Wake-up Source Key Identifier, Custom, Wake-up Source to Activate the Display State, and Wake-up Method.

Detail Information:

  • Key = powerStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.1.

Power Action

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select an Action to control the Power to the device.

  • If the value Sleep is selected, the device will go to Sleep (i.e. enter Suspend Mode).

  • If the value Reboot is selected, the device will perform an OS Reboot (i.e. simple Reset).

Detail Information:

  • Key = powerAction

  • Type = string

 UI Choice  JSON Value 
 Sleep  1 
 Reboot  4 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.1.

Battery Percentage Decommission Threshold

   Transaction Steps  >  Transaction Step  >  Power Configuration

Enter the percentage of remaining battery capacity below which the battery will be deemed ready for decommissioning.

Detail Information:

  • Key = powerBatteryThresholdPercentage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Battery Usage Decommission Threshold

   Transaction Steps  >  Transaction Step  >  Power Configuration

Enter the amount of battery usage (e.g. charge/discharge cycles, coulombs in/out, etc.) that can occur beefore the battery will be deemed ready for decommissioning.

Detail Information:

  • Key = powerBatteryThresholdUsage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Battery Critical Low Threshold

   Transaction Steps  >  Transaction Step  >  Power Configuration

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 selected, the currently configured critically low threshold will not be changed, which is functionally equivalent to not specifying value.
  • If a value from 1 through 25 will cause the critically low threshold will be set to the specified value.

Detail Information:

  • Key = powerBatteryThresholdCriticalLow

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Battery Optimization Action

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select an Action to control which applications are subject to battery optimization and which are exempt.

  • If the value Add is selected, one or more applications will be made subject to battery optimizations and you must also specify Add Package Names to provide the Android Package Name(s) of the application(s) to be made subject to battery optimizations.
  • If the value Remove is selected, one or more applications will be made subject to battery optimizations and you must also specify Remove Package Names to provide the Android Package Name(s) of the application(s) to be exempted from battery optimizations.

Detail Information:

  • Key = powerBatteryOptimizationAction

  • Type = string

 UI Choice  JSON Value 
 Add  Add 
 Remove  Remove 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Add Package Names

   Transaction Steps  >  Transaction Step  >  Power Configuration

Enter one or more Android Package Name(s) that identify application(s) that should be made subject to battery optimizations.

  • If specified, multiple Android Package Names should be separated using commas.

Detail Information:

  • Key = powerBatteryOptimizationActionAddPackageNames

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Remove Package Names

   Transaction Steps  >  Transaction Step  >  Power Configuration

Enter one or more Android Package Name(s) that identify application(s) that should be exempted from battery optimizations.

If specified, multiple Android Package Names should be separated using commas.

Detail Information:

  • Key = powerBatteryOptimizationActionRemovePackageNames

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.0.

Port Action

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select an Action to control the Output Power various Ports on the device.

  • If the value Turn Output Power OFF is selected, the Output Power for a specified Port will be turned off.
  • If the value Turn Output Power ON is selected, the Output Power for a specified Port will be turned on.

You must also specify Port Select to provide the Port for which Output Power will be controlled.

Detail Information:

  • Key = powerPortAction

  • Type = string

 UI Choice  JSON Value 
 Turn Output Power OFF  2 
 Turn Output Power ON  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Port Select

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select the Port that will be affected by an Action to control the Output Power on the device when Port Action is specified.

  • If the value Serial Port 1 is selected, the Output Power will be turned on or off for the first device Serial Port.
  • If the value Serial Port 2 is selected, the Output Power will be turned on or off for the second device Serial Port.
  • If the value USB Port 2 is selected, the Output Power will be turned on or off for the second device USB Port.

Detail Information:

  • Key = powerPortSelect

  • Type = string

 UI Choice  JSON Value 
 Serial Port 1  1 
 Serial Port 2  2 
 USB Port 2  3 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Auto Power Control

   Transaction Steps  >  Transaction Step  >  Power Configuration

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 the following:
  • Auto Power Off to specify whether/how device power will automatically be turned off.
  • Auto Power On to specify whether/how device power will automatically be turned on.

Detail Information:

  • Key = powerAutoPowerControl

  • Type = string

 UI Choice  JSON Value 
 Off  0 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Auto Power Off

   Transaction Steps  >  Transaction Step  >  Power Configuration

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 = powerAutoPowerOff

  • Type = string

 UI Choice  JSON Value 
 Never  0 
 When Ignition is Turned Off  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Timeout

   Transaction Steps  >  Transaction Step  >  Power Configuration

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 Auto Power Control is specified and the value When Ignition is Turned Off is selected for Auto Power Off.

Detail Information:

  • Key = powerAutoPowerOffTimeout

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Auto Power On

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select whether and how device power will be automatically turned on 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 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 = powerAutoPowerOn

  • Type = string

 UI Choice  JSON Value 
 Never  0 
 When Ignition is Turned On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Heater Action

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select an Action to control device heaters.

You must also specify Heater Select to identify the Heater to be affected.

  • If the value Enable Heater is selected, the Heater will be be turned on and off as needed based on the configured ON/OFF thresholds.
  • If the value Disable Heater is selected, the Heater will turned off and will stay off, regardless of the configured ON/OFF thresholds.
  • If the value Set ON/OFF Thresholds is selected, the ON/OFF thresholds that will be used when the Heater is Enabled will be configured. You must also specify all of the following:
  • On Threshold to set the threshold temperature below which the Heater will automatically be turned on.
  • Off Threshold to set the threshold temperature above which the Heater will automatically be turned off.

Detail Information:

  • Key = powerHeaterAction

  • Type = string

 UI Choice  JSON Value 
 Enable Heater  1 
 Disable Heater  2 
 Set ON/OFF Thresholds  3 

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 Select

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select the Heater to be affected by a specified Heater Action when Heater Action is specified:

  • 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 = powerHeaterSelect

  • Type = string

 UI Choice  JSON Value 
 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.

  • Supported from: MX 9.1.

Off Threshold

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select the temperature above which a specified Heater should automatically turn OFF, when the value below which the specified Heater should automatically turn on is selected for Heater Action.

Detail Information:

  • Key = powerHeaterActionOffThreshold

  • 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.

  • Supported from: MX 9.1.

On Threshold

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select the temperature below which a specified Heater should automatically turn ON, when the value below which the specified Heater should automatically turn on is selected for Heater Action.

Detail Information:

  • Key = powerHeaterActionOnThreshold

  • 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.

  • Supported from: MX 9.1.

All Wake-up Sources State

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select whether all Wake-Up Sources will be enabled or not

  • If the value Off is selected, the device will not have all the wake-up sources enabled - If the value On is selected, the device will have all the wake-up sources enabled.

Detail Information:

  • Key = powerAllWakeupSourceState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.3.

Battery Saver Control Mode

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select how Battery Saver Mode will be activated (turned on) and deactivated (turned off) on the device.

  • If the value Automatically is selected, the device will activate (turn on) Battery Saver Mode automatically, and Battery Saver Control Mode Automatic Percentage Threshold must also be specified to provide the threshold battery level percentage below which the device will automatically activate Battery Saver Mode.

  • If the value Manually is selected, the device will NOT activate (turn on) Battery Saver Mode automatically, and will activate Battery Saver Mode only when specifically requested by the Device User or by specifying the value Turn On for Battery Saver Mode.

Detail Information:

  • Key = batterySaverControlMode

  • Type = string

 UI Choice  JSON Value 
 Manually  2 
 Automatically  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

Battery Saver Control Mode Automatic Percentage Threshold

   Transaction Steps  >  Transaction Step  >  Power Configuration

Enter the battery level percentage below which Battery Saver Mode will automatically be activated (turned on) on the device when Automatically is specified for Battery Saver Control Mode.

Detail Information:

  • Key = batterySaverModePercentage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

Battery Saver Mode

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select whether Battery Saver Mode is active (turned on) or inactive (turned off) on the device when Manually is specified for Battery Saver Control Mode.

  • If the value Turn On is selected, then Battery Saver Mode will be activated (turned on) on the device.

  • If the value Turn Off is selected, then Battery Saver Mode will be deactivated (turned off) on the device.

Detail Information:

  • Key = batterySaverModeUsage

  • Type = string

 UI Choice  JSON Value 
 Turn Off  2 
 Turn On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.1.

Doze Mode State

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select whether Doze Mode will be globally used on the 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 = powerDozeModeState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.2.

Wake-up Source Key Identifier

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select the Key Identifier of the Wake-Up Source to control

  • If the value L1 Button is selected, the device will use the First (Topmost) Button located on the Left side of the device for Display Wake-Up

  • If the value L2 Button is selected, the device will use the Second (Down from the top) Button located on the Left side of the device for Display Wake-Up

  • If the value R1 Button is selected, the device will use the First (Topmost) Button located on the Right side of the device for Display Wake-Up

  • If the value R2 Button is selected, the device will use the Second (Down from the top) Button located on the Right side of the device for Display Wake-Up

  • If the value Grip (Gun) Trigger is selected, the device will use the Trigger on the Grip (Gun Handle) for Display Wake-Up

  • If the value Rear Button is selected, the device will use the Button located on the Rear of the device for Display Wake-Up

  • If the value Custom is selected, the device will use a Custom Button for Display Wake-Up

Detail Information:

  • Key = powerWakeupKeyId

  • 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.

  • Supported from: MX 9.3.

Custom

   Transaction Steps  >  Transaction Step  >  Power Configuration

Enter the Custom name of the key identifier of the Wake-Up Source to control

Detail Information:

  • Key = powerWakeupKeyIdCustom

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.3.

Wake-up Source to Activate the Display State

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select whether to turn on or off the ability of a Wake-up Source to activate the display

  • If the value Off is selected, the device will not have all the wake-up sources enabled - If the value On is selected, the device will have all the wake-up sources enabled.

Detail Information:

  • Key = powerWakeupDisplayState

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.3.

Wake-up Method

   Transaction Steps  >  Transaction Step  >  Power Configuration

Select the Method that will be used to implement and control device Wake-up

  • If the value Use Hardware Signals for Wake-Up is selected, the device will use hardware signals for wake-up - If the value Use Software (Mappable Keycodes) for Wake-Up is selected, the device will use software (mappable keycodes) for wake-up.

Detail Information:

  • Key = powerWakeupMethod

  • Type = string

 UI Choice  JSON Value 
 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.3.


Remote Scanner Management

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Config Serial Number, Config File, Update Serial Number, Update File, Reset Serial Number, Page Serial Number, Disconnect Serial Number, and Unpair Serial Number.

Detail Information:

  • Key = remotescannerStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Action

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

Select an Action to control a Remote Scanner that isconnected to a device.

  • If the value Apply Configuration Package(RS6000 only) is selected, a configuration file will be used to apply new configuration to a Remote Scanner. You must also specify Config Serial Number to provide the Serial Number that identifies the Remote Scanner to be configured. You must also specify Config File to provide the path and file name of the configuration file to be applied.
  • If the value Update Scanner Firmware is selected, a firmware file will be used to update the firmware of a Remote Scanner. You must also specify Update Serial Number to provide the Serial Number that identifies the Remote Scanner to be updated. You must also specify Update File to provide the path and file name of the firmware file to be applied.
  • If the value Reset Scanner(RS6000 only) is selected, a Remote Scanner will be reset, allowing errors to be cleared and proper operation of aRemote Scanner to be restored. You must also specify Reset Serial Number to provide the Serial Number that identifies the Remote Scanner to be reset.
  • If the value Page Scanner(RS6000 only) is selected, a Remote Scanner will be paged, allowing a misplaced Remote Scanner to be more easily located. You must also specify Page Serial Number to provide the Serial Number that identifies the Remote Scanner to be paged.
  • If the value Disconnect Scanner(RS6000 only) is selected, a Remote Scanner will be disconnected, terminating the connection between the device and the Remote Scanner and preventing its subsequent use. You must also specify Disconnect Serial Number to provide the Serial Number that identifies the Remote Scanner to be disconnected.
  • If the value Unpair Scanner(RS6000 only) is selected, a Remote Scanner will be unpaired, terminating the pairing between the device and the Remote Scanner and preventing its re-connection without first repairing. You must also specify Unpair Serial Number to provide the Serial Number that identifies the Remote Scanner to be unpaired.

Detail Information:

  • Key = remotescannerAction

  • Type = string

 UI Choice  JSON Value 
 Apply Configuration Package(RS6000 only)  1 
 Update Scanner Firmware  2 
 Reset Scanner(RS6000 only)  3 
 Page Scanner(RS6000 only)  4 
 Disconnect Scanner(RS6000 only)  5 
 Unpair Scanner(RS6000 only)  6 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.3.

Config Serial Number

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

Enter the Serial Number that identifies a Remote Scanner to which configuration should be applied when the value Apply Configuration Package(RS6000 only) is selected for Action. You must also specify Config File to provide the path and file name of the configuration file to be used.

Detail Information:

  • Key = remotescannerActionConfigSerialNumber

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.2.

Config File

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

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 when the value Apply Configuration Package(RS6000 only) is selected for Action.

Detail Information:

  • Key = remotescannerActionConfigFile

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.2.

Update Serial Number

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

Enter the Serial Number that identifies a Remote Scanner for which a firmware update should be performed when the value Update Scanner Firmware is selected for Action. You must also specify Update File to provide the path and file name of the firmware file to be used.

Detail Information:

  • Key = remotescannerActionUpdateSerialNumber

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Update File

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

Enter the path and file name of a firmware file, which must exist at the specified location in the device file system, from which firmware update should be performed to the specified Remote Scanner when the value Update Scanner Firmware is selected for Action.

Detail Information:

  • Key = remotescannerActionUpdateFile

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.2.

Reset Serial Number

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

Enter the Serial Number that identifies a Remote Scanner to be reset when the value Reset Scanner(RS6000 only) is selected for Action.

Detail Information:

  • Key = remotescannerActionResetSerialNumber

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.2.

Page Serial Number

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

Enter the Serial Number that identifies a Remote Scanner to be paged when the value Page Scanner(RS6000 only) is selected for Action.

Detail Information:

  • Key = remotescannerActionPageSerialNumber

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.2.

Disconnect Serial Number

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

Enter the Serial Number that identifies a Remote Scanner to be disconnected when the value Disconnect Scanner(RS6000 only) is selected for Action.

Detail Information:

  • Key = remotescannerActionDisconnectSerialNumber

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.2.

Unpair Serial Number

   Transaction Steps  >  Transaction Step  >  Remote Scanner Management

Enter the Serial Number that identifies a Remote Scanner to be unpaired when the value Unpair Scanner(RS6000 only) is selected for Action.

Detail Information:

  • Key = remotescannerActionUnpairSerialNumber

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.2.


RFID Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Country of Operation, Channel Mask, Channel Hopping, Ukraine Region Power Mode, Action, Update Firmware File, Transmit Power Level, Query Select, Query Session, and Query Target.

Detail Information:

  • Key = rfidStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Country of Operation

   Transaction Steps  >  Transaction Step  >  RFID Configuration

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 = rfidCountryOfOperation

  • 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 Mask

   Transaction Steps  >  Transaction Step  >  RFID Configuration

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.

Consult the product documentation for the device being used to obtain the set of allowable Channel Numbers.

Detail Information:

  • Key = rfidCountryOfOperationChannelMask

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Channel Hopping

   Transaction Steps  >  Transaction Step  >  RFID Configuration

Select whether Channel Hopping will be performed among the Channels that are used by the RFID module.

Detail Information:

  • Key = rfidCountryOfOperationChannelHopping

  • Type = string

 UI Choice  JSON Value 
 Off  0 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Ukraine Region Power Mode

   Transaction Steps  >  Transaction Step  >  RFID Configuration

Select the Ukraine Region specific power mode to be used by the RFID module.

Detail Information:

  • Key = rfidCountryOfOperationUkraineRegionPowerMode

  • 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.

Action

   Transaction Steps  >  Transaction Step  >  RFID Configuration

Select an Action to alter the behavior or configuration of the RFID module.

  • If the value Update Firmware is selected, the firmware of the RFID module will be updated and you must also specify Update Firmware File to provide the path and file name of the file, which must exist in the device file system, containing the firmware update to be applied to the RFID module.
  • If the value Export Settings is selected, the current configuration of the RFID module will be exported and stored in a file in the device file system. This file could then be extracted from the device and used for troubleshooting potential configuration issues related to the RFID module.
  • If the value Reset Radio is selected, the radio of the RFID module will be reset, without changing its settings. This could be used to recover from an error or other failure of the RFID module.
  • If the value Reset Radio to Factory Defaults is selected, the configuration of the RFID module will be returned to its default out-of-box state and the radio will be reset. This could be used to recover from a serious configuration error that prevents the RFID module from functioning appropriately.
  • If the value Update Firmware and Reset Radio to Factory Defaults is selected, the firmware of the RFID will be updated,l the configuration of the RFID module will be returned to its default out-of-box state, and the radio will be reset. This could necessary when applying a major new firmware update, that add lots of new configuration settings, to ensure that the RFID module is configured in a known and compatible state.

Detail Information:

  • Key = rfidAction

  • Type = string

 UI Choice  JSON Value 
 Update Firmware  1 
 Export Settings  2 
 Reset Radio  4 
 Reset Radio to Factory Defaults  5 
 Update Firmware and Reset Radio to Factory Defaults  6 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Update Firmware File

   Transaction Steps  >  Transaction Step  >  RFID Configuration

Enter the path and file name of the file containing the firmware update to be applied when the value Update Firmware or the value Update Firmware and Reset Radio to Factory Defaults is selected for Action.

Detail Information:

  • Key = rfidActionUpdateFirmwareFile

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Transmit Power Level

   Transaction Steps  >  Transaction Step  >  RFID Configuration

Enter the RFID Power Level that should be used by the RFID module.

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 = rfidTransmitPowerLevel

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

Query Select

   Transaction Steps  >  Transaction Step  >  RFID Configuration

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 = rfidQuerySelect

  • Type = string

 UI Choice  JSON Value 
 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

   Transaction Steps  >  Transaction Step  >  RFID Configuration

Select which Session should 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 = rfidQuerySession

  • Type = string

 UI Choice  JSON Value 
 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

   Transaction Steps  >  Transaction Step  >  RFID Configuration

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 = rfidQueryTarget

  • Type = string

 UI Choice  JSON Value 
 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.


Security Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Add Key Name, Add Key Value, Remove Key Name, Encrypt SD Card Key Name, Instant Screen Lock on Power Key, Screen Lock Type, and Screen Lock Timeout.

Detail Information:

  • Key = securityStep

  • Type = bundle

Action

   Transaction Steps  >  Transaction Step  >  Security Configuration

Select an Action to adjust various security features on a device.

  • If the value Add Key is selected, you must also specify Add Key Name to provide the name of the key to be added and you must also specify Add Key Value to provide the value of the key to be added.
  • If the value Remove Key is selected, you must also specify Remove Key Name to provide the name of the key to be removed.
  • If the value Remove All Keys is selected, you do not need to specify any additional information. Not supported on devices running Android 11 or later.
  • If the value Encrypt SD Card is selected, you must also specify Encrypt SD Card Key Name to provide the name of the key to be used to encrypt the SD Card.
  • If the value Wipe SD Card is selected, you do not need to specify any additional information.

Detail Information:

  • Key = securityAction

  • Type = string

 UI Choice  JSON Value 
 Add Key  AddKey 
 Remove Key  RemoveKey 
 Remove All Keys  RemoveAllKeys 
 Encrypt SD Card  EncryptSdCard 
 Wipe SD Card  WipeSdCard 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Add Key Name

   Transaction Steps  >  Transaction Step  >  Security Configuration

Enter the name of a key to be added when the Action value Add Key is selected for Action.

You must also specify Add Key Value to provide the value to be added for the specified key name.

Detail Information:

  • Key = securityActionAddKeyName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Add Key Value

   Transaction Steps  >  Transaction Step  >  Security Configuration

Enter the value of a key to be added when the Action value Add Key is selected for Action.

You must also specify Add Key Name to provide the key name for which this value should be added.

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 keys to maximize their effectiveness in protecting data.

Detail Information:

  • Key = securityActionAddKeyValue

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Remove Key Name

   Transaction Steps  >  Transaction Step  >  Security Configuration

Enter the name of a key to be removed when the Action value Remove Key is selected for Action.

Detail Information:

  • Key = securityActionRemoveKeyName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Encrypt SD Card Key Name

   Transaction Steps  >  Transaction Step  >  Security Configuration

Enter the name of a key to be used to encrypt the SD Card when the Action value Encrypt SD Card is selected for Action.

Detail Information:

  • Key = securityEncryptSDCardKeyName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Instant Screen Lock on Power Key

   Transaction Steps  >  Transaction Step  >  Security Configuration

Select what happens when the Power Key on the device is used to turn the device off, especially whether the device will be locked, requiring it to be unlocked by entering a PIN or password, if one is specified.

  • If the value Off is selected, turning the device off using the Power Key will be handled the same as when the device times out and turns itself off automatically. In such a case, if device remains off for longer than value set via Screen Lock Timeout, when it is turned back on, the device will be locked, requiring whatever unlock action is set via Screen Lock Type.
  • If the value On is selected, turning the device off using the Power Key will be handled differently than when the device times out and turns itself off automatically, specifically the device will become locked immediately when the device is turned off using the Power Key. In such a case, no matter how long the device remains off, when it is turned back on, the device will be locked, requiring whatever unlock action is set via Screen Lock Type.

Detail Information:

  • Key = securityPowerKeyInstantLock

  • Type = string

 UI Choice  JSON Value 
 Off  Off 
 On  On 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Screen Lock Type

   Transaction Steps  >  Transaction Step  >  Security Configuration

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 = securityScreenLockType

  • Type = string

 UI Choice  JSON Value 
 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.

Screen Lock Timeout

   Transaction Steps  >  Transaction Step  >  Security Configuration

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 = securityScreenLockTimeout

  • Type = string

 UI Choice  JSON Value 
 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.


Service Access Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Service Binding Action, Allow Service Identifier, Disallow Service Identifier, Service Caller Action, Allow Service Identifier, Allow Caller Package, Allow Caller Signature, Disallow Service Identifier, Disallow Caller Package, Disallow Caller Signature, Use CSP Action, Protect CSP Auto Approve, Protect CSP Name, Custom, Unprotect CSP Auto Unapprove, Unprotect CSP Name, Custom, Approve Caller Package, Approve Caller Signature, Approve CSP Name, Custom, Unapprove Caller Package, Unapprove Caller Signature, Unapprove CSP Name, Custom, Use CSP Function Group Action, Create Group Details, Create Group Name, Delete Group Name, Protect Auto Approve, Protect Group Name, Custom, Unprotect Auto Unapprove, Unprotect Group Name, Custom, Approve Caller Package, Approve Caller Signature, Approve Group Name, Custom, Unapprove Caller Package, Unapprove Caller Signature, Unapprove Group Name, and Custom.

Detail Information:

  • Key = serviceAccessStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Service Binding Action

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select an Action to allow or disallow Bindings to Zebra Value-Add Services, such as those that expose Privilege Escalation APIs, typically used by special purpose applications, such as Remote Control Clients.

To utilize Zebra Value-Add Services that expose APIs, an application must successfully create a Binding to the desired Service, after which it can make API calls via that Binding. Since the APIs provided by such Services enable applications that call them to perform sensitive operations, they should only be used by applications that you explicitly trust to use them safely.

By default, all Zebra Value-Add Services that expose APIs are configured to reject all Bindings. This ensures that the APIs exposed by such a Service cannot be used at all, unless you explicitly choose to allow use of specific Services.

Note that allowing Bindings to a Zebra Value-Add Service enables ALL applications to successfully initiate a Binding to that Service but does NOT enable ANY application to actually call the APIs exposed by that Service. To allow selected applications to call APIs on a Service for which Bindings are allowed, use Service Caller Action.

  • If the value Allow is selected, Bindings to a specifically identified Service will be enabled, potentially allowing the APIs of that Service to be called. You must also specify Allow Service Identifier to identify the Zebra Value-Add Service to which Bindings should be allowed.

  • If the value Disallow is selected, Bindings to a specifically identified Service will be disabled, preventing the APIs of that Service from being called. This is the default state for all Zebra Value-Add Services that provide APIs. You must also specify Disallow Service Identifier to identify the Zebra Value-Add Service to which Bindings should be disallowed.

Note that every Zebra Value-Add Service that exposes APIs will be identified by a unique Service Identifier, that identifies the Service when controlling access to that Service. Consult the documentation for a given Zebra Value-Add Service to determine its Service Identifier that you will need to identify that Service when controlling access to it.

Detail Information:

  • Key = serviceBindingAction

  • Type = string

 UI Choice  JSON Value 
 Allow  1 
 Disallow  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Allow Service Identifier

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Service Identifier of a Zebra Value-Add Service when the value Allow is selected for Service Binding Action, to identify the specific Zebra Value-Add Service to which Bindings should be allowed.

Detail Information:

  • Key = serviceBindingActionAllowServiceIdentifer

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Disallow Service Identifier

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Service Identifier of a Zebra Value-Add Service when the value Disallow is selected for Service Binding Action, to identify the specific Zebra Value-Add Service to which Bindings should be disallowed.

Detail Information:

  • Key = serviceBindingActionDisallowServiceIdentifer

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Service Caller Action

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select an Action to allow or disallow a specific application to call APIs exposed by a Zebra Value-Add Service, via a successfully established Binding.

Note that the default state for all Zebra Value-Add Services is for ALL applications to be disallowed from calling the APIs exposed by that Service. This ensures that no applications can call the potentially sensitive APIs exposed by a Service unless you explicitly choose to allow it.

Note also that since a Binding to a Service is required to call any APIs exposed by that Service, Bindings to a Zebra Value-Add Service MUST be allowed in addition to allowing specific applications to call the Service. Bindings to a Zebra Value-Add Service can be allowed via Service Binding Action.

  • If the value Allow is selected, a specifically identified application will be allowed to call APIs to a specifically identified Service. You must also specify Allow Service Identifier to identify the Zebra Value-Add Service to which API calls should be allowed and you must also specify Allow Caller Package and Allow Caller Signature to identify the application to be allowed to make API calls to the identified Service.

  • If the value Disallow is selected, a specifically identified application will be disallowed from calling APIs to a specifically identified Service. This is the default state for every Zebra Value-Add Service and for every potential calling application. You must also specify Disallow Service Identifier to identify the Zebra Value-Add Service to which API calls should be disallowed and you must also specify Disallow Caller Package and Disallow Caller Signature to identify the application to be disallowed from making API calls to the identified Service.

Detail Information:

  • Key = serviceCallerAction

  • Type = string

 UI Choice  JSON Value 
 Allow  4 
 Disallow  5 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Allow Service Identifier

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Service Identifier of a Zebra Value-Add Service when the value Allow is selected for Service Caller Action, to identify the specific Zebra Value-Add Service to which API calls should be allowed.

Detail Information:

  • Key = serviceCallerActionAllowServiceIdentifer

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Allow Caller Package

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Name of an application that should be allowed to call APIs exposed by a Zebra Value-Add Service when the value Allow is selected for Service Caller Action, to identify the specific application that should be allowed to make calls to the Service identified by a specified Service Identifier.

Detail Information:

  • Key = serviceCallerActionAllowCallerPackage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Allow Caller Signature

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Signature of an application that should be allowed to call APIs exposed by a Zebra Value-Add Service when the value Allow is selected for Service Caller Action, to provide the Android Package Signature of a specified application that should be allowed to make calls to the Service identified by a specified Service Identifier.

Note that the use of a Android Package Signature is MANDATORY and ensures that the application being allowed to make API calls to the specified Service is genuine and has not been spoofed. This prevents anyone from creating an impostor application with the same Android Package Name, but signed differently and then trying to make calls to the APIs of the Service as if they were the genuine application.

Detail Information:

  • Key = serviceCallerActionAllowCallerSignature

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Disallow Service Identifier

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Service Identifier of a Zebra Value-Add Service when the value Disallow is selected for Service Caller Action, to identify the specific Zebra Value-Add Service to which API calls should be disallowed.

Detail Information:

  • Key = serviceCallerActionDisallowServiceIdentifer

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Disallow Caller Package

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Name of an application that should be disallowed from calling APIs exposed by a Zebra Value-Add Service when the value Disallow is selected for Service Caller Action, to identify the specific application that should be disallowed from making calls to the Service identified by a specified Service Identifier.

Detail Information:

  • Key = serviceCallerActionDisallowCallerPackage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Disallow Caller Signature

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Signature of an application that should be disallowed from calling APIs exposed by a Zebra Value-Add Service when the value Disallow is selected for Service Caller Action, to provide the Android Package Signature of a specified application that should be disallowed from making calls to the Service identified by a specified Service Identifier.

Detail Information:

  • Key = serviceCallerActionDisallowCallerSignature

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.3.

Use CSP Action

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select an Action to Declare a CSP to be Protected or Unprotected and/or to make an application Approved or Unapproved to use a CSP that has been declared as Protected.

Note that the default state for all CSPs is Unprotected. This means that ALL CSPs can used by ALL applications. This ensures backward compatibility wherein any applications designed to use any CSPs will continue to be allowed to do so unless you specifically choose to prevent it.

To limit access to a CSP, the CSP must first be declared to be Protected. Once a CSP has been declared to be Protected, no applications will be allowed to use that CSP until they have been explicitly been Approved to use that CSP.

  • If the value Protect is selected, a specifically identified CSP will be declared to be Protected and hence will be limited to use by specifically Approved applications. You must also specify one of Protect CSP Name or Custom to identify the CSP to be declared Protected. You may also specify Protect CSP Auto Approve to automatically make OemConfig Approved to use that CSP.

  • If the value Unprotect is selected, a specifically identified CSP will be declared to be Unprotected and hence will no longer be limited to use by specifically Approved applications. You must also specify one of Unprotect CSP Name or Custom to identify the CSP to be declared Unprotected. You may also specify Unprotect CSP Auto Unapprove to automatically make OemConfig Unapproved from using that CSP.

  • If the value Approve is selected, a specifically identified application will be Approved to use a specifically identified Protected CSP. You must also specify one of Approve CSP Name or Custom to identify the CSP for which access is to be Approved. You must also specify Approve Caller Package and Approve Caller Signature to identify the specific application that will be Approved to use the specified CSP.

  • If the value Unapprove is selected, a specifically identified application will Unapproved from using a specifically identified Protected CSP. You must also specify one of Unapprove CSP Name or Custom to identify the CSP for which access is to be Unapproved. You must also specify one of Unapprove Caller Package and Unapprove Caller Signature to identify the specific application that will be Unapproved from using the specified CSP.

Detail Information:

  • Key = serviceCspAction

  • Type = string

 UI Choice  JSON Value 
 Protect  1 
 Unprotect  2 
 Approve  4 
 Unapprove  5 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Protect CSP Auto Approve

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select whether OemConfig should automatically be Approved to use the CSP being Declared as Protected when the value Protect is selected for Use CSP Action to Declare a CSP as Protected. This is a convenience to eliminate the need to separately make OemConfig Approved to allow it to use a CSP that has been Declared as Protected.

  • If the value True is selected, the effect will be the same as if a Use CSP Action were with the value Approve to make OemConfig Approved to use that CSP. In most cases, it makes sense for OemConfig to be Approved to use any CSP that it used to declare to be Protected.
  • If the value False is selected, the effect will be the same as if Use CSP Action was not used with the value Approve to make OemConfig Approved to use that CSP. This should be used with caution since if OemConfig is Unapproved from using any CSP that it has been used to declare to be Protected, any subsequent use of OemConfig that relies on that CSP will fail.

Detail Information:

  • Key = serviceCspActionProtectAutoApprove

  • Type = string

 UI Choice  JSON Value 
 Approve  1 
 Do Not Approve  0 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Protect CSP Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select a standard CSP that will be declared as Protected when the value Protect is selected for Use CSP Action.

All standard CSP names are listed and can be picked from the list instead of having to enter them manually. This can help to avoid errors that could occur from mis-typing a CSP name. Custom could alternately be used in cases where typing in the CSP name is preferable.

Detail Information:

  • Key = serviceCspActionProtectCspName

  • Type = string

 UI Choice  JSON Value 
 AccessMgr  AccessMgr 
 AnalyticsMgr  AnalyticsMgr 
 AppGalleryMgr  AppGalleryMgr 
 AppMgr  AppMgr 
 AudioMgr  AudioMgr 
 AudioVolUIMgr  AudioVolUIMgr 
 AutoTriggerMgr  AutoTriggerMgr 
 Batch  Batch 
 BatteryMgr  BatteryMgr 
 BluetoothMgr  BluetoothMgr 
 BrowserMgr  BrowserMgr 
 BugReportMgr  BugReportMgr 
 CameraMgr  CameraMgr 
 CellularMgr  CellularMgr 
 CertMgr  CertMgr 
 Clock  Clock 
 ComponentMgr  ComponentMgr 
 ConditionMgr  ConditionMgr 
 DevAdmin  DevAdmin 
 DeviceCentralMgr  DeviceCentralMgr 
 DisplayMgr  DisplayMgr 
 EncryptMgr  EncryptMgr 
 EnterpriseKeyboard  EnterpriseKeyboard 
 EthernetMgr  EthernetMgr 
 FileMgr  FileMgr 
 GmsMgr  GmsMgr 
 GooglePlayMgr  GooglePlayMgr 
 GprsMgr  GprsMgr 
 HostsMgr  HostsMgr 
 Intent  Intent 
 KeyMappingMgr  KeyMappingMgr 
 LicenseMgr  LicenseMgr 
 LifeGuardOTAManager  LifeGuardOTAManager 
 NfcMgr  NfcMgr 
 PersistMgr  PersistMgr 
 PersonalDictionary  PersonalDictionary 
 PowerKeyMgr  PowerKeyMgr 
 PowerMgr  PowerMgr 
 RemoteScannerMgr  RemoteScannerMgr 
 RfidMgr  RfidMgr 
 ScanModeMgr  ScanModeMgr 
 SdCardMgr  SdCardMgr 
 SettingsMgr  SettingsMgr 
 Stats  Stats 
 StatusMgr  StatusMgr 
 ThreatMgr  ThreatMgr 
 TouchMgr  TouchMgr 
 UiMgr  UiMgr 
 UsbMgr  UsbMgr 
 Wi-Fi  Wi-Fi 
 WirelessMgr  WirelessMgr 
 WorryFreeWiFiMgr  WorryFreeWiFiMgr 
 XmlMgr  XmlMgr 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Custom

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of a custom CSP that will be declared as Protected when the value Protect is selected for Use CSP Action.

Use when the CSP to be declared as Protected is not in the list of standard CSP names, such as when the CSP is a Plug-In CSP. Standard CSP names COULD be entered, but it would generally be preferable to use Protect CSP Name instead, since picking a name from a list is less error-prone than typing the name.

Detail Information:

  • Key = serviceCspActionProtectCspNameCustom

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Unprotect CSP Auto Unapprove

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select whether OemConfig should automatically be Unapproved from using the CSP being Declared as Unprotected when the value Unprotect is selected for Use CSP Action to declare a CSP as Unprotected.

This is a convenience to eliminate the need to separately make OemConfig Unapproved to remove it from the list of applications that are Approved to use a CSP that it has been used to declare as Unprotected. Strictly speaking, this is not mandatory, since once a CSP has been declared as Unprotected the list of applications that are Approved to use that CSP is no longer relevant. But since the list of applications that are Approved to use a CSP is preserved across declaring a CSP as Unprotected and then later declaring that CSP as Protected, it is good practice to clean-up the list to avoid unexpected behavior in the future.

  • If the value True is selected, the effect will be the same as if Use CSP Action were used with the value Unapprove to make OemConfig Unapproved to use that CSP. This will NOT result in OemConfig being unable to use the CSP since declaring the CSP as Unprotected explicitly allows ALL applications to use that CSP.

  • If the value False is selected, the effect will be the same as if Use CSP Action were not used with the value Unapprove to make OemConfig Unapproved to use that CSP. This would effectively clean-up the list and could avoid unexpected behavior in the future, should the CSP later be Protected again.

Detail Information:

  • Key = serviceCspActionUnprotectAutoUnapprove

  • Type = string

 UI Choice  JSON Value 
 Unapprove  1 
 Do Not Unapprove  0 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Unprotect CSP Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select a standard CSP that will be declared as Unprotected when the value Unprotect is selected for Use CSP Action.

All standard CSP names are listed and can be picked from the list instead of having to enter them manually. This can help to avoid errors that could occur from mis-typing a CSP name. Custom could alternately be used in cases where typing in the CSP name is preferable.

Detail Information:

  • Key = serviceCspActionUnprotectCspName

  • Type = string

 UI Choice  JSON Value 
 AccessMgr  AccessMgr 
 AnalyticsMgr  AnalyticsMgr 
 AppGalleryMgr  AppGalleryMgr 
 AppMgr  AppMgr 
 AudioMgr  AudioMgr 
 AudioVolUIMgr  AudioVolUIMgr 
 AutoTriggerMgr  AutoTriggerMgr 
 Batch  Batch 
 BatteryMgr  BatteryMgr 
 BluetoothMgr  BluetoothMgr 
 BrowserMgr  BrowserMgr 
 BugReportMgr  BugReportMgr 
 CameraMgr  CameraMgr 
 CellularMgr  CellularMgr 
 CertMgr  CertMgr 
 Clock  Clock 
 ComponentMgr  ComponentMgr 
 ConditionMgr  ConditionMgr 
 DevAdmin  DevAdmin 
 DeviceCentralMgr  DeviceCentralMgr 
 DisplayMgr  DisplayMgr 
 EncryptMgr  EncryptMgr 
 EnterpriseKeyboard  EnterpriseKeyboard 
 EthernetMgr  EthernetMgr 
 FileMgr  FileMgr 
 GmsMgr  GmsMgr 
 GooglePlayMgr  GooglePlayMgr 
 GprsMgr  GprsMgr 
 HostsMgr  HostsMgr 
 Intent  Intent 
 KeyMappingMgr  KeyMappingMgr 
 LicenseMgr  LicenseMgr 
 LifeGuardOTAManager  LifeGuardOTAManager 
 NfcMgr  NfcMgr 
 PersistMgr  PersistMgr 
 PersonalDictionary  PersonalDictionary 
 PowerKeyMgr  PowerKeyMgr 
 PowerMgr  PowerMgr 
 RemoteScannerMgr  RemoteScannerMgr 
 RfidMgr  RfidMgr 
 ScanModeMgr  ScanModeMgr 
 SdCardMgr  SdCardMgr 
 SettingsMgr  SettingsMgr 
 Stats  Stats 
 StatusMgr  StatusMgr 
 ThreatMgr  ThreatMgr 
 TouchMgr  TouchMgr 
 UiMgr  UiMgr 
 UsbMgr  UsbMgr 
 Wi-Fi  Wi-Fi 
 WirelessMgr  WirelessMgr 
 WorryFreeWiFiMgr  WorryFreeWiFiMgr 
 XmlMgr  XmlMgr 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Custom

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of a custom CSP that will be declared as Unprotected when the value Unprotect is selected for Use CSP Action.

Use when the CSP to be declared as Unprotected is not in the list of standard CSP names, such as when the CSP is a Plug-In CSP. Standard CSP names COULD be entered, but it would generally be preferable to use Unprotect CSP Name instead, since picking a name from a list is less error-prone than typing the name.

Detail Information:

  • Key = serviceCspActionUnprotectCspNameCustom

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Approve Caller Package

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Name of an application that should be Approved to use a CSP when the value Approve is selected for Use CSP Action, to identify the specific application that should be Approved to use the CSP.

Detail Information:

  • Key = serviceCspActionApproveCallerPackage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Approve Caller Signature

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Signature of an application that should be Approved to use a CSP when the value Approve is selected for Use CSP Action, to provide the Android Package Signature of the specific application that should be Approved to use the CSP.

Detail Information:

  • Key = serviceCspActionApproveCallerSignature

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Approve CSP Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select a standard CSP that will be Approved for an application when the value Approve is selected for Use CSP Action.

All standard CSP names are listed and can be picked from the list instead of having to enter them manually. This can help to avoid errors that could occur from mis-typing a CSP name. Custom could alternately be used in cases where typing in the CSP name is preferable.

Detail Information:

  • Key = serviceCspActionApproveCspName

  • Type = string

 UI Choice  JSON Value 
 AccessMgr  AccessMgr 
 AnalyticsMgr  AnalyticsMgr 
 AppGalleryMgr  AppGalleryMgr 
 AppMgr  AppMgr 
 AudioMgr  AudioMgr 
 AudioVolUIMgr  AudioVolUIMgr 
 AutoTriggerMgr  AutoTriggerMgr 
 Batch  Batch 
 BatteryMgr  BatteryMgr 
 BluetoothMgr  BluetoothMgr 
 BrowserMgr  BrowserMgr 
 BugReportMgr  BugReportMgr 
 CameraMgr  CameraMgr 
 CellularMgr  CellularMgr 
 CertMgr  CertMgr 
 Clock  Clock 
 ComponentMgr  ComponentMgr 
 ConditionMgr  ConditionMgr 
 DevAdmin  DevAdmin 
 DeviceCentralMgr  DeviceCentralMgr 
 DisplayMgr  DisplayMgr 
 EncryptMgr  EncryptMgr 
 EnterpriseKeyboard  EnterpriseKeyboard 
 EthernetMgr  EthernetMgr 
 FileMgr  FileMgr 
 GmsMgr  GmsMgr 
 GooglePlayMgr  GooglePlayMgr 
 GprsMgr  GprsMgr 
 HostsMgr  HostsMgr 
 Intent  Intent 
 KeyMappingMgr  KeyMappingMgr 
 LicenseMgr  LicenseMgr 
 LifeGuardOTAManager  LifeGuardOTAManager 
 NfcMgr  NfcMgr 
 PersistMgr  PersistMgr 
 PersonalDictionary  PersonalDictionary 
 PowerKeyMgr  PowerKeyMgr 
 PowerMgr  PowerMgr 
 RemoteScannerMgr  RemoteScannerMgr 
 RfidMgr  RfidMgr 
 ScanModeMgr  ScanModeMgr 
 SdCardMgr  SdCardMgr 
 SettingsMgr  SettingsMgr 
 Stats  Stats 
 StatusMgr  StatusMgr 
 ThreatMgr  ThreatMgr 
 TouchMgr  TouchMgr 
 UiMgr  UiMgr 
 UsbMgr  UsbMgr 
 Wi-Fi  Wi-Fi 
 WirelessMgr  WirelessMgr 
 WorryFreeWiFiMgr  WorryFreeWiFiMgr 
 XmlMgr  XmlMgr 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Custom

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of a custom CSP that will be Approved to use a CSP when the value Approve is selected for Use CSP Action.

Use when the CSP to be Approved for an application is not in the list of standard CSP names, such as when the CSP is a Plug-In CSP. Standard CSP names COULD be entered, but it would generally be preferable to use Approve CSP Name instead, since picking a name from a list is less error-prone than typing the name.

Detail Information:

  • Key = serviceCspActionApproveCspNameCustom

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Unapprove Caller Package

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Name of an application that should be Unapproved from using a CSP when the value Unapprove is selected for Use CSP Action, to identify the specific application that should be Unapproved from using the CSP.

Detail Information:

  • Key = serviceCspActionUnapproveCallerPackage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Unapprove Caller Signature

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Signature of an application that should be Unapproved from using a CSP when the value Unapprove is selected for Use CSP Action, to provide the Android Package Signature of the specific application that should be Unapproved from using the CSP.

Detail Information:

  • Key = serviceCspActionUnapproveCallerSignature

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Unapprove CSP Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select a standard CSP that will be Unapproved for an application when the value Unapprove is selected for Use CSP Action.

All standard CSP names are listed and can be picked from the list instead of having to enter them manually. This can help to avoid errors that could occur from mis-typing a CSP name. Custom could alternately be used in cases where typing in the CSP name is preferable.

Detail Information:

  • Key = serviceCspActionUnapproveCspName

  • Type = string

 UI Choice  JSON Value 
 AccessMgr  AccessMgr 
 AnalyticsMgr  AnalyticsMgr 
 AppGalleryMgr  AppGalleryMgr 
 AppMgr  AppMgr 
 AudioMgr  AudioMgr 
 AudioVolUIMgr  AudioVolUIMgr 
 AutoTriggerMgr  AutoTriggerMgr 
 Batch  Batch 
 BatteryMgr  BatteryMgr 
 BluetoothMgr  BluetoothMgr 
 BrowserMgr  BrowserMgr 
 BugReportMgr  BugReportMgr 
 CameraMgr  CameraMgr 
 CellularMgr  CellularMgr 
 CertMgr  CertMgr 
 Clock  Clock 
 ComponentMgr  ComponentMgr 
 ConditionMgr  ConditionMgr 
 DevAdmin  DevAdmin 
 DeviceCentralMgr  DeviceCentralMgr 
 DisplayMgr  DisplayMgr 
 EncryptMgr  EncryptMgr 
 EnterpriseKeyboard  EnterpriseKeyboard 
 EthernetMgr  EthernetMgr 
 FileMgr  FileMgr 
 GmsMgr  GmsMgr 
 GooglePlayMgr  GooglePlayMgr 
 GprsMgr  GprsMgr 
 HostsMgr  HostsMgr 
 Intent  Intent 
 KeyMappingMgr  KeyMappingMgr 
 LicenseMgr  LicenseMgr 
 LifeGuardOTAManager  LifeGuardOTAManager 
 NfcMgr  NfcMgr 
 PersistMgr  PersistMgr 
 PersonalDictionary  PersonalDictionary 
 PowerKeyMgr  PowerKeyMgr 
 PowerMgr  PowerMgr 
 RemoteScannerMgr  RemoteScannerMgr 
 RfidMgr  RfidMgr 
 ScanModeMgr  ScanModeMgr 
 SdCardMgr  SdCardMgr 
 SettingsMgr  SettingsMgr 
 Stats  Stats 
 StatusMgr  StatusMgr 
 ThreatMgr  ThreatMgr 
 TouchMgr  TouchMgr 
 UiMgr  UiMgr 
 UsbMgr  UsbMgr 
 Wi-Fi  Wi-Fi 
 WirelessMgr  WirelessMgr 
 WorryFreeWiFiMgr  WorryFreeWiFiMgr 
 XmlMgr  XmlMgr 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Custom

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of a custom CSP that will be Unapproved for an application when the value Unapprove is selected for Use CSP Action.

Use when the CSP to be Unapproved for an application is not in the list of standard CSP names, such as when the CSP is a Plug-In CSP. Standard CSP names COULD be entered, but it would generally be preferable to use Unapprove CSP Name instead, since picking a name from a list is less error-prone than typing the name.

Detail Information:

  • Key = serviceCspActionUnapproveCspNameCustom

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Use CSP Function Group Action

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select an Action to perform for a CSP Function Group.

  • If the value Create is selected, then a new Custom CSP Function Group will be Created. You must specify Create Group Name to provide the name of the Custom Group to be Created and Create Group Details to define the CSP Functions to be controlled by the Custom Group.

  • If the value Delete is selected, then an existing, previously Created Custom CSP Function Group will be Deleted. You must specify Delete Group Name to provide the name of the Custom Group to be Deleted.

  • If the value Protect is selected, then an existing CSP Function Group will be made Protected. You must specify Protect Group Name or Custom to provide the name of the Standard or Custom Group to be made Protected.

  • If the value Unprotect is selected, then an existing CSP Function Group will be made Unprotected. You must specify Unprotect Group Name or Custom to provide the name of the Standard or Custom Group to be made Unprotected.

  • If the value Approve is selected, then an Application will be Approved to use all the Functions of an existing CSP Function Group. You must specify Approve Group Name or Custom to provide the name of the Standard or Custom Group and you must specify Approve Caller Package and Approve Caller Signature to identify the Application to be Approved to use the Functions in that Group.

  • If the value Unapprove is selected, then an Application will be Unapproved from using all the Functions of an existing CSP Function Group. You must specify Unapprove Group Name or Custom to provide the name of the Standard or Custom Group and you must specify Unapprove Caller Package and Unapprove Caller Signature to identify the Application to be Unapproved from using the Functions in that Group.

Detail Information:

  • Key = serviceCspFunctionGroupAction

  • Type = string

 UI Choice  JSON Value 
 Create  1 
 Delete  2 
 Protect  3 
 Unprotect  4 
 Approve  6 
 Unapprove  7 

Support Information:

  • Supported from: MX 10.0.

Create Group Details

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Custom Group Details for the Custom CSP Function Group to be Created when Create is selected for Use CSP Function Group Action.

Custom Group Details define which CSP Functions are included in a Custom Group and hence can be Protected together as a set. Custom Group Details are entered as a comma separated list that can include one or more of the following:

  • CSPname

   Indicates that ALL CSP Function(s) supported by the named CSP are in the Group.

  • CSPname:parmname

   Indicates that the CSP Function(s) invoked by the named parm within the named CSP are in the Group.

  • CSPname:parmname={values}

   Indicates that CSP Function(s) invoked by value(s)of the named parm in the named CSP are in the Group.

   Multiple values, if specified, must be separated by semi-colon.

Some examples:

  • AppMgr,AccessMgr

   Group contains ALL CSP Functions in the AppMgr CSP and the AccessMgr CSP.

  • AppMgr:Action={Install;Uninstall}

   Group contains the 2 CSP Functions in the AppMgr CSP identified by the values Install and Uninstall.

For more information on Zebra MX, see https://techdocs.zebra.com/mx/overview/.

For more information on Zebra MX Custom Group Details, see https://techdocs.zebra.com/mx/accessmgr/.

Detail Information:

  • Key = serviceCspFunctionGroupActionCreateGroupDetails

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Create Group Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of the Custom CSP Function Group to be Created when Create is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionCreateGroupName

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Delete Group Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of the Custom CSP Function Group to be Deleted when Delete is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionDeleteGroupName

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Protect Auto Approve

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select whether Zebra OemConfig should be automatically Approved to use the CSP Functions in this Sub-group when Protect is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionProtectAutoApprove

  • Type = string

 UI Choice  JSON Value 
 Approve  1 
 Do Not Approve  0 

Support Information:

  • Supported from: MX 10.0.

Protect Group Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select the name of the Standard CSP Function Group to be Protected when Protect is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionProtectGroupName

  • Type = string

 UI Choice  JSON Value 
 CSP Access Management  1 
 Stop Application  2 
 Custom Group  98 

Support Information:

  • Supported from: MX 10.0.

Custom

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of the Custom CSP Function Group to be Protected when Protect is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionProtectGroupNameCustom

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Unprotect Auto Unapprove

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select whether Zebra OemConfig should be automatically Unapproved from using the CSP Functions in this Sub-group when Unprotect is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionUnprotectAutoUnapprove

  • Type = string

 UI Choice  JSON Value 
 Unapprove  1 
 Do Not Unapprove  0 

Support Information:

  • Supported from: MX 10.0.

Unprotect Group Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select the name of the Standard CSP Function Group to be Unprotected when Unprotect is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionUnprotectGroupName

  • Type = string

 UI Choice  JSON Value 
 CSP Access Management  1 
 Stop Application  2 
 Custom Group  98 

Support Information:

  • Supported from: MX 10.0.

Custom

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of the Custom CSP Function Group to be Unprotected when Unprotect is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionUnprotectGroupNameCustom

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Approve Caller Package

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Name of an Application that should be Approved to use a specified CSP Function Group when Approve is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionApproveCallerPackage

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Approve Caller Signature

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Signature of an Application that should be Approved to use a specified CSP Function Group when Approve is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionApproveCallerSignature

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Approve Group Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select the name of the Standard CSP Function Group to be Approved when Approve is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionApproveGroupName

  • Type = string

 UI Choice  JSON Value 
 CSP Access Management  1 
 Stop Application  2 
 Custom Group  98 

Support Information:

  • Supported from: MX 10.0.

Custom

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of the Custom CSP Function Group to be Approved when Approve is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionApproveGroupNameCustom

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Unapprove Caller Package

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Name of an Application that should be Unapproved to use a specified CSP Function Group when Unapprove is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionUnapproveCallerPackage

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Unapprove Caller Signature

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the Android Package Signature of an Application that should be Unapproved to use a specified CSP Function Group when Unapprove is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionUnapproveCallerSignature

  • Type = string

Support Information:

  • Supported from: MX 10.0.

Unapprove Group Name

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Select the name of the Standard CSP Function Group to be Unapproved when Unapprove is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionUnapproveGroupName

  • Type = string

 UI Choice  JSON Value 
 CSP Access Management  1 
 Stop Application  2 
 Custom Group  98 

Support Information:

  • Supported from: MX 10.0.

Custom

   Transaction Steps  >  Transaction Step  >  Service Access Configuration

Enter the name of the Custom CSP Function Group to be Unapproved when Unapprove is selected for Use CSP Function Group Action.

Detail Information:

  • Key = serviceCspFunctionGroupActionUnapproveGroupNameCustom

  • Type = string

Support Information:

  • Supported from: MX 10.0.


Settings UI Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Allow Device User Access Quick Settings, Allow Device User Control Airplane Mode, Allow Device User Control App Notifications, Allow Device User Control Apps, Allow Device User Control Background Data, Allow Device User Control Ethernet, Allow Device User Control Instant Lock, Allow Device User Control Unknown Sources, Allow Device User Control USB, Allow Device User Control WLAN, Allow Device User to Initiate an Enterprise Reset, Configure Default Client Mode, Control Access to Device Storage From PC, Show Quick Settings Icon, Use of Notification Settings Icon, Use of Settings Slide Out Drawer, Use of Tethering and Portable Hotspot, and Use Reduced Version.

Detail Information:

  • Key = settingsStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Allow Device User Access Quick Settings

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to access the Android Quick Settings Panel UI.

  • If the value Off is selected, any attempt by the Device User to enter the Quick Settings Panel will be ignored.

  • If the value On is selected, attempts by the Device User to enter the Quick Settings Panel will be honored and the Quick Settings Panel UI will be presented on request.

Detail Information:

  • Key = settingsUserAccessToQuickSettings

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.2.

Allow Device User Control Airplane Mode

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to change the state of Airplane Mode.

  • If the value Off is selected, any attempt by the Device User to change the state of Airplane Mode will be blocked.
  • If the value On is selected, attempts by the Device User to change the state of Airplane Mode will be honored.

Detail Information:

  • Key = settingsUserControlOfAirplaneMode

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Allow Device User Control App Notifications

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to configure which application notifications will be generated.

  • If the value Off is selected, any attempt by the Device User to change the configuration of application notifications will be blocked.
  • If the value On is selected, attempts by the Device User to change the configuration of application notifications will be honored.

Detail Information:

  • Key = settingsUserControlAppNotifications

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.2.

Allow Device User Control Apps

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

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 = settingsUserControlApps

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Allow Device User Control Background Data

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to change the usage of Background WWAN data.

  • If the value Off is selected, any attempt by the Device User to change the usage of Background WWAN data will be blocked.
  • If the value On is selected, attempts by the Device User to change the usage of Background WWAN data will be honored.

Detail Information:

  • Key = settingsUserControlOfBackgroundData

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Allow Device User Control Ethernet

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to change the state of the Ethernet adapter.

  • If the value Off is selected, any attempt by the Device User to change the state of Ethernet adapter will be blocked.
  • If the value On is selected, attempts by the Device User to change the state of Ethernet adapter will be honored.

Detail Information:

  • Key = settingsUserControlOfEthernet

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Allow Device User Control Instant Lock

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to change whether pressing the Power key causes the device to lock instantly.

  • If the value Off is selected, any attempt by the Device User to change whether pressing the Power key causes the device to lock instantly will be blocked.
  • If the value On is selected, attempts by the Device User to change whether pressing the Power key causes the device to lock instantly will be honored.

Detail Information:

  • Key = settingsUserControlInstantLock

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Allow Device User Control Unknown Sources

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to change whether applications can be installed from Unknown Sources.

  • If the value Off is selected, any attempt by the Device User to change whether applications can be installed from Unknown Sources.
  • If the value On is selected, attempts by the Device User to change whether applications can be installed from Unknown Sources.

Detail Information:

  • Key = settingsUserControlUnknownSources

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported on Operating System(s): Nougat.

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

  • Support discontinued from: MX 9.0.

Allow Device User Control USB

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to change the state of USB.

  • If the value Off is selected, any attempt by the Device User to change the state of USB will be blocked.
  • If the value On is selected, attempts by the Device User to change the state of USB will be honored.

Detail Information:

  • Key = settingsUserControlOfUsb

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 4.2.

Allow Device User Control WLAN

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to change the configuration of the WLAN adapter.

  • If the value Off is selected, any attempt by the Device User to change the configuration of the WLAN adapter will be blocked.
  • If the value On is selected, attempts by the Device User to change the configuration of the WLAN adapter will be honored.

Detail Information:

  • Key = settingsUserControlWlan

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Allow Device User to Initiate an Enterprise Reset

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to perform an Enterprise Reset from the Settings UI.

  • If the value Off is selected, any attempt by the Device User to perform an Enterprise Reset from the Settings UI will be blocked.
  • If the value On is selected, attempts by the Device User to perform an Enterprise Reset from the Settings UI will be honored.

Detail Information:

  • Key = settingsUserInitiateEnterpriseReset

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.2.

Configure Default Client Mode

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

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 
 Charging Only (no data transfer)  0 
 File Transfer  4 
 MIDI  8 
 PTP  16 
 USB Tethering  32 

Support Information:

  • Supported from: MX 10.4.

Control Access to Device Storage From PC

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to change the state of USB.

  • If the value Disable is selected, PC access is blocked and any attempt by the Device User to change the state of PC access will be blocked.
  • If the value Enable is selected, PC access is allowed and attempts by the Device User to change the state of PC access will be honored.

Detail Information:

  • Key = settingsUserControlOfDeviceStorageFromPC

  • Type = string

 UI Choice  JSON Value 
 Disable  2 
 Enable  1 

Support Information:

  • Supported from: MX 4.2.

Show Quick Settings Icon

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User will be allowed to invoke the Settings UI using an icon on the Quick Settings Panel.

  • If the value Off is selected, any attempt by the use of the icon to invoke the Settings UI will be blocked.
  • If the value On is selected, the use of the icon to invoke the Settings UI will be allowed.

Detail Information:

  • Key = settingsShowQuickSettingsIcon

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.1.

Use of Notification Settings Icon

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User is allowed to use the Settings Icon on the Notification Panel to launch the Settings UI.

  • If the value Off is selected, the Device User will be blocked from using the Settings Icon on the Notification Panel to launch the Settings UI.
  • If the value On is selected, the Device User will be allowed to use the Settings Icon on the Notification Panel to launch the Settings UI.

Detail Information:

  • Key = settingsUseOfNotificationSettingsIcon

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 5.1.

Use of Settings Slide Out Drawer

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User is allowed to use the Slide Out Drawer in Settings UI to rapidly switch laterally to other parts of the Settings UI.

  • If the value Off is selected, the Device User will be blocked from using the Slide Out Drawer in Settings UI to rapidly switch laterally to other parts of the Settings UI.
  • If the value On is selected, the Device User will be allowed to use the Slide Out Drawer in Settings UI to rapidly switch laterally to other parts of the Settings UI

Detail Information:

  • Key = settingsUseOfSlideOutDrawer

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.1.

  • Support discontinued from: MX 9.0.

Use of Tethering and Portable Hotspot

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Device User is allowed to use the Settings Icon on the Notification Panel to launch the Settings UI.

  • If the value Disallow is selected, the Device User will be blocked from using the Settings UI to configure and utilize Tethering and Portable Hotspot mode.
  • If the value Allow is selected, the Device User will be allowed to use the Settings UI to configure and utilize Tethering and Portable Hotspot mode.

Detail Information:

  • Key = settingsUseOfTetheringAndPortableHotspot

  • Type = string

 UI Choice  JSON Value 
 Disallow  2 
 Allow  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 8.0.

Use Reduced Version

   Transaction Steps  >  Transaction Step  >  Settings UI Configuration

Select whether the Full or Reduced version of the Settings UI will be used.

  • If the value Off is selected, when the Device User launches the Settings UI, the Full version,with support for all settings, will be used.
  • If the value On is selected, when the Device User launches the Settings UI, the Reduced version, with support for only a few settings, will be used.

Detail Information:

  • Key = settingsUseReducedVersion

  • Type = string

 UI Choice  JSON Value 
 Off  1 
 On  2 

Support Information:

  • Supported from: MX 4.1.


Threat Management Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Detect Threat Type, Detect Countermeasures, Action Detect Threat Type MDM Client Removal Package Name, Ignore Threat Type, Periodic Scan, Interval, Additional Folders, List, and Send Externally Detected Threat Message.

Detail Information:

  • Key = threatStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Action

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Select an Action to configure whether a given threat will be monitored.

  • If the value Detect is selected, a specific threat will be configured to be monitored and, if that threat is detected, a countermeasure will be taken to mitigate that threat. You must also specify Detect Threat Type to provide the threat that will be monitored. In addition, you must also specify the Sub-array Detect Countermeasures to provide the set of countermeasures that will be performed if the specified threat is detected.
  • If the value Ignore is selected, a specific threat will be configured to not be monitored and hence will never be detected. You must also specify Ignore Threat Type to provide the threat that will be ignored.

Detail Information:

  • Key = threatAction

  • Type = string

 UI Choice  JSON Value 
 Detect  Detect 
 Ignore  Ignore 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Detect Threat Type

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Select the type of threat that will be monitored when the value Detect is selected forAction.

  • If the value Max Password Attempts is selected, the Threat Management System will be configured to monitor password entry attempts and the threat will be considered to be detected if the maximum number of unsuccessful password entry attempts are made without an intervening successful password entry.
  • If the value MDM Client Removal is selected, the Threat Management System will be configured to monitor the device and detect if a specific Android Package Name is ever uninstalled from the device. You must also specify Action Detect Threat Type MDM Client Removal Package Name to provide the Android Package Name that will be monitored. While this is typically used to detect the removal of the MDM Client, which would render a managed device unmanaged, it could be used to detect the removal of ANY application, if detection of the removal of an MDM Agent is not required.
  • If the value Externally Detected is selected, the Threat Management System will be configured to listen for indication from an application on the device that can itself provide a way of detecting an signaling any threat not otherwise known to the Threat Management System. The Threat Management System will consider the threat to have been detected whenever it is signaled by the external application.
  • If the value Exchange Active Sync Command is selected, the Threat Management System will be configured to handle a threat detected and signaled by a connection to an Exchange Active Sync Server via an Exchange Active Sync Client on the device.
  • If the value Device is Rooted is selected, the Threat Management System will be configured to monitor the device to see if it has been rooted. Root detection mechanism seek to identify common exploits that could grant an escalated privileges to an untrusted application that might use them to compromise the security or privacy of the device.

Detail Information:

  • Key = threatActionDetectThreatType

  • Type = string

 UI Choice  JSON Value 
 Max Password Attempts  MaxPasswordAttempts 
 MDM Client Removal  MDMClientRemoval 
 Externally Detected  ExternallyDetected 
 Exchange Active Sync Command  ExchangeActiveSyncCommand 
 Device is Rooted  DeviceisRooted 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Detect Countermeasures

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Use this Sub-array to configure one or more Countermeasure(s).

Detail Information:

  • Key = threatActionDetectCountermeasures

  • Type = bundle_array

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Countermeasure

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration  >  Detect Countermeasures

Use this Sub-group to configure Type, Uninstall Package Name, Unsolicited Alert Package Name, Unsolicited Alert Class, and Unsolicited Alert Message.

Detail Information:

  • Key = threatCountermeasure

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Type

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration  >  Detect Countermeasures  >  Countermeasure

Select the type of a single countermeasure that will be performed to mitigate a detected threat.

  • If the value FormatSdcard is selected, the countermeasure to format the removable SD Card will be performed when the associated threat is detected.
  • If the value FactoryReset is selected, the countermeasure to Factory Reset the device will be performed when the associated threat is detected.
  • If the value WipeSecureStorageKeys is selected, the countermeasure to Wipe all encryption keys, deployed via the Group Security Configuration will be performed when the associated threat is detected.
  • If the value LockDevice is selected, the countermeasure to lock the device, requiring it to be unlocked by the Device User, will be performed when the associated threat is detected.
  • If the value UninstallApplication is selected, the countermeasure to Uninstall an application will be performed when the associated threat is detected. You must also specify Uninstall Package Name to provide the Android Package Name of the application that will be uninstalled.
  • If the value UnsolicitedAlert is selected, the countermeasure to send an unsolicited alert via an Android Intent will be performed when the associated threat is detected. You must also specify Unsolicited Alert Package Name, Unsolicited Alert Class, and Unsolicited Alert Message to provide the information needed to deliver the alert.

Detail Information:

  • Key = threatCountermeasureType

  • Type = string

 UI Choice  JSON Value 
 FormatSdcard  FormatSdcard 
 FactoryReset  FactoryReset 
 WipeSecureStorageKeys  WipeSecureStorageKeys 
 LockDevice  LockDevice 
 UninstallApplication  UninstallApplication 
 UnsolicitedAlert  UnsolicitedAlert 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Uninstall Package Name

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration  >  Detect Countermeasures  >  Countermeasure

Enter the Android Package Name of an application that will be uninstalled as a countermeasure to mitigate a threat when the value UninstallApplication is selected for Type.

Detail Information:

  • Key = threatCountermeasureUninstallPackageName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Unsolicited Alert Package Name

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration  >  Detect Countermeasures  >  Countermeasure

Enter the Android Package Name of an application that will be sent an unsolicited alert to notify it that a threat has been detected as a countermeasure to mitigate a threat when the value UnsolicitedAlert is selected for Type.

Detail Information:

  • Key = threatCountermeasureUnsolicitedAlertPackageName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Unsolicited Alert Class

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration  >  Detect Countermeasures  >  Countermeasure

Enter the Class Name of component within an application that will be sent an unsolicited alert to notify it that a threat has been detected as a countermeasure to mitigate a threat when the value UnsolicitedAlert is selected for Type.

Detail Information:

  • Key = threatCountermeasureUnsolicitedAlertClass

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Unsolicited Alert Message

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration  >  Detect Countermeasures  >  Countermeasure

Enter the string text message that will be sent to a component of an application via an unsolicited alert to notify it that a threat has been detected as a countermeasure to mitigate a threat when the value UnsolicitedAlert is selected for Type.

Detail Information:

  • Key = threatCountermeasureUnsolicitedAlertMessage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Action Detect Threat Type MDM Client Removal Package Name

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Enter the Android Package Name of the MDM Agent that will be monitored to detect a threat when the value MDM Client Removal is selected for Detect Threat Type.

Detail Information:

  • Key = threatMdmClientPackageName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Ignore Threat Type

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Select the type of threat that will NOT be monitored, and hence cannot be detected, when the value Ignore is selected forAction.

  • If the value Max Password Attempts is selected, the Threat Management System will be configured to NOT monitor password entry attempts and hence will never detect the threat of exceeding the maximum number of unsuccessful password entry attempts.
  • If the value MDM Client Removal is selected, the Threat Management System will be configured to NOT monitor the device and detect if a specific Android Package Name is ever uninstalled from the device, and hence will never detect the threat of removal of the MDM Client.
  • If the value Externally Detected is selected, the Threat Management System will be configured to NOT listen for indication from an application on the device that can signal a threat and hence no external threats will ever be detected.
  • If the value Exchange Active Sync Command is selected, the Threat Management System will be configured NOT to handle a threat detected and signaled by a connection to an Exchange Active Sync Server via an Exchange Active Sync Client on the device and hence such threats will never be detected.
  • If the value Device is Rooted is selected, the Threat Management System will be configured to NOT monitor the device to see if it has been rooted and hence the threat of the device being rooted will never be detected.

Detail Information:

  • Key = threatActionIgnoreThreatType

  • Type = string

 UI Choice  JSON Value 
 Max Password Attempts  MaxPasswordAttempts 
 MDM Client Removal  MDMClientRemoval 
 Externally Detected  ExternallyDetected 
 Exchange Active Sync Command  ExchangeActiveSyncCommand 
 Device is Rooted  DeviceisRooted 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Periodic Scan

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Select whether the Threat Management System should perform background polling to increase the accuracy and timeliness of detection of Rooted Device threat.

  • If the value Off is selected, the Threat Management System will NOT perform background polling. This may increase performance and improve battery life somewhat, but will reduce the ability to detect the Rooted Device threat and or result in a delay in detection of that threat.
  • If the value On is selected, the Threat Management System will perform background polling. This may reduce performance and degrade battery life somewhat, but will increase the ability to detect the Rooted Device threat and accelerate detection of that threat. You may also specify Interval, Additional Folders, and List to adjust the nature of the background polling, allowing trade-offs to be made in the balance pf thoroughness vs. the impact to performance and battery life. This value should generally be selected when detection of the Device is Rooted threat has been enabled, since it would have little value otherwise.

Detail Information:

  • Key = threatPeriodicScan

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.1.

Interval

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Enter the interval between polls when the value On is selected for Periodic Scan.

The interval is specified in seconds between polls.

  • Choosing a lower value can increase the aggressiveness of detection of rooted devices, which can reduce the time required to successfully detect that a device has been rooted, but can also reduce the impact of polling on performance and battery life. - Choose a higher value can reduce the aggressiveness of detection of rooted devices, which can increase the time required to successfully detect that a device has been rooted, but can also decrease the impact of polling on performance and battery life.

Detail Information:

  • Key = threatPeriodicScanInterval

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.1.

Additional Folders

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Select whether additional folders will be polled when the value On is selected for Periodic Scan.

When background polling to detect device rooting is performed, the Threat Management System will always scan certain key folders that are considered common or likely locations where changes might occur that could signal that device has been rooted. In some cases, rooting might occur through changes made to other folders.

  • If the value Off is selected, the Threat Management System will only scan the default folders.
  • If the value On is selected, the Threat Management System will scan the default folders plus additional folders. You must also specify List to identify the list of additional folders to be scanned.

Detail Information:

  • Key = threatPeriodicScanAdditionalFolders

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.1.

List

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Enter list of additional folders that will be polled when the value On is selected for Periodic Scan and the value On is selected for Additional Folders.

Detail Information:

  • Key = threatPeriodicScanAdditionalFoldersList

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 6.1.

Send Externally Detected Threat Message

   Transaction Steps  >  Transaction Step  >  Threat Management Configuration

Enter the message which will signal the detection of an externally detected threat. This would generally be relevant only if the Externally Detected was selected for Detect Threat Type, since any signaling of an externally detected threat would otherwise be ignored.

Detail Information:

  • Key = threatSendExternallyDetectedMessage

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.


Volume UI Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Action, Add Profile Name, Add Profile Streams, Remove Profile Name, Set Current Profile Name, and Set Current Profile Adjust Volume.

Detail Information:

  • Key = volumeuiStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Action

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration

Select an Action to alter the UI behavior of the Zebra Volume Control on a device.

The Zebra Volume Control provides a configurable UI that allows the Device Users to adjust the volume of one or more Audio Streams on a device. The UI behavior of the Zebra Volume Control is configured by defining one or more Audio UI Profiles and controlling which Audio UI Profile is active. Each Audio UI Profile defines which Audio Streams can be configured and adjusts the experience of the Device User when adjusting the volumes of those Audio Streams. The Zebra Volume Control also has a Factory Preset Audio UI Profile that can be used to return the behavior of the Zebra Volume Control to it default out-of-box state.

  • If the value Add Profile is selected, a new Audio UI Profile is added to the list of Audio UI Profiles. You must also specify Add Profile Name and Add Profile Streams to define the Audio UI Profile being added.
  • If the value Remove Profile is selected, an existing Audio UI Profile is removed from the list of Audio UI Profiles. You must also specify Remove Profile Name to provide the name that identifies the Audio UI Profile to be removed.
  • If the value Set Current Profile is selected, an existing Audio UI Profile is set to be the active Audio UI Profile. You must also specify Set Current Profile Name to provide the name that identifies the Audio UI Profile to be made the new active Audio UI Profile.
  • If the value Apply Current Profile is selected, the currently active Audio UI Profile is applied to the current device Volume Settings. If the current device Volume Settings are outside the range of Volume Settings defined for the currently active Audio UI Profile the current device Volume Settings will be adjusted as needed to bring them within the range of Volume Settings defined for the currently active Audio UI Profile.
  • If the value Set Factory Preset is selected, the Factory Preset Audio UI Profile is made the active Audio UI Profile, causing the behavior of the Zebra Volume Control to return to its default out-of-box state.

Detail Information:

  • Key = volumeuiAction

  • Type = string

 UI Choice  JSON Value 
 Add Profile  1 
 Remove Profile  2 
 Set Current Profile  01 
 Apply Current Profile  02 
 Set Factory Preset  03 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Add Profile Name

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration

Enter the name of a new Audio UI Profile to be added when the value Add Profile is selected for Action.

  • If an Audio UI Profile with the specified name already exists, the new Audio UI Profile will replace the existing Audio UI Profile with that name.
  • If no Audio UI Profile with the specified name already exists, the new Audio UI Profile will be added with that name.

Detail Information:

  • Key = volumeuiActionAddProfileName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Add Profile Streams

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration

Use this Sub-array to configure one or more Stream(s). to configure when the value !!1@steps.step.volumeuiStep.volumeuiAction!! is selected for %%steps.step.volumeuiStep.volumeuiAction%%.

Detail Information:

  • Key = volumeuiActionAddProfileStreams

  • Type = bundle_array

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Stream

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams

Use this Sub-group to configure Type, Label, Icon, Visible, and Modes. configured as part of a new Audio UI Profile being added when the value !!1@steps.step.volumeuiStep.volumeuiAction!! is selected for %%steps.step.volumeuiStep.volumeuiAction%% within the Sub-array %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams.volumeuiStream%%.

Detail Information:

  • Key = volumeuiStream

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Type

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream

Select the type of a single Audio Stream that will be included as part of a new Audio UI Profile being added within each instance of the Sub-group Stream within Sub-array Add Profile Streams. You must also specify Label, Icon, Visible, and Modes to define the characteristics of the new Audio Stream of the specified type that will be added.

  • If the value Music is selected, the Audio Stream to be added to the new Audio UI Profile will define the behavior of the Zebra Volume Control with respect to the Audio Stream used for playback of Music and other Media.
  • If the value Ring is selected, the Audio Stream to be added to the new Audio UI Profile will define the behavior of the Zebra Volume Control with respect to the Audio Stream used for ringtones.
  • If the value Notification is selected, the Audio Stream to be added to the new Audio UI Profile will define the behavior of the Zebra Volume Control with respect to the Audio Stream used for notifications.
  • If the value System is selected, the Audio Stream to be added to the new Audio UI Profile will define the behavior of the Zebra Volume Control with respect to the Audio Stream used for system sounds.
  • If the value Alarm is selected, the Audio Stream to be added to the new Audio UI Profile will define the behavior of the Zebra Volume Control with respect to the Audio Stream used for alarms.
  • If the value VoiceCall is selected, the Audio Stream to be added to the new Audio UI Profile will define the behavior of the Zebra Volume Control with respect to the Audio Stream used for voice calls.
  • If the value VVS is selected, the Audio Stream to be added to the new Audio UI Profile will define the behavior of the Zebra Volume Control with respect to the Audio Stream used for Decode Beep Vertical Volume Scale (VVS).
  • If the value KeypadTone is selected, the Audio Stream to be added to the new Audio UI Profile will define the behavior of the Zebra Volume Control with respect to the Audio Stream used for the keypad tone.

Detail Information:

  • Key = volumeuiStreamType

  • Type = string

 UI Choice  JSON Value 
 Music  Music 
 Ring  Ring 
 Notification  Notification 
 System  System 
 Alarm  Alarm 
 VoiceCall  VoiceCall 
 VVS  VVS 
 KeypadTone  KeypadTone 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Label

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream

Enter the text label to be displayed for a single Audio Stream that will be included as part of a new Audio UI Profile being added and may be specified within each instance of the group Stream within the Sub-array Add Profile Streams.

The text label might be changed for an Audio Stream because it is used for some purpose(s) other than the one identified by the default text label. Changing the text label to something more description of the actual purpose(s) for which the Audio Stream is used can make the Zebra Volume Control behavior more intuitive for the Device User.

If no text label is selected for an Audio Stream, the Factory Preset default text label will be used.

Detail Information:

  • Key = volumeuiStreamLabel

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Icon

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream

Enter the icon to be displayed for a single Audio Stream that will be included as part of a new Audio UI Profile being added and may be specified within each instance of the group Stream within the Sub-array Add Profile Streams.

The icon might be changed for an Audio Stream because it is used for some purpose(s) other than the one identified by the default text label. Changing the icon to something more representative of the actual purpose(s) for which the Audio Stream is used can make the Zebra Volume Control behavior more intuitive for the Device User.

If an icon is specified, the value specified must be the full path and file name of a PNG format icon file that must already be present in the device file system. An icon size of 48x48 pixels is recommended.

If no icon is selected for an Audio Stream, the Factory Preset default icon will be used.

Detail Information:

  • Key = volumeuiStreamIcon

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Visible

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream

Select whether a single Audio Stream will be visible to the Device User within the Zebra Volume Control when it is included as part of a new Audio UI Profile being added and may be specified within each instance of the Group Stream within the Sub-array Add Profile Streams.

If an Audio Stream is made not visible for an Audio UI Profile, the Zebra Volume Control will not present ANY UI to the Device User to control the volume of that Audio Stream. The result is basically identical to not including the Audio Stream in the Audio UI Profile. This might be used when temporarily disabling an Audio Stream to avoid the need to remove and then add back in the entire definition of that Audio Stream.

Detail Information:

  • Key = volumeuiStreamVisible

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Modes

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream

Use this Sub-array to configure one or more Mode(s). to specify the behaviors of the UI for a single Audio Stream in one or more modes as part of a new Audio UI Profile being added when the value !!1@steps.step.volumeuiStep.volumeuiAction!! is selected for %%steps.step.volumeuiStep.volumeuiAction%% and as part of an instance of the group %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams.volumeuiStream%% within the Sub-array %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams%%.

Detail Information:

  • Key = volumeuiStreamModes

  • Type = bundle_array

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Mode

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream  >  Modes

Use this Sub-group to configure Minimum, Maximum, Preset, and Type. to define the behavior of the UI for a single Audio Stream in a single Audio Mode as part of a new Audio UI Profile being added when the value !!1@steps.step.volumeuiStep.volumeuiAction!! is selected for %%steps.step.volumeuiStep.volumeuiAction%% within the Sub-array %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams.volumeuiStream.volumeuiStreamModes%% as an instance of the Group %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams.volumeuiStream%% within the Sub-array %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams%%.

For each Audio Mode defined for an Audio Stream, You must also specify %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams.volumeuiStream.volumeuiStreamModes.volumeuiMode.volumeuiModeType%% to provide which Audio Mode will be defined. You must also specify %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams.volumeuiStream.volumeuiStreamModes.volumeuiMode.volumeuiModeMin%%, %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams.volumeuiStream.volumeuiStreamModes.volumeuiMode.volumeuiModeMax%%, and %%steps.step.volumeuiStep.volumeuiActionAddProfileStreams.volumeuiStream.volumeuiStreamModes.volumeuiMode.volumeuiModePreset%% to define the lower, upper, and default (preset) volume levels for that Audio Mode within that Audio Stream.

Detail Information:

  • Key = volumeuiMode

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Minimum

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream  >  Modes  >  Mode

Enter the minimum volume level that the UI will allow the Device User to select for a single Audio Stream in a single Audio Mode as part of a new Audio UI Profile being added when the value Add Profile is selected for Action within the Sub-array Modes as an instance of the Group Stream within the Sub-array Add Profile Streams.

The value must be an integer that is greater than 0 and less than 256, with 1 being the lowest possible volume level and 255 being the highest possible volume level.

You must also specify Maximum and Preset to define the complete behavior of a single Audio Mode within a single Audio Stream.

The value specified must be less than or equal to the value entered for Maximum and less than or equal to the value entered for Preset.

Detail Information:

  • Key = volumeuiModeMin

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Maximum

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream  >  Modes  >  Mode

Enter the maximum volume level that the UI will allow the Device User to select for a single Audio Stream in a single Audio Mode as part of a new Audio UI Profile being added when the value Add Profile is selected for Action within the Sub-array Modes as an instance of the Group Stream within the Sub-array Add Profile Streams.

The value must be an integer that is greater than 0 and less than 256, with 1 being the lowest possible volume level and 255 being the highest possible volume level.

You must also specify Minimum and Preset to define the complete behavior of a single Audio Mode within a single Audio Stream.

The value specified must be greater than or equal to the value entered for Minimum and greater than or equal to the value entered for Preset.

Detail Information:

  • Key = volumeuiModeMax

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Preset

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream  >  Modes  >  Mode

Enter the preset volume level that the UI will allow the Device User to select for a single Audio Stream in a single Audio Mode as part of a new Audio UI Profile being added when the value Add Profile is selected for Action within the Sub-array Modes as an instance of the Group Stream within the Sub-array Add Profile Streams.

The value must be an integer that is greater than 0 and less than 256, with 1 being the lowest possible volume level and 255 being the highest possible volume level.

You must also specify Minimum and Maximum to define the complete behavior of a single Audio Mode within a single Audio Stream.

The value specified must be greater than or equal to the value entered for Minimum and less than or equal to the value entered for Maximum.

Detail Information:

  • Key = volumeuiModePreset

  • Type = integer

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Type

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration  >  Add Profile Streams  >  Stream  >  Modes  >  Mode

Select the type of behavior of the UI for a single Audio Stream in a single Audio Mode as part of a new Audio UI Profile being added when the value Add Profile is selected for Action within the Sub-array Modes as an instance of the Group Stream within the Sub-array Add Profile Streams.

  • If the value Speaker is selected, the Audio Mode will be configured for the Audio Stream under conditions where the Audio Stream is being routed to the built-in device speaker.
  • If the value Receiver is selected, the Audio Mode will be configured for the Audio Stream under conditions where the Audio Stream is being routed to receiver mode.
  • If the value WiredHeadset is selected, the Audio Mode will be configured for the Audio Stream under conditions where the Audio Stream is being routed to a wired audio headset.
  • If the value BluetoothHeadset is selected, the Audio Mode will be configured for the Audio Stream under conditions where the Audio Stream is being routed to a wireless Bluetooth audio headset.

Detail Information:

  • Key = volumeuiModeType

  • Type = string

 UI Choice  JSON Value 
 Speaker  Speaker 
 Receiver  Receiver 
 WiredHeadset  WiredHeadset 
 BluetoothHeadset  BluetoothHeadset 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Remove Profile Name

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration

Enter the name of an existing Audio UI Profile to be removed when the value Remove Profile is selected for Action.

Detail Information:

  • Key = volumeuiActionRemoveProfileName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Set Current Profile Name

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration

Enter the name of an existing Audio UI Profile to be made the current active Audio UI Profile when the value Set Current Profile is selected for Action. You must also specify Set Current Profile Adjust Volume to control whether the current device Volume Settings will be adjusted to ensure that they fall within the range of Volume Settings defined by the Audio UI Profile.

Detail Information:

  • Key = volumeuiActionSetCurrentProfileName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.

Set Current Profile Adjust Volume

   Transaction Steps  >  Transaction Step  >  Volume UI Configuration

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 Profilewhen the value Set Current Profile is selected for Action and Set Current Profile Name is specified.

Detail Information:

  • Key = volumeuiActionSetCurrentProfileAdjustVolume

  • Type = string

 UI Choice  JSON Value 
 Off  Off 
 On  On 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.4.


Wakeup Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Select Wakeup Source Method, and Wakeup Sources.

Detail Information:

  • Key = wakeupStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Select Wakeup Source Method

   Transaction Steps  >  Transaction Step  >  Wakeup Configuration

Select the Method that will be used to implement and control device Wake-up. - Hardware - Use Hardware Signals for Wake-Up - Software - Use Software (Mappable Keycodes) for Wake-Up

Detail Information:

  • Key = selectwakeupsourceMethod

  • Type = string

 UI Choice  JSON Value 
 Hardware  1 
 Software  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 9.2.

Wakeup Sources

   Transaction Steps  >  Transaction Step  >  Wakeup Configuration

Select whether all controllable Wakeup Sources should be turned on or off.

  • If the value Off is selected, all wakeup sources that can be turned on or off will be turned off, causing the physical events corresponding to those wakeup sources to be ignored and hence NOT to cause the device to wakeup from a suspend state.

  • If the value On is selected, all wakeup sources that can be turned on or off will be turned on, causing the physical events corresponding to those wakeup sources to be honored and hence to cause the device to wakeup from a suspend state.

Detail Information:

  • Key = wakeupSources

  • Type = string

 UI Choice  JSON Value 
 Off  2 
 On  1 

Support Information:

  • Supported from: MX 8.0.


Whitelist Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Mode, Action, Allow Package Name, Allow Signature, Disallow Signature, Disallow Package Name, and State.

Whitelisting applies only to user applications; it has no effect on System applications, which are applications built into the device and are therefore always present. User applications are those that DO NOT come preinstalled on the device, but are installed during staging or at some time after the device is put into service. System apps are controlled using the Blacklist Configuration Group.

WARNING: It is important to understand that if an app uses the Whitelist Configuration Group to enable whitelisting, then that app becomes subject to whitelisting. If the app does not add itself to the "whitelist," the app is prevented from running once the configuration is successfully applied. .

Detail Information:

  • Key = whitelistStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.1.

Mode

   Transaction Steps  >  Transaction Step  >  Whitelist Configuration

Select the Whitelisting Mode, which determines how the applications that can be installed and run on a device will be controlled.

  • If the value Package Name Only is selected, when configuring which applications can be installed and run, only the Android Package Name will be used to identify the allowed applications.
  • If the value Package Name and Signature is selected, when configuring which applications can be installed and run, both the Android Package Name and the Package Signature will be used to identify the allowed applications.

Using the value Package Name and Signature provides significantly better security than using Package Name Only since it provides much stronger protection against spoofing. If Package Name Only is used, any APK whose Android Package Name matches one of the allowed Android Package Names will be allowed to be installed and run. Since any APK can be assigned any Android Package Name, the potential for a rogue application circumventing the protections of Whitelisting is relatively high. If Package Name and Signature is used, the Android Package Signature of an application must match an allowed Android Package Signature in addition to the Android Package Name matching an allowed Android Package Name. Since a rogue APK cannot be signed with a given Android Package Signature without possessing the corresponding Private Key, the chances of successfully spoofing are greatly reduced, and effectively eliminated if Private Keys are properly controlled.

Detail Information:

  • Key = whitelistMode

  • Type = string

 UI Choice  JSON Value 
 Package Name Only  1 
 Package Name and Signature  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Action

   Transaction Steps  >  Transaction Step  >  Whitelist Configuration

Select an Action to alter the Whitelisting configuration of a device.

  • If the value Allow is selected, a single application will be allowed to be installed and run. You must also specify Allow Package Name to provide the Android Package Name of the application that will be allowed. In addition, if the value Package Name and Signature is selected for Mode, you must also specify Allow Signature to provide the Android Package Signature to be allowed.
  • If the value Disallow is selected, a single application will be prevented from being installed and run. You must also specify Disallow Package Name to provide the Android Package Name of the application that will be disallowed.

Detail Information:

  • Key = whitelistAction

  • Type = string

 UI Choice  JSON Value 
 Allow  Add 
 Disallow  Delete 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Allow Package Name

   Transaction Steps  >  Transaction Step  >  Whitelist Configuration

Enter the Android Package Name of an application to be allowed when the value Allow is selected for Action.

  • If the value Package Name and Signature is selected for Mode, you must also specify Allow Signature to provide the Android Package Signature to be allowed.

Detail Information:

  • Key = whitelistActionAddPackageName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.1.

Allow Signature

   Transaction Steps  >  Transaction Step  >  Whitelist Configuration

Enter the Android Package Signature of an application to be allowed when the value Allow is selected for Action, Allow Package Name is specified, and the value Package Name and Signature is selected for Mode.

Detail Information:

  • Key = whitelistActionAddSignature

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Disallow Signature

   Transaction Steps  >  Transaction Step  >  Whitelist Configuration

Enter the Android Package Signature of an application to be disallowed when the value Disallow is selected for Action, and when Disallow Package Name is specified, and when the value Package Name and Signature is selected for Mode.

Detail Information:

  • Key = whitelistActionDeleteSignature

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.3.

Disallow Package Name

   Transaction Steps  >  Transaction Step  >  Whitelist Configuration

Enter the Android Package Name of an application to be disallowed when the value Disallow is selected for Action.

If the value Package Name and Signature is selected for Mode, you must also specify Disallow Signature to provide the Android Package Signature to be allowed.

Detail Information:

  • Key = whitelistActionDeletePackageName

  • Type = string

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.1.

State

   Transaction Steps  >  Transaction Step  >  Whitelist Configuration

Select the Whitelisting State, which determines whether the set of applications that can be installed and run on a device will be controlled.

  • If the value Off is selected, Whitelisting will not be used and no restrictions will be placed on which applications can be installed and run.

  • If the value On is selected, Whitelisting will be used and you should specify additional configuration in the Group to configure how the set of applications will be controlled and which applications will be allowed to be installed and run.

Detail Information:

  • Key = whitelistState

  • Type = string

 UI Choice  JSON Value 
 Off  1 
 On  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 4.1.


Wireless General Configuration

   Transaction Steps  >  Transaction Step

Use this Sub-group to configure Antenna Selection, Bluetooth Scanning State, GPS Location Mode, GPS Power State, Location State, and Wi-Fi Scanning State.

Detail Information:

  • Key = wirelessStep

  • Type = bundle

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Antenna Selection

   Transaction Steps  >  Transaction Step  >  Wireless General Configuration

Select which of multiple antennas should be used for wireless communications.

  • If the value Internal is selected, the internal built-in antenna will be used.

  • If the value External is selected, an externally connected antenna will be used.

Detail Information:

  • Key = wirelessAntennaSelection

  • Type = string

 UI Choice  JSON Value 
 Internal  1 
 External  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 7.1.

Bluetooth Scanning State

   Transaction Steps  >  Transaction Step  >  Wireless General Configuration

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 = wirelessGpsBluetoothScanning

  • Type = string

 UI Choice  JSON Value 
 Turn On  1 
 Turn Off  2 

Support Information:

  • NOT supported on Device(s): TC20 and TC25.

  • Supported from: MX 10.4.

GPS Location Mode

   Transaction Steps  >  Transaction Step  >