Virtual Desktop Infrastructure Support

Last modified: June 22, 2022

Overview

Use this guide to deploy Alteryx Designer via persistent and non-persistent Virtual Desktop Infrastructure (VDI).

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

Note that we are evaluating support for additional (non-Citrix) configurations. In the meantime, we can work with you to help configure non-Citrix environments.

Application Virtualization is not supported.

Persistent VDI (Citrix-only) Requirements

  • Use dedicated non-shared system resources like CPU and RAM.
  • Must meet Alteryx Designer system requirements.
  • Designer version 2022.1.1.25127 or later.
  • Citrix Virtual Apps and Desktops 7.
  • Compatible with Designer-supported Windows OS.
  • Alteryx License Server (ALS) is optional (if you don't want your client machines to communicate outside of your network).

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 later.
  • Alteryx License Server (ALS) version 2021.4.1.04899 or later.
  • Citrix Virtual Apps and Desktops 7.
  • Compatible with Designer-supported Windows OS.
  • ALS installed on a non-Citrix server so that it’s a static server and so that the Citrix environment can communicate with it on Port 7070.

Get Started

To get started with non-persistent VDI deployment…

  1. Install Alteryx Designer version 2022.1.1.25127 or later.
  2. Before deploying to end-users, launch Designer as Administrator to connect to your License Server.
    • 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
<?xml version="1.0" encoding="UTF-8"?>
<SystemSettings>
    <Engine>
        <InterfaceLanguage>English</InterfaceLanguage>
    </Engine>
</SystemSettings>
<Environment>
    <LicensingMode>LocalLicensingServer</LicensingMode>
    <LocalLicensingServerUrl>http://SERVERNAME:7070/request</LocalLicensingServerUrl>
</Environment>

Best Practices and Recommendations (Non-Persistent VDI)

  • As of Alteryx License Server 2021.4.1.04899, you can use the borrowIntervalMax configuration option to set when a served seat is returned to the License Server (in days):
    -config -set licensing.borrowIntervalMax=[n+u]
    For example, to set a served seat to be returned after 2 days, use:
    -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

What happens if I have more non-persistent VDI users than available seats (including non-VDI users that need their licenses)?

To prevent running out of seats, 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.

Command-line Options

Command-line options are available for IT departments to install and activate Alteryx without the need for user intervention. This is helpful for installs to large user bases, software updates pushed to computers on a regular schedule, or automated setup of new desktop machines. Go to Use Command-Line Options for more details.

Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.