Alteryx Server Implementation key terms
Alteryx Server Implementation · Get comfortable with the vocabulary.
- Worker Node
- Related: Controller Node, Alteryx Service
A Server component that runs published workflows and scheduled jobs. It receives work from the Controller, executes the Alteryx Engine processes, and returns results and logs, scaling execution capacity when added to the environment.
- Controller Node
- Related: Worker Node, Alteryx Service
The Server component that manages the environment: it stores metadata, queues jobs, coordinates Worker Nodes, and hosts the web interface and API. It does not execute workflows itself in a multi-machine deployment.
- Alteryx Service
- Related: Controller Node, Worker Node
The Windows service (AlteryxService) that runs on every Server node and provides the Controller and Worker roles. It must be running for the web interface, scheduling, and job execution to function.
- System Settings
- Related: Alteryx Service, Subscription
The administrative area of the Server interface where global configuration is managed, including licensing, workers, engine settings, SMTP, authentication, and persistence. Changes here affect the whole environment.
- MongoDB Persistence
- Related: Controller Node, High Availability
The database layer that stores Server metadata such as users, workflows, schedules, and results. It can run as a remote replica set for resilience or in a local embedded mode for simple single-machine installs.
- Gallery
- Related: Collection, Workflow Credentials
The web interface where users browse, run, and share published workflows and apps, and where administrators manage content, users, and permissions. It is the primary end-user entry point to the Server.
- Subscription
- Related: Collection, Gallery
The association between a user account and a workflow or app that grants that user access to it in the Gallery. Subscriptions control who can see and run published content.
- Collection
- Related: Subscription, Role
A container used to organize and share workflows, schedules, and credentials among a defined group of users. Collections simplify permission management by granting access to many items at once.
- Role
- Related: Collection, Subscription
A named set of permissions assigned to users, such as Curator, Artisan, or Viewer. Roles determine what actions a user can take in the Gallery, including publishing, scheduling, and administering content.
- Workflow Credentials
- Related: Gallery, Encryption Key
Stored username and password values that a published workflow uses to connect to data sources at run time. They are managed separately from user login credentials and can be set at user, workflow, or system level.
- Encryption Key
- Related: Workflow Credentials, Backup and Restore
A secret value used by the Server to encrypt sensitive stored data such as credentials and connection strings. It must be backed up and preserved, because losing it makes encrypted values unrecoverable.
- Run As User
- Related: Alteryx Service, Worker Node
The Windows account under which the Alteryx Service and workflow executions operate. It needs appropriate file system and database permissions, and its rights affect what workflows can access.
- Authentication Type
- Related: SAML, Role
The configured method by which users prove identity to the Server, such as built-in accounts, Windows integrated authentication, SAML, or OpenID Connect. It is set in System Settings and affects login and user provisioning.
- SAML
- Related: Authentication Type, Role
A standards-based single sign-on protocol that lets the Server delegate user authentication to an external identity provider. It is commonly used to integrate Gallery access with corporate identity systems.
- Schedule
- Related: Worker Node, Job Queue
A configured trigger that runs a published workflow or app automatically at set times or intervals. Schedules are owned by users, can be shared, and are executed by Worker Nodes through the Controller.
- Job Queue
- Related: Schedule, Worker Node
The Controller-managed list of pending workflow executions waiting for an available Worker. Monitoring queue depth helps identify capacity shortages and long wait times.
- Chained App
- Related: Gallery, Subscription
A workflow that, after running, presents another app or workflow to the user for a subsequent step. Chained apps let a single entry point guide users through a multi-stage analytic process.
- Workflow Version
- Related: Gallery, Backup and Restore
A saved revision of a published workflow that is retained by the Server. Versions allow rollback to a prior state and provide an audit trail of changes made to published content.
- Result
- Related: Job Queue, Schedule
The stored output and log generated by a workflow run, viewable in the Gallery. Results include messages, errors, and any output files the workflow produced, and are subject to retention settings.
- Log File
- Related: Alteryx Service, Result
A record written by Server components that captures events, errors, and execution details. Logs are the primary source for troubleshooting failures and are often collected for support analysis.
- High Availability
- Related: Load Balancer, MongoDB Persistence
A deployment design in which redundant nodes and services keep the Server available if a component fails. It typically involves multiple Controllers, a replicated database, and load balancing.
- Load Balancer
- Related: High Availability, Worker Node
A network device or service that distributes incoming requests across multiple Server nodes. It provides a single access point and improves availability and throughput in multi-node deployments.
- Horizontal Scaling
- Related: Worker Node, Job Queue
Adding more Worker Nodes to increase execution capacity, rather than increasing the resources of a single machine. It is the standard approach for handling growing workflow demand on the Server.
- Backup and Restore
- Related: Encryption Key, Upgrade
The practice of regularly saving Server configuration, metadata, and the encryption key so the environment can be rebuilt after failure or migration. Restores must use the matching encryption key to decrypt stored values.
- Upgrade
- Related: Backup and Restore, Migration
The process of moving the Server to a newer version, which generally requires backing up data, verifying prerequisites, and running the installer on each node in the correct order.
- Migration
- Related: Upgrade, Backup and Restore
Moving a Server deployment to new hardware, a new environment, or a different topology. It involves exporting configuration and data and restoring them on the target system.
- License Key
- Related: System Settings, Worker Node
The file or code that activates the Server and defines licensed capabilities, such as the number of Workers. It is applied through the interface and must match the deployment size.
- Engine
- Related: Worker Node, Horizontal Scaling
The Alteryx processing component that executes workflow logic on a Worker Node. Each Worker runs one or more engine processes, and engine count affects concurrent execution capacity.
- Data Connection
- Related: Workflow Credentials, Encryption Key
A centrally defined connection to a data source that published workflows can reference. Administrators manage these in the Server so users can share governed access without embedding credentials in each workflow.
- API
- Related: Gallery, Schedule
A programmatic interface that allows external tools to interact with the Server for tasks such as publishing, running, and managing workflows. It is used for automation and integration with other systems.
- Audit Log
- Related: Log File, Role
A record of user and administrative actions taken in the Server, such as logins, permission changes, and publishing events. It supports compliance review and security investigations.
- SMTP Configuration
- Related: System Settings, Schedule
The mail server settings used by the Server to send notifications and password reset messages. Incorrect SMTP settings prevent users from receiving account and schedule-related email.