Engine Works

Samantha_Jayne · ‎04-10-2025

Introduction
Upgrading Smart
Version to Version Guide
Treating Designer Desktop & Alteryx Server as One Upgrade
Which version type should I install? Admin or Non-Admin?
Can Designer Desktop version be newer than the Server?
Key Steps to an Alteryx Upgrade
Testing
Summary

Blog 2 - Owning Your Server.png

Introduction

As a previous customer and Sales Engineer, I have seen a need for an open series of blogs to support our Server-purchasing customers. A place where they can come and learn about Alteryx Server and how to implement a standard installation. This blog series may expand further to include some non-standard ways, but one must start somewhere, so I will keep it as simple as possible to explain concepts, best practices and key decisions you need to make when getting started, owning and using an Alteryx Server. So, strap in, grab a cookie, and let’s get started.

This blog is the second part of our series, all about owning your server, being aware of and supporting that important task of upgrading once a year, and the best practices around that. The last thing we want is our customers in version paralysis, unable to move because they are not aware of all the right steps to take to upgrade. So, I promise to keep this pragmatic and helpful to get through your annual upgrade.

You can find the first part of the series here Alteryx Server Success: Getting Started.

Upgrading Smart

First thing is first, upgrading annually is important. You want to keep all those amazing features new and fresh but at the same time you want to ensure you don’t bring into your environment any bugs either. So, like the good folks in IT, it is our recommendation to stay within Version minus 1 (V-1) from the latest release. In other words, the major release before the latest release, to ensure you have the bugs ironed out and the security you need. Upgrading to the latest version is always at your own risk, no matter which software you are upgrading. 😉 I would also recommend you read the release notes--these are incredibly useful and provide all the detail you need to know about the release.

We have a great guide to help you within our help pages: Server Upgrade Checklist.

At this point, you can involve a partner or Alteryx Professional Services to help you.

Blog 2 - Stop Decision Time.png

Like blog one, you need to understand your environment and what you plan to upgrade. If you are new to Alteryx Server, take a moment to understand all the components which have been installed and are part of the environment. This is important because you will impact the business processes which are run on the Alteryx Server if you do not upgrade everything in sync. Understand if you are a single node or multiple node environment before you get started and the order in which items need to be carried out.

As part of this series I built a tool to help (download it here), and you can run this tool on your previous environment, which helps you document what is being used to get you started. You and your end users know your setup better than I will, so use this documentation to talk with them and get approval for the parts of your installation that require updating.

Blog 2 - Alteryx Env Tool.png

Also remember Designer needs to be upgraded as well so if you are an organization who packages your software and you are required to, and planning to upgrade your Server without working on the Designer package, it may already be too late. So please go and speak to the packaging team to organize your latest version of designer to be packaged.

Blog 2 - Advisory Timescales.png

Version to Version Guide

Here at Alteryx, we love to equip you with the tools you need to support your upgrade, however I have seen that not a lot of Server administrators are aware of these tools within the community.

The version-to-version guide is a great tool to help you understand the major differences, or points of awareness between versions. Such as upgrading to 22.3 you need to complete the crypto migration process, upgrading to 24.1 has a major python base update. You need to be aware of these major differences between versions so that you can inform your user base and plan accordingly as some of these changes will have business impact, being aware and mitigating them is important.

Alteryx Server: Version-to-Version Guide

How to use this guide:

Find your current version and scroll down to the version you are moving to, reading all the points in between. The points highlighted in the table above will need to be understood by Admins. All other points are worth noting and highlighting those which will impact your end users at your earliest convenience.

Communication is key throughout an upgrade lifecycle.

For example, moving from 22.1 to 24.2 would have the following critical steps:

(BOLD is highlighting areas where I would talk to end users)

22.3

Upgrade 22.1 to Patch 9
Crypto Migration of the MongoDB
Designer Version Requirement: Designer 2022.3 required
Configuration Change: SAML ACS endpoint must be all lowercase

23.1

R Upgrade: Embedded R version upgrades from 4.1.3 to 4.2.3

23.2

MongoDB Upgrade: Embedded MongoDB upgrades from version 4.2.15 to 6.0.5
MongoDB Upgrade Dialog: The dialog to initiate the embedded MongoDB upgrade is minimized

24.1

Python Upgrade: Embedded Python upgrades from 3.8.16 to 3.10.13
MongoDB Datetime Field Change

24.2

Upgrade Embedded MongoDB to Version 7

Depending on your organization, some of these points may not be required, and others may be needed. It is important to take a moment to reflect at this point and understand your end users and what they use Alteryx for, so that you are very aware of the requirements of the platform and know when something would impact workflows.

As you can see, the bigger the gap between versions, the more you have to mitigate between them. This is why it is very important to have an annual upgrade cycle. Ideally, the above example should be a very rare one.

Should you find yourself in the rare scenario as described above; deciding how to "hop" to your version, so you avoid installing several times, can be tricky. Here is our recommendation: the main point you cannot ignore is the MongoDB version, as you can only move past one MongoDB version during your upgrade, not two.

So for the example above, to get to 24.2 from 22.3, you would have to install 24.1 then 24.2. However if speaking with the business you discover you are a massive Python user, you may need to have a "hop pause" where you install 23.2 and then pause whilst you mitigate and plan for your Python dependencies then move to 24.2. This is why the version to version guide alongside effective communication with your end users is incredibly important to make these decisions.

Further useful documentation:

URL	Description
System Requirements	We have an open Server requirements page for our customers via our help pages. We also update this per version so that you are aware of the minimum and recommended requirements for your hardware for the version you plan to move to. I would always take a moment to check what you currently have and compare to what you need moving forward.
Release Notes	And of course, we have our release notes, which provide a detailed understanding of what has changed and what is completely new in the version you are reviewing. All end users, as well as admins, should read these. I often ran quizzes at my local user group to help people understand the new features landing in the current release. It can be fun.
Server Pre-Upgrade Checks	When using the Server Checklist, you will be introduced to the pre-upgrade checker, which checks the integrity of your embedded MongoDB before upgrading. I would carry this out before every upgrade to keep the integrity of your MongoDB to a required standard.
Migration Prep Tool	You will also be made aware of the Crypto Migration Requirement when moving to or beyond version 22.3. This is a major pit stop for customers to be aware of to increase the encryption level of your data in MongoDB so that users can be assured that we have done our best to keep your data safe and secure.
MongoDB Backups	The Server Checklist will also link you to how to create a backup and restore your MongoDB before carrying out an upgrade. You must be very familiar with these details and information on the community. Backups are essential!
Critical Server Files and Settings	The Server Checklist is a great resource to keep you aligned with the activities specific to your Alteryx Server upgrade. Beyond the MongoDB backups there are some critical files I recommend taking some copies of too, to protect you against full failure. When you do backups regularly, this becomes second nature.

Treating Designer Desktop & Alteryx Server as One Upgrade

It is important to treat Designer and Server upgrade as one, as per my graphic at the start of this blog post. There are often questions about Designer Desktop that come up with relation to Alteryx Server installations from customers, so I will pop them in this section to keep them together.

Which version type should I install? Admin or Non-Admin?

The honest answer it really doesn’t matter, both are the same, however you should be consistent with your decision across your organization to make it easier to maintain. Consistency is key, it makes sense, it’s standardization ahead of time and enables you to package the software and apply changes to it in an easy to manage way. The key differences is that an non-admin will install under a user profile and an admin will install for all users on that machine.

Golden Nugget #2 – Create a Setup Folder

When going into an upgrade or installation, create a folder with all the necessary parts for the installation and number order them. This could be a folder for Designer Desktop and one for Alteryx Server. Walk through the installation on a test machine and document all steps the process and save that into the folder as well. It will make all the difference when engaging with your IT teams.

Can Designer Desktop version be newer than the Server?

The answer here is No. Your Alteryx Server should always be the version -1 you are installing within the business and all Designers that need to communicate with it should be on the same version or lower. Ideally the same version, as this means you will have access to all the same functionalities. Yes, this means sometimes eager Designer users have to “downgrade”.

Blog 2 - Are You Ready.png

Key Steps to an Alteryx Upgrade

By now we have gone over a few basics around what you need to be aware of an how to think and approach your upgrade. A reminder that the best guide to walk you through your upgrade is here: Server Upgrade Checklist

The following keeps high level with the Server Upgrade Checklist in mind and alongside your Designer Upgrade.

Plan your Server Upgrade
1. Understand your current Alteryx estate
  1. Alteryx Environment Tool
2. Decide your Version
  1. Version to Version Guide
Arrange your Designer Package Deployment
1. Pilot Group
  1. Create a pilot great of individuals to support your cause with one of the following methods.
    1. Should be from different departments
2. Manual (not a package deployment but individuals given the rights to install on their machines)
  1. Create a setup folder where everyone can access installation files
  2. Download the installation files
  3. Create steps and order of installation document
  4. Block out time in users diaries to encourage installations during a certain period
  5. Offer drop in sessions to enable support on mass, when the same issues arise its clear to see.
3. Automated (Packaged deployment with IT team)
  1. Engage with your internal IT packaging team
    1. Always take up their offer of a test machine!
    2. Provide handy links to them like this one: Command Line Options Guide
  2. Create a setup folder
  3. Download the installation files
  4. Create steps and order of installation document
  5. Customer Managed Telemetry - Runtimesettings.xml updates to enable this to a central location
  6. Organize rollout methodology to be OPTIONAL not forced until after Server installation.
4. Once package or manual deployment is ready
  1. Ask your Pilot Group to test ahead of the Alteryx Server Upgrade
Prep Work for your Server Upgrade
1. Design your rollback plan
  1. Backup your Production
  2. Critical Workflows available locally
  3. Key setting files
2. Pre Upgrade Checks
  1. Document all mitigations and methods
Upgrade Sandbox Environment
1. Using your Production backup (Point 3.1.a)
Testing on your Sandbox Environment
1. All business critical workflows should be tested
2. Gallery Collection owners to sign off their areas, post testing
3. Depending on the size of your business but a 1 week window tends to work well
Troubleshoot
1. Remember the following resources:
  1. Support
  2. Community
  3. Knowledge Base
  4. Technical Account Manager (Troubleshooting)
  5. Account Team (Escalation)
Sign off Sandbox as Completed
Prep Work
1. Just in case it was a long time between Sandbox and Production, take another backup 😉
  1. Backup your Production
  2. Critical Workflows available locally
  3. Key setting files
2. Pre Upgrade Checks
  1. Use any previous documented mitigations (Point 3.2.a)
Upgrade Production
Testing on your Production Environment
1. All business critical workflows tested
2. Gallery collection owners to sign off their areas as tested
3. Depending on the size of your business but a 1 week window tends to work well
Troubleshoot
1. Remember the following resources:
  1. Support
  2. Community
  3. Knowledge Base
  4. Technical Account Manager (Troubleshooting)
  5. Account Team (Escalation)
Sign off your Production Environment as Completed
Rollout your Desktop Designer package

Testing

Good end user testing is always recommended when deploying and upgrading technology. If you are using collections within your Alteryx Server, I would recommend having a lead tester in each collection. This way you can deliver the right messages through great communication to all the teams through your network of collection leads.

Don’t forget that not everyone is a Server user, so ensure that you have a pool of Designer only users to call up on too.

Always test your business-critical workflows. Always. Before you begin the upgrade process on a sandbox environment. When it comes to testing your designer deployment, you want to make sure all the fundamental functions and features are working for you.

Run a workflow in designer you know well
Open a workflow from Server and run it
1. Make a change and save it
2. Run it on the Server gallery
3. Check for expected outcomes
Use the one tool examples to test predictive tools, formula tool, intelligence suite are working within your Designer.
Test your connections and drivers, especially the marketplace tools as with python upgrades, etc. these may need to be reviewed if not upgraded.
1. Perhaps build one tool examples for your organisation in which you can open up and run during these tests.
Run a selected few workflows which include, macros, interface tools, Python & R scripting and data packs to ensure all functions here are working as expected.
Anything environmental or organisational specific, do add this in, this list is not exhaustive but to give you great ideas to get started.

Windows Groups come in handy here. (If you're not sure what this is, please pop back to blog #1.) I would recommend having windows groups with emails setup for communication to the end users. You will have a group of Server Users and Designer Users; you can break this down to as complex as you need. But I would always keep it simple. Set up a group for server users to email everyone when there is news for the Server, and a group for Designer users to update on the Designer side. Also, by having these groups with automated packaging you can use these groups across your organization to automate who gets access to Designer. Once their name is added to the Designer group, they get Designer installed on their machine for example. 😉 Ah the automation life continues.

Another group I have had in the past is an Administrator group which includes my IT folks to ensure everyone is up to date on internal messaging and deployments.

Ideas for group names 😊 AYX_Designers_Users, AYX_Server_Users, AYX_Administrators. You are welcome.

Summary

This blog shows how to approach a full upgrade with Alteryx Server as well as Alteryx Designer in your business. I hope it has also brought together a number of useful resources for you to rely upon.

I do hope this has helped you plan for your next upgrade and feel confident to attack it with purpose. Should you need support, or you have found yourself in a situation of having to upgrade past many versions, do reach out to your account team to involve Professional Services or your Partner to support.

If you have any questions, please let me know below, and I will continue to expand on this blog series to help our customers get the best Alteryx Server Success for their organizations.

I’ll see you next time, where I will help you understand how to get the most out of USING your Alteryx Server.