How to configure a VDA to use Unicode Keyboard Layout mapping for non-Windows Receivers

How to configure a VDA to use Unicode Keyboard Layout mapping for non-Windows Receivers

book

Article ID: CTX226335

calendar_today

Updated On:

Description

Details:

As of XenApp and XenDesktop 7.15 CU3, VDAs support Unicode keyboard layout mapping for non-Windows Citrix Receivers. This is an enhancement to the keyboard layout mapping feature available in previous VDA versions. 

There have been customer issues in which characters typed using the client’s local keyboard layout produce incorrect character output in the published resource on the VDA. For example, User1 changes the local keyboard layout from English to German. User1 then changes the server-side keyboard to German. Even though both keyboard layouts are German, they might not be in sync causing incorrect character output.
 
The issue occurs because the mechanism of non-Windows client keyboard input is based on Unicode characters instead of scan code and Unicode injection. This feature enhancement provides VDA-side support for Unicode keyboard layout mapping to resolve these types of issues.

Benefits:
The client-side keyboard layout is always effective no matter what keyboard layout at VDA side is.
This enhancement benefits Receiver for Mac, Receiver for Linux, HTML5 Receiver, Receiver for iOS, and Receiver for Android.


Instructions

There is no user interface method for configuring this feature enhancement. Configuration of this this feature enhancement is performed through the system registry on the Server OS VDA.
 
Unicode Keyboard Layout Mapping Feature
This feature is not enabled by default. To enable Unicode keyboard mapping between the non-Windows client and the VDA:
In the VDAs’ system registry, navigate to:
HKEY_LOCAL_MACHINE/SOFTWARE/Citrix
Create the following key:
HKEY_LOCAL_MACHINE/SOFTWARE/Citrix/CtxKlMap
In this key, create the DWORD entry EnableKlMap with a value of 1
The feature can be disabled by setting EnableKlMap to a value of 0
 
Unicode Keyboard Layout Mapping Compatible Mode
Setting the EnableKlMap to a value of 1 will hook a Windows API that reloads a new Unicode keyboard layout map when the user changes keyboard layout on the VDA side. Some published applications may not be able to be hooked, so in addition to enabling EnableKlMap, the feature can also be configured for compatibility mode.
In the VDAs’ system registry, navigate to:
HKEY_LOCAL_MACHINE/SOFTWARE/Citrix/CtxKlMap
In this key, create the DWORD entry DisableWindowHook with a value of 1
Compatibility mode can be disabled by setting DisableWindowHook to a value of 0
 

Environment

Caution! Using Registry Editor incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Be sure to back up the registry before you edit it.

Issue/Introduction

As of XenApp and XenDesktop 7.15, VDAs support Unicode keyboard layout mapping for non-Windows Citrix Receivers. This is an enhancement to the keyboard layout mapping feature available in previous VDA versions.