Skip to main content

Version-to-Version Server Upgrade Guide: Supported Versions

Important

Please see the Server Upgrade Checklist to help plan and execute a successful Server upgrade, including the Pre-Upgrade Checks workflow to identify issues that cause upgrades to fail.

How Does This Document Help?

This document highlights tasks and changes you need to be aware of when upgrading through versions of Alteryx Server. Issues are cumulative, so read through each section as you upgrade through multiple versions. This doesn't replace Release Notes (see links in each section).

Release Schedule

  • Semi-annual releases add features but can also change Server management requiring you or your users to change behavior.

  • Maintenance releases/patches within each quarter address issues found in the initial release. For example, the first maintenance release for 2022.3 would be 2022.3.2.

Legend

PIT-STOP

Significant change that requires upgrading to this version before upgrading to a later version.

MongoDB Upgrade

The Mongo database version is upgraded.

An Alteryx Server upgrade can only include ONE MongoDB version upgrade between your current version and target upgrade version.

CRITICAL

Critical Issue: Admins must address or be aware of when moving to or past this version.

Criteria for Entries in This List

This list condenses each version's Release Notes to highlight where:

  • Admin or Users are required to perform an action.

  • Item is important in choosing an upgrade version (that is, changed behavior or defect).

  • A significant change was made in Server administration.

2023.2 and Prior Versions

For unsupported versions (2023.2 and prior), refer to the Version-to-Version Server Upgrade Guide: Unsupported Versions.

2024.1

What's New / Release Notes

Version

Actions to take when upgrading to—or past—this version.

2024.1

Administrative Feature: Ability to Transfer Asset Ownership via UI and API

Admins can transfer ownership of workflows and schedules between users via Server UI or using Server API V3 endpoints.

Impact:

Note

  • Workflow job history is not visible to the new owner.

  • Workflow will move to the new owner's studio, impacting visibility to other users in source or destination studio.

  • Additional elements need to be shared with new owner to run workflow successfully:

    • DCM Connection

    • Shared Gallery Database Connection

    • Shared Gallery Credential

2024.1

New Feature: New Database Option Added (SQL DB)

User-Managed SQL Server database can be used instead of MongoDB. Currently, the only officially supported version of SQL is MSSQL Server 2019 and 2022.

Impact:

2024.1

CRITICAL

Python Upgrade: Embedded Python upgrades from 3.8.16 to 3.10.13

Impact:

The following error message appears if an incompatible version of a Connector is used in Designer: " Version 3.8 was not found in our alteryx distribution. Please select another version. Internal Error - Deadlock detected."

Task:

  • All Connector Tools must be replaced with a new version.

  • Users should retest Python in workflows. Engine still uses Python Version 3, so there should be little impact on scripts.

2024.1

CRITICAL

MongoDB Datetime Field Change (Service Timestamps Moved to UTC Format in Server Databases)

Impact: We moved all datetime fields to UTC to improve handling of time zone and daylight savings time changes. For more information, go to Server 2024.1 Release Notes.

  • All Server APIs with a timestamp element are affected.

  • If you upgrade from an older version to 2024.1, the timestamps of existing assets will be converted to the new UTC standard when AlteryxService starts.

Task: Review how datetime fields are handled in applications that access MongoDB or the API. They might need to be adjusted to expect the datetime in UTC.

2024.1

DCM Dev/Prod Server Management: Prod Server can redirect Dev DCM to Prod Connections

Impact: DCM Connections and DCM Connection Handling added to Admin menu. For more information, visit the following help pages:

Task: Add DCM redirections to Prod Server to allow workflows migrated from Dev to access Prod data sources with no changes in the workflow.

2024.1

DCM Administration: User Permission Granularity

Impact: New DCM permissions added. For more information, go to the User Roles and Permissions help page.

2024.1

DCM Administration: DCM Generic External Vault added

Impact: You can configure a generic vault that can retrieve secrets from any vault with a programmatic interface using basic authentication.

2024.1

Administration Change: DCM Concurrent Sharing

Impact: You can share the same DCM Connection for Collaboration and, separately, for Execution. Previously you could only choose 1 sharing option. For more information, go to Data Connection Manager: Server UI.

2024.1

Insights End of Life

Impact: Insights no longer available in Alteryx Server. Go to our FAQ page for more information.

2024.2

What's New / Release Notes

Version

Actions to take when upgrading to—or past—this version.

2024.2

PIT-STOP

CRITICAL

Upgrade Embedded MongoDB to Version 7

Impact: As part of Server 2024.2 installation, embedded MongoDB will upgrade to version 7.0. Minimum Server version for upgrade is 2023.2 (MongoDB version 6.0).

Task: Ensure Server version is 2023.2 or 2024.1, then follow the steps described in Server 2024.2 Release Notes.

2024.2

PIT-STOP

CRITICAL

Version 2024.2 is the last release to include Crypto Migrator Code.

This pit-stop is only applicable for User-Managed MongoDB upgrading from 2022.1 or prior, which will require the database to be crypto-migrated during the upgrade.

Task: Go through the crypto-migration process explained in the 2022.3 section of Version-to-Version Server Upgrade Guide: Unsupported Versions and the Migration Prep Tool.

2024.2

Migrate Data Connections and Workflows to DCM

You can now migrate Shared Server Data Connections to DCM Connections. To do so, check the How to migrate Server Data Connections to DCM and Data Connections.

2024.2

Possibility to Limit Users in a Studio to One User

Curators have the option to turn off shared studios by limiting the users in a studio to one user. As an admin, you can now easily transfer asset ownership by transferring the workflow from one studio to another.

To limit the number of members in a studio to one user, go to Admin > Settings > Configuration > Users. Then select the Limit Studio to 1 User checkbox. For more information, go to Alteryx Server Settings.

2024.2

Restriction to Make Workflows Public: Global Setting

Curators can now control the way workflows are getting published (publicly or non-publicly) by selecting or clearing the Restrict Public Workflow (Global) checkbox. To do so, go to Admin > Settings > Security.

For more information, go to Alteryx Server Settings.

2024.2

Designer Proxy Settings Expanded

In Designer, Options > User Settings > Edit User Settings > Proxy > Enable New Proxy Settings (Preview) has been added to provide better control over proxy settings and to allow PAC scripts.

Note: In this Initial release, the setting applies to several features (for example, Download Tool) but not others (for example, Connectors or ODBC) in Designer. See User Settings for details.

2024.2

System Setting “Cancel jobs running longer than (seconds)“ Now Applies to All Jobs

In previous versions, this setting only applied to scheduled jobs. To allow manual jobs to run longer than scheduled jobs, clear this setting and use the two new Server UI options explained below.

For more information, go to Alteryx Server Settings.

Option Added to Cancel Long-Running Manual Job Runs

In Server UI > Admin > Settings > Assets, there is a new option to cancel manual job runs (including API job runs) running longer than a specified time. This applies to all Workers unless the Worker has set Alteryx System Settings > Worker > General > Cancel jobs running longer than (seconds). The Worker setting overrides the Server UI setting.

Option Added to Cancel Long-Running Scheduled Job Runs

In Server UI > Admin > Settings > Assets, there is a new option to cancel scheduled job runs running longer than a specified time. This applies to all Workers unless the Worker has set Alteryx System Settings > Worker > General > Cancel jobs running longer than (seconds). The Worker setting overrides the Server UI setting.

2024.2

API Updates:

API Filtering Added to GET v3/workflows/{workflowID}/jobs

The GET v3/workflows/{workflowID}/jobs endpoint can now optionally filter by status and resultCode, returning a list of job IDs that match these filters. For more information, go to Server 2024.2 Release Notes and Workflow Endpoints.

  • All Server APIs with a timestamp element are affected.

  • If you upgrade from an older version to 2024.1, the timestamps of existing assets will be converted to the new UTC standard when AlteryxService starts.

Task: Review how datetime fields are handled in applications that access MongoDB or the API. They might need to be adjusted to expect the datetime in UTC.

New API Endpoints for Subscriptions (Studios)

Curators can now manage subscriptions (studios) using Server V3 API endpoints. These endpoints help to edit subscriptions in bulk and provide the ability to move individual users back to individual studios.

For more information about these endpoints, go to Subscription Endpoints.

API Updates for Workflow Endpoints

  • SourceAppId is now returned in the response body of the following API calls:

    • GET/v3/workflows

    • GET/v3/workflow/{workflowID}

    • GET /admin/v1/workflows/migratable

  • The following can now be called by Artisans:GET v3/workflows/{workflowId}

  • Filtering by status and resultCode has been added to GET v3/workflows/{workflowID}/jobs:

For more information, go to Server 2024.2 Release Notes and Workflow Endpoints.

New API Endpoint to Allow Updating Individual Schedule Settings

Use the new API endpoint PATCH /v3/schedules/{scheduleId} to update a schedule without having to populate several required fields to make a single change. For more information, go to Schedules Endpoints.

Updates for Job Endpoints

  • New API endpointGET /v3/jobs/{jobId}/messages

    This endpoint is for Curators only. Use the jobId as an input parameter to retrieve the corresponding messages for that job.

  • Updated API endpointGET /v3/jobs/{jobId}

    The GET /v3/jobs/{jobId} endpoint has been updated so users can see the jobs that have been shared with them via Collections.

For more information, go to Job Endpoints.

2025.1

What's New / Release Notes

Version

Actions to take when upgrading to—or past—this version.

2025.1

New Credentials Page for Non-Admin Users

Non-admin users now have access to a Credentials page in the Server UI. This page allows them to view, create, edit, and delete custom credentials. Refer to Credentials: Server User Interface for more details.

2025.1

Added Workflow Results View for Admins

Admins now have the option to view the workflow results and Job messages on the Workflow Results view. For more details, go to Workflow Results: Admin Interface.

2025.1

Added Auditlog for Alteryx System Settings

Updates to the RuntimeSettings.xml via the Alteryx System Settings application are now logged under C:\ProgramData\Alteryx.

2025.1

Server API

New Endpoint to Cancel a Specific Job

Added the DELETE /v3/jobs/{jobId} endpoint to cancel any running or queued job (manual or scheduled).

For more details, go to Job Endpoints.

New Endpoints for Shared Server Credentials

Added the following endpoints for Server credentials (non-DCM):

  • Create Server credentials: POST /v3/credentials

  • Update password for existing Server credentials: PUT /v3/credentials/{credentialId}

These endpoints are available only to Curators and require TLS to be enabled. For more information, refer to the Credential Endpoints help page.

Added Cron Expression for Schedule Endpoints

Added a dynamic scheduling flexibility by using Cron entries. You can now use Cron expression in these APIs:

  • POST /v3/schedules

  • PUT /v3/schedules/{scheduleId}

  • PATCH /v3/schedules/{scheduleId}

  • GET /v3/schedules/{scheduleId}

For more details, visit the Schedule Endpoints help page.

2025.1

Admins Can Invite Users to Add Credentials

This feature allows admins to invite a user to add a Shared Credential that the admin can then manage and share. Refer to Invite to Create or Edit a Credential for more details.

2025.1

SAML Assertion Encryption Support Added

We now support SAML assertion encryption, allowing you to both encrypt and sign assertions. This feature is available in both FIPS and non-FIPS environments.

For configuration details, see the Configure Alteryx Server Authentication help page.

2025.2

What's New / Release Notes

Version

Actions to take when upgrading to—or past—this version.

2025.2

PIT-STOP

CRITICAL

Upgrade Embedded MongoDB to Version 8

Impact: As part of Server 2025.2 installation, embedded MongoDB will upgrade to version 8.0.

Task: Review the Schema Version Crosswalk to ensure your upgrade path moves to the same version of MongoDB or only one version higher. You cannot upgrade Server directly across more than one MongoDB version at a time. For more information, refer to the Server 2025.2 Release Notes.

2025.2

Server to Alteryx One

Alteryx Server now includes a new “Connections – Alteryx One” feature on the Controller page. This feature simplifies and secures the process of linking your Alteryx Server environment to the Alteryx One Platform. It enables direct transfer of lineage metadata from Server to external data catalogs (such as Atlan or Collibra) through Alteryx One.

Tasks:

  • Set up the connection in Alteryx One Platform. For more information, refer to Data Lineage Connection.

  • Set up the connection in Alteryx System Settings. For more information, refer to Controller.

2025.2

Decoupled Designer and Server Updates

You can upgrade Designer independently from Server, so users can immediately access the latest Designer features without waiting for Server approval or environment upgrades. Assets built in newer versions of Designer are no longer blocked from being published to older Server environments.

For important details and ongoing updates, go to Designer Server Version Compatibility.

Because of this change, a new parameter has been added to workflow API endpoints. For more details see New Parameter Added to Workflow Endpoints.

2025.2

Updated Server Host Recovery Process

Choose between 2 recovery options:

  • Manual: Complete all steps yourself.

  • Scripted: Use the new recovery script to automate preparation, installation, and restoration of RuntimeSettings and MongoDB, then finish the remaining steps manually.

Download the script from the License Portal. For more information on the new recovery process, go to Server Host Recovery Guide.

2025.2

Schedule Analytic Apps from the Server UI

You can now schedule Analytic Apps directly from the Server UI. To schedule an Analytic App, simply select the app in the Server UI, select Schedule, set your preferences, complete any required input fields, and save the schedule. For more information, refer to Schedule a Workflow.

2025.2

Server API

New API Endpoint for Monitoring Jobs

Added the GET /v3/jobs/ endpoint to monitor all jobs on Server.

For more details, go to Job Endpoints.

New API Endpoint to Support SDK Connectors

Added the PUT /v3/dcm/connections/{id}/sharing/collaboration endpoint to DCM endpoints.

This endpoint is available only to Curators. For more information, refer to the DCM Endpoints help page.

New Parameter Added to Workflow Endpoints

To support decoupled Designer and Server updates, a new parameter—bypassWorkflowVersionCheck—has been added to the following workflow endpoints:

  • POST /v3/workflows

  • POST /v3/workflows/{workflowId}/versions

This allows you to bypass the guardrail that typically blocks uploads if the Server version is older than the workflow version. For more details on usage, go to Workflow Endpoints.

2025.2

User Credential Sharing Features Completed

You can now use duplicate credentials—even if they aren’t shared via the Alteryx Server platform. This update also resolves usability and visual issues for a smoother credentials management experience.

For more information on credentials, go to Credentials: Server User Interface and Credentials: Admin Interface.

In this section: