Welcome to the Alteryx Knowledge Base
How To: Downgrade Alteryx Server
Created/Edited -
How To
Environment
- Alteryx Server
- All Versions
- Embedded MongoDB
- All Versions
Note: Prior to downgrading, you may wish to search Alteryx Community and/or contact Alteryx Support to discuss reasons for the downgrade.
Important: Please ensure you have a backup of MongoDB prior to the upgrade. Without this you will NOT be able to downgrade.
Prerequisites
- Administrator permissions on the Server machine
- Server down time to perform downgrade
- Installer file for previous version of Server you are downgrading to
- MongoDB backup taken from the previous version that you are downgrading to
- If downgrading from version 2022.3+ to a version older than 2022.3, the backup Runtimesettings.xml file from prior to upgrade to version 2022.3+ is required: "C:\ProgramData\Alteryx\RuntimeSettings.22_2_legacy.xml"
Procedure
The following expands on the Help page Downgrade Alteryx Server
Downgrade Alteryx Server
This procedure shows how to downgrade Alteryx Server to an older version that was running before in the same environment. For the purposes of this article we are downgrading from Alteryx Server 2021.2 to 2020.4 as an example.
- Connect to the Alteryx Server. For multi-node environments, connect to the Controller Node hosting the embedded MongoDB
- Open the Services.msc console and Stop the service. See How to start the Alteryx service but select Stop instead of Start
Note: If the service is stuck in a stopping state, its likely you have job running or queued. Please review this article for more info.
- Open the Control Panel by searching for Control Panel in the Start Menu
- Click on Programs and Features and uninstall both Alteryx 2021.2 x64 Server and Predictive Tools. Pedictive Tools may uninstall with Server
- Click Remove and continue through any prompts to uninstall the program. Check the Control Panel again to confirm both Alteryx Server Package and Predictive tools have been uninstalled
- If you are downgrading from version 2022.3+ to a version older than 2022.3, you will need to restore your original RuntimeSettings.xml
- Rename %ProgramData%\Alteryx\RuntimeSettings.xml to RuntimeSettings_rollback_bkp.xml
- Rename RuntimeSettings.22_2_legacy.xml to RuntimeSettings.xml
- After uninstalling the current version of Server, run the Alteryx Server Installer for 2020.4.6 or whichever version your downgrading to. Right-click on the installer file and select Run as administrator
- Select the folder path to install to if different from the default location, then select Next
- Check the License Agreement and Click Next
- Once the installation is complete, you will be prompted to install Predictive tools as shown in the below image. If you intend on staying on this version and have workflows that rely on predictive tools, select Install Predictive Tools then Finish. If not, you can skip the Install Predictive Tools option and click Finish
Note: For multi-node environments, follow the same process on each node.
Restore MongoDB Database
The next step is to restore your MongoDB database to the previous version.
- At this point the Alteryx Service should still be in a Stopped state. Check the services.msc console to confirm
- Restore MongoDB from the latest MongoDB backup taken from the version that you are downgrading to. The steps to restore the MongoDB and verify its success can be found in the Restore from a MongoDB Backup section in this Help documentation page on MongoDB Backup
Post Downgrade Checks
- Check that the Server UI (Gallery) is accessible and the expected content such as users, workflows, and schedules have been successfully restored
- Check the Gallery logs for any unexpected locks. The logs' location can be found here. If you see the below errors, please contact Alteryx Support to investigate further
2020-05-11 15:53:06.564593,FATAL,18,QueueWorker,RunOnce,,,,LD-LT-241,,,,,,Lock obtain timed out: MongoDB.Lucene.MongoDocumentLock->Retry in (1) seconds...,"Lucene.Net.Store.LockObtainFailedException: Lock obtain timed out: MongoDB.Lucene.MongoDocumentLock-context, String name)
2020-05-11 15:33:59.700855,FATAL,20,QueueWorker,RunOnce,,,,LD-LT-241,,,,,,Failed to obtain IndexWriter lock.->Retry in (1) seconds...,System.Exception: Failed to obtain IndexWriter lock. -> at Alteryx.Server.Models.BackgroundThread.QueueWorker.RunOnce()
Note: If you don't feel confident with the process please reach out to Alteryx Support for additional assistance.
Additional Information
Was this article helpful?