community
cancel
Showing results for 
Search instead for 
Did you mean: 

alteryx server Knowledge Base

Definitive answers from Server experts.

IT Admin Guide: How to set up your very own Alteryx License Server (aka LLS)!

Alteryx Alumni (Retired)
Created on

large.png

 

 

Introducing the Alteryx License Server

 

The Alteryx License Server is available with Alteryx versions 2018.3 and newer. Also referred to as Local License Server, or LLS, this is an optional method for an organization’s IT department to deploy and manage Alteryx products. This option is an addition to the standard method of using license keys.

 

The Alteryx License Server is an implementation of our technology partner Flexera Software’s Local License Server, and enables the deployment of a local license server within an organizations’ internal network. This allows for a smoother and more secure deployment of Alteryx products, especially behind proxies and firewalls.

 

Note: This guide references an optional method of deploying Alteryx products using the Alteryx License Server. To find out more about the standard method of using license keys, visit one of the following:

  • To license Alteryx versions 11.8, 2018.1, and newer using license keys, check out How to License Alteryx.
  • To license Alteryx versions 11.7 or older, check out the Licensing Series blogs.

If you have other questions about licensing, let us know at fulfillment@alteryx.com!

 

How does it work?

 

The Alteryx Local License Server may be deployed on any device on your company’s network that meets the technical requirements located in the attached FlexNet Embedded 2018 R1 License Server Administration Guide. The Alteryx License Server may also be deployed on any device already running an Alteryx Server.

 

Once deployed, a pool of Alteryx license keys may be activated on the LLS. Individual Alteryx Designer and Alteryx Server users may then freely connect to the LLS via a URL on the local network. When a client Alteryx Designer or Alteryx Server connects to the License Server, the available pool of licenses will be available for license activation in a list presented to the user.

 

6_licensed_LM_LLS_obf.pngOnce connected to an Alteryx License Server, available licenses may be activated and deactivated from a list.

 

FAQ

 

How does this work with pre-Flexera licensing?
The Alteryx License Server uses the Downloads & Licenses portal for licensing, just like the new licensing system. This means that the licenses do not appear in the Alteryx Gallery like pre-11.8 licenses, and your license keys should have dashes (-). These license keys would have arrived in an email like this one.

email.pngThe license administrator receives an email like this, with all licenses associated to an order.

 

Do we need special license keys for customers that are already in the new system?
No, the same license keys may be used as for the regular system. The license administrator / IT admin will just need to add these licenses to the Alteryx License Server for people to license against.

 

Can I control what licenses are available for my users to activate?
Yes. The simplest way to manage what licenses are available for connected devices to access is to only map licenses to the LLS that you would like users to be able to access. For example, if there are 100 Alteryx Designer licenses, but only one Alteryx Server license, it may be preferable to license the Alteryx Server using the standard license key method rather than map this license to the LLS.
In order to create more comprehensive access control to licenses, it is possible to set up Reservation Lists on the Alteryx License Server. To learn more about how to do this, see the section on Managing Reservations in the attached FlexNet Embedded 2018 R1 License Server Administration Guide.

 

What products are supported with Alteryx License Server?

Alteryx Designer and Alteryx Server versions 2018.3 and later are supported for licensing against an Alteryx License Server.

What happens if a computer with Alteryx Designer or Alteryx Server loses contact with the Alteryx License Server?

If Alteryx loses its network connection to the License Server, it will remain licensed with its current license keys for 1 week (7 days). After this grace period, the licenses would disappear from the local machine and those license seats would return to the pool on the License Server. If you just haven't been using Alteryx for over a week, then it will try to synch up with the License Server next time Alteryx is started up; this would re-activate any of those license keys behind the scenes.

 

How do I get my hands on the Alteryx License Server?

If you'd like to try out this free, optional deployment method, reach out to your Account Executive at Alteryx. They would be happy to add this product to your organization's area of the Downloads & Licenses portal for you to download.

 

Installation Instructions

 

These instructions refer to the documentation available in our online Licensing Help, under the topic Install and Use Alteryx License Server, and the FlexNet Embedded 2018 R1 License Server Administration Guide.

 

  1. Download the latest Alteryx License Server executable (e.g., AlteryxLLS_2018.X.X.XXXXX.exe) from the Downloads & Licenses portal, along with the supplementary FlexNet Embedded 2018 R1 License Server Administration Guide. This supplementary guide, published by Flexera Software, is the primary reference for maintaining the Alteryx License Server.

  2. Verify that your system meets the prerequisites for installation:
    1. Hardware Requirements
      Disk Space: 500 MB

      RAM: 4 GB
      CPU: 2 GHz, 2 cores
    2. Supported Platforms
      The Alteryx License Server supports Windows Server OS. See FlexNet Embedded 2018 R1 License Server Administration Guide for specific OS details.
    3. Virtual Machine Support
      See FlexNet Embedded 2018 R1 License Server Administration Guide for a full list of supported virtualization platforms.
    4. Java Runtime Environment
      A Java 8 Runtime Environment is a necessary component that needs to be set up before installing the Alteryx License ServerEnsure that a JRE is installed and check that the JAVA_HOME (or JRE_HOME) environment variable is set to the path for your default JDK or JRE installation. The JRE may be downloaded from the Oracle Technology Network
      .

      JRE error.pngA Java Runtime Environment is a prerequisite for installing the Alteryx License Server.
      N.B. Sometimes having multiple versions of Java installed will mess up the environmental variables that are used by the License Server. Make sure that only the supported Java SE Runtime Environment 8 is installed.
    5. Microsoft .NET Framework
      Ensure that the latest Microsoft .NET Framework is installed. For more information about Microsoft .NET Framework, visit Microsoft .NET Framework Runtime.

  3. Run the Alteryx License Server installer as an administrator.

    0_runinstaller.pngRun the installer as an administrator.

     

  4. Select where you would like to install the Alteryx License Server. The default location is C:\Program Files\Alteryx\LicenseServer.

  5. Accept the Software & Data License Agreement.

  6. When prompted, enter an admin password. It will be necessary to provide this password when administrating the Alteryx License Server, for example when mapping licenses to the LLS. The username that corresponds to this password is always "admin".

    04_installer.PNGSet a password to carry out authenticated actions on the License Server.

    Troubleshooting the admin password: The default password for the Alteryx License Server out-of-the-box is "Admin1234#". If something went wrong during installation, try using the default password to change your password. See the FlexNet Embedded 2018 R1 License Server Administration Guide for information on changing your password.

     

  7. To start up the Alteryx License Server, click Finish.

    05_installer.PNGClick "Finish" to start the Alteryx License Server.
  8. After clicking Finish, it may take a few minutes to start up the LLS. When successful, you will see a new Windows Service called "AlteryxLicenseServer".

    06_service.PNGCheck your Services to see if the License Server was installed successfully.

    07_service.pngYou can also verify the service via command line.

     

Mapping License Keys to the Alteryx License Server

 

Now that the License Server is up and running, the next step is to map license keys to the server. This will allow you to create a list of the licenses available for users to activate.

  1. Identify your server's network address and port. This is the IP address of the machine, but could also be a DNS record. The default port used by the Alteryx License Server is port 7070.

    ipconfig.pngUse "ipconfig /all" to quickly identify the IPv4 address.

    For example, my Windows Server's name is DEN-DEV-LIC-01 and I use the default port of 7070, so the network address of my Alteryx License Server is http://DEN-DEV-LIC-01:7070.

  2. Open a command prompt as an administrator and navigate to the "enterprise" folder. Then, activate a license key using this command:

    flexnetlsadmin.bat -server <Network Address : Port> -authorize admin <Password>
    -activate -id <License Key> -count <How many seats should be available?>
    -activate -id <License Key> -count <Seats>
    -activate -id <License Key> -count <Seats>

    activate_cmd.pngUse the flexnetlsadmin.bat command to map licenses to the License Server.

     

  3. You can use a command line to check which licenses have been successfully mapped onto the LLS. This prompt should also be run from the "enterprise" folder.
    LicenseServerAdminCmd.exe -s <Network Address : Port> -u admin -p <Password> -l
  4. If you need to remove a license from the pool, simply use the same command except with a count set to 0 seats.

 

Licensing Alteryx Designer or Alteryx Server against the LLS

 

Now that the Alteryx License Server is installed and licenses have been mapped to it, individual devices on the network may connect to it. Here is how an Alteryx Designer user would activate a product using the LLS.

 

  1. Download the latest Alteryx Designer executable (eg.  AlteryxInstallx64_2018.X.X.XXXXX.exe) from the Downloads & Licenses portal. Only versions 2018.3 or newer will be eligible for licensing against an Alteryx License Server.

  2. Install or upgrade Alteryx Designer in the usual way. At the end of the installer, select "Close and run Alteryx Designer later".

    7_installed.PNGSelect the second radio button and click "Finish".

     

  3. Open Alteryx as an administrator. The connection to the Alteryx License Server can only be established when running under elevated permissions.

    0_RunAsAdmin.PNGRun as an admin to connect to the LLS.

     

  4. When Alteryx starts up, you should see one of the following Activation windows.

    unlicensedDesigner.pngLeft: Normal Activation window. Right: The file authentication window is shown when Alteryx has difficulty contacting the activation service.

     

  5. Click the link outlined in red above, that reads "To access your License Server click here".

  6. Provide an email address and the network address of your LLS. The email is used only to identify the device for the license administrator in the Downloads & Licenses portal and is never shared.

    3_LLSConnect.PNGMake sure to add "/request" to the end of the LLS network address.

     

  7.  Click Connect to establish a connection to the Alteryx License Server. You should now see the licenses which are mapped to the LLS and available to you.


    connected.pngThe license key details have been obfuscated in this screenshot.

     

  8. Use the buttons under the Action column to Activate or Deactivate the licenses you would like to use on this device.

     

Activating.pngPick and choose licenses from the list.

 

Using Command Line to create a deployment script

 

Many of the manual steps described above have command line analogues that may be used to script up a deployment package or app. The below is taken largely from our help documentation, under Use Command Line Options.

 

  1. Installing Alteryx Designer. The Alteryx executable may be run from the command line, allows specifying various options:
    1. /s to suppress dialogs
    2. /l for logging
    3. REMOVE for uninstallation
    4. SERIAL_NUM sets the email address associated with the device
    5. TARGETDIR sets the installation directory
    6. ALLUSERS allows for creating shortcuts for all users on the system
    7. CMD_LANGUAGE sets the language to install

  2. Once Alteryx Designer is installed, command line may also be used to connect Designer to the Alteryx License Server. The below can be found under Change license system.

    cmd.PNGThe deployment script can automatically connect to an Alteryx License Server.

     

  3. It is also possible to script up the license activation step, so the user doesn't need to activate licenses manually. The commands for this are the same as for activating licenses in a regular deployment of Alteryx that does not require an Alteryx License Server. Here are the commands for online activation.

    activatecmd.PNGA command line script may use the online activation commands to activate licenses from an Alteryx License Server.
     

Administering the Alteryx License Server from the Downloads & Licenses portal

 

The Alteryx License Server may be found in the list of devices associated with your organization in the Downloads & Licenses portal at licenses.alteryx.com.

 

  1. Locate the Alteryx License Server by navigating to "Administer Machines".

    admin.pngMachines > Administer Machines

      

  2. The easiest way to find the License Server is by using the filter functionality in the top-right of the screen, above the list of machines.

    filter.pngFilter on "Active" and "Local License Servers".

     

  3. Click on the name of the Alteryx License Server to view details for the LLS.

    names.PNGThe name of the machine corresponds to the physical address of the Ethernet adapter supporting the Alteryx License Server.

    server_obf.pngOpen the LLS details to view license keys and quantity of seats mapped to the LLS.

     

  4. From the Downloads & Licenses portal, the administrator of the LLS may also:

    1. "View Machine History" to understand recent activity on the License Server.
    2. "View Served Machines" to see who has connected to the LLS.
    3. Map additional licenses to the License Server, by license key or by product selection.
    4. Revoke licenses from the server and recover those license seats.
      view served.pngSelect "View Served Machines" to see what devices have connected to the LLS.

      activate revoke.pngMap or revoke licenses from the Server under the "Action" menu.

       

       

Comments

Hello,

 

Under Administer Machine, How can I re-activate a Inactive status machine?

 

Thanks,

Alteryx Alumni (Retired)

Hi @sodajeffnz. I don't believe there is a way to do this. If you activate licenses on the same machine, you should then see a new 'active' version in the portal.

Thank you @AlexKo, will re-install Alteryx and see if that helps. As the machine is tagged inactive, the user couldn't activate the licences, I can see the request in machine history but fails activation. I can't allocated a license to an inactive machine neither.  On machine history I see a line says "Hose returned". That's probably why.

Alteryx Alumni (Retired)

An awesome customer reached out to me and provided a PowerShell 4+ command for a health check against a License Server. His goal with it was to create an activation script that does a health check and selects an available Alteryx License Server if more than one is set up.

 

I'll post it here in case it's useful for anyone.

 

$flexLmStatus = Test-NetConnection -ComputerName ServerName -Port 7070 | Select-Object -ExpandProperty TcpTestSucceeded

                      If ($flexLmStatus) {Do Something}

Alteryx Partner
Alteryx Partner

@AlexKo ,

 

Can this be used with an AD group to authenticate what access to licenses an individual should have? (Ex: User 1: Designer Only, User 2: Designer and Data Package).

 

Also, can the License Server be used to implement Silent installations and if necessary through a proxy?

 

Thank you for your help.

Alteryx Alumni (Retired)

Hi @AndrewDataKim 

 

There isn't any out-of-the-box support for AD authentication. That being said, it may be be possible to set it up something using the command line. I'm not aware of anyone trying this yet.

 

The License Server can be set up with silent installation by scripting with the CLI as well.

 

In all honesty, I'm a bit out of the loop on licensing at this point, so I'll tag in @ErinN here - she's our Product Manager in charge of downloads, licensing, and installation.

Alteryx Partner
Alteryx Partner

Thank you @AlexKo ,

 

I would like to see this as part of the platform for enterprises as a default. There are a lot of silent pushes and it can really help with the expansion of the deployments and reduce the burden on the admins.

Thank you @AlexKo ,

Curious that there is a reference to this file ---  FlexNet Embedded 2018 R1 License Server Administration Guide --- I was not sure if this is posted here somewhere, but I can't seem to locate it. 

 

Can I control what licenses are available for my users to activate?
Yes. The simplest way to manage what licenses are available for connected devices to access is to only map licenses to the LLS that you would like users to be able to access. For example, if there are 100 Alteryx Designer licenses, but only one Alteryx Server license, it may be preferable to license the Alteryx Server using the standard license key method rather than map this license to the LLS.
In order to create more comprehensive access control to licenses, it is possible to set up Reservation Lists on the Alteryx License Server. To learn more about how to do this, see the section on Managing Reservations in the attached FlexNet Embedded 2018 R1 License Server Administration Guide.

 

Any assistance?

 

Best,

 

Mark

Alteryx
Alteryx

@marklmullins

 

Do you currently have access to the license server in your product downloads in licenses.alteryx.com?

 

If you do, the FlexNet Embedded 2018 R1 License Server Administration Guide is located there.

 

Thanks,

Kylor