Configure Server

Last modified: April 02, 2020

Alteryx Server can be configured in a basic setup, with all components running on the same machine, or as a multi-node instance with multiple machines.

After you install and license Alteryx Server components, the System Settings window will automatically open. Configure Alteryx Server components in System Settings.

Single-Machine Configuration

  1.  If the window does not open automatically, click the Alteryx System Settings icon on your desktop. The System Settings Status screen displays the system components that are enabled by default. 
  2. Click Next to configure settings for each component.
  3. On the Finalize Your Configuration screen, click Finish. The Status screen displays the system components you enabled.
  4. Click Done to close the System Settings window.

Multiple-Machine Configuration

After the Alteryx Server is installed on a machine, you can scale it to accommodate for higher levels of usage by enabling certain components on additional machines. Increase Engine processing capabilities by configuring an additional machine to act as a worker.

Configure a Worker Machine

You must configure each additional worker machine with the unique controller security token to be able to communicate with it. The security token is available as part of the System Settings of the controller machine.

  1. If necessary, double-click the System Settings icon on the desktop of the controller machine, to open it.
  2. Click Next on the System Settings screens until you reach the Controller General Configuration screen.
  3. Click View to display the controller token. Copy the token, and save it for later use.
  4. Find and copy the machine name of the controller machine, and save it for later.
  5. Install Alteryx Server on the machine to be configured as a worker.
  6. Double-click the System Settings icon on the desktop of the worker machine.
  7. Click Next to configure settings for each component.

Setup Screen

  1. Select Custom and Enable Worker.
  2. Click Next.

Alteryx Designer is automatically enabled when you select the Custom option.


Workspace Screen

  1. Click Browse and find the location you want to save all temporary files, log files, and database files.
  2. Click Next.

Remote Screen

  1. In Host, paste the machine name, and in Token, paste the controller token.
  2. Click Test to verify the connection to the controller machine.
  3. Click Next.

General Screen

  1. Configure the options as needed. 
    • Workspace: Displays the path to the location where you want to save all temporary files, log files, and database files.
    • Allow machine to run scheduled Alteryx workflows: Enable if you want this machine to process scheduled workflows. In multi-node deployments, you may want to disable this option if you are using another machine to run workflows, and want this machine to process other requests. 
    • Workflows allowed to run simultaneously: Define the maximum number of scheduled workflows allowed to run simultaneously on this machine. You may want to increase this number to improve the responsiveness of scheduled jobs, but the overall processing time may be increased.
    • Maximum sort/join memory usage: Define the amount of memory for Alteryx to use when encountering Sort or Join tools in a workflow. A general rule for an appropriate setting is to be half the amount of available system memory, divided by the number of simultaneous workflows allowed to run.
    • Cancel jobs after timeout: Define the period of time after which you want to force running jobs to cancel. This will help to free up system resources that might otherwise be taken up by unintentionally long running jobs.
    • Quality of Service: Define resource allocation in an environment where multiple workers are deployed by restricting which jobs will be run by each worker. For normal operation with one machine configured as a worker, set this value to 0.
  2. Click Next to continue.


Was This Helpful?

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