Skip to main content

Alteryx Designer on Citrix

Overview

Use this guide to deploy Alteryx Designer via persistent and non-persistent Virtual Desktop Infrastructure (VDI). VDI licensing is not floating, concurrent, or network-based. Go to our EULA for complete details.

Requirements and Prerequisites

Alteryx now supports persistent and non-persistent VDI deployment via Citrix. We tested and validated a Citrix configuration on:

  • Citrix VDA 7.15 CU8

  • FSLogix Apps 2.9.7979.62170

Important

Application Virtualization is not supported.

Persistent VDI (Citrix-only) Requirements

Non-Persistent VDI (Citrix-only) Requirements

  • Use dedicated non-shared system resources like CPU and RAM.

  • Must meet Alteryx Designer system requirements.

  • Alteryx Designer Admin (recommended) or Non-admin version 2022.1.1.25127 or newer (refer to Version Support Policy for currently-supported versions).

  • Citrix Virtual Apps and Desktops 7.

  • Compatible with Designer-supported Windows OS.

  • (Legacy Licensing) Alteryx License Server (ALS) version 2021.4.1.04899 or newer (version 2024.2.1 is the most recent). The addition of Alteryx Licensing Server may require changes to an existing software agreement.

  • (Legacy Licensing) Alteryx Licensing Server installed on a static, non-Citrix server with communication enabled between the Citrix environment and Alteryx Licensing Server on Port 7070.

Get Started with VDI Deployment

The non-persistent VDI deployment process varies depending on your Alteryx account type.

Get Started (Alteryx One Account)

Alteryx One accounts with Designer versions 2025.1 or later no longer use the License Server to deploy non-persistent VDI.

To get started with non-persistent VDI deployment…

  1. As a Workspace Admin, first invite users to join your Alteryx One workspace. Invited users receive an invitation email message. For additional information about user management, go to Manage Users.

  2. Users will need to follow the link in their email to accept the invitation.

  3. Once users access their Alteryx One accounts, they can use the Alteryx One download center to download and activate Designer.

Get Started (ALS and Legacy Licensing)

Important

The Alteryx License Server (ALS) deployment option is available for customers on legacy license keys until Designer version 2025.2. Please note that License Server releases ended with version 2024.2.1.

We recommend deployment via Alteryx One going forward (available for Designer version 2025.1 and newer).

To get started with non-persistent VDI deployment…

  1. Install Alteryx Designer version 2022.1.1.25127 or newer (refer to Version Support Policy for currently-supported versions).

  2. Before you deploy to end-users, launch Designer as Administrator to connect to your License Server.

    Warning

    • Do not set an email address.

    • Do not activate the license.

    • If Alteryx Designer is licensed, remove the license.

  3. You now have a RuntimeSettings.xml in %PROGRAMDATA%\Alteryx configured to use LocalLicensingServer mode and connects Designer to your ALS instance. Note that the Server URL value depends on your environment.

  4. Deploy the preconfigured RuntimeSettings.xml to your users.

Example RuntimeSettings XML File

<?xml version="1.0" encoding="UTF-8"?>
<SystemSettings>
    <Engine>
        <InterfaceLanguage>English</InterfaceLanguage>
    </Engine>
    <Environment>
       <LicensingMode>LocalLicensingServer</LicensingMode>
       <LocalLicensingServerUrl>http://SERVERNAME:7070/request</LocalLicensingServerUrl>
    </Environment>
</SystemSettings>

Best Practices and Recommendations (ALS and Legacy Licensing)

Important

The Alteryx License Server deployment option is available for customers on legacy license keys until Designer version 2025.2. Please note that License Server releases ended with version 2024.2.1.

We recommend deployment via Alteryx One going forward (available for Designer version 2025.1 and newer).

  • As of Alteryx License Server 2021.4.1.04899, you can use the borrowIntervalMax configuration option to set when a served license is returned to the License Server (in days):

    -config -set licensing.borrowIntervalMax=#d

    For example, to set a served license to be returned after 2 days, use:

    flexnetlsadmin -server http://localhost:7070/api/1.0/instances/~ -authorize admin [Password] -config -set licensing.borrowIntervalMax=2d

    Refer to the License Server guide on the Downloads & Licenses portal for more information.

  • For non-persistent VDI environments, we recommend that you script and schedule command-line activation and deactivation in accordance with a Windows session. If the scheduled task fails, the borrow interval will still release the license.

    - AlteryxActivateLicenseKeyCmd.exe delete

  • We recommend that you use the Admin version of Designer to avoid the manual steps of moving folders and files required with the Non-admin version.

FAQ

How do Database and DCM Connections work on a VDI?

Persistent VDI

Database and DCM Connections should be preserved and accessible from session to session.

Non-Persistent VDI

  • These are only available from session to session if built into the base image for the user:

    • Database Drivers

    • DSN Connections

    • In-Database (In-DB) Connections (unless using In-DB File connections saved to a network location)

    • Saved Connection Alias (Managed User or System) Database Connections

  • DSN-less connections are part of the workflow but rely on the driver being included in the base image, as noted above. Password encryption must be Hide or Encrypt for the User.

  • Shared database connections, as well as DCM connections, need to be re-synced at the start of a session.

  • DCM connections can be synced to an Alteryx Server or external vault (if one is available) before the session ends. At the start of the next session, the DCM connections can be synced from the Alteryx Server or an external vault.

ALS and Legacy Licensing FAQ

Why would one of my licensed users be unable to access a license from the license server?

They may not have returned the license when they last ended a session. We recommend that you run this command (from the Alteryx installation\bin directory) when a non-persistent user signs out of their session:

AlteryxActivateLicenseKeyCmd.exe delete

What happens if I have more non-persistent VDI users than available licenses?

Alteryx isn’t able to license the Designer instance in the new VDI instance.

When using non-persistent environments, can a user have more than 1 license activated if they have signed in to or out of multiple VDI instances?

Yes, this is why we recommend that you use a license deactivation script on sign-out when you use non-persistent environments. This prevents scenarios where a user has signed in to multiple environments or activated multiple licenses at one time.

In this section: