UI Manager

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

EMDK For Android - 6.10

Overview

The UI Manager (UiMgr) provides control of miscellaneous UI configuration settings, such as those for language and locale, the device notification pull-down, Quick Settings controls, default input device and Clipboard behavior.

Android devices contain a variety of System applications that access UI elements spread throughout the OS. In some cases, one or more of these "standard" UI elements were deemed undesirable by Zebra customers and/or partners for devices deployed in an enterprise. The UiMgr provides control over these UI elements and the option of disabling Android behaviors or features with the potential to hinder the productivity of device users engaged in specific business tasks.

Security Warning: The UiMgr permits the "Network may be monitored..." message to be suppressed. This important safeguard is intended to warn device users of a potential security risk. Administrators should not suppress this message unless CA certificates have been properly vetted before installation on a device, and should ensure that no untrusted certificates can be subsequently installed while the message remains suppressed.

Main Functionality

  • Enable/Disable the following:
    • Quick Settings controls for user access to Wi-Fi, Bluetooth and other settings
    • Clipboard function, which allows a device user to copy and paste information between applications
    • The AutoCorrect function, which stores commonly entered words and allows them to be entered instead of similar words that were mistyped
    • The Home Key function, which exits current application and presents the Home Screen application
    • The Bluetooth Paring pop-up feature, which requests device-user involvement even if an application has supplied all required pairing information
    • "The network may be monitored..." message
    • "Recent Apps" button
    • Navigation Bar
    • The Status Bar
    • Display of the virtual keyboard
    • Screen magnification gesture
    • Split-screen mode
    • Multi-user mode
    • Do Not Disturb mode
    • The Large Key Indicator (LKI) pop-up
    • User access to the LKI feature
    • The On-screen Power Button
  • Configure localization settings to:
    • Set the Current Locale for a desired language and region
    • Set the Default Input Method to enhance entry of localized data
  • Clear the Clipboard, which discards any prior data that might have been copied

Clipboard

Controls whether the Clipboard function can be used, potentially enabling a device user to move data from one app to another.

Parm Name: ClipBoardUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no changes as to whether the Clipboard function can be used; any previously selected setting will be retained.

OSX: 4.2+

MX: 4.2+

1 Enable Enables the Clipboard function to be used.

OSX: 4.2+

MX: 4.2+

2 Disable Disables use of the Clipboard function. Note- This will prevent the user from using the copy and paste functions for moving data to and from the clipboard. Attempting to use a disabled clipboard will result in an Android Toast message stating that the clipboard is disabled.

OSX: 4.2+

MX: 4.2+

Clear Clipboard

Used to immediately clear the contents of the clipboard, preventing data that was stored there from being pasted at any time thereafter. If use of the Clipboard function is allowed by an application, it might be advisable to use this parm to clear sensitive information from clipboard upon exiting. This would ensure that such information could not later be pasted into another application.

Parm Name: ClipBoardClear

Option Name Description Note Requires
true true Clears the clipboard, erasing any content that was previously copied and preventing such content from being pasted.

OSX: 4.2+

MX: 4.2+

false false Causes no change to the contents of the clipboard.

OSX: 4.2+

MX: 4.2+

AutoCorrect Usage Enable/Disable

Controls whether AutoCorrect functionality is accessible on the device. AutoCorrect can be used to save commonly entered words or industry-specific words or phrases and offer them as corrections to potentially mistyped words. Such functionality could present a security risk by exposing sensitive information to subsequent device users that are not authorized to view or reuse that information.

Note: This parameter does not turn the AutoCorrect function on or off or configure any of its functions. When AutoCorrect is enabled, an administrator or device user must still use the System Settings panel turn the function on or off and configure its functions. When disabled, AutoCorrect functionality cannot be used on the device.

Parm Name: AutoCorrectUsage

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no changes to be made as to whether the AutoCorrect function is allowed to be used; any previously selected setting will be retained.

MX: 4.3+

Android API: 1+

1 Enable Enables use of the AutoCorrect function, allowing an administrator or device user to the turn the function on and off and configure its settings using the System Settings panel.

MX: 4.3+

Android API: 1+

2 Disable Disables use of the AutoCorrect function, preventing an administrator or device user from turning the function on or off and configuring its settings using the System Settings panel.

MX: 4.3+

Android API: 1+

HOME Key Enable/Disable

Used to prevent use of the HOME key to exit the current app and run the Home Screen app. This might be desirable when the device is devoted to running a single application, such as that of a kiosk. By blocking use of the HOME key, a common method of navigating away from the application (whether intentional or not) can be eliminated.

Note: Enabling this parameter does not affect the "long press" behavior of the HOME key. To completely prevent all HOME key functionality, use the Key Mapping Manager (on supported devices) to disable the HOME key or map it to a desired behavior.

Parm Name: HomeKeyUsage

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

OSX: 1.0+

MX: 4.3+

1 Enable Allows use of the HOME key to exit the current app and launch the Home Screen app.

OSX: 1.0+

MX: 4.3+

2 Disable Prevents use of the HOME key, which would otherwise exit the current app and run the Home Screen app.

OSX: 1.0+

MX: 4.3+

Long-Press HOME Key Enable/Disable

This is the On/Off switch for device response to a "long-press" of the HOME key, which launches the Google Assistant.

Parm Name: LongPressHomeKeyUsage

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

OSX: 7.7+

MX: 8.2+

1 Enable Allows the device to respond to a "long-press" of the HOME key.

OSX: 7.7+

MX: 8.2+

2 Disable Prevents the device from responding to a "long-press" of the HOME key.

OSX: 7.7+

MX: 8.2+

Multi-user Enable/Disable

This is the On/Off switch for Multi-user mode on the device, which can provide separate user accounts, data and apps or app restrictions on a shared device. Zebra devices support a maximum of 4 users.

This feature is supported only on SDM660-platform devices, which includes (but is not limited to):

  • PS20
  • TC52
  • TC57
  • TC72
  • TC77

Note: Supported on SDM660-platform devices only. Zebra devices support a maximum of 4 users.

Parm Name: MultiUser

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

OSX: 8.5+

MX: 8.1+

1 Enable Enables multiple users on the device.

OSX: 8.5+

MX: 8.1+

2 Disable Disables multi-user mode on the device.

OSX: 8.5+

MX: 8.1+

Do Not Disturb Enable/Disable

This is the On/Off switch for "Do Not Disturb" mode, which suppresses notifications on the device. Disabling DND (option 2) prevents the device user from entering DND mode.

This feature is supported only on SDM660-platform devices, which includes (but is not limited to):

  • PS20
  • TC52
  • TC57
  • TC72
  • TC77

Note: Supported on SDM660-platform devices only.

Parm Name: DND

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

OSX: 8.5+

MX: 8.1+

1 Enable Enables the device user to enter "Do Not Disturb" mode, potentially blocking app notifications and sounds.

OSX: 8.5+

MX: 8.1+

2 Disable Disables "Do Not Disturb" mode on the device, preventing the device user from suppressing app notifications.

OSX: 8.5+

MX: 8.1+

Network 'Monitored' Message Enable/Disable

Controls whether the message "Network may be monitored..." is displayed on the device when the device user connects to certain types of networks. This message is generally associated with networks that implement a public key infrastructure and require a root certificate on the device before a client will be allowed to connect.

Security Warning: The "Network may be monitored..." message is a safeguard intended to warn device users of a potential security risk. Administrators should not suppress this message unless CA certificates have been properly vetted before installation on a device, and should ensure that no untrusted certificates can be subsequently installed while the message remains suppressed.

Note: On TC20/TC25 devices, available only when running Android 8.x Oreo and higher.

Parm Name: NetworkMonitorNotification

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

OSX: 6.0+

MX: 6.1+

1 Turn On Allows "Network may be monitored..." notifications to be displayed.

OSX: 6.0+

MX: 6.1+

2 Turn Off Prevents "Network may be monitored..." notifications from being displayed.

OSX: 6.0+

MX: 6.1+

App Info Icon Enable/Disable

This is the On/Off switch for device response to a "long-press" of an app icon in the Recent Apps Header. When enabled, long-pressing an app icon allows the device user access application information and potentially undesireable actions, such as stopping the app.

Parm Name: AppInfoIconOnRecentAppHeader

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

OSX: 7.7+

MX: 8.2+

1 Enable Allows the device respond to a "long-press" on an app icon in the Recent Apps Header.

OSX: 7.7+

MX: 8.2+

2 Disable Prevents the device from responding to a "long-press" of an app icon in the Recent Apps Header.

OSX: 7.7+

MX: 8.2+

Set Current Locale

Permits the selection of the device's Locale. A locale is the combination of a language and a region in which that language is spoken. Languages are identified by two lower-case letters; regions are identified by two upper-case letters. The locale joins the two letter-pairs with an underscore ("_") character. For example, "en_US" is the locale specification for "English spoken in the United States," and "fr_CA" is the locale specification for "French spoken in Canada."

When changing the Locale, it also might be desirable to change the Default Input Method to one that is suitable for entry of characters for the language associated with the selected Locale. Setting a particular Input Method as the Default Input Method does not prevent the device user from manually selecting a different Input Method, it merely determines which Input Method will come up automatically each time that parm is invoked.

Parm value input rules:

  • String containing two lower-case letters corresponding to the language
  • Optionally may contain two upper-case letters designating a region code
  • When a region code is used, letter pairs are joined by an underscore ("_") character. For example: en_US
  • The minimum length is 2 characters; the maximum length is 5 characters

Parm Name: CurrentLocale

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

OSX: 1.3+

MX: 4.3+

98 Extended Permits selection from the Extended List of Locales

MX: 5.1+

99 Custom Permits selection from the Custom List of Locales

MX: 5.1+

en_CA CANADA English spoken in Canada

OSX: 1.3+

MX: 4.3+

fr_CA CANADA_FRENCH French spoken in Canada

OSX: 1.3+

MX: 4.3+

zh_CN CHINA Chinese spoken in China

OSX: 1.3+

MX: 4.3+

zh CHINESE Chinese (non-region specific)

OSX: 1.3+

MX: 4.3+

en ENGLISH English (non-region specific)

OSX: 1.3+

MX: 4.3+

fr_FR FRANCE French spoken in France

OSX: 1.3+

MX: 4.3+

fr FRENCH French (non-region specific)

OSX: 1.3+

MX: 4.3+

de GERMAN German (non-region specific)

OSX: 1.3+

MX: 4.3+

de_DE GERMANY German spoken in Germany

OSX: 1.3+

MX: 4.3+

it ITALIAN Italian (non-region specific)

OSX: 1.3+

MX: 4.3+

it_IT ITALY Italian spoken in Italy

OSX: 1.3+

MX: 4.3+

ja_JP JAPAN Japanese spoken in Japan

OSX: 1.3+

MX: 4.3+

ja JAPANESE Japanese (non-region specific)

OSX: 1.3+

MX: 4.3+

ko_KR KOREA Korean spoken in Korea

OSX: 1.3+

MX: 4.3+

ko KOREAN Korean (non-region specific)

OSX: 1.3+

MX: 4.3+

zh_CN PRC Alternate Chinese spoken in China

OSX: 1.3+

MX: 4.3+

zh_CN SIMPLIFIED_CHINESE Alternate Chinese spoken in China

OSX: 1.3+

MX: 4.3+

zh_TW TAIWAN Chinese spoken in Taiwan

OSX: 1.3+

MX: 4.3+

zh_TW TRADITIONAL_CHINESE Alternate Chinese spoken in Taiwan

OSX: 1.3+

MX: 4.3+

en_GB UK English spoken in Great Britain/United Kingdom

OSX: 1.3+

MX: 4.3+

en_US US English spoken in the United States of America (USA)

OSX: 1.3+

MX: 4.3+

es_ES SPAIN_SPANISH Spanish spoken in Spain

OSX: 1.3+

MX: 5.0+

es_US US_SPANISH Spanish spoken in the United States of America (USA)

OSX: 1.3+

MX: 5.0+

pt_BR BRAZIL_PORTUGUESE Portuguese spoken in Brazil

OSX: 1.3+

MX: 5.0+

pt_PT PORTUGAL_PORTUGUESE Portuguese spoken in Portugal

OSX: 1.3+

MX: 5.0+

Date Launches Clock App Enable/Disable

This is the On/Off switch for launching the Clock app on the device by tapping the date in the Notifications drop-down panel.

Parm Name: NotificationDate

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

OSX: 7.7+

MX: 8.2+

1 Enable Allows the Clock app to launch on the device by tapping the date in the Notifications drop-down panel.

OSX: 7.7+

MX: 8.2+

2 Disable Prevents the Clock app from launching on the device by tapping the date in the Notifications drop-down panel.

OSX: 7.7+

MX: 8.2+

Battery Percentage Show/Hide

Controls whether the current battery-charge percentage is displayed. When shown, the percentage appears in the Android Status Bar at the top of the screen.

Parm Name: ShowBatteryPercentage

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

MX: 10.1+

1 Turn On Causes battery-charge percentage to be shown in the Status Bar.

MX: 10.1+

2 Turn Off Causes the battery-charge percentage to be hidden.

MX: 10.1+

Split Screen Enable/Disable

This is the On/Off switch for Split Screen functionality on the device, which allows two apps to be usable at the same time, each with its own section of the screen. When enabled, Split Screen mode is accessed on some devices by long-pressing the "Recent Apps" button.

Parm Name: SplitScreenMode

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

OSX: 7.7+

MX: 8.1+

1 Enable Allows two apps to be usable at the same time by sharing screen space.

OSX: 7.7+

MX: 8.1+

2 Disable Prevents more than one app from being visible at a time.

OSX: 7.7+

MX: 8.1+

Bluetooth Pairing Pop-up Enable/Disable

Controls whether to present the Bluetooth Pairing Pop-up during a pairing operation, useful mainly when the device user is responsible for pairing. If one or more applications are expected to control pairing operations, suppressing the Pairing Pop-up can reduce the potential for user interference with the pairing process.

Parm Name: BluetoothPairingPopupUsage

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

OSX: 4.3+

MX: 4.3+

1 Enable Allows the Bluetooth Pairing Pop-up to be presented during pairing operations.

OSX: 4.3+

MX: 4.3+

2 Disable Prevents display of the Bluetooth Pairing Pop-up during pairing operations.

OSX: 4.3+

MX: 4.3+

Set a Custom Locale

Permits the selection of the device's Custom Locale. A locale is the combination of a language and a region in which that language is spoken. Languages are identified by two lower-case letters; regions are identified by two upper-case letters. The locale joins the two letter-pairs with an underscore ("_") character. For example, "en_US" is the locale specification for "English spoken in the United States," and "fr_CA" is the locale specification for "French spoken in Canada."

When changing the Locale, it also might be desirable to change the Default Input Method to one that is suitable for entry of characters associated with the language of the selected Locale. Setting a particular Input Method as the Default Input Method does not prevent the device user from manually selecting a different Input Method, it merely determines which Input Method will come up automatically each time that parm is invoked.

Parm value input rules:

  • String containing two lower-case letters corresponding to the language
  • Optionally may contain two upper-case letters designating a region code
  • When a region code is used, letter pairs are joined by an underscore ("_") character. For example: en_US
  • The minimum length is 2 characters; the maximum length is 5 characters

Shown if: Current Locale value is "Custom" (99)

Parm Name: CustomLocale

Requires:

  • MX: 5.1+

Set an Extended Locale

Permits the selection of the device's locale from the list of Extended Locales. A locale is the combination of a language and a region in which that language is spoken. Languages are identified by two lower-case letters; regions are identified by two upper-case letters. The locale joins the two letter-pairs with an underscore ("_") character. For example, "en_US" is the locale specification for "English spoken in the United States," and "fr_CA" is the locale specification for "French spoken in Canada."

When changing the Locale, it also might be desirable to change the Default Input Method to one that is suitable for entry of characters for the language associated with the selected Locale. Setting a particular Input Method as the Default Input Method does not prevent the device user from manually selecting a different Input Method, it merely determines which Input Method will come up automatically each time that parm is invoked.

Parm value input rules:

  • String containing two lower-case letters corresponding to the language
  • Optionally may contain two upper-case letters designating a region code
  • When a region code is used, letter pairs are joined by an underscore ("_") character. For example: en_US
  • The minimum length is 2 characters; the maximum length is 5 characters

Shown if: Current Locale value is "Extended" (98)

Parm Name: ExtendedLocale

Option Name Description Note Requires
en_AU AUSTRALIA_ENGLISH Not supported on TC55 KitKat

OSX: 1.3+

MX: 5.1+

en_IN INDIA_ENGLISH Not supported on TC55 KitKat

OSX: 1.3+

MX: 5.1+

sv_SE SWEDEN_SWEDISH

OSX: 1.3+

MX: 5.1+

nb_NO NORWAY_NORWEGIAN-BOKMAL

OSX: 1.3+

MX: 5.1+

fi_FI FINLAND_FINISH

OSX: 1.3+

MX: 5.1+

da_DK DENMARK_DANISH

OSX: 1.3+

MX: 5.1+

Set Default Input Method

Controls whether to change the Default Input Method (i.e. a soft keyboard) when that change is requested programmatically or manually by the device user. Setting a particular Input Method as the Default Input Method does not prevent the device user from manually selecting a different Input Method, it merely determines which Input Method will come up automatically each time that parm is invoked. When changing the Current Locale, it may desirable to also change the Default Input Method to one that is suitable for entry of characters that are associated with the selected Locale.

Parm Name: InputMethodAction

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to be made to the Current Default Input Method; any previously selected setting will be retained.

MX: 4.3+

Android API: 16+

1 Change Current Input Method This value will change the Current Default Input Method.

MX: 4.3+

Android API: 16+

Input Method Package Name

Used to enter the Android Package Name of a user-defined Input Method to be made the Default Input Method (i.e. a soft keyboard).

Note- The specified Package Name must match the Package Name of an Input Method that is already installed. If an attempt is made to enter a Package Name that does not match an installed Input Method, an error will be returned in the Result XML document.

Parm value input rules:

  • String containing the valid Package Name of an Android application that is currently installed and that implements a valid Input Method. For example: com.mycompany.myinputmethod
  • String with a minimum size of 1 character

Shown if: The "Input Method Action" is "Change Current Input Method" and the "Select a Default Input Method Option" is "User defined Input Method"

Parm Name: InputMethodPackageName

Requires:

  • MX: 4.3+
  • Android API: 16+

Input Method Class Name

Used to enter the Android Class Name of a user-defined Input Method to be made the Default Input Method.

Note: The specified Class Name is used in conjunction with the Package Name and must match the name of the class that implements an Input Method within an Android application that is already installed and that has the specified Package Name. If an attempt is made to enter a Class Name that does not match an installed Input Method, an error will be returned.

Parm value input rules:

  • String with a minimum size of 1 character

Shown if: The "Input Method Action" is "Change Current Input Method" and the "Select a Default Input Method Option" is "User defined Input Method"

Parm Name: InputMethodClassName

Requires:

  • MX: 4.3+
  • Android API: 16+

Set Default Input Method

Allows the selection of the Default Input Method (i.e. the soft keyboard). If the selected Input Method is not already enabled, this parameter will first enable it and then set it as the new default. The desired Input Method must have been previously installed and must be specified using its Android Package Name and Class Name.

Shown if: The "Input Method Action" is "Change Current Input Method"

Parm Name: InputMethodOption

Option Name Description Note Requires
1 English Sets the standard English Input Method as the Default Input Method.

MX: 4.3+

Android API: 16+

2 Japanese Sets the standard Japanese Input Method as the Default Input Method.

MX: 4.3+

Android API: 16+

3 Chinese(China) Sets the standard Chinese Input Method as the Default Input Method.

MX: 4.3+

Android API: 16+

4 User defined Input Method Sets a non-standard user-defined Input Method as the Default Input Method.

MX: 4.3+

Android API: 16+

Gear Icon Show/Hide

Controls whether the "Gear" icon is displayed in the Android Notifications panel. The Gear icon provides immediate access to Wi-Fi, Bluetooth, GPS and other commonly used System settings without having to go through the Settings panel. The Notifications panel is accessed from most applications by dragging downward from the Notification/Status bar at the top of the Android screen. Hiding the Gear icon can prevent a device user from accessing those Settings and changing device behavior.

Parm Name: NotificationSettings

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to visibility of the Gear icon in the Notifications panel; any previously selected setting will be retained.

OSX: 5.1+

MX: 5.1+

1 Show Shows the Gear icon in the Notifications panel.

OSX: 5.1+

MX: 5.1+

2 Hide Hides the Gear icon in the Notifications panel.

OSX: 5.1+

MX: 5.1+

Notification Pulldown Enable/Disable

Controls whether a device user will be allowed to "pull down" the Notifications/Status bar and access the Notifications panel. Depending on the Android version, the Notifications panel displays application alerts, text messages, widgets and other notifications, and provides access to device Settings. Preventing access to the Notification Pulldown can prevent a device user from accessing device Settings and other system objects that might allow a user to change system behavior or navigate away from the current application.

Parm Name: NotificationPullDown

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to ability of the device user to pull down the Notifications panel; any previously selected setting will be retained.

OSX: 5.1+

MX: 5.1+

1 Enable Allows the Notifications panel to be pulled down.

OSX: 5.1+

MX: 5.1+

2 Disable Prevents the Notifications panel from being pulled down.

OSX: 5.1+

MX: 5.1+

Two-Finger Quick Settings Enable/Disable

Controls whether Quick Settings can be accessed using a two-finger downward swipe gesture on some versions of Android. Quick Settings icons provide immediate access to Wi-Fi, Bluetooth, GPS and other commonly used System settings without having to go through the Settings panel. Disabling Quick Settings access can prevent a device user from changing device behavior.

Note: This parameter is superseded by the "System Settings Access" parameter of Access Manager. If Reduced Access is enabled, later attempts enable Quick Settings result in failure.

Note: Superseded by the System Settings Access parameter of Access Manager. On TC20/TC25 devices, available only when running Android 8.x Oreo and higher.

Parm Name: QuickSettings

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to the accessibility of Quick Settings icons using a two-finger downward swipe; any previously selected setting will be retained.

OSX: 5.2+

MX: 5.2+

1 Enable Enables access to Quick Settings using a two-finger downward swipe.

OSX: 5.2+

MX: 5.2+

2 Disable Disables access to Quick Settings using a two-finger downward swipe.

OSX: 5.2+

MX: 5.2+

This is the On/Off switch for the on-screen Navigation Bar, which contains the BACK, HOME and RECENT soft keys. Disabling the Navigation Bar prevents the user from quitting the currently running app by means of those keys. This parameter applies only to the soft keys; it does not control capacitive or hardware keys, which can be disabled separately using the Keymapping Manager.

Also see the Recent App Button Usage parameter elsewhere on this page.

Parm Name: NavigationBarUsage

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

OSX: 6.2+

MX: 7.1+

1 Enable Enables the navigation soft keys (BACK, HOME and RECENT) on the screen-bound Navigation Bar to be displayed and usable.

OSX: 6.2+

MX: 7.1+

2 Disable Disables the navigation soft keys (BACK, HOME and RECENT) on the screen-bound Navigation Bar.

OSX: 6.2+

MX: 7.1+

Recent App Button Enable/Disable

Controls access to the Android Recent Apps button, which displays a list of applications recently accessed on the device and from which the user can re-launch. Note: Disabling the recent apps button prevents the user from configuring the device for multi-window operation.

Parm Name: RecentAppButtonUsage

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

OSX: 7.2+

MX: 7.1+

1 Enable Enables the Recent Apps button, which displays a list of recently used apps that can be viewed and launched.

OSX: 7.2+

MX: 7.1+

2 Disable Disables the Recent Apps button, preventing the display and launch of recently used apps.

OSX: 7.2+

MX: 7.1+

Magnification Gesture

Controls the "Magnification gesture" setting on the device, which is found in the Accessibility section of the Android Settings Panel. By turning this feature on (option 1), triple-tapping the screen magnifies the device display (except navigation bar and keyboard).

Parm Name: MagnificationGesture

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

MX: 8.0+

Android API: 24+

1 Turn On Allows screen magnification by use of a touch gesture.

MX: 8.0+

Android API: 24+

2 Turn Off Prevents screen magnification by use of a touch gesture.

MX: 8.0+

Android API: 24+

Password Characters Show/Hide

Controls whether each password character is displayed briefly on the screen as it is entered; otherwise masked at all times. This parameter controls the "Security & Location" function of the Settings panel.

Parm Name: ShowPasswords

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

MX: 9.1+

Android API: 26+

1 Turn On Allows each password character to be displayed briefly as it is typed.

MX: 9.1+

Android API: 26+

2 Turn Off Prevents passwords from being displayed.

MX: 9.1+

Android API: 26+

Virtual Keyboard Show/Hide

Controls whether to display the virtual keyboard on the device screen while a physical keyboard is active.

Parm Name: ShowVirtualKeyBoard

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

MX: 8.0+

Android API: 26+

1 Show Shows the Gear icon in the Notifications panel.

MX: 8.0+

Android API: 26+

2 Hide Hides the Gear icon in the Notifications panel.

MX: 8.0+

Android API: 26+

LKI Usage Enable/Disable

Controls whether the device user can enable/disable the Large Key Indicator (LKI) pop-up, which is used to show active modifier keys. LKI features are supported on MC93 devices only.

Note: Supported on MC93 devices only.

Parm Name: SetLKI

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

OSX: 8.1+

MX: 9.0+

1 Turn On Allows device user to change the LKI state.

OSX: 8.1+

MX: 9.0+

2 Turn Off Prevents the device user from changing the LKI state.

OSX: 8.1+

MX: 9.0+

LKI Enable/Disable

This is the On/Off switch for the Large Key Indicator (LKI) pop-up, which is used to show active modifier keys. On most devices, the indicator is displayed in the Status Bar at the top of the screen. This parameter is accessible by the user only when SetLKI is set to "Turn On." LKI features are supported on MC93 devices only.

Note: Supported on MC93 devices only.

Parm Name: EnableLKI

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

OSX: 8.1+

MX: 9.0+

1 Enable Enables the Large Key Indicator (LKI) pop-up on the device.

OSX: 8.1+

MX: 9.0+

2 Disable Disables the Large Key Indicator (LKI) pop-up on the device.

OSX: 8.1+

MX: 9.0+

Status Bar Enable/Disable

This is the On/Off switch for the Android Status bar on the device, which displays notifications and system icons. When disabled (option 2), the bar is not visible on the device and cannot be accessed by any means.

This feature is supported only on SDM660-platform devices, which includes (but is not limited to):

  • PS20
  • TC52
  • TC57
  • TC72
  • TC77

Note: Supported on SDM660-platform devices only.

Parm Name: StatusBarUsage

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

OSX: 8.1+

MX: 8.4+

Android API: 27+

1 Enable Enables the Android Status bar on the device.

OSX: 8.1+

MX: 8.4+

Android API: 27+

2 Disable Disables the Android Status bar on the device.

OSX: 8.1+

MX: 8.4+

Android API: 27+

On-screen Power Button Enable/Disable

This is the On/Off switch for on-screen power button on the device, which is the power button on the soft-key nav bar on devices running Android Oreo and later.

This feature is supported only on SDM660-platform devices, which includes (but is not limited to):

  • PS20
  • TC52
  • TC57
  • TC72
  • TC77

Note: Supported on SDM660-platform devices only.

Parm Name: StatusBarUsage

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

OSX: 8.1+

MX: 8.4+

Android API: 27+

1 Enable Enables the on-screen power button to turn off the device.

OSX: 8.1+

MX: 8.4+

Android API: 27+

2 Disable Prevents the on-screen power button from turning off the device.

OSX: 8.1+

MX: 8.4+

Android API: 27+

Examples

Configure Device Region and Keyboard


<wap-provisioningdoc>
  <characteristic type="UiMgr" version="4.3" >
    <parm name="CurrentLocale" value="en_GB"/>
    <parm name="InputMethodAction" value="1"/>
    <characteristic type="InputMethodDetails">
      <parm name="InputMethodOption" value="1"/>
    </characteristic>
  </characteristic>
</wap-provisioningdoc>

Set Enterprise Keyboard as the Default Input Method

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm name="InputMethodAction" value="1"/>
        <characteristic type="InputMethodDetails">
        <parm name="InputMethodOption" value="4"/>
        <parm name="InputMethodPackageName" value="com.symbol.mxmf.csp.enterprisekeyboard"/>
        <parm name="InputMethodClassName" value="com.android.inputmethod.latin.LatinIME"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>

Queries

Get Current Locale

Input


 <wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm-query name="CurrentLocale"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm name="CurrentLocale" value="en"/>
    </characteristic>
</wap-provisioningdoc>

Get Home Key Usage

Input


<wap-provisioningdoc>
<characteristic type="UiMgr" version="4.3" >
  <parm-query name="HomeKeyUsage"/>
</characteristic>

Output


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm name="HomeKeyUsage" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get Clipboard Usage

Input


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm-query name="ClipboardUsage"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm name="ClipboardUsage" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get AutoCorrect Usage

Input


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm-query name="AutoCorrectUsage"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm name="AutoCorrectUsage" value ="1"/> 
    </characteristic>
</wap-provisioningdoc>

Get Paring Popup

Input


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm-query name="BluetoothPairingPopupUsage"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm name="BluetoothPairingPopupUsage" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get Input Methods

Input


<wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <characteristic-query type="InputMethodDetails"/>
    </characteristic>
</wap-provisioningdoc>

Output Selected Input


 <wap-provisioningdoc>
    <characteristic type="UiMgr" version="4.3" >
        <parm name="InputMethodAction" value="1"/>
        <characteristic-query type="InputMethodDetails">
            <parm name="InputMethodOption" value="1"/>
        </characteristic>
    </characteristic>

Output Custom Input


<characteristic type="UiMgr" version="4.3" >
    <parm name="InputMethodAction" value="1"/>
    <characteristic type="InputMethodDetails">
        <parm name="InputMethodOption" value="4"/>
        <parm name="InputMethodPackageName" value="PackageName1"/>
        <parm name="InputMethodClassName" value="ClassName1"/>
    </characteristic>
</characteristic>

Get All Settings

Input


<wap-provisioningdoc>
    <characteristic-query type="UiMgr"/>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
  <characteristic type="UiMgr" version="4.3" >
        <parm name="CurrentLocale" value="en"/>
        <parm name="HomeKeyUsage" value="1"/>
        <parm name="ClipboardUsage" value ="1"/>
        <parm name="AutoCorrectUsage" value ="1"/> 
        <parm name="InputMethodAction" value="1"/>
        <parm name="BluetoothPairingPopupUsage" value="1"/>
        <characteristic type="InputMethodDetails">
          <parm name="InputMethodOption" value="4"/>
          <parm name="InputMethodPackageName" value="PackageName1"/>
          <parm name="InputMethodClassName" value="ClassName1"/>
        </characteristic>
    </characteristic>
</wap-provisioningdoc>

Get Recent App Button status

Input

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="7.1" >
        <parm-query name="RecentAppButtonUsage" />
    </characteristic>
</wap-provisioningdoc>

Output (button enabled)

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="7.1" >
        <parm name="RecentAppButtonUsage" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Enable Navigation Bar

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="7.1" >
        <parm name="RecentAppButtonUsage" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get Navigation Bar Status

Input

<wap-provisioningdoc>
    <characteristic type="UiMgr">
        <parm-query name="NavigationBarUsage"/>
    </characteristic>
</wap-provisioningdoc>

Output (Navigation Bar enabled)

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="7.1" >
        <parm name="RecentAppButtonUsage" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Disable Magnification Gesture

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="8.0" >
        <parm name="MagnificationGesture" value="2"/>
    </characteristic>
</wap-provisioningdoc>

Hide Virtual Keyboard

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="8.0" >
        <parm name="ShowVirtualKeyBoard" value="2"/>
    </characteristic>
</wap-provisioningdoc>

Enable SplitScreen Mode

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="8.1" >
        <parm name="SplitScreenMode" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Disable SplitScreen Mode

<wap-provisioningdoc>
    <characteristic type="UiMgr" version="8.1" >
        <parm name="SplitScreenMode" value="2"/>
    </characteristic>
</wap-provisioningdoc>

Hide passwords

<wap-provisioningdoc>
    <characteristic version="9.1" type="UiMgr">
        <parm name="ShowPasswords" value="2" />
    </characteristic>
</wap-provisioningdoc>

Show passwords

<wap-provisioningdoc>
    <characteristic version="9.1" type="UiMgr">
        <parm name="ShowPasswords" value="1" />
    </characteristic>
</wap-provisioningdoc>