Citrix Connections with HTML5

You can use Eggplant Gateway to facilitate Eggplant Functional and Eggplant DAI tests running against applications on a Citrix Virtual Desktop or applications.

info

Support for Citrix Virtual Desktops or applications temporary is available on Windows only.

Getting Started

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

• Check on the pre-requisite page.

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> \
  --enableBrowserConnection <EnableBrowserConnection> \
  --citrixSdkFilePath <CitrixSdkFilePath> \
  --browserExecutablePath <BrowserExecutablePath>

The available options are:

Key	Description
name	The name of the connection you want to create. You can freely choose this name.
storefront	The URL of the Citrix Storefront. It typically is a URL such as http://{server}/Citrix/{company name}.
username	The name of the Citrix user.
password	The password for the Citrix user.
application	The title of the Citrix application you want to launch, as listed in the Citrix Storefront application. This should be a full desktop environment.
screenshotInterval	The amount of time, in milliseconds, to wait between two subsequent captures of the Citrix framebuffer. The default value is 400.
screenResolution	The 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.
enableBrowserConnection	Indicates whether Citrix browser connection is enabled.
citrixSdkFilePath	The file path of the CitrixClientHTML5 SDK zip file.
browserExecutablePath	The path of the browser executable.

For example, the following command would create a connection to launch Citrix Virtual Desktop deployed on a 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 --enableBrowserConnection true --citrixSdkFilePath "C:\\temp\\CitrixWorkspaceAppHTML5SDK_25.5.10.46.zip" --browserExecuteblePath "C:\\Program Files (x86)\\Microsoft\\Edge\\Application\\msedge.exe"

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

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

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