Citrix Blogs

Citrix Virtual Apps and Desktops keyboard and IME configurations

Citrix Virtual Apps and Desktops offers rich configurations around keyboards and input method editors to support user and IT admin requirements, including languages and platforms. But configuring keyboards and IMEs correctly can be difficult because of factors like the variety of Citrix Workspace app clients, OS platforms, and more.

Keyboard Synchronization Mode

Citrix Virtual Apps and Desktops supports both client keyboards and VDA-side keyboards. If the client keyboard layout is different with VDAs, one common issue is which side of the keyboard layout is applied. The basic rules are:

  1. If the client is Citrix Workspace app for Windows, or set as Citrix Workspace app for Linux in Mode 1, the VDA-side keyboard will be applied, which means key input is determined by the VDA-side keyboard layout.
  2. If the client is a non-Windows Citrix Workspace app (Mac, Linux, iOS, or Android), the client keyboard will be applied, which means key input is determined by client side keyboard layout.
  3. If rules 1 and 2 don’t work, there might be incorrect configurations or Citrix Virtual Apps and Desktops doesn’t support that type of scenario. If this is the case, contact Citrix Customer Service.

Another common issue is which keyboard layout is set on the VDA side when users log in or reconnect to a session. Does it sync the client keyboard layout to VDA side? If it doesn’t, which keyboard layout is used? It depends on the keyboard synchronization mode settings. Citrix Virtual Apps and Desktops supports four keyboard synchronization modes:

All four synchronization modes are exclusive, and individual clients can only work in one of the modes. If a user has more than one client, I don’t recommend setting different synchronization modes for every client, even if you can. That causes confusion about which keyboard will be applied in session when logging in and reconnecting through a different client.

Using Mode 1 and Mode 2 may cause inconsistency between the client keyboard and the VDA-side keyboard. For example, the client-side keyboard might display the German keyboard icon, but the VDA side might display the English keyboard icon. Mode 1 and Mode 2 are normally used in deployments that use only one kind of keyboard layout and where the client side does not need to change the keyboard layout. For Windows OS, the VDA side default keyboard depends on the Windows OS language, the current user profile setting, and the Windows OS configurations. The keyboard layout in VDA is unknown in Mode 1, and using this mode is not recommended.

Citrix Workspace app Default Synchronization Mode
Citrix Workspace app for Windows Mode 3: Only synchronize VDA side keyboard with client default keyboard when logging in or reconnecting to the VDA
Citrix Workspace app for Mac Mode 3: Only synchronize VDA side keyboard with client default keyboard when logging in or reconnecting to the VDA
Citrix Workspace app for Linux Mode 3: Only synchronize VDA side keyboard with client default keyboard when logging in or reconnecting to the VDA
Citrix Workspace app for Android Mode 1: Use VDA side default keyboard
Citrix Workspace app for iOS Mode 3: Only synchronize VDA side keyboard with client default keyboard when logging in or reconnecting to the VDA
Citrix Workspace app for HTML5 Mode 3: Only synchronize VDA side keyboard with client default keyboard when logging in or reconnecting to the VDA

Table 1.1 Default Synchronization Mode for Citrix Workspace app

The sync mode supportability in different platform of Citrix Workspace app is below:

Citrix Workspace app Mode 1 Mode 2 Mode 3 Mode 4
Citrix Workspace app for Windows Yes Yes Yes Yes
Citrix Workspace app for Mac Yes Yes Yes Yes
Citrix Workspace app for Linux Yes Yes Yes Yes
Citrix Workspace app for Android Yes No No Yes
Citrix Workspace app for iOS No No Yes No
Citrix Workspace app for HTML5 No No Yes No

Table 1.2 Sync Mode Supportability in Different Platform of Citrix Workspace app

Mode 1: Configure “Use VDA side default keyboard when logging in or reconnecting to the VDA” Mode

This mode will not synchronize client keyboard layout to VDA-side when logging in or reconnecting to the VDA. There are two levels for configuring this mode. One is through modifying the local configure file installed with the Citrix Workspace app for each user. The other is through modifying default.ica in the StoreFront server. The StoreFront configuration has higher priority than the client local file configuration.

Configure in configuration file

Citrix Workspace app Configuration
Citrix Workspace app for Windows File path: %appdata%\ICAClient\APPSRV.ini Change setting in [WFClient]: KeyboardLayout=(Server Default)
Citrix Workspace app for MAC File path: ~/Library/Application Support/Citrix Receiver/Config Change setting in [WFClient]: KeyboardLayout=(Server Default)
Citrix Workspace app for Linux File path: ~/.ICAClient/wfclient.ini Change setting in [WFClient]: KeyboardLayout=(Server Default)
Citrix Workspace app for Android Does not support configuration file
Citrix Workspace app for iOS Does not support configuration file
Citrix Workspace app for HTML5 Does not support configuration file

Table 1.1.1.1 Use VDA side default keyboard Mode in Local File Configuration

Configure in UI

Citrix Workspace app for Windows

Open Advanced Preferences → Keyboard and Language bar → Keyboard layout page, and select the Don’t sync option after version 2103 to replace setting in configure file.

Configure in StoreFront

Path: C:\inetpub\wwwroot\Citrix\%StoreName%\App_Data\default.ica

Change setting in [WFClient]: KeyboardLayout=(Server Default)

Configure in group policy

Only Citrix Workspace app for Windows support group policy. The high priority is group policy > StoreFront configuration > UI configuration

Citrix Workspace app for Windows

Refer to the keyboard layout and language bar in Citrix Workspace app for Windows product document. It is supported after version 2103. Change settings as below:

Mode 2: Configure “Use specific keyboard when logging in or reconnecting to the VDA” Mode

This mode also supports the “Configure in configuration file” and the “Configure in StoreFront”. It uses the same configuration item in the “Configure in configuration file.” Users can set the specific keyboard layout listed in Appendix A. For example, set the specific keyboard to “French” in the configure file when logging in or reconnecting to the VDA and change the setting in [WFClient]: KeyboardLayout=French.

Mode 3: Configure “Only synchronize VDA side keyboard with client default keyboard when logging in or reconnecting to the VDA” Mode

This mode will synchronize the client keyboard layout to the VDA side once when logging in or reconnecting to the VDA. This mode also support the file configuration and StoreFront configuration.

This mode isn’t supported by all Citrix Workspace app types, as shown in the following table:

Citrix Workspace app Support
Citrix Workspace app for Windows Yes
Citrix Workspace app for MAC Yes
Citrix Workspace app for Linux Yes
Citrix Workspace app for Android No
Citrix Workspace app for iOS Yes
Citrix Workspace app for HTML5 Yes, but judge the client keyboard layout according to the current display language of the browser.

Table 1.3.1 Citrix Workspace app Capability for Only synchronize VDA side keyboard with client default keyboard when logging in or reconnecting to the VDA Mode

Configure in configuration file

It uses the same configuration item in the file configuration. You’ll change the setting in [WFClient]: KeyboardLayout=(User Profile).

Configure in UI

Citrix Workspace app for Windows

Open Advanced Preferences → Keyboard and Language bar → Keyboard layout page. Sync only once, when the session launches option after version 2103 to replace setting in configure file.

Configure in StoreFront

It uses the same configuration item in the StoreFront configuration. You’ll change the setting in [WFClient]: KeyboardLayout=(User Profile).

Configure in group policy

Only Citrix Workspace app for Windows support group policy. The high priority is group policy > StoreFront configuration > UI configuration

Citrix Workspace app for Windows

Refer to Keyboard layout and language bar in Citrix Workspace app for Windows product documentation. It is supported after version 2103. Change settings as below:

Mode 4: Configure “Synchronize VDA side keyboard with client keyboard dynamically in the VDA session” Mode

This mode will synchronize the client keyboard to the VDA side in the session every time the client keyboard is changed. It will always maintain keyboard consistency between the client and the VDA side. This mode does not support synchronizing of the VDA side keyboard to the client side if users change the keyboard in the VDA side. For CJK (Chinese, Japanese, Korean) users, this mode will enable them to use the client IME instead of the VDA-side IME. This mode is also called the Client Keyboard Synchronization and Generic Client IME feature, and you must configure both the client and VDA sides to enable this feature.

VDA Configurations

Configure in registry

It is obsolete. Use group policy instead of registry configuration.

VDA Configuration
Windows VDA Default On for Windows Server 2012, Windows 10. Default Off for Windows Server 2016 and Windows Server 2019. Need to add registry: HKLM\Software\Citrix\ICA\IcaIme\DisableKeyboardSync value = DWORD 0 This setting enables client keyboard synchronization dynamically and generic client IME.
Linux VDA Default Off. Enable client keyboard synchronization dynamically, run the command: /opt/Citrix/VDA/bin/ctxreg update -k “HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Citrix\LanguageBar” -v “SyncKeyboardLayout” -d “0x00000001” Enable generic client IME, run the command: /opt/Citrix/VDA/bin/ctxreg update -k “HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Citrix\LanguageBar” -v “SyncClientIME” -d “0x00000001”

Table 1.4.1.1.1 VDA Configuration for Synchronize VDA side keyboard with client keyboard dynamically in VDA session Mode

Configure in Citrix group policy

After Windows VDA version 1912 CU2 and 2006, Linux VDA 2012, VDA configuration support Citrix Group Policy. Refer to CTX312404 for more information. Enable VDA dynamic client keyboard layout sync and IME improvement is below:

Citrix Workspace app configurations

Configure in configuration file

Citrix Workspace app Configuration
Citrix Workspace app for Windows File path: %appdata%\ICAClient\APPSRV.ini Change setting in [WFClient]: LocalIME=1 or run command wfica32.exe /localime:off command from the Citrix Workspace app installation folder C:\Program Files (x86)\Citrix\ICA Client. Refer to Generic client Input Method Editors (IME).
Citrix Workspace app for MAC Does not support configuration file.
Citrix Workspace app for Linux Configure file path: /opt/Citrix/ICAClient/config/module.ini Section [ICA 3.0]: KeyboardSync=On Find more details on Keyboard layout synchronization.
Citrix Workspace app for Android Does not support configuration file.
Citrix Workspace app for iOS Does not support configuration file.
Citrix Workspace app for HTML5 This mode is not supported.

Table 1.4.2.1.1 CWA Configure for Synchronize VDA side keyboard with client keyboard dynamically in VDA session Mode

Configure in UI

Citrix Workspace app for Windows

Open Advanced Preferences → Keyboard and Language bar → Keyboard layout page. Allow dynamic sync option after version 2103 to replace setting in configuration file.

Citrix Workspace app for MAC

Open Citrix Workspace app Preferences → Keyboard and select Use local keyboard layout, rather than the remote server keyboard layout. Refer to Keyboard layout synchronization for more details.

Citrix Workspace app for Android

Select Settings → Keyboard → Enable client IME and Sync Keyboard. Find more details on Keyboard layout synchronization.

Citrix Workspace app for iOS

Select Settings -> Keyboard Options -> Keyboard Layout Sync. Find more details on Keyboard layout synchronization.

Configure in StoreFront

Only Citrix Workspace app for Windows support StoreFront configuration.

Citrix Workspace app Supported
Citrix Workspace app for Windows Yes
Citrix Workspace app for MAC No
Citrix Workspace app for Linux No
Citrix Workspace app for Android No
Citrix Workspace app for iOS No
Citrix Workspace app for HTML5 No

Path: C:\inetpub\wwwroot\Citrix\%StoreName%\App_Data\default.ica

Change setting in [WFClient]: LocalIME=1

Configure in group policy

Only Citrix Workspace app for Windows support group policy. The high priority is group policy > StoreFront configuration > UI configuration

Citrix Workspace app for Windows

Refer to Keyboard layout and language bar in Citrix Workspace app for Windows product document. It is supported after version 2103. Change settings as below:

Non-Windows Citrix Workspace app support

Enable Unicode Keyboard Layout Mapping for Windows VDA

The difference in keyboard layout among operating systems can cause key mapping issues. For example, the Mac France keyboard layout is different from Windows. Citrix Virtual Apps and Desktops uses “Unicode Keyboard Layout Mapping” technology to make rule 2 from earlier in this post happen. Windows VDAs need to enable “Unicode Keyboard Layout Mapping” feature if users have key input issue when using a non-Windows version of Citrix Workspace app.

Configure in registry

Registry configuration is obsolete, but still support. Recommend to use group policy instead.

Add the following registries in Windows VDA to enable this feature:

HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\CtxKlMap\EnableKlMap value = DWORD 1

HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\CtxKlMap\DisableWindowHook value = DWORD 1

Please note, non-Windows versions of Citrix Workspace app will always follow rule 2 if the feature is enabled, even if the keyboard language is different between the client and the VDA. For example, Citrix Workspace app for Mac uses a U.S. English keyboard, but Windows VDA use a France keyboard layout. The key mapping will use the U.S. English keyboard. Mode 4 Synchronize VDA side keyboard with client keyboard dynamically in VDA session will always try to keep the keyboard layout as similar as possible between Citrix Workspace app and the VDA to reduce the key input issue.

Configure in Citrix group policy

After Windows VDA version 1912 CU2 and 2006, Linux VDA 2012, VDA configuration support Citrix Group Policy. Refer to CTX312404 for detail. Enable VDA dynamic client keyboard layout sync and IME improvement is below:

Recommend configuration

Citrix Workspace app Configuration
Citrix Workspace app for MAC Sync mode 4 and Enable Unicode Keyboard Layout Mapping
Citrix Workspace app for Linux Sync mode 1 key input follow rule 1 which means that key input is determined by VDA side keyboard layout.
Citrix Workspace app for Android Sync mode 4 and Enable Unicode Keyboard Layout Mapping
Citrix Workspace app for iOS Sync mode 4 and Enable Unicode Keyboard Layout Mapping
Citrix Workspace app for HTML5 Sync mode 3 (default) and Enable Unicode Keyboard Layout Mapping

Generic Client IME for Chinese, Japanese, and Korean (CJK) Users

The Generic Client IME feature provides a seamless input experience for CJK users if they want to use the client IME instead of the VDA side for a better user experience in the scenarios:

The Generic Client IME feature is enabled with keyboard synchronization mode 4. Citrix IME for CJK languages will be applied automatically in the VDA side when the user selects an IME in the client side.

Touch Keyboard in Windows 10

Windows 10 has touch keyboard to support tablet mode. Users can switch the keyboard layout from a touch keyboard using keyboard synchronization mode 4. Another setting is enables the keyboard to automatically pop up while opening the app with CWAs. Learn more about this configuration.

Other Related Configurations

Show/Hide Remote Language Bar

This feature only applies to Citrix Virtual Apps. For Windows VDA, the remote language bar will be displayed as default if the remote VDA has more than one keyboard layout. The default setting is showing the remote language bar as below:

You can hide the remote language bar with the following configurations:

Citrix Workspace app Configuration
Citrix Workspace app for Windows Refer to Language Bar
Citrix Workspace app for MAC Refer to Language Bar
Citrix Workspace app for Linux Not supported
Citrix Workspace app for Android Not supported
Citrix Workspace app for iOS Not supported
Citrix Workspace app for HTML5 Not supported

Configure in UI

Citrix Workspace app for Windows

Open Advanced Preferences → Keyboard and Language bar → Language bar page, select No, hide the language bar. Default option is Yes

Citrix Workspace app for MAC

Open Citrix Workspace app Preferences → Keyboard and uncheck Show the remote language bar for the published applications. Default setting is checked.

Show/Hide Keyboard Layout Switch Pup-up Message Box

A message box will pop up in keyboard synchronization Mode 4 in Windows VDA if users switch the keyboard layout in the client side as below:

Configure in registry

Registry configuration is obsolete, but still support. Recommend to use group policy instead.

Add the following registries in Windows VDA to enable this feature:

HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\IcaIme\HideNotificationWindow DWORD = 1

Configure in Citrix group policy

After Windows VDA version 1912 CU2 and 2006, Linux VDA 2012, VDA configuration support Citrix Group Policy. Refer to CTX312404 for detail. Hide keyboard layout switch pop-up message box is below:

101, 103 and 106 Keyboards

Most people use a 101 keyboard type. The 103 keyboard type, which supports two additional special keys, is used in Korea, and the 106 keyboard is used in Japan. The keyboard type is determined when a session starts.

103 Korean Keyboard

106 Japanese Keyboard

The following table shows how to configure Japanese 106 keyboard.

Citrix Workspace app Japanese 106 Keyboard Support
Citrix Workspace app for Windows Support to detect client keyboard type automatically when session starts. Or manually configure: File path: “%appdata%\ICAClient\WFCLIENT.ini” Change setting in [WFClient]: KeyboardType=106 Keyboard (Japanese)
Citrix Workspace app for MAC File path: ~/Library/Application Support/Citrix Receiver/Config. Change setting in [WFClient]: KeyboardType=106 Keyboard (Japanese)
Citrix Workspace app for Linux File path: ~/.ICAClient/wfclient.ini. Change setting in [WFClient]: KeyboardType=106 Keyboard (Japanese)
Citrix Workspace app for Android Not supported
Citrix Workspace app for iOS Not supported
Citrix Workspace app for HTML5 Not supported

Appendix A. Supported Keyboard Name

Keyboard Name in Configure File Windows Keyboard Layout Identifier Keyboard Name in Windows 10
Belgian Dutch 0x00000813 Dutch (Belgium) Belgian (Period) keyboard
Belgian French 0x0000080C Dutch (Belgium) Belgian French keyboard
Brazilian (ABNT) 0x00000416 Portuguese (Brazil) Portuguese (Brazil ABNT) keyboard
British 0x00000809 English (United Kingdom) United Kingdom keyboard
Canadian English (Multilingual) 0x00001009 English (Canada) US keyboard
Canadian French 0x00000C0C English (Canada) Canadian French keyboard
Croatian 0x0000041A Croatian (Croatia) Standard keyboard
Czech 0x00000405 Czech Czech keyboard
Danish 0x00000406 Danish Danish keyboard
Dutch 0x00000413 Dutch (Netherlands) Dutch keyboard
Finnish 0x0000040B Finnish Finnish keyboard
French 0x0000040C French (France) French Keyboard
German 0x00000407 German (Germany) German keyboard
Greek 0x00000408 Greek Greek keyboard
Hungarian 0x0000040E Hungarian Hungarian keyboard
Icelandic 0x0000040F Icelandic Icelandic keyboard
Italian 0x00000410 Italian (Italy) Italian keyboard
Italian (142) 0x00010410 Italian (Italy) Italian (142) keyboard
Japanese (JIS) 0xe00010410 Japanese Microsoft IME
Korean 0xe00010412 Korean Microsoft IME
Latin American 0x0000080A Spanish (Mexico) Latin Americon keyboard
Norwegian 0x00000414 Norwegian (Bokmål) Norwegian keyboard
Polish (Programmers) 0x00000415 Polish Polish (Programmers) keyboard
Polish (214) 0x00010415 Polish Polish (214) keyboard
Portuguese 0x00000816 Portuguese (Portugal) Portuguese keyboard
Romanian 0x00000418 Romanian (Romania) Romanian (legacy) keyboard
Russian 0x00000419 Russian Russian keyboard
Slovak 0x0000041B Slovak Slovak keyboard
Slovenian 0x00000424 Slovenian Slovenian keyboard
Spanish 0x0000040A Spanish (Spain) Spanish keyboard
Spanish variation 0x0001040A Spanish (Spain) Spanish variation keyboard
Swedish 0x0000041D Swedish (Sweden) Swedish keyboard
Swiss French 0x0000100C Fench (France) Swiss French Keyboard
Swiss Geraman 0x00000807 German (Switzerland) Swiss German keyboard
Turkish (F) 0x0001041F Turkish Turkish F keyboard
Turkish (Q) 0x000041F Turkish Turkish Q keyboard
US 0x00000409 English (United States) US keyboard
US-Dvorak 0x00010409 English (United States) United States-Dvorak keyboard
US-International 0x00020409 Dutch (Netherlands) United States-International keyboard

Exit mobile version