Skip to main content

Install and Use Alteryx License Server

Alteryx License Server Compatibility

Alteryx License Server is compatible with Designer and Server. It is not compatible with Connect, Promote, and Alteryx Analytics Hub.

With Alteryx License Server, license administrators can locally deploy Alteryx products. The License Server operates offline so users can activate and deactivate Alteryx product license keys without having to connect to the Alteryx online activation service.

For Flexera License Server product documentation, visit the Alteryx Downloads and Licenses portal and go to Downloads & Licenses > Alteryx License Server > FlexNet Embedded License Server Administration Guide.

The FlexNet License Server Manager, found in Chapter 4 of the FlexNet Embedded License Server Administration Guide, is not supported for Alteryx License Server. Instead, use the FlexNet License Server Administrator Command-line Tool, also referred to as the CLI, found in Chapter 3 of the FlexNet Embedded License Server Administration Guide.

Run the command prompt as administrator when you run any of the License Server commands in these instructions.

Note

This topic is for Alteryx License Server. For help with the product, Alteryx Server, go to Alteryx Server Help for Administrators.Administer Alteryx Server

Prerequisites and Requirements

Alteryx License Server is supported on Windows Server. It is not supported on Linux. Before you install and start the License Server, review the below information.

System Requirements

Note

We recommend installing the Alteryx License Server (ALS) on its own server that is not shared with an Alteryx Server or Designer instance. While they don’t use the same ports for communication, they compete for resources. Any updates to the ALS require you to take Server or Designer offline for the update duration.

The License Server requires access to these web domains to successfully activate online:

  • whitelist.alteryx.com

  • *. flexnetoperations.com—This allows connections to alteryx-fno.flexnetoperations.com, fnocustomer.flexnetoperations.com, and any other site names in the flexnetoperations.com domain.

If these web domains are not allowlisted, or you can't activate the License Server online, follow the Offline Activation steps in the supplementary document, FlexNet Embedded License Server Administration Guide.

Java Runtime Environment (JRE) Component Requirements

The License Server requires Java SE Runtime Environment 8 (JRE 8) Ensure Java SE Runtime Environment 8 is installed. For more information about JRE, go to Oracle Technology Network.

Microsoft .NET Framework

The License Server requires Microsoft .NET Framework. Ensure Microsoft .NET Framework is installed. Specifically, .NET Framework 4.5 or newer is required for Windows platforms. For more information about Microsoft .NET Framework, go to Microsoft .NET Framework Runtime.

The IP address of the machine determines the License Server URL. Certain commands require the License Server URL. By default, The License Server URL uses port 7070.

In this example, the IP address of the machine is 10.11.12.123 and the port is 7070:

http://10.11.12.123:7070

Identify 1 or More License Keys to Use on the License Server

You use license keys during the setup of the License Server. At least 1 valid license key is required to start and activate the License Server. A valid license key follows this format:

XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX

Install and Start License Server

To install and start the License Server, follow the steps below.

Once the License Server is running and a key has been activated on it, the License Server is available to users. Users can't access the License Server until a license key is activated on the License Server.

Install License Server

  1. Download and install the product from the Alteryx Downloads and Licenses portal at licenses.alteryx.com.

  2. Wait while the InstallAware Wizard runs.

  3. At the Install window, select Next to install the License Server. Alteryx creates files and saves them to C:\Program Files\Alteryx\LicenseServer.

  4. When prompted by the installer, set the administrator password.

  5. Select Start Alteryx License Server now and then select Finish.

For more information about product downloads, go to Download a Product.

Verify Status

Run the -status command from the server folder to verify the License Server status:

C:\Program Files\Alteryx\LicenseServer\server>flexnetls.bat -status

The system responds letting you know if the License Server service is running. If the License Server is not running, visit the Troubleshooting section at the end of this page.

Activate License Server by Mapping 1 or More License Keys

At least one valid license key is required to activate the License Server and prepare it for users.

When you map a license key to the machine, it creates a Capability Request which prompts Alteryx to create the machine in the Alteryx Downloads and Licenses portal.

Run the -activate command from the enterprise folder to map and activate the license key:

C:\Program Files\Alteryx\LicenseServer\enterprise>flexnetlsadmin.bat -server 
[server URL] -authorize admin [admin password] -activate -id [license key] -count 
[number of seats]

Single License Key Example

C:\Program Files\Alteryx\LicenseServer\enterprise>flexnetlsadmin.bat -server 
http://localhost:7070/api/1.0/instances/~ -authorize admin Admin1234# -activate -id 
1234-2234-3234-4234-5234-6234-7234-8234 -count 2

Multiple License Keys Example

C:\Program Files\Alteryx\LicenseServer\enterprise>flexnetlsadmin.bat -server 
http://localhost:7070/api/1.0/instances/~ -authorize admin Admin1234# 
-activate -id 1234-2234-3234-4234-5234-6234-7234-8234 -count 1 
-activate -id 3331-2234-3234-4234-5234-6234-7234-8234 -count 1 
-activate -id 3332-2234-3234-4234-5234-6234-7234-8234 -count 1

The system responds with a success message. Users can now use the license server to activate Alteryx products.

Once you activate a license, you can use Alteryx even when not connected to your License Server, for a specified period of time. Alteryx displays a notification message with the number of days remaining before you are required to reconnect to the License Server. Go to Activate Using a License Server.

View Available Product Licenses

You can view available product licenses using the -l or list command.

C:\Program Files\Alteryx\LicenseServer\enterprise>LicenseServerAdminCmd.exe -s [server URL] -u admin -p [admin password] -l

Example

C:\Program Files\Alteryx\LicenseServer\enterprise>LicenseServerAdminCmd.exe -s http://BF-LT-192:7070 -u admin -p Admin1234# -l

Or...

C:\Program Files\Alteryx\LicenseServer\enterprise>LicenseServerAdminCmd.exe --server [server URL] --user admin --password [admin password] --list

Example

C:\Program Files\Alteryx\LicenseServer\enterprise>LicenseServerAdminCmd.exe --server http://BF-LT-192:7070 --user admin --password Admin1234# --list

Test License Server

After you install and start the License Server, you can use Alteryx Designer to test it.

Users connect to the License Server URL to view available licenses and to activate license keys. When you provide the License Server URL to your Alteryx users, include the request command.

License Server URL Examples

http://10.11.12.123:7070/request or http://CHI-PROD-LIC-09:7070/request

Connect to License Server

To connect to your License Server...

  1. Launch Alteryx Designer.

  2. Select Options > Manage Licenses.

  3. In the Manage Licenses window, select the settings icon.

  4. Select Change License System or Connect to License Server.

  5. Review the confirmation message and then select Continue.

  6. Enter the License Server URL to connect to the License Server. For example, http://111.222.0.30:7070/request.

Activate License

Use the Manage Licenses window to activate a base product (Alteryx Designer or Server), data sets, Alteryx Designer Desktop Automation, and additional server CPU cores.

To activate a license...

  1. Select Options > Manage Licenses.

  2. Enter the license server URL to connect to the License Server. For example, http://111.222.0.30:7070/request.

  3. In the Manage Licenses window, select Activate for each product you want to activate.

  4. Select Close.

Manage Connectivity

Once you activate a license, you can use Alteryx even when not connected to your License Server, for a specified period of time. Alteryx displays a notification message with the number of days remaining before you are required to reconnect to the License Server.

To reconnect to a License Server...

  1. Select Options > Manage Licenses.

  2. Select Connect.

Reserve Products for Specific Users (Admin-only)

Starting with Alteryx Designer version 2021.2, Administrators can reserve product access for specific users via Reservation Groups. This ensures that users have access to the products and features that they need.

Go to Alteryx License Server Reservations for detailed instructions.

FAQ

Where do I search for and view my License Server?

You can manage and view the License Server in the Alteryx Downloads and Licenses portal. Go to Administer Alteryx License Server.

Do I have to run the command prompt as administrator?

Run the command prompt as administrator when you run any of the License Server commands in these instructions.

How do I start and stop the License Server?

There is more than one way to start and stop the License Server. One way is to use the Services local to the machine. Search for Alteryx License Server.

How long can a user be disconnected from my License Server before they have to reconnect?

Once you activate a license, you can use Alteryx even when not connected to your License Server, for a specified period of time. Alteryx displays a notification message with the number of days remaining before you are required to reconnect to the License Server.

What happens if a user does not reconnect to my License Server before the disconnect time limit expires?

The license key is deactivated from the user and the same key becomes available to other users.

Where can I find more documentation?

For Flexera License Server product documentation, visit the Alteryx Downloads and Licenses portal and go to Downloads & Licenses > Alteryx License Server > FlexNet Embedded License Server Administration Guide.

The FlexNet License Server Manager, found in Chapter 4 of the FlexNet Embedded License Server Administration Guide, is not supported for Alteryx License Server. Instead, use the FlexNet License Server Administrator Command-line Tool, also referred to as the CLI, found in Chapter 3 of the FlexNet Embedded License Server Administration Guide.

Troubleshoot License Server

To troubleshoot a License Server...

  1. Determine the build number using the flexnetls command:

    C:\Program Files\Alteryx\LicenseServer\server>flexnetls

    The system responds with the build number and lets you know it is starting the license server.

  2. Update the FNLS service using the -update command:

    C:\LLS\LicenseServer\server>flexnetls.bat -update

    During this process, the system stops FNLS-alteryx, uninstalls it, and reinstalls it. If necessary, restart the License Server.

  3. Verify the License Server status by running the -status command from the server folder:

    C:\Program Files\Alteryx\LicenseServer\server>flexnetls.bat -status

    The system responds letting you know if the license server service is running.

In this section: