Skip to main content

Required Registry Changes for Citrix Record/Replay

You must set some registry entries for all Eggplant Performance Controller and Injector Windows Machines as described below. The Registry changes are required for all injectors that will be used for Citrix tests.

The CitrixRegistrySetup.exe program is called on first use of the Citrix Recorder and automatically creates the entries (as described below) if they do not exist in the Registry (on the system under test used to create the recording).

The program can also be run manually on the desired Injector machines. It is included in the product installation bin/ folder and will work provided you have administrator permissions to change the Registry.

If you do not use the CitrixRegistrySetup.exe program, you can make the changes manually.

Manually Creating the Registry Change

To manually create the registry entries, follow these steps:

  1. Open the Windows Registry Editor or type regedit.exe into the Run prompt.

  2. For 64-bit platforms, navigate to HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Citrix\ICA Client and for 32-bit, switch to HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\ICA Client.

  3. Right-click on the ICA Client folder and select New > Key from the drop-down list. Name this as CCM.

  4. Inside the CCM folder you just created, add the following DWORD values by right clicking New > DWORD Value.

    • Name: AllowSimulationAPI
    • Type: REG_DWORD
    • Data: 1

    If this registry setting is not enabled, the virtual User will get unexpectedly disconnected from the Citrix server soon after the start of the test run. Usually a FatalCommunicationException (Citrix client is not connected to the server) error is saved to the virtual user's event log and the user's Citrix viewer will display the message Virtual Driver Error.

    • Name: AllowLiveMonitoring
    • Type: REG_DWORD
    • Data: 1

    This registry setting is required to ensure that screenshots are fully supported.

  5. Navigate to one level up, HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client and locate the Engine > Configuration > Advanced >Modules > GfxRender folder, then add the following DWORD value:

    • Name: UseD3DHybrid
    • Type: REG_DWORD
    • Data: 0

This registry setting is required to ensure that screenshots are fully supported

The Citrix runtime and Citrix recorder will attempt to set the above registry entries automatically, but they will only succeed if either UAC is disabled or the process is running as an administrator. However, recent versions of Citrix Workspace do not function this way when running as an Administrator and display the Unsupported function error instead.