Keyboard layout sync failures due to Microsoft API limitation

Keyboard layout sync failures due to Microsoft API limitation

book

Article ID: CTX575028

calendar_today

Updated On:

Description

Symptom 1:  In a Windows Server VDA session the keyboard layout might not sync with the client keyboard layout when launching session with the "Sync only once - when the session launches" in the Citrix Workspace App Windows/Linux/Mac keyboard setting.

Symptom 2:  In a Windows 10/11, Windows Server 2016/2019 VDA session, East-Asian language keyboard layout or input method editor (IME) might not be added to keyboard list on Windows login UI, when launching session with "Sync only once - when the session launches" in CWA Windows/Linux/Mac keyboard setting.

Symptom 3: In a Windows Server VDA session, Citrix Generic client IME might not work on Windows login UI, when launching session with "Allow dynamic sync" in CWA Windows/Linux/Mac keyboard setting.

Symptom 4:  In a Window Server VDA session, "Sync only once - when the session launches" of CWA Windows is not working for Simplified Chinese IME.

Symptom 5:  In a Windows VDA session, synced client keyboard might not be getting selected by default on Windows login UI.

Symptom 6:  In a Windows VDA session, on selecting and cancelling the ctrl+Alt+del option, the keyboard layout is set to VDA default layout.

Environment

Citrix is not responsible for and does not endorse or accept any responsibility for the contents or your use of these third party Web sites. Citrix is providing these links to you only as a convenience, and the inclusion of any link does not imply endorsement by Citrix of the linked Web site. It is your responsibility to take precautions to ensure that whatever Web site you use is free of viruses or other harmful items.

Resolution

Disclaimer:  Screenshots reflect Citrix test environment data, not customer information.

The workaround is to manually set the keyboard layout, follow the steps outlined below based on the symptom indicated above:

Symptom 1 workaround: SL image 1.png

Symptom 2 workaround:
  • There is not a workaround.  However, tryo to copy/paste for username, and generally, password will not include East-Asian language characters (i.e. Chinese, Japanese and Korean characters).
Symptom 3 workaround:
  • There is not a workaround.  Manually set keyboard layout or IME from the keyboard layout list of the Windows UI to use Microsoft IME instead (it will need to be installed in the VDA).
SL image 2.png
Symptom 4 workaround: Symptom 5 workaround:
  • Manually set the keyboard layout or IME from the keyboard layout list of the Windows UI (respective keyboard layouts or IMEs will need to be installed in the VDA).
SL image 3.png
Symptom 6 workaround:

Problem Cause

These issues are caused by Microsoft API limitations to setting keyboard layout.

Additional Information

Reference articles related to Microsoft issues: