Install or Upgrade Server

Version:
Current
Last modified: July 06, 2020

Before installing and activating Server, verify your network has access to all required licensing system domains. See Licensing System Requirements for a complete list.

Download Server

Download the Server product from the Alteryx Downloads and Licenses portal.

To download the Server product:

  1. Sign in to the Alteryx Downloads and Licenses portal at licenses.alteryx.com.
  2. Under Product Downloads, select Alteryx Server.
  3. On the Download Products page, select the version of the product you want to download. The latest version is available on the New Versions tab. Access previous versions on the Previous Versions tab.
  4. On the Downloads page, select the plus icon next to Alteryx Server to display a description of the product.
  5. Select the link for the Alteryx Server product in the File Name column to download the file.

Install Server

To install Server:

  1. Run the Alteryx Server Installer with admin rights. (Right-click and select Run as administrator.)
  2. Confirm the destination folder and select Next.
  3. Select the I accept the license agreement checkbox and select Next.
  4. Select one of the following options and select Finish.
    • Configure Server now: Opens the System Settings window to configure the server.
    • Close and run Alteryx Designer later: Closes the installation window. Access the System Settings at any time via the Alteryx System Settings desktop icon.
    • Install Predictive Tools: Installs the predictive tools in Designer. The predictive tools use R, an open-source programming language used for statistical and predictive analysis. Select this option to launch the R installer. You have to install the predictive tools to use the predictive macros in Designer. To install at a later time, go to Options > Download Predictive Tools in Designer.

License Your Server

If you have not licensed your Server, you will be prompted to do so. Use the license key from your license administrator to activate a product license. If the license prompt does not immediately load, it can always be reached from within the Designer under Options > Activate License Key.

Activate Online

To activate a license online:

  1. In the Alteryx Server Activation window, enter your email address.
  2. Enter your License keys (one per line).
  3. Select Activate.
  4. In the Activation Success window, select Experience Alteryx.
Activate Offline

As an alternative to online activation, you can submit a request for an activation (.bin) file. If you want to activate with a file, select Activate with File to open the Alteryx Offline Activation window.

To activate a license offline:

Step 1. Create a Request (.req) File from the Offline Computer

  1. Open Designer. If the Alteryx Designer Activation window does not open, select Options > Manage Licenses > Activate New License.
  2. In the Alteryx Offline Activation window, select Create to create a request (.req) file to request product activation.
  3. Enter your First name, Last name, and Email address and then enter your License keys.
  4. Select Create request. Designer creates a request file with your email address and .req extension as shown in this example: email@company.com.req
  5. Select Save to save the request (.req) file where it can be accessed from the Alteryx Downloads and Licenses portal or send the file to your license administrator.

Step 2. Upload the Request File to the Alteryx Downloads and Licenses Portal

Internet access is required for this step.

  1. Sign in to the Alteryx Downloads and Licenses portal at licenses.alteryx.com.
  2. On the Home page, select Upload Activation Request.
  3. Select Browse and select the request (.req) file you saved created in the previous step.
  4. The Alteryx Downloads and Licenses portal generates an activation file with your email address and .bin extension as shown in this example: name@company.com.bin
  5. Save the activation (.bin) file so that you can access it from the offline computer.

Step 3. Open the Activation (.bin) File on the Offline Computer

  1. In the Alteryx Designer Activation window on the offline computer, select Back.

    Or, select Options > Manage Licenses > Activate New License to open the Alteryx Offline Activation window.

  2. Select Browse and select the activation (.bin) file.
  3. In the Activation Success window, select Experience Alteryx.
Activate Using a License Server

The Alteryx License Server allows for the hosting and managing of purchased product licenses within an organizations' internal network. The license server allows for smoother and more secure deployment of Alteryx products, especially behind proxies and firewalls. Download the license server from the Alteryx Downloads and Licenses portal at licenses.alteryx.com.

To activate using a License Server:

  1. Open Designer. If the Alteryx Designer Activation window does not open, select Options > Manage Licenses > Activate New License.

    If you have no valid licenses, the license server displays Install License. Select OK to continue.

  2. Select the here link within To access your License Server, click here text. The license server displays Manage Licenses.
  3. In License Server Connectivity, select Connect. The license server displays available licenses. If this is the first time you have activated a license, enter your email address.​​​​​​
  4. Select Activate for each product you want to activate.
  5. Select Close.

For more help including command line options, see Product Activation and Licensing Help.

Upgrade Server

Follow these steps to upgrade to a newer Server version:

  1. Stop the AlteryxService.
    1. Open Task Manager.
    2. Select the Services tab. 
    3. Locate the AlteryxService
    4. Right-click and select Stop.
  2. Perform a backup of the MongoDB. See MongoDB Backups.
  3. Follow the download and install steps to upgrade to a newer version of Server.
  4. If you are upgrading to a Server version that uses another MongoDB version, select Migrate Mongo Database to run the migration utility during the install process to update the MongoDB version. See MongoDB Schema Reference for a table showing what MongoDB versions correspond with Server versions.
    Screenshot of Install screen highlighting the Migration Mongo Database option

The Alteryx Service should automatically start after the upgrade. The Alteryx Service has to be running to access the Gallery. If you cannot access Gallery, confirm the Alteryx Service has restarted. 

  1. Open Task Manager.
  2. Select the Services tab. 
  3. Locate the AlteryxService.
  4. Confirm the Status shows Running.
  5. If the Status shows Stopped, right-click and select Start.

Embedded MongoDB Version Timeline & Migration

The embedded MongoDB Server Database uses one of these MongoDB versions: 3.0, 3.4, or 4.0. The version of MongoDB depends on what version of Server you have installed.

To successfully migrate data to a new version of Server, you have to make sure that MongoDB upgrades consecutively to each newer version that we support. So, to upgrade from 3.0 to 4.0, you have to upgrade from 3.0 to 3.4 and then to 4.0. To accomplish this, make sure that you install versions of Server that support each of those versions of MongoDB. It doesn't matter what version of Server you upgrade to, as long as it supports the correct version of MongoDB.

See MongoDB Schema Reference for a table showing what MongoDB versions correspond with Server versions.

What's Next?

Configure Server from the System Settings.

Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.