Citrix Virtual Apps and Desktops

Windows - Keyboard & IME Supportability Tool

This is a self-service command line tool which can diagnose relevant problems to the keyboard and Input Method Editor.

In order to meet a variety of user requirements, provide platform versatility, and provide users with personalized needs, the functions of the keyboard and Input Method Editor (IME) rely on different configurations and capabilities in VDAs and Citrix Workspace apps.

An incorrect setting in VDA or client side might result in unexpected input behaviors.

However, Citrix provides the recommended settings for some common usage scenarios, and these recommendations are also included in the diagnose results.

With this tool, below categories of issues can be identified:

  • Keyboard type inconsistency: will check VDA keyboard type and client keyboard type to confirm if there is inconsistency. For example, VDA is using 101 English keyboards, but the client is using a Japanese 106 keyboard. This diagnostic is targeted for JP 106/109 keyboard, and KO 103/106 keyboard use cases.
  • Keyboard layout sync mode inconsistency: will check the keyboard layout sync settings, registry settings, group policies, and sort out problems in sync mode configurations in a given environment.
  • Client keyboard layout and VDA keyboard layout inconsistency: will check if the client keyboard layout is the same as VDA keyboard layout
  • Remote Language Bar is now showing for application sessions: will check if the remote language bar is showing when end users launch an application session and are using more than 1 keyboard layout.

This command line tool is hosted in Windows VDA - CtxKbImeDiagnostics.exe. The command line interfaces are as below:

Interface Description Note
CtxKbimeDiagnostics show diagnostic result only for current ICA session If the user has admin privilege, it shows diagnostic for all active ICA sessions. If the user has no admin privilege, it shows diagnostic for current users’ ICA sessions
CtxKbimeDiagnostics [-v] show setting information and diagnostic result for the current session If the user has admin privilege, it shows diagnostic for all active ICA sessions
CtxKbimeDiagnostics [-v] [-s Session_Id] show setting information and diagnostic result for this session  
CtxKbimeDiagnostics [-s Session_Id] specific a session and show the respective diagnostic result for this session Admin Privilege can query other ICA sessions/Normal user can only query their own ICA sessions
CtxKbimeDiagnostics [-s Session_Id] [-v] specific a session and show all setting information and diagnostic result for this session Admin Privilege can query other ICA sessions. Normal user can only query their own ICA sessions
CtxKbimeDiagnostics [-h] show supported args/parameters and example “help” interface
CtxKbimeDiagnostics [-V] show current tool version  

Note:

In this version, only CWA Windows as a client is supported.

Windows - Keyboard & IME Supportability Tool

In this article