Environment

Version:
2022.3
Last modified: November 29, 2022

On the Environment screens in System Settings, select the Server Setup Type and the Environment Configuration to use as a root location for file storage.

Setup Type

On the Setup Type screen, select the components of the Server architecture to enable on the machine. You can enable the complete Server architecture on a single machine. If you want to have a multi-machine, scaled Server deployment, you can enable specific components per machine.  

  • Designer Only: Enables only Designer on the machine. Scheduler and Server functionality aren't enabled or configurable.
  • Designer and Scheduler Only: Enables Designer and Scheduler on the machine. Server functionality isn't enabled. Select this option if you want users on the machine to build and run workflows and schedule workflows to run in the future.
  • Complete Alteryx Server: Enables the entire Server architecture to run on the machine. This includes Designer, Scheduler, and Server UI. Select this option if you want to run a single-machine environment and want the complete Server functionality.
  • Custom: Allows you to enable specific components for the machine. Select this option for multi-machine deployments of Server.
    • Enable Controller: Enables a controller on the machine. The controller manages and distributes scheduled workflow jobs to workers.
    • Enable Worker: Enables a worker on the machine. Workers execute scheduled workflow jobs assigned by the controller.
    • Enable Gallery: Enables Server on the machine. If you enable Gallery, you have to specify a Default Gallery Administrator on the Server UI > Authentication screen.
  • Send Server usage data: When enabled, Alteryx collects usage data for each job run, including manual and scheduled runs. Alteryx uses this information to plan future enhancements and prioritize fixes and features. To opt-out of sending your usage data to Alteryx uncheck this option. Unchecking this option doesn't prevent your IT department from collecting usage data. The usage data collected includes the following:
    • Version of Server running the job.
    • Serial number of the Server installation.
    • Job schedule.
    • Job ID.
    • Date and time the job was run.
    • Errors, warnings, conversion errors, messages.

Environment Configuration

On the Environment Configuration screen, select a root location where Server files are stored, specify the Hostname, Workspace, and if the SSL/TLS should be enabled globally.

Workspace

The root path is used as the base location for the storage of temporary files, log files, and database files. This path should point to a location that is safe to store large amounts of files. Visit Configure and Use Server Logs for more info.

Hostname

This should be a fully qualified domain name for the machine. If a fully qualified domain is not required, a hostname is fine. The hostname or FQDN you specify will be used to build default recommendations for later URL/URI configurations.

Globally Enable SSL/TLS

Server-FIPS

AlteryxService now supports TLS for internal and direct service layer communication. For the Server-FIPS, TLS is enabled for all services and cannot be disabled. Because of this change, you must install an X.509 (TLS) certificate on the Controller and Server UI nodes. This allows communication between nodes to work with TLS. We recommend installing certificates on all of the machines hosting Server, regardless of their configuration. 

This setting will enable SSL/TLS for the whole environment, which includes TLS for the controller communications. Before you select this setting, ensure you have a valid signed certificate and private key installed on both the Server UI node and the Controller node (if they’re separate). See Configure Server SSL/TLS for details on installing and configuring certificates.

Note that when you check the Globally Enable SSL/TLS setting, then the Use SSL/TLS setting on the Remote Controller page, the Enable Controller SSL/TLS setting on the Controller Configuration page, and the Enable Server UI SSL/TLS setting on the Server UI Configuration page will all be enabled and locked.

What's Next?

Configure Controller.

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.