Skip to main content

Citrix Virtual Desktop

You can use the Eggplant Gateway for the Citrix Virtual Desktops to run Eggplant Functional and Eggplant DAI tests on applications running on a Citrix Virtual Desktop.

info

Support for Citrix Virtual Desktops is available on Windows only.

Getting started

Before you can use the Eggplant Gateway with Citrix Virtual Desktops, you'll need:

info

Eggplant Gateway Citrix connection are now able to support Citrix Workspace version 23.9 and 22.03 (LTSR).

Setup Eggplant Gateway for Citrix environment

To set up Eggplant Gateway for Citrix SUT connection, run the following command in Administrator mode:

./epgw setup citrix

Creating a connection

To set up a connection to a Citrix Virtual Desktop, run the following command:

./epgw add citrix \
  --name <name> \
  --storefront <storefront> \
  --username <username> \
  --password <password> \
  --application <application> \
  --screenshotInterval <screenshotInterval> \
  --screenResolution <screenResolution>
KeyDescription
nameThe name of the connection you want to create. You can freely choose this name.
storefrontThe URL of the Citrix Storefront. It typically is a URL such as http://{server}/Citrix/{company name}.
usernameThe name of the Citrix user.
passwordThe password for the Citrix user.
applicationThe title of the Citrix application you want to launch, as listed in the Citrix Storefront application. This should be a full desktop environment.
screenshotIntervalThe amount of time, in milliseconds, to wait between two subsequent captures of the Citrix framebuffer. The default value is 400.
screenResolutionThe resolution of at which to initialize the Citrix desktop. The default value is 1600x900, resulting in a Citrix desktop with a width of 1600 pixels and a height of 900 pixels.

For example, to create a connection which will launch Citrix Virtual Desktop that deployed to Citrix Server:

./epgw add citrix --name test_citrix --storefront https://domain.com/Citrix/CitrixStorefront --username "testuser" --password "testuser123" --application "Windows Server 2019" --screenshotInterval 400 --screenResolution 1600x900
caution

Keysight has tested the Eggplant Gatway for Citrix using screen the 1280x960 and 1600x900 screen resolutions and a screenshot interval of 400. Keysight only supports testing Citrix Desktops with Eggplant using these resolutions and screenshot intervals. Do not use different values, unless instructed to do so by Eggplant support.

Connecting to Eggplant Functional

Follow these steps to log in to your Citrix environment and establish a connection to Eggplant Functional:

  1. Start Eggplant Functional
  2. Run epgw connect <name>, where name is the name of your Gateway connection. For example, epgw connect citrix-desktop

The Eggplant Gateway will now log in to your Citrix environment, establish a connection and connect to Eggplant Functional.

Setting up a VNC server for your Citrix application

Alternatively, you can set up a VNC server for your Citrix application. To do so:

  1. Run epgw vnc <name>, where name is the name of your Gateway connection. For example, epgw vnc citrix-desktop

The Eggplant Gateway will now log in to your Citrix environment, establish a connection and start a VNC server at port 5900.

You'll need to manually add your device to the connection list in Eggplant Functional.

Last updated on