Keyboard Profiles

Most Frame customers have unique use cases and often require highly-customized environments. Sessions can be tailored to fit a variety of scenarios from the Session settings page, which now includes our “Keyboard profiles” feature. Keyboard profiles consist of custom keyboard shortcuts and language settings that can be applied at the account level, based on the needs of your end users. Administrators can view, add, and modify keyboard profiles by navigating to the “Settings” page of the desired account and clicking on the “Session” tab.

../_images/keyboard_prof1.png

Use the links below to skip to specific parts of the documentation, if needed:

Add a Keyboard Profile

  1. If you would like to create a new keyboard profile from scratch, simply click on the blue “Add” link in the upper right corner of the “Keyboard profiles” section.

../_images/keyboard_prof1a.png
  1. Select the language of the endpoint devices and enter a name for your new profile. In this example, we will select the Serbian language and name our keyboard profile accordingly since the Windows OS in this account Sandbox has been configured to use Serbian as the default language. You can define multiple keyboard profiles, each corresponding to a specific language, as configured in your Frame account Sandbox.

Important

The operating systems in the tabs correlate with the user’s endpoint operating system. For instance, if your users are accessing Frame/Frame App from Windows machines and Macs, you will want to add your custom keyboard mapping under both the “Windows” and “OS X” tabs.

../_images/keyboard_prof3.png
  1. If you already know which custom keyboard mappings you would like to apply, you can move on to the keyboard mapping section. If not, you can simply click “Add” to create your new keyboard profile and edit later.

Edit a Keyboard Profile

  1. Administrators can edit an existing keyboard profile by clicking on the kebab menu adjacent to the desired profile and selecting “Edit.”

../_images/keyboard_prof4.png

Default Keyboard Profiles

You can edit your default keyboard profile for your account as desired, however, the default keyboard cannot be deleted from the account. If you would like to reset the default profile back to its original state, simply click on the adjacent kebab menu and select “Reset.”

../_images/keyboard_prof_def.png

Add a New Keyboard Mapping

New keyboard mappings can be applied to existing or new keyboard profiles. It is important to note that some key combinations will not work in the Frame session or Frame App simply because they are already being intercepted by the endpoint operating system (OS) or browser. For instance, CTRL + ALT + DEL would not carry into a Frame session on a Windows-based endpoint because that key combination would be intercepted by the OS. Similarly, CMD + P would be intercepted by the Safari browser on MacOS as a print command and would not carry into Frame browser-based session. For this reason, administrators should use the operating system tabs to apply their custom key mappings for one or more of the four supported endpoint operating systems their end users might be accessing Frame/Frame App with.

  1. Start by adding/editing your keyboard profile (as shown in the sections above). Once you have opened the keyboard profile window, select the desired operating system tab (we’re using OS X in this example) and then click on the blue “Add new keyboard mapping” link.

../_images/keyboard_prof2.png
  1. A new line will appear in the list of shortcuts:

../_images/keyboard_map2.png
  1. Click on the left side of the line to specify the client shortcut, as shown below. In this example, we’re using the left command (⌘) key as our “modifier key” and entering the 4 key as our “other key.”

../_images/keyboard_map3.png

Setting the left ⌘ key plus the 4 key as our client side (local) shortcut.

  1. Click “Save” once you have specified the first portion of the key mapping.

  2. Next, click on the right side of the line to add the corresponding shortcut/action.

    1. Shortcut: The first (shortcut) option can be used to designate a corresponding shortcut within the Frame session. For example, we could instruct Frame to interpret the left command (⌘) key combined with the 4 key as the left Windows (⊞) key plus the 4 key within the session. This could be helpful for users accessing Windows apps on Frame from a local Mac endpoint. Once you have designated the desired in-session shortcut using the buttons, click “Save.”

      ../_images/keyboard_map4.png
    2. Terminal action: Select the blue “Switch to a Terminal action” link if you would prefer your shortcut be tied to a specific Frame terminal action. For this example, we will use our key mapping to open terminal settings within the Frame session. Once you have selected the desired action from the drop-down menu, click “Save.”

      ../_images/keyboard_map5.png
  3. After adding your desired key mappings under the appropriate operating system tabs, click “Add/Save” in the bottom right corner of the window to apply the changes to your keyboard profile.

Edit/Delete Keyboard Mappings

To edit a default keyboard mapping (or any existing keyboard mapping) simply click on the component of the mapping you wish to change (the client shortcut or the remote shortcut/action) and modify as desired.

../_images/keyboard_map_edit.png

Click “Save” when you are finished.

../_images/keyboard_map_edit2.png

If you wish to delete an existing keyboard mapping, simply click on the delete (🗑) icon adjacent to the mapping you wish to delete.

../_images/keyboard_map_del.png

Be sure to click the “Save” button in the bottom right corner of the window. If you accidentally deleted a keyboard mapping, simply click “Cancel.”

Important

Any changes made to keyboard profiles will take effect after the next session start for end users. Administrators are not required to publish their Sandboxes to see changes propagate to end user sessions.

Troubleshooting

In the event that an administrator has correctly configured a keyboard profile and finds that one or more of their shortcuts is not working in the session, there are some tools available for Windows-based accounts to verify that the shortcut is passing through to the session from the local endpoint. If your Sandbox and workloads are running Windows, consider following the steps below before filing a support case. If you are using a different operating system, please reach out to our support team for help.

  1. First, download and run KeyboardStateView for Windows from NirSoft’s website. This application displays the current state and virtual key code of every key you press and does not require any installation process or additional files.

Additional Languages

NirSoft provides instructions and zip files for additional languages on their website. Dutch, French, German, Greek, Japanese, Portuguese, and many other languages are available for testing.

  1. KeyboardStateView will display every key that you press in the application’s UI, even when the application is not in focus. If you want to view the state of all keys, simply turn off the ‘Show Only Keys Pressed In Last seconds’ option under the “Options” menu.

You can use this tool to provide more specific information to your Nutanix Frame support personnel when creating a support case.