Using Zebra EKB Designer

Enterprise Keyboard Designer 1.9

Overview

Each Enterprise Keyboard Designer project contains one or more key layouts, which are defined as any grouping of keys. Layouts are created using “drag and drop” or the “grid layout” option and are saved as a single encrypted file. The project name becomes the file name, with “.encrypted” as the file extension (i.e. myTC75Layout.encrypted).

Change Log

  • ADDED in v1.4: Create "canned text" to appear in a list for easy selection (requires EKB 3.4 or later).
  • ADDED in v1.4: Set a default layout to display on input field focus (EKB 3.4+).
  • ADDED in v1.9: RepeatKeys function causes a specified keyCode to be repeated when long-pressing the key (EKB 3.9+).
  • ADDED in v1.9: Macros feature combines multiple keyCodes, presses or Actions into a single key-press (EKB 3.9+).
  • ADDED in v1.9: Undo function (CTRL-Z) reverses up to 10 operations.
  • ADDED in v1.9: Deploy button exports the custom key-layout definition file (an encrypted file) to a USB-connected device.
  • ADDED in v1.9.8: Consolidates target-selection menu by device skin and screen resolution, ehnances UI.

General Usage Notes

  • The Enterprise Keyboard Designer must be used only in full screen mode.
    Resizing the Enterprise Keyboard Designer application window after starting a Project can cause unpredictable behavior.
  • To display EKD layouts on a device, Enterprise Keyboard must be installed on that device and set as the default input source.
  • The "Switch-Scan" Press Action (intended to invoke the EKB "scan" layout) sometimes brings up a different layout.
  • When opening a layout using the "Switch-abc," "Switch-123," "Switch-#*/" and "Switch-Scan" Actions, the layout tab name shown is sometimes NOT that of the layout being displayed.
  • Use of switch actions (Switch-abc, Switch-123, etc.) requires the respective tab(s) (Alpha, Numeric, etc.) to be enabled in Enterprise Keyboard Preferences on the target device(s).
  • The order of layout names shown in the EKD layout menu can vary from the list returned by the GET available keyboard layouts intent API. See Enterprise Keyboard APIs for details.
  • Deployed layouts sometimes look slightly different than their appearance in the device simulator.
  • Do NOT deploy empty key layouts; they can cause Enterprise Keyboard to behave unpredictably.
  • When using DataWedge to switch layouts, the EKB fixed layout is sometimes shown briefly or until the focus changes again. See DataWedge Notes, below.
  • When custom layouts are displayed, all EKB settings, preferences and functions are suspended.
  • If a custom layout is the default, an IME change request from the Google keyboard sets that custom layout as the default.

DataWedge Notes

The DataWedge service is included on every Zebra device and when enabled, allows any application on the device to acquire data from various input sources. The following rules apply when DataWedge is used.

  • DataWedge default layout settings always takes precedence over those set by EKD.
  • If DataWedge is enabled at the time a custom layout file is deployed, the EKD default setting is ignored and the Enterprise Keyboard fixed layout is shown when an input field gets focus.
  • If DataWedge is enabled after a custom layout had been set as the default, the DataWedge setting takes precedence (and is enabled).
  • If DataWedge is disabled after a custom layout file is deployed, the custom file must be redeployed to use that custom file as the default layout.

Note: In this guide, the terms “button” and “key” are used interchangeably.

Also See

I. Create Project

  1. Launch the Enterprise Keyboard Designer utility:
  2. Click the “NEW KEYBOARD PROJECT” button:
  3. Enter a project name and click “Submit” or press ENTER (recommended 15 character max):

  4. Select a target device from the drop-down and click the “Confirm” button:

    To target EC50/EC55 devices, Zebra recommends selecting "TC5-Series" from the list.
    To target MC22/MC27 devices, Zebra recommends selecting "MC3-Series" from the list.

When the Project name is displayed in the upper-left corner of the main designer screen (as seen in Step 1, below), EKD is ready to create custom layouts within the Project.

Note: Once a project is created, its target device and other project-level settings cannot be changed.

II. Create Layout(s)

Before beginning a layout, please read the notes below.

Layout Notes

  • The Grid layout option automatically fills the layout with a matrix of equally spaced buttons based on the specified number of columns and rows. The new layout is placed along the left and bottom edges of the simulator and can be resized (and buttons relocated) as needed.
  • Grid Layout option offers the best way to create layouts quickly.
  • All buttons should be placed within the bounds of the layout background. A layout must not be resized so that it hides any key or button.
  • When switching from one layout to another during design, a thin white line is sometimes visible at the bottom or sides of the layout background in the device simulator. This has no effect on the simulated display.
  • Button positions sometimes shift slightly when switching layouts during design.

IMPORTANT: Layout-creation UI elements become available when applicable to the layout being created.

Grid Usage Notes

  • Button and layout property settings are enabled only after saving the Grid layout.
  • The "Keys" panel is disabled during Grid-layout creation. To enable, save and import the layout.
  • Once a grid is created, its properties–including the number of columns and rows– cannot be changed.
  • For the best layout performance, Zebra recommends the following:
    • Horizontal layouts: max rows = 5; max columns = 15
    • Vertical layouts: max rows = 15; max columns = 5
  • Departure from recommended values might cause unpredictable button positioning or layout performance.
  • Layout drag-and-drop and resize features are disabled when using Grid Layout.
  • Button-drag and -resize features are enabled only after saving the Grid Layout.
  • Style Properties can be configured when using drag-and-drop or grid layout functions.
  • When switching between layouts in a project, resizing or changing layout position might effect a Grid layout design.
  • IMPORTANT: Switching the Layout Type (from Grid to Manual or vice-versa) clears the existing layout.
  • Changes to Grid Type and Properties CANNOT be undone using CTRL-Z.

Undo Notes

The undo function allows the keyboard designer to reverse as many as 10 of the most recent actions or commands, subject to the limitations listed below.

  • Press CTRL-Z to undo the most recent operations(s) from newest to oldest.
  • There is no "Redo" function; changes made using CTRL-Z must be reverted manually.
  • The Undo "stack" stores as many as 10 actions, and works only within the active layout.
  • The Undo stack is cleared when:
    • Switching layouts
    • Creating a new layout
    • Clearing the current layout
    • Switching layout type (e.g. from Grid to Drag-and-Drop or vice-versa)
  • Changes to Grid layout properties cannot be undone.
  • Actions performed on multi-selected keys cannot be undone.
  • Undo can be used to clear an entire layout (after user confirmation). This action cannot be undone.

Starting a Layout

  1. From the main designer screen, click the menu button in the upper-left corner (if necessary):
    Click image to enlarge, ESC to exit.

  2. Click the [+] icon to create a new layout: Click image to enlarge, ESC to exit.

  3. Select the device orientation and click the “Confirm” button:
    NOTE: Orientation option NOT applicable to CC600, CC6000, MC33, MC93, PS20, TC8x, VC80x or VC83x devices. Click image to enlarge, ESC to exit.

  4. Enter a layout name and press ENTER.
    NOTE: Layout names are case-sensitive, may contain only alpha-numeric characters and must be unique within a project.
    Zebra recommends layout names contain a maximum of 15 characters. Click image to enlarge, ESC to exit.

  5. The Designer window now shows Project Name > Layout Name in the title bar and an active Layout Settings panel.
       a. Select the Layout Type and enter layout properties (for Grid Layout; see Grid Properties, below).
       b. For grid layouts, press Save Grid Layout button when finished.
    NOTE: Once a grid layout is saved, its properties cannot be changed. Click image to enlarge, ESC to exit.

    NOTE: Buttons shown in the sample images are for illustration purposes. They DO NOT appear in layouts created with EKD.

  6. When Grid Layout is selected and saved, Layout and Button Properties panels become active and a grid is created with the letter "A" populated in all buttons (as shown below).
    NOTE: The "Keys" panel is disabled during Grid-layout creation. To enable, save and import the layout.
       a. To begin, enter desired layout properties (see Section IV for layout property details).
       b. Click on a button and enter desired button properties (see Section III for button property details).
       c. Repeat Step 6b until all buttons are configured as desired.
       e. SKIP TO STEP 10. Click image to enlarge, ESC to exit.

  7. If precise button location is desired:
       a. Select Manual Layout from the Create Layout panel. NOTE: This clears the current layout.
       b. Click on simulated device screen and drag to create a layout background.
       c. Resize and reposition background as needed: Click image to enlarge, ESC to exit.

  8. Drag the desired key(s) from the key panel (at right) to the layout, dragging to resize and/or reposition as needed: Click image to enlarge, ESC to exit.
  9. Repeat Step 8 until the layout is configured as desired.
       b. Click on a button and enter desired button properties (see sections below for button property details).
       c. Repeat Step 8b until all buttons are configured as desired.
  10. Click "Save Layout" button when finished.
    NOTE: To set layout as the default (to appear whenever EKB is used), click on the layout's star icon in the Main Menu:
    NOTE: Setting the default layout from EKD requires Enterprise Keyboard 3.4 or later on the device.

Continue to the next sections to configure button and layout properties and deploy layout(s).

Grid Properties

See Zebra device specs for device resolution information.

III. Set Button Properties

Button Positioning

Buttons can be positioned and resized within a layout by dragging manually, by using the keys on the host computer's keyboard, or by setting their coordinates in the Layout Properties panel.

Note: In this guide, the terms “button” and “key” are used interchangeably.

Manual Positioning

Double-click a button to select it and adjust its position and properties. Selected key(s) are indicated by a red border, and supported input fields for Button Properties are enabled. Changes to most properties appear immediately on the selected button(s).

To move a key, drag it within the key layout background or double-click it (to select) and move it using the arrow keys on the host computer keyboard. To resize a key, drag the key's right and bottom edges within the key layout background or select it and edit the "Layout Properties" fields in the Button Properties panel.

The Layout Properties section of the Button Properties panel refers to the left and top offsets and the width and height of the selected button. All measurements are in pixels. If the layout was created using drag-and-drop, at least one key must be selected from the key panel and dropped into the layout before these properties can be set. Double-click a key to change its default property settings. If the layout was created using Grid Layout, double-click on box(es) in the grid to configure button properties.

(Button) Layout Properties

  • Left - Layout offset (in pixels) from the left edge of the screen. Value must fall between the layout's left and right boundaries.
  • Top - Layout offset (in pixels) from the top edge of the screen. Value must fall between the layout's upper and lower boundaries.
  • Width - Specifies the width (in pixels) of the selected button. Value must be less than the layout width (min = 50).
  • Height - Specifies the height (in pixels) of the selected button. Value must be less than the layout height (min = 50).

IMPORTANT: The button layout properties above DO NOT support multi-key selection; behavior is unpredictable.

Text Properties

  • Text - Specifies the button label (displayed text) for the selected button (max = 5); must be blank if an image is selected as button background.
  • Font Size - Specifies the font size (in points) of the button label text for the selected button (min = 10; max = 25).
  • TextColor - Specifies the color of the button label text for the selected button.
  • TextStyle – Specifies the style of the button label text for the selected button. Drop-down values: Normal, Bold, BoldItalic, Italic.
  • SecondaryText - Specifies the secondary button label displayed in the upper-right corner of the selected button. Indicates the key’s output or Action when long-pressed (max = 2); must be blank if an image is selected as button background.

Text Properties Usage Notes

  • Button property minimum and maximum value rules are the same for individual and multi-key selections.
  • Deleting a group of multi-selected keys using the “Delete” key on the host computer’s keyboard is not supported. Keys must be deleted individually.
  • The text input field accepts all characters, including Chinese.
  • All key-label text (including secondary text) is ignored if a key image is specified.
  • The font size used for a button label is dependent on the size of the button being labeled. To avoid automatic button resizing, select a font size appropriate for the size of the button.
  • The number and size of characters in the button text and secondary text fields should correspond to the key size to avoid automatic size changes.
  • The position of secondary text can exceed button height (and be positioned out of view) if button is too small. To avoid this issue, increase button height.

Action Properties

  • PressAction - Defines the action taken when the selected Button is pressed and released. Accepts only the predefined command strings in drop-down menu (see below).
    Overridden by ActionDown property. Default = no action.
  • LongPressAction – Defines the action taken when the selected button is pressed and held. Accepts only the predefined command strings in drop-down menu (see below).
    Overridden by ActionUp property. Default = no action.
  • ActionDown - Defines the action to be taken immediately upon button press (before it is released). Accepts only the predefined command strings in the drop-down menu (see below).
    Overrides PressAction property. Default = no action.
  • ActionUp - Defines the action to be taken when the selected key is released (after being pressed). Accepts only the predefined command strings in the drop-down (see below).
    Overrides LongPressAction property. Default = no action.

IMPORTANT: The Action properties above DO NOT support multi-key selection.

Button Actions

Button Actions supported by EKD include predefined command strings for generating keyEvent output and for switching the key layout currently displayed on the device.

Perform keyEvent Action - Used to generate a particular keyEvent or output a character. Enter the key and value in key-value format from among the standard Android keyEvent values. The keyEvent for a key can be captured inside JavaScript onKeyDown events and outputs the value, if associated. The drop-down action commands are selected using the steps below.

To assign a keyEvent value:

  1. In the Action section of the Button Properties panel, select the desired Action from the drop-down: Click image to enlarge, ESC to exit.
  2. For keyCodes (i.e. key in caps, Unicode, etc), a box pops up similar to the one below.
    Enter a single value corresponding to the type of Action selected:
    Click image to enlarge, ESC to exit.
  3. Repeat Steps 1 and 2 until each button contains the desired Action.
  4. Click "Save Layout" button to store the project settings.
  5. Click "Save Project" to create a project file for deployment.
  • Predefined command strings - Enter an Android keyEvent value in the pop-up:
    • key in caps - Outputs an upper-case letter corresponding to the keyValue entered.
    • key - Outputs the lower-case character corresponding to the keyValue entered.
    • Canned text - Displays a list of predefined responses (see below).
    • UC - Outputs the Unicode character corresponding to the Unicode value entered.
  • Actions to switch the layout - Use the key-value pairs below to switch to a specific layout.
    • Switch-abc - Switches to the Enterprise Keyboard standard alpha-numeric layout.
    • Switch-123 - Switches to the fixed numeric layout.
    • Switch-Scan - Switches to the “scanning button" layout.
    • Switch-#*/ - Switches to the “#*/” (symbolic) layout.
    • Switch-CustomLayout - Switches to a custom layout (enter a valid layout name in the pop-up).
    • Scan Trigger - Scans a barcode using DataWedge. Supported only with Press Action. Note: DataWedge must be configured before use of this command. Disabled if DataWedge APIs are protected. More about DataWedge Secure APIs.
      Also see DataWedge EKB guide.

See all Unicode characters
See all Android keyEvent values

Note: All entries are case-sensitive.

Macros

Multiple events can be assigned to a single key-press using Macros. Any key can be configured to send any number of keyCodes, events or Actions as listed below.

Supported Key-press Actions:

  • PressAction
  • LongPressAction
  • ActionDown
  • ActionUp

Supported Events:

  • Send keyEvent
  • Send uppercase or lowercase keyCode or Unicode character
  • Switch to a fixed or custom layout
  • Set a delay between Actions (required*)

*A delay of at least 500ms is required between key events to ensure desired execution order.

To Assign a Macro:

  1. Select a key to which to assign a Macro.
  2. In the Action section of the Button Properties panel, select "Macros" from the desired Press Action drop-down (Press, LongPress, ActionDown or ActionUp):
    Click image to enlarge, ESC to exit.
  3. In the input box that appears click the drop-down.
    A partial list of available key events is shown in Step 4. Click image to enlarge, ESC to exit.
  4. From the drop-down, select an event (and enter a value if applicable).
    Then click the "Add" button: Click image to enlarge, ESC to exit.
  5. Select "Delay" and enter a value of at least 500 (ms) between each key event.
  6. Repeat Steps 4 and 5 until all desired events are added to the Macro as desired.
    Click image to enlarge, ESC to exit.
  7. When finished, click the "Save" button: Click image to enlarge, ESC to exit.

The Macro is now assigned to the selected key

To Edit or Delete a Macro

  1. Click on the key containing the Macro to edit or delete.
    The list of the Macro's key events appears.
  2. Click the "X" for each key event to be removed from the sequence: Click image to enlarge, ESC to exit.
  3. Add events as desired as in Steps 4 and 5 above.
    If deleting the Macro, remove all events.
  4. Click the "Save" button to finish.

WARNING: If all events are deleted from a Macro, the key will perform no function.

Canned text

A list of Canned text or predefined responses can be assigned to any key and appear in a pop-up list when that key is pressed. This can help improve the speed and accuracy of responses when using Enterprise Keyboard. Tapping on a predefined response enters the text into the focused field as if it had been typed in manually.

IMPORTANT: Use of the plus sign (+) in Canned text list items might cause unpredictable behavior.

Example Responses:

  • "I'm in a meeting...please call back later"
  • "Unable to talk now...please send a text"
  • "Application busy...try again later"
  • "Please refer to patient record"
  • "Item out of stock"

Note: This feature requires Enterprise Keyboard 3.4 or later on the device.

To create Canned text response(s):

  1. Create (or select) a button in the current layout.
  2. In the Action section of the Button Properties panel, select "Canned text" from the drop-down: Click image to enlarge, ESC to exit.
  3. Enter a desired response in the pop-up: IMPORTANT: Use of the plus sign (+) in Canned text list items might cause unpredictable behavior.
  4. Click "Add" to store the response and add another.
  5. Repeat Steps 3 and 4 until all responses are stored.
  6. Click "Save" to store all responses and exit pop-up.

Canned text responses are stored and deployed with the layout.

NOTE: Setting the default layout from EKD requires Enterprise Keyboard 3.4 or later on the device.

To edit or delete Canned text Response(s):

  1. Open the key layout project that contains the response list(s) to be modified.
  2. In the layout, select the button that contains the response list(s) to be edited.
  3. In the Action section of the Button Properties panel, select "Canned text" from the drop-down: Click image to enlarge, ESC to exit.
    A pop-up appears with the list of responses currently stored with that button: Click image to enlarge, ESC to exit.
  4. To Delete response(s), click the "X" for the response(s). Then skip to Step 8.
    WARNING: Responses are deleted immediately. This action cannot be undone.
  5. To Edit, click the edit button for the response to be edited:
    Click image to enlarge, ESC to exit.
  6. Edit the response as desired and click Submit.
    IMPORTANT: Use of the plus sign (+) in Canned text responses might cause unpredictable behavior.
  7. Repeat Steps 5 and 6 until all Canned text responses appear as desired.
  8. Click Save to store changes and exit the pop-up.

Canned text responses are stored and deployed with the layout.

NOTE: Setting the default layout from EKD requires Enterprise Keyboard 3.4 or later on the device.

Repeat Keys

EKD 1.9 (and later) adds three Action Properties for repeatedly sending keyCodes when a key is long-pressed. Enterprise Keyboard 3.9 or later is required.

Click image to enlarge, ESC to exit.

  • Repeat keyinCaps continuously sends an uppercase letter corresponding to the key being long-pressed as long as the key is held down, regardless of whether the shift key was used.
  • Repeat key continuously sends a lowercase letter corresponding to the key being long-pressed as long as the key is held down.
  • Repeat UC continuously sends the specified Unicode character when the key is long-pressed as long as the key is held down.

Note: These actions apply only to Long-Press Action properties.

Style Properties

Changes to these settings appear immediately in the device simulator unless otherwise noted.

  • Preview - When True, displays the value of a key when pressed (default = True).
  • Transparency - Used to select the transparency for the selected key from 0 (opaque) to 100 (fully transparent) (default = opaque).
  • Button Color - Used to select the color of the selected key using the standard Windows color picker (default = blue).
  • ColorPressed - Used to select the color of the selected key when the key is pressed using the standard Windows color picker.
  • Image - Used to select an image to fill the space of the selected key. When the layout is saved, selected image(s) are embedded within the “.encrypted” file. Supports .jpg and .png image files. Zebra recommends using files of 100 KB or less for optimal layout performance. File name must begin with an alpha-numeric character.
  • ImagePressed - Used to select an image to be displayed when the button is pressed. After selection, the image appears on the device simulator when the button is pressed. When the layout is saved, selected image(s) are embedded within the “.encrypted” file. Supports .jpg and .png image files. Zebra recommends using files of 100 KB or less for optimal layout performance. File name must begin with an alpha-numeric character.

Style Properties Usage Notes

  • Button property minimum and maximum value rules are the same for individual and multi-key selections.
  • Deleting a group of multi-selected keys using the “Delete” key on the host computer’s keyboard is not supported. Keys must be deleted individually.

Feedback Properties

Applies only to devices that support vibration.

  • HapticFeedback - Used to control whether the device vibrates when the selected button is clicked. Set the value to “true” to vibrate (default = false).
  • Duration - Used to enter the duration (in ms) of vibration when the “Haptic Feedback” property is set to true (min = 40 (default); max = 1000).

NOTE: Button property minimum and maximum value rules are the same for individual and multi-key selections.

Multi-key Selection

Use the CTRL key on the host computer's keyboard to select multiple keys simultaneously. Selected key(s) are indicated by a red border, and supported input fields for Button Properties are enabled. Changes to properties appear immediately on the selected button(s). Properties are described in their relevant sections above.

Click image to enlarge, ESC to exit.

These properties can be assigned to multiple buttons simultaneously:

  • Text
  • Secondary Text
  • Font Size
  • Text Color
  • Text Style
  • Preview value
  • Transparency
  • Button Color
  • Color pressed
  • Haptic Feedback
  • Duration

These properties CANNOT be assigned to multi-selected keys:

  • Button action properties:
    • Press Action
    • Long Press Action
    • Action Up
    • Action Down
    • Image
    • Image pressed
  • Layout properties:
    • Left
    • Top
    • Width
    • Height

Multi-key Usage Notes

  • Button property minimum and maximum value rules are the same for individual and multi-key selections.
  • Deleting a group of multi-selected keys using the “Delete” key on the host computer’s keyboard is not supported. Keys must be deleted individually.
  • Button layout (i.e. width, height, etc.) and action properties (Press, LongPress, etc.) MUST NOT be changed using multi-key selection; behavior is unpredictable.

IV. Set Layout Properties

Style Properties

  • Background Color - Specifies the color of the key layout. Changes appear in the layout immediately after clicking OK in the color picker.
  • Transparency - Used to select of the transparency from 0 (opaque) to 100 (fully transparent) of the key layout Background using a slider. Changes appear immediately.

Simulator Properties

  • Status Bar - Used to show/hide the Status bar (which contains notifications and system icons) at the top of the device simulator screen. The layout “Top” coordinate changes based on this setting, which depends on status bar setting configured at the application level. Must be hidden for full-screen applications.
  • System Bar - Used to show/hide the System (navigation) bar at the bottom of the device simulator screen. The layout “Top” coordinate changes based on this setting, which depends on System bar setting configured at the application level. Must be hidden for full-screen applications.

Save Layout

To save the current layout data, click the “Save Layout” button in the lower-right corner of the main designer screen or the “Save Grid Layout” button in the Layout Properties panel.

Save Project

To save the current key layout project:

  1. Click the “Save Project” button.
    A dialog appears indicating the location of the saved “.encrypted” file: EKD's "Save Project" button invokes a dialog showing the default save-to folder.
  2. Take note of the save directory for reference during deployment.

Delete a Key

  1. In the layout that contains the key to be deleted, double-click on the the key to be deleted; the selected key is surrounded by a dotted red line.
  2. Press the “Delete” key on the host computer’s keyboard. A confirmation dialog appears.
  3. Click “Yes” on the confirmation dialog to delete.

NOTE: Keys must be deleted individually; multi-select is not supported for key deletion.

Clear a Layout

  1. In the layout to be cleared, Click the red “Clear Layout” button.
  2. Click “Yes” to confirm the deletion of all layout elements in the current layout.
    WARNING: This action cannot be undone.

Set Default Layout

If a definition file contains more than one layout, any one of the layouts can be set as the default, to be automatically invoked whenever the Enterprise Keyboard is displayed on the device.

Also see important DataWedge Notes later in this document.

To set the default layout:

  1. From the main designer screen, click the Main Menu button in the upper-left corner.
    A list of available layouts is displayed: The current default layout is indicated by a solid star icon.
  2. Click the star icon corresponding to the layout to be set as the default.
  3. Click the "Save Layout" button to store settings.
  4. Click "Save Project" to create a project file for deployment.

The selected layout will be the default on any device to which the file is deployed.

To remove a layout as the default:

  1. From the main designer screen, click the menu button in the upper-left corner.
    A list of available layouts is displayed.
  2. Click the star icon to deselect it.
  3. Click the "Save Layout" button to store settings.
  4. Click "Save Project" to create a project file for deployment.

The new layout preference will be activated on any device to which the file is deployed.

V. Deploy Layout(s)

The data for custom key layout(s) is stored in the custom key-layout definition file, an encrypted file generated by the Enterprise Keyboard Designer. This file contains information about key locations, key-value assignments, etc. for each key layout created. This single file can contain as many as 20 layout groups, each of which defines one key layout. NOTE: An app can access only a single layout file on the device; all layouts required for a device MUST be stored in that single file.

Deployment methods:

  • Manual push from host PC to USB-connected device using the "Deploy" button or adb commands
  • Mass deployment using StageNow and (optionally) an Enterprise Mobile Management (EMM) system

Single Device Deployment

Deploy button requirements:

  • Development host:
  • Target device:
    • Enterprise Keyboard 3.9 (or later) installed and enabled as default input source
    • Connected to host via USB
  1. Press the "Deploy" button (see below) to push the current layout to the USB-connected device.
    Layout file is saved to /enterprise/device/settings/ekb/config on the device. Click image to enlarge, ESC to exit.
  2. If an older config file already exists, a message like the image below is displayed.
    Press "Yes" to proceed, "No" to cancel. Click image to enlarge, ESC to exit.

Custom key layouts are available on the device immediately upon deployment.

Platform Notes:

  • On Zebra ET40, ET45, TC15, TC53 (and other 6375- and 6490-platform devices), Android restrictions prohibit the adb “push” command for file deployment to devices, even when the device is in developer mode. The EKD deployment feature for custom layouts is therefore not functional for such devices.
  • To deploy custom layout files to 6375-platform devices, use a desktop file explorer and copy files to:
    /sdcard/Android/data/com.zebra.mdna.enterprisekeyboard/files/config/
  • Administrators can continue to mass-deploy custom layout files to:
    /enterprise/device/settings/ekb/config

Mass Deployment

The process below assumes that Enterprise Keyboard is already installed on target device(s).

Note: If EKB is not already installed on the target device(s), add steps for deploying and installing EKB first, then begin at Step 1, below.

To mass-deploy a layout file:

  1. Locate the key layout definition file (i.e. LayoutProjectName.encrypted) on the development host computer.
    By default, the files are saved on the host PC in the download directory of the current user:
    c:\Users\userName\Downloads\LayoutProjectName.encrypted
    NOTE: When clicking EKD's "Save Project" button, the default save-to folder is shown as in the image below: Click image to enlarge, ESC to exit.
  2. In the "Language and input" Settings panel on the device, set Enterprise Keyboard as a default input source.
  3. Push definition file to the device folder:
    /enterprise/device/settings/ekb/config/
    ~OR~
    /sdcard/Android/data/com.zebra.mdna.enterprisekeyboard/files/config†

Custom key layouts are available on the device immediately upon file deployment.

† Deployment to this secure destination requires use of the "Deploy file for an application" File Action of MX File Manager (or the equivalent EMM functionality). In the TargetApplicationAndFileName parameter, enter the value: com.zebra.mdna.enterprisekeyboard/config/<yourLayoutFileName>.encrypted in the deployment Profile.

Note: If custom layouts are to be accessed by Enterprise Browser and/or DataWedge, layout files copied to /enterprise/device/settings/ekb/config/ must grant full ("777") read, write, and execute permissions for all users.

Also See

VI. Switch Layouts

This section explains the program logic involved when switching layouts with Android intents when focus of an input field changes.

For programming guidance, see Enterprise Keyboard APIs.
For changing layouts through DataWedge, see the DataWedge EKB configuration guide.

Requirements

  • EKB v3.2 installed and activated on the target device(s) and set as the default input source
  • A single EKD layout file (i.e. myProject.encrypted) in the following device folder:
    /enterprise/device/settings/ekb/config/
  • Layout file must contain ALL layouts being used by apps on the device

Use Case 1

This case describes an Android app with two text input fields. Substitute sample names shown below with those in the deployed layout definition file (i.e. myLayout.encrypted). More info.

  • editText1 input field uses the standard Enterprise Keyboard fixed layout, which includes numeric, alpha-numeric, scan and symbol keyboards manually switchable by the user as needed.
  • editText2 input field uses a custom layout made with EKD that contains keys specifically designed for a particular type of input.

Program logic for switching between standard and custom layouts according to changes from onFocus listener:

When the editText1 field gets focus, send the following intents to display the EKB fixed layout:

  1. Send ENABLE intent to Enterprise Keyboard fixed layout.
  2. Send RESET to the custom EKB layout.
  3. When the onReceive() method receives a result type value of DEFAULT_LAYOUT, send a SHOW intent to the EKB fixed layout to display it.

When the focus changes to edittext2, send the following intents to show the custom layout:

  1. Send a SET intent to set the custom layout.
    Note: If the custom layout name is not known, send a GET intent before the calling the onFocus change listener to receive a list of all available layout names in the layout file. Then send the SET intent with the name of the desired layout.
  2. On focusOut of editText1, send ENABLE "false" intent the EKB fixed layout to disable it.

IMPORTANT: Enterprise Keyboard must be enabled if the application goes to the background to avoid a device user resetting the layout from outside the app.

Use Case 2

This case describes an Android app with two text input fields, both requiring custom layouts alternated within a specific time interval:

  • editText1 input field uses a custom layout called numericLayout.encrypted
  • editText2 input field uses a custom layout called functionLayout.encrypted

Program logic for switching between two custom layouts according to changes from onFocus listener:

When the editText1 field gets focus, send the following intents to display numericLayout:

  1. Send a SET intent for numericLayout.encrypted to set the custom numeric layout.
    Note: If the custom layout name is not known, send a GET intent before the calling the onFocus change listener to receive a list of all available layout names in the layout file. Then send the SET intent with the name of the desired layout.

When the focus changes to edittext2, send the following intents to show the custom layout:

  1. Send a SET intent for functionLayout.encrypted to set the custom function-key layout.
    Note: If the custom layout name is not known, send a GET intent before the calling the onFocus change listener to receive a list of all available layout names in the layout file. Then send the SET intent with the name of the desired layout.

IMPORTANT: Enterprise Keyboard must be enabled if the application goes to the background to avoid a device user resetting the layout from outside the app.

Layout Switching Usage Notes

  • Switching layouts is supported on Zebra Enterprise Keyboard only.
  • Do NOT use the terms shown below as custom names; they are reserved for default Enterprise Keyboard layouts:
    • abc
    • 123
    • scan
    • #*/
    • Scantrigger
    • switch-abc
    • switch-123
    • switch-#*/
    • switch-scan
    • customLayout
    • key-[any Content]

Import an EKD Project

Layout projects can be saved and modified later for use on different devices, adapted for different applications or screen sizes and appended with additional keys and/or key layouts.

To import a project:

  1. On the Enterprise Keyboard Designer’s launch screen, click the “IMPORT KEYBOARD PROJECT” button.
  2. Navigate to and double-click the project (“.encrypted” file) to import.
  3. Select the target device using the drop-down menu and click the “Confirm” button.
  4. Click the EKD menu button to view a list of layouts available for editing.
  5. Select the layout to be edited and click the edit icon. The layout is displayed in the device simulator and its name is displayed the top-left corner.
  6. Edit the layout as desired.
  7. To add a new layout to the project, click the [+] icon on the EKD menu and follow steps in the Create Layout(s) section.
  8. Repeat Step 7 until the layout is configured as desired.
  9. Click "Save Layout" button to store the new project settings.
  10. Click "Save Project" to create a project file for deployment.

Also See