Migration Prep Tool

Version:
2022.3
Last modified: December 02, 2022

The Migration Prep Tool for Server is a utility that allows for a pre-migration of a database of workflows and apps to be more quickly migrated to the new AES256 standard. 

This Migration Prep Tool is optional and a separate command line utility. You only need to run it once before you upgrade from Server 2022.1 (or earlier versions) to 2022.3.x or newer.

Why Did We Create This Tool?

Server is updating its cryptography to use AES256 for data at rest. All existing cryptographically stored data needs to migrate from its current encryption method to the new one. Some of this data can be migrated in advance of the upgrade to 2022.3 while your Server is in production.

The most time-consuming data that needs to migrate are the apps and workflows stored in Server. This data can be migrated in advance to save time when performing the upgrade to Server 2022.3.

Alteryx created the Migration Prep Tool to assist you in migrating this data before the upgrade. 

When to Use the Migration Prep Tool

We recommend you run the Migration Prep Tool in these cases:  

  • If the Server installation you are upgrading is a production system or a development system that can't be down for more than a few hours, and 
  • You have more than a few hundred workflows, and
  • You are running on MongoDB Atlas or user-managed MongoDB. 

Further, you might also consider the size of db.AS_App_Chunks.dataSize() and AS_PackageDefinitions. We don’t have recommendations related to the database size for when you should run the Migration Prep Tool in prep mode. 

If you only have a few workflows or you don’t mind if Server takes several hours to days to upgrade, you can skip using the Migration Prep Tool and run the standard Server installer to upgrade to 2022.3. The downtime will be longer than usual since the crypto migration will be part of the upgrade. 

If you choose to not run the Migration Prep Tool before the upgrade, the tool will be installed and run as part of the 2022.3 upgrade installation.  

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.