To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.
Input fields accept ENGLISH ONLY.
Queries from MX are not supported on Zebra devices running Android 11 or later. See alternative method.
The "SmartDocs" bar can customize this page to show only the features present on a particular Zebra device.
OSX, MX and Android version information for a device can be found in the Android Settings panel or by querying the device through ADB, EMDK or the MX CSP. More info.
Enterprise Keyboard Manager (EnterpriseKeyboard) controls the settings of Enterprise Keyboard, Zebra's soft input device that provides an efficient means of manual input of data into Zebra devices running Android. Building on the stock Android keyboard, Enterprise Keyboard adds programmable keys, switches quickly between languages and key layouts, and can scan data directly into an application.
Enterprise Keyboard also makes use of Android's Personal Dictionary for spelling suggestions and corrections, and permits customers and partners to populate the device with industry-specific terms to help improve the speed and accuracy of keyboard input. A Personal Dictionary can be populated manually or from a file, and can be mass-deployed through Zebra's Mobility Extensions (MX) and StageNow tools. Learn more about the Personal Dictionary.
Also see the Enterprise Keyboard User Guide.
Enterprise Keyboard Manager offers limited support for devices localized for Japanese:
NOTE: Settings configured using StageNow barcodes (and other sources of MX-XML) ARE supported on devices localized for Japanese. Parameter prompts appear in Japanese, but settings MUST be input in English.
The Enterprise Keyboard Tab key is designed to move the cursor or UI focus from one text field or UI component to the next. Zebra recommends that apps be built to use the Tab key to navigate in this way. On devices with versions prior to MX 6.2 and/or Enterprise Keyboard 1.3, the Tab key might not move the cursor as expected. For help with native-app navigation, please refer to the Android Tab-key navigation section of the Android developer docs.
Controls whether to capitalize the first word of each sentence following a period.
Parm Name: AutoCapitalization
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Enterprise Keyboard to perform Auto-capitalization. |
MX: 6.0+ |
||
2 | Turn off | Disables the Auto-capitalization feature. |
MX: 6.0+ |
Controls whether to allow automatic replacement of misspelled words with those found in the Add-on and Personal dictionaries when suggestion for one or more dictionaries is enabled. Suggested replacements are inserted by pressing the spacebar.
Parm Name: AutoCorrection
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Enterprise Keyboard to perform Auto-correction on words spelled incorrectly. |
MX: 6.0+ |
||
2 | Turn off | Disables the Auto-correction feature. |
MX: 6.0+ |
Controls whether to the display as suggested spelling corrections words that might be deemed offensive or insensitive as determined by external standards of decency.
Parm Name: BlockOffensiveWords
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Activates Google's routines for blocking offensive words as spelling suggestions. |
MX: 6.0+ |
||
2 | Turn off | Disables the Block Offensive Words feature, allowing all spelling suggestions to be shown. |
MX: 6.0+ |
Controls whether to automatically insert a period and space when double-tapping the spacebar.
Parm Name: DoubleSpacePeriod
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Enterprise Keyboard to perform Double-Space Period function. |
MX: 6.0+ |
||
2 | Turn off | Disables the Double-Space Period function. |
MX: 6.0+ |
Controls whether a finger "flick" can be used to input characters otherwise accessible by using the shift key or a long-press.
Parm Name: Flick
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.1+ |
||
1 | Turn on | Enables a finger flick to input alternate characters. |
MX: 6.1+ |
||
2 | Turn off | Disables finger flick for character input. |
MX: 6.1+ |
Controls whether to enter the length of time (in ms) a key must be held down before being considered a long-press (default = 300ms), or to leave the setting unchanged. When "Enter duration" is selected, the long-press delay is set using the "KeyLongPressDelay" parameter.
Parm Name: KeyLongPressDelayMode
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | A null value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Enter duration | Enables specification of the length of time (in ms) that a key must be held before being considered a long press. |
MX: 6.0+ |
Controls the length of time (in ms) a key must be held down before being considered a long-press (default = 300ms).
Parm input rules:
Shown if: Key Long-Press Delay Mode is set to "Enter duration"
Parm Name: KeyLongPressDelay
Requires:
- MX: 6.0+
Controls whether to enter the sound volume (as a percentage of the maximum) or to accept the System setting (default).
Parm Name: KeypressSoundVolumeMode
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | A null value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Enter volume | Enables keypress sound volume (as a percentage of the maximum) to be specified. |
MX: 6.0+ |
||
2 | System default | Accepts the System setting for the keypress sound volume. |
MX: 6.0+ |
Allows the sound volume for each keypress to be speficied as a percentage of the maximum.
Parm input rules:
Shown if: Keypress Sound Volume Mode is set to "Enter duration"
Parm Name: KeypressSoundVolume
Requires:
- MX: 6.0+
Controls whether to enter the length of time (in ms) to operate device vibration when a key is pressed or to accept the System setting.
Parm Name: KeypressVibrationDurationMode
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | A null value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Enter duration | Enables a vibration duration (in ms) to be specified for each keypress. |
MX: 6.0+ |
||
2 | System default | Accepts the System setting for the keypress vibration duration. |
MX: 6.0+ |
Controls whether to Enterprise Keyboard will suggest possible next words based on the word being typed or most recently entered. This feature is sometimes referred to as "Predictive text."
Parm Name: NextWordSuggestions
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Enterprise Keyboard to suggest the next word to be entered based on the most recent word entered. |
MX: 6.0+ |
||
2 | Turn off | Disables the suggestion of the next word to be entered based on the most recent word entered. |
MX: 6.0+ |
Used to enter the length of time (from 0 to 100ms) that the device will vibrate to indicate that a key has been pressed (default = 0ms).
Parm input rules:
Shown if: Keypress Vibration Duration Mode is set to "Enter duration"
Parm Name: KeypressVibrationDuration
Requires:
- MX: 6.0+
Controls whether Enterprise Keyboard will suggest words and terms that have been previously entered and stored in the Personal Dictionary. Suggested words will appear as spelling corrections for words as they are being typed. Enable Auto-correction to accept suggested words by pressing the space bar.
Parm Name: PersonalizedSuggestions
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Enterprise Keyboard to display personalized spelling suggestions from the Personal Dictionary. |
MX: 6.0+ |
||
2 | Turn off | Disables suggestions for spelling corrections from the Personal Dictionary. |
MX: 6.0+ |
Controls whether a "big character bubble" will pop up when a key on the Enteprise Keyboard is pressed.
Parm Name: PopupOnKeypress
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Popup On Keypress feature. |
MX: 6.0+ |
||
2 | Turn off | Disables the Popup On Keypress feature. |
MX: 6.0+ |
Controls whether Enterprise Keyboard will display spelling correction suggestions for words being typed. Enable Auto-correction to accept suggested words by pressing the space bar.
Parm Name: ShowCorrectionSuggestions
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Enterprise Keyboard to suggest words to replace misspelled or incomplete words as they are typed. |
MX: 6.0+ |
||
2 | Turn off | Prevents Enterprise Keyboard from suggesting spelling corrections. |
MX: 6.0+ |
Permits selection of the Numeric keypad layout.
Note: Enabling the Numeric tab disables remapping of the Alphanumeric P1 key.
Parm Name: NumericLayoutMode
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.1+ |
||
1 | Telephone mode | Enables Telephone keypad mode. |
MX: 6.1+ |
||
2 | Calculator mode | Enables Calculator keypad mode. |
MX: 6.1+ |
Controls the means of navigating between keyboard layouts. "Tabs" mode permits switching layouts by swiping the key layout in either direction or by tapping directly on the desired tab. The tab bar will be visible at all times except when next-word suggestions (if enabled) are being displayed. "Keys" mode permits specific keys to be used to switch layouts, as with the default Android keyboard. However, this mode prevents certain keys from being remapped and overrides any previous assignment, mapping those keys to their respective keyboard layouts. See important notes, below.
Remapping Notes:
Behavior Notes:
TYPE_TEXT_FLAG_NO_SUGGESTIONS
input type is enabled, neither the tab bar nor the suggestion bar appears. About Android input types. Parm Name: NavigationMode
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
1 | Tabs | Enables tab-based navigation for switching between keyboard layouts. |
MX: 7.1+ |
||
2 | Keys | Enables key-based navigation for switching between keyboard layouts. |
MX: 7.1+ |
Controls whether to display the alphanumeric tab among other selected keyboard layout tabs. Note: Hiding this tab prevents the alphanumeric key layout from being selected by the device user.
Parm Name: ShowAlphaNumericTab
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 7.1+ |
||
1 | Turn on | Shows the alphanumeric tab among the other key layout tabs. |
MX: 7.1+ |
||
2 | Turn off | Hides the alphanumeric tab and prevents selection of the alphanumeric key layout. |
MX: 7.1+ |
Controls whether to display the numeric tab among other selected keyboard layout tabs.
Notes:
Parm Name: ShowNumericTab
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 7.1+ |
||
1 | Turn on | Shows the numeric tab among the other key layout tabs. |
MX: 7.1+ |
||
2 | Turn off | Hides the numeric tab and prevents selection of the numeric key layout. |
MX: 7.1+ |
Used to enter the tab to appear when EKB is invoked for text input.
Parm Name: SelectPreferTab
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 7.1+ |
||
1 | Numeric | Causes the numeric layout to appear whenever EKB is invoked. |
MX: 7.1+ |
||
2 | Alpha numeric | Causes the alphanumeric layout to appear whenever EKB is invoked. |
MX: 7.1+ |
||
3 | Symbol | Causes the symbol layout to appear whenever EKB is invoked. |
MX: 7.1+ |
||
4 | Scan | Causes the scan tab to appear whenever EKB is invoked. |
MX: 7.1+ |
||
5 | Voice | Causes the microphone tab to appear whenever EKB is invoked. |
MX: 11.5+ Android API: 30+ |
Controls whether to display the symbol tab among the other keyboard layout tabs. Hiding this tab prevents the symbol key layout from being selected by the device user.
Note: Enabling the Symbol tab disables remapping of the Numeric P3 key.
Parm Name: ShowSymbolTab
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 7.1+ |
||
1 | Turn on | Shows the symbol tab among other key layout tabs. |
MX: 7.1+ |
||
2 | Turn off | Hides the symbol tab and prevents selection of the symbol key layout. |
MX: 7.1+ |
Controls whether to display the scan tab among the other keyboard layout tabs. The scan tab displays the scanner controls for collecting barcode data. Scanning from within Enterprise Keyboard requires the DataWedge service to be enabled on the device.
Note: The scan tab is disabled whenever a scanning app is running.
Parm Name: ShowScanTab
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Shows the scan tab for activating the device scanner. |
MX: 6.0+ |
||
2 | Turn off | Hides the scan tab. |
MX: 6.0+ |
Controls whether to display the microphone tab, which enables voice input when selected by the user.
Parm Name: ShowVoiceTab
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 11.5+ Android API: 30+ |
||
1 | Turn on | Shows the microphone tab, allowing the device user to tap for voice input. |
MX: 11.5+ Android API: 30+ |
||
2 | Turn off | Hides the microphone tab. |
MX: 11.5+ Android API: 30+ |
Controls whether to play a sound when a key is pressed. To control volume of Keypress sound, see Keypress Sound Volume.
Parm Name: SoundOnKeypress
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Sound On Keypress feature. |
MX: 6.0+ |
||
2 | Turn off | Disables the Sound On Keypress feature. |
MX: 6.0+ |
Controls whether to automatically display contacts from the device contact list when typing names. This feature works only with specific field types.
Parm Name: SuggestContactNames
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables Enterprise Keyboard to suggest contact names from contacts stored on the device as they're being typed. |
MX: 6.0+ |
||
2 | Turn off | Disables the suggestion of contact names from contacts stored on the device as they're being typed. |
MX: 6.0+ |
Controls whether to activate device vibration (haptic feedback) when a key is pressed. To control the length of time the device will vibrate, see Keypress Vibration Duration.
Shown if: Vibrate on Keypress is set to "Enable"
Parm Name: VibrateOnKeypress
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Enables vibration (haptic feedback) when a key is pressed. |
MX: 6.0+ |
||
2 | Turn off | Disables vibration (haptic feedback) when a key is pressed. |
MX: 6.0+ |
Controls whether to display the voice input key, which contains a microphone icon. When enabled, will display a key for allowing Enterprise Keyboard to accept spoken input using the device microphone. This feature is visible on GMS-enabled devices only.
Notes:
TYPE_TEXT_FLAG_NO_SUGGESTIONS
input type is enabled in the app, neither the tab bar nor the suggestion bar will appear. About Android input types. Parm Name: VoiceInputKey
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) will cause no change to Enterprise Keyboard settings; any previously selected setting will be retained. |
MX: 6.0+ |
||
1 | Turn on | Causes the Voice Input Key (mic) to be shown. |
MX: 6.0+ |
||
2 | Turn off | Hides the Voice Input Key (mic). |
MX: 6.0+ |
Used to enter a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 4, Column 1. If this field is left blank, no change is made and any previously selected value is retained.
Notes:
Parm input rules:
Parm Name: RemapAlphaP1
Requires:
- MX: 6.0+
Used to enter a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 1, Column 1. If this field is left blank, no change is made and any previously selected value is retained.
Parm input rules:
Parm Name: RemapNumericP1
Requires:
- MX: 6.0+
Used to enter a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 2, Column 1. If this field is left blank, no change is made and any previously selected value is retained.
Parm input rules:
Parm Name: RemapNumericP2
Requires:
- MX: 6.0+
Used to enter a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 3, Column 1. If this field is left blank, no change is made and any previously selected value is retained.
Notes:
Parm input rules:
Parm Name: RemapNumericP3
Requires:
- MX: 6.0+
Used to enter a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Numeric Keypad Row 4, Column 1. If this field is left blank, no change is made and any previously selected value is retained.
Notes:
Parm input rules:
Parm Name: RemapNumericP4
Requires:
- MX: 6.0+
Used to enter a character, UNICODE value or EMOJI selection panel for substitution with the default key on the Symbol Keypad Row 4, Column 1. If this field is left blank, no change is made and any previously selected value is retained.
Notes:
Parm input rules:
Parm Name: RemapSymbolP1
Requires:
- MX: 8.0+
Used to select which built-in languages to offer for selection when using Enterprise Keyboard. Options include languages delivered with Enterprise Keyboard and those included with Android.
Parm Name: UseSystemLanguages
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) causes no change to Enterprise Keyboard settings; any previously selected setting is retained. |
MX: 10.1+ |
||
1 | Android System | Allows selection of languages built into the Android system. |
MX: 10.1+ |
||
2 | Enterprise Keyboard | Allows selection of languages built into Enterprise Keyboard. |
MX: 10.1+ |
Used to select whether languages provided by Enterprise Keyboard are used on the device.
Shown if: Use System Language is set to "Enterprise Keyboard"
Parm Name: LanguageAction
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do nothing | This value (or the absence of this parm from the XML) causes no change to Enterprise Keyboard settings; any previously selected setting is retained. |
MX: 10.1+ |
||
1 | Enable | Enables languages provided by Enterprise Keyboard to be used on the device. |
MX: 10.1+ |
||
2 | Disable | Prevents languages provided by Enterprise Keyboard from being used on the device. |
MX: 10.1+ |
Used to select which language is used by Enterprise Keyboard on the device. When using Custom Language option, enter custom language name using the Custom Language parameter.
Shown if: Use System Language is set to "Enterprise Keyboard" and Language Action is "Enable" or "Disable"
Parm Name: Language
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | English (US) | Selects English as used in the United States. |
MX: 10.1+ |
||
1 | English (UK) | Selects English as used in the United Kingdom. |
MX: 10.1+ |
||
2 | Polish | Selects the Polish language as used in Poland. |
MX: 10.1+ |
||
3 | Slovak | Selects Slovlak as used in Slovakia. |
MX: 10.1+ |
||
4 | romanian | Selects Romanian as used in Romania. |
MX: 10.1+ |
||
5 | Czech | Selects Czech as used in the Czech Republic. |
MX: 10.1+ |
||
6 | Russian | Selects Russian as used in Russia. |
MX: 10.1+ |
||
7 | All Supported Languages | Allows selection of any language. |
MX: 10.1+ |
||
8 | Custom Language | Allows a custom language to be used. |
MX: 11.9+ |
Used to enter the name of a custom language to be used by Enterprise Keyboard.
Parm input rules:
Shown if: Use System Language is set to "Enterprise Keyboard" and Language Action is "Enable" or "Disable" and Language is "Custom Language"
Parm Name: LanguageCustom
Requires:
- MX: 11.9+
Used to select a width for the soft input panel (SIP) when it appears on an external monitor as with Zebra Workstation Connect.
Parm Name: KeyboardWidth
Option | Name | Description | Note | Status | 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: 11.5+ Android API: 30+ |
||
1 | Specify width | Enables a custom width percentage to be entered. |
MX: 11.5+ Android API: 30+ |
||
2 | System default | Uses the Android-default value for keyboard width. |
MX: 11.5+ Android API: 30+ |
Used to enter a custom width for the SIP as a percentage (from 25-100) to reduce its width when displayed on an external monitor.
Parm input rules:
Shown if: Keyboard Width is set to "Specify width"
Parm Name: KeyboardCustomWidth
Requires:
- MX: 11.5+
- Android API: 30+
Used to select a height for the soft input panel (SIP) when it appears on an external monitor as with Zebra Workstation Connect.
Parm Name: KeyboardHeight
Option | Name | Description | Note | Status | 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: 11.5+ Android API: 30+ |
||
1 | Specify height | Enables a custom height percentage to be entered. |
MX: 11.5+ Android API: 30+ |
||
2 | System default | Uses the Android-default value for keyboard height when SIP is displayed on an external monitor. |
MX: 11.5+ Android API: 30+ |
Used to enter a custom height for the SIP as a percentage (from 25-100) to reduce its height when displayed on an external monitor.
Parm input rules:
Shown if: Keyboard Height is set to "Specify height"
Parm Name: KeyboardCustomHeight
Requires:
- MX: 11.5+
- Android API: 30+