Workspace Environment Management

WEM health check tool

The WEM health check tool is a standalone tool that checks the status of the WEM components and helps you to identify and resolve configuration issues with your WEM deployment. Citrix.WEM.Health.Check.Tool is installed with the WEM agent and the WEM infrastructure service. You need the local administrator privilege to use this tool. To collect the logs for troubleshooting purposes, enable the Debug mode and then retrieve the logs after the problem occurs.

Home page

The Home page includes the following configurations:

  • Configurations for both the WEM agent and the WEM infrastructure server. Select the Name, the Agent Type, the Agent version, and the Join type.
  • The pre-requisite for the Join type can be either an AD joined or a Non-domain joined type.
  • You can enable the Force debug mode or the Debug mode for WEM agent and WEM infrastructure server respectively.
  • When you enable the Force debug mode, the debug mode is turned on for the agent regardless of the settings specified in the Administration console.
  • For the changes to take effect on the WEM agent or the WEM infrastructure server immediately, you can restart the Citrix WEM agent Host Service and VUEMUIAgent.exe or the Citrix WEM Infrastructure Service respectively.
  • Retrieve logs lets you retrieve and save the logs in a zipped folder as a package. You can then check the package saved on your local machine.

Infrastructure server

To check the configuration of the WEM infrastructure server, open the tool and check the basic information of the infrastructure server.

  • Enable the Debug mode of the infrastructure server.
  • Click the Start check button to check the configurations of the infrastructure server.
  • Click Retrieve logs to retrieve logs, Open report file to view the detailed report, and Check again to re-check the configurations.

The following components are considered to generate the health check report.

  • Windows Firewall configuration
  • Agent Broker service
  • Cache sync service
  • Admin service
  • License server


  • Make sure that the agent cache resides in a persistent location. Using a non-persistent cache location can cause potential cache synchronization issues, excessive network data usage, performance issues, and so on.
  • We recommend that you set the directory service timeout based on your connection time.

The following services are required for the WEM agent to function as expected. Make sure that the services are running and the startup type for each service is set to automatic.

  • System event notification service
  • Citrix WEM agent host service
  • Citrix WEM user logon service
WEM health check tool