Enterprise Keyboard Setup - Zebra Technologies TechDocs

WARNING: A newer version of this product and documentation are available. See the latest

Overview

Enterprise Keyboard (EKB) setup varies by device but activation is always necessary to make it available to users. EKB also can be set as the default input method, if desired.

EKB can be activated and configured:

Manually at the device (covered here)
Remotely (covered elsewhere):
- Zebra's StageNow device configuration tool and the UI Manager and Enterprise Keyboard Manager services (requires MX 6.3 or higher on the device)
- Through a company's own enterprise mobility management (EMM) system (if compatible; see that system's info)

This guide covers:

Installation of user-app versions of EKB
Manual activation and setting EKB as the default input source

For advanced settings, such as language selection and scan-tab configuration:

See the Customize section of this guide.

Install/Upgrade EKB

From Google Play

Enterprise Keyboard 4.0 (and later) is available from Google Play, which can automatically manage updates as they become available.

Requirements

Zebra device running Android 11 (or later)
Device OS image (BSP):
- For Android 10: 10-16-10.00-QG-U111-STD-HEL-04 (or later)
- For Android 11: 11-20-02.00-RG-U00-STD-HEL-04 (or later)
No prior EKB version installed (see Uninstalling/Downgrading EKB)

To install, visit Google Play and follow normal installation procedures.

Use of EKB with Enterprise Browser requires EB 3.3 or later.

Some current and older versions of EKB can be downloaded from the Zebra Support Portal and installed as a user app. Devices running Android 7.x Nougat (or higher) with older versions of EKB can be upgraded to the latest EKB version using the latest .apk file. Visit the Support Portal for specific EKB device and OS support information. Installation and upgrade instructions are below.

Before beginning any installation...

See EKB download instructions and get the correct file(s) for the target device(s).

Ensure that target device(s) are able to connect via USB to the host computer. If needed, get USB drivers.

Note that Enterprise Keyboard requires activation following installation.

Upgrade/install using USB

EKB versions prior to v4.0 must be uninstalled before EKB 4.0 can be installed.

Connect the device via USB to the host computer that contains the downloaded Enterprisekeyboard.apk file.
Copy the Enterprisekeyboard.apk file to the root directory of the device.
Navigate to the file using a file manager app on the device.
Tap the file to install it.
See Verify Installation section below.

Notes:

After installation, Enterprise Keyboard requires activation.
Enterprise Keyboard (3.6.1.4 and later) does not appear in the Android launcher.

Upgrade/install using adb

EKB versions prior to v4.0 must be uninstalled before EKB 4.0 can be installed.

Connect the device via USB to the host computer that contains the downloaded Enterprisekeyboard.x.x.x.x.apk file (where "x.x.x.x" = EKB version number).
For devices with an older EKB already installed, run the following command:
```
adb install –r EnterpriseKeyboard_file_name.apk
```
The "-r" option reinstalls an existing app and retains any existing user data.
For devices with no prior version of EKB installed, run the following command:
```
adb install EnterpriseKeyboard_file_name.apk
```
See Verify Installation section below.

Notes:

After installation, Enterprise Keyboard requires activation.
Enterprise Keyboard (3.6.1.4 and later) does not appear in the Android launcher.

Also see

Uninstalling/Downgrading EKB

Notes:

If EKB was installed as a user app on a device with no prior version, removal is the same as for any standard Android app.
If EKB was installed as an upgrade on a device with EKB preinstalled, removal reverts to the preinstalled version.

Uninstall EKB 3.9 (and older) using adb

Connect the host computer to the device that contains the Enterprise Keyboard to be uninstalled.

From a terminal window, run the following command:


adb uninstall com.zebra.mdna.enterprisekeyboard

To verify uninstallation, use the Verify Installation instructions below to confirm that EKB was removed or downgraded to the preinstalled version.
To uninstall EKB 4.0 (or later), change the package name above to com.zebra.mdna.enterprisekeyboard

NOTE: A "dummy" client icon remains present on some devices after EKB 4.0 is installed.

Uninstall using the Settings panel

If downgrading to a preinstalled version:

On the device that contains the Enterprise Keyboard to be uninstalled:
Go to Settings -> Apps & Notification -> Enterprise Keyboard
Tap "Disable" then "Disable App" then "OK" to confirm the downgrade.
When uninstallation completes, the older EKB version number is displayed.
Tap the "Enable" button to use the older EKB version.
To use a different keyboard see the Manual Activation section.

If removing EKB installed as a user app:

On the device that contains the Enterprise Keyboard to be uninstalled:
Go to Settings -> Apps & Notification -> Enterprise Keyboard
Tap the "Uninstall" button.
When uninstallation completes, the standard Android keyboard becomes the default.
To verify, open "Apps & Notification" in the Settings panel and confirm that "Enterprise Keyboard" is not listed.

NOTE: Settings panel labels such as "Apps & Notification" vary by Android version.

Verify Installation

Verify installation/upgrade success

Go to Settings -> Apps & Notification -> Enterprise Keyboard
Verify that the version corresponds with the version installed.

NOTE: After installation, Enterprise Keyboard requires activation. To activate, go to:
Settings -> System -> Languages & input -> Virtual Keyboard -> Enterprise Keyboard

Manual Activation

The section covers direct activation of Enterprise Keyboard on a single device. If using one of the remote methods referenced above to activate and configure multiple managed devices, please see the Automated Activation section later in this guide.

To quickly determine whether Enterprise Keyboard has been activated:

1. Bring up the Android keyboard and long-press the spacebar.

2. If "Enterprise Keyboard" appears in a screen like the one below, tap its radio button (arrow) to set it as the default input device:

If the Enterprise Keyboard does not appear, proceed to the steps below.

Activate Enterprise Keyboard

1. Open the Settings panel on the device:

2. Scroll to and tap the "Language and input" control:

3. Place a check next to "Enterprise Keyboard" to enable it on the device. Uncheck other input devices to disable them, if desired. * This step might not be necessary* if Enterprise Keyboard was included with the device by default (and not downloaded as a user app or OS patch).

NOTE: To activate EKB on the EC30 and certain other devices:
Go to Settings -> System -> Languages & input -> Virtual Keyboard -> Enterprise Keyboard

4. Tap "Default" to set the default input device:

5. Tap the Enterprise Keyboard radio button to set it as default input device: Note: This panel also can be invoked by long-pressing the spacebar whenever the Android or Zebra keyboard is visible.

6. Tap the HOME key to exit the Settings panel.

Enterprise Keyboard is now ready to use with default settings.

EC30 Note: To activate EKB on an EC30 device, go to:
Settings -> System -> Languages & input -> Virtual Keyboard -> Enterprise Keyboard.

Enterprise Keyboard Settings

Following installation, Enterprise Keyboard settings can be changed through the Android Settings panel.

Change EKB settings:

1. Open the Settings panel on the device:

2. Tap the "Language and input" control:

3. Tap the Enterprise Keyboard Settings button to change settings:

4. On the Enterprise Keyboard Preferences panel, tap the setting(s) that require change: See the Customize section for more information about Enterprise Keyboard settings.

Automated Activation

Enterprise Keyboard 1.1 (and higher) can be configured remotely on multiple managed devices using Zebra's StageNow tools and the UI Manager service or an organization's own MDM system.

Actions to be executed on the Android Settings panel:

Open Language and input
Add a check for "Enterprise Keyboard" to enable it on the device
Select Enterprise Keyboard as the default input device
Select a language (if other than the system default)

Set as Default Input Device

Whether using the UI Manager service through Zebra's StageNow or EMDK tools, or if deploying Enterprise Keyboard from a company's own MDM, it is necessary to specify Enterprise Keyboard's package and class names to select it as the default keyboard on the device.

The required package and class names are shown as the values below, wrapped by the coding necessary for using one of Zebra's tools:

    
    <parm name="InputMethodPackageName" value="com.zebra.mdna.enterprisekeyboard"/>
    <parm name="InputMethodClassName" value="com.android.inputmethod.latin.LatinIME"/>

For additional information about usage and syntax, please refer to respective documentation.

Manual Deactivation

Enterprise Keyboard cannot be removed if it was included with the device operating system. However, it can be deactivated by reversing the activation process described in the Activation section. The steps below describe how to deactivate Enterprise Keyboard using the Android Settings panel.

Warning: This action renders Enterprise Keyboard inaccessible, including its scanning and other capabilities.

Deactivate Enterprise Keyboard on a device:

1. Open the Settings panel on the device:

2. Scroll to and tap the "Language and input" control:

NOTE: To deactivate EKB on the EC30 and certain other devices:
Go to Settings -> System -> Languages & input -> Virtual Keyboard -> Enterprise Keyboard

3. Remove the check next to "Enterprise Keyboard" to disable it on the device. If the Android keyboard is the only other input device, it automatically becomes the default input device and cannot be disabled.

Manual deactivation of Enterprise Keyboard is complete.

Automated Deactivation

Enterprise Keyboard 1.1 (and higher) can be deactivated on multiple managed devices using an organization's own MDM server in the same way as other Android apps. Alternatively, remote uninstallation can be accomplished through Zebra's EMDK or StageNow tools using the App Manager service.