Worker

Version:
2019.4
Last modified: September 04, 2020

The worker handles the execution of analytic workflows. There has to be at least 1 machine enabled as a worker to execute workflows. You can configure the same machine to be both the controller and a worker. The number of workers needed depends on the desired system performance.

Configure the worker on the Worker screens in System Settings. The worker screens are available for configuration if you've selected 1 of these options on the Environment > Setup Type screen: 

  • Designer and Scheduler Only
  • Complete Alteryx Server
  • Custom > Enable Worker

Worker Configuration

The Worker Configuration screen includes configuration options, such as, where you want to store temporary files and whether you want the machine to run scheduled workflows.

Workspace

The Workspace is where the worker stores temporary or cache files, and unpackaged workflows for use when executing workflows. By default, it is the same as the controller folder. This path should point to a location that is safe to store large amounts of files.

Allow machine to run scheduled Alteryx workflows

When checked, the worker accepts requests to run workflows from the scheduler and the Gallery. In multi-node deployments, you might want to uncheck this option if you have another machine that runs workflows. When unchecked, the machine will only render map tiles or insights.

Workflows allowed to run simultaneously

This is the maximum number of jobs that you want to allow to run simultaneously on this machine. You might want to increase this to improve the responsiveness of scheduled jobs.

We recommend setting this to {# of Physical CPU Cores}/2.

Depending on the available resources and other configuration parameters, if set too high, this might cause poor job throughput, stability issues, or general performance issues. For help with this setting, reach out to your Sales or Support representative.

Cancel jobs running longer than (seconds)

Use this setting to force cancel jobs after a certain amount of time. This frees up system resources from being taken up by long-running jobs. This setting only applies to scheduled jobs and does not affect manual runs from the Gallery.

Quality of Service

In an environment where you have deployed multiple workers, Quality of Service determines which jobs each worker runs. When a worker handles a job request, it compares the priority level of the job to its Quality of Service value. Jobs that have a value greater than or equal to the worker's Quality of Service value are handled by that worker.

For example, if an available worker has a Quality of Service of 0, the worker handles any request. But, a worker with a Quality of Service of 3 only handles jobs that have a priority of 3 or higher. This allows you to reserve resources for higher-priority requests. For normal operation with 1 machine configured as a worker, set quality of service to 0.

  • 0: Low (normal workflow execution)
  • 1: Medium
  • 2: High
  • 3: Critical
  • 4: Chained application execution (all apps in the chain aside from the last)
  • 6: Workflow validation requests

Job Assignment

You can assign a specific worker to run a job. To do so, first add a job tag for the worker, then select that job tag when creating a schedule or running a workflow.

  • Run unassigned jobs: Select this option to use the worker to run untagged jobs.
  • Job tags: To assign the worker to run specific tagged jobs, add job tags. Comma separate multiple job tags. You can add the same job tag to multiple workers.

Run the Worker as a Different User

You can configure the machine to run the workflows as a specified user or account. This allows the worker to use specific credentials to access files or data locations. To set the machine to run as a different user, enter the Domain, Username, and Password.

For information on Run As User permissions, see Set Required Run As User Permissions.

Mapping Configuration

You can enable the worker to act as a map worker. Map workers render map tiles for map questions and the Map Input tool. You can specify the number of processes to use for tile rendering. The more processes allowed, the more simultaneous rendered tiles. Increasing this setting increases the system resources used.

Insights Configuration

Enable Insight Worker

You can configure the worker to act as an insight worker. Insights are interactive dashboards created in Designer and published in a Gallery. When enabled, the worker renders insights.

Insights allowed to run simultaneously

The maximum number of insights to run simultaneously on the machine. Increasing this setting increases the system resources used.

Max Cache Size (# of Cache Directories)

The maximum number of insights cached on a worker machine. Each insight consists of a description and data file, so each insight cache is a directory that contains those files.

Max Port, Min Port

The range of port numbers designated for use when rendering insights.

What's Next?

Configure Gallery.

Was This Helpful?

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