Skip to main content

Server Host Recovery Guide

This guide is intended to assist a Server administrator with recovering a Server instance in the event of failure of an original host or hosts, when moving to a new upgraded Server, moving from an on-premises to a cloud server, and in other cases where your infrastructure changes.

A Server recovery allows you to get a new Server running with your original users, workflows, schedules, etc., based on having the following from your original Server:

  • Controller Token

  • RuntimeSettings.xml from Controller node

  • MongoDB backup

Below are details for each step of the process:

1 - Prepare

2 - Recover RuntimeSettings.xml

3 - Recover MongoDB

4 - Restore Other Files and Settings

5 - Start Alteryx Server

6 - Test

In Scope

  • Recovery from the failure of a single, default Server installation using embedded MongoDB.

  • Available backup with necessary information intact.

  • The target machine(s) can be overwritten.

Out of Scope

  • Multi-node Server environment, user-managed MongoDB, or user-managed SQL Server - please contact Customer Support for help.

  • Merging of databases of connection files.

  • Back up or restoration of ODBC drivers.

  • Back up or restoration of User or system DSNs.

  • Back up or restoration of other aliases stored in Windows that exist outside of Alteryx.


  • Install all database drivers and necessary software for workflow operation before completing the steps outlined in this guide to ensure minimal downtime.

  • Administrator rights on the target Server.

  • Access to all credentials used for impersonation including, the service account (if not Local System), the Run As user, and any defined/used workflow credentials.

  • Controller Token from the original Server.

  • Access to RuntimeSettings.xml from the original Server is found here: %ProgramData%\Alteryx\RuntimeSettings.xml.

  • Backup of MongoDB from the original Server. Learn how to perform a backup.

    • For more information on Server Backup & Recovery, please see the Server Backup & Restore Best Practices: Part 1 and Part 2.

  • Verify the target Server is set to the same time zone as the original Server in Windows time zone settings. If not set to the same time zone, errors might occur in schedule views.


The following items might not have been leveraged in the original Server. Check if the functionality was used and complete the corresponding steps marked (Optional) in this guide.

  • Service Log On user, if used.

  • Run-As User details for Worker configuration:

    • Domain

    • Username

    • Password

  • SMTP server username and password for Server configuration.

  • Connectors from %ProgramData%\Alteryx\Tools.

  • Alteryx System-Based and In-DB Connection aliases from the original Server.

    • System In-DB Data Connections see %ProgramData%\Alteryx\Engine\SystemConnections.xml

    • System Data Connections see%ProgramData%\Alteryx\Engine\SystemAlias.xml

  • Alteryx User-Based and In-DB Connection Aliases from the original Server – the below might be relevant for each run-as or workflow credential user account

    • User Data Connections see C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserConnections.xml

    • User In-DB Data Connections see C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserAlias.xml

Step 1: Prepare





Set machine time zone

The Windows time zone of the new machine must be set to match the original machine.


Ensure access to Alteryx

Ensure the machine can contact used by the Alteryx licensing system.


Install the same version of Server

Perform a clean install of the same version Server that generated the Mongo backup.

Use the latest maintenance release for the quarter, for example, if your backup is from version 2022.4.2 and the 2022.4.5 maintenance release is available, use that release. If your version is not still available at, please contact

Install or Upgrade Server

Test the Server UI appears in a browser, you do not need to log in.



License key "in use" error

If your license key is still tied to your old server you will need to deactivate it on that machine. If that machine is inaccessible, contact your License Administrator to release the license.

Step 2: Recover RuntimeSettings.xml





Open Command Prompt 1 in bin folder

Open a Command Prompt As Administrator and navigate to the Alteryx\bin folder, enter the commands below (adjust based on your install location).

c: cd \Program Files\Alteryx\bin


Stop the Service

Enter the command

net stop alteryxservice

On success you should see "The AlteryxService service was stopped successfully."


Backup existing RuntimeSettings.xml

Enter the command

c: cd \ProgramData\Alteryx ren RuntimeSettings.xml RuntimeSettings_BACKUP.xml


Restore RuntimeSettings.xml

Copy the RuntimeSettings.xml file from your original server to the current %ProgramData%\Alteryx\ directory.


Clear Controller Token

Edit the RuntimeSettings.xml you just copied and delete everything between the <ServerSecretEncrypted> tags, leaving just the tags as shown below:


Save and close the file.


Restore Controller Token

Enter the command using your original server Controller Token

AlteryxService.exe setserversecret=CONTROLLER_TOKEN_FROM_ORIGINAL_SERVER


Version 2021.3+ can error on this step with: "Set server secret failed: Error in CryptImportKey(3): Bad Data. (-2146893819)". To correct this, see the previous step to ensure the value was removed from between the tags.


Restore Storage Keys Encrypted

The <StorageKeysEncrypted> value might have changed when the controller token was reset in step 2.6. If so, it should be replaced with the value from the original RuntimeSettings.xml file. If needed, open ProgramData%\Alteryx\RuntimeSettings.xml on your original machine to get the needed value. It is easiest to copy the tags as well to ensure that the entire value between them is copied from the original RuntimeSettings.xml file. You can leave RuntimeSettings.xml open in a text editor as you make further changes in step 3.

Step 2.7 Restore Encryption Keys


Restore Run As User

If you had a Run As User on the original Server, enter the following command, otherwise skip this step.AlteryxService.exe setexecuteuser=NAME,DOMAIN,PASSWORD


Restore SMTP Password

If you had filled in Alteryx System Settings > Server UI > SMTP > Password (even if the SMTP checkbox was unchecked), enter the following command, otherwise skip this step.AlteryxService.exe setsmtppassword=PASSWORD


Save RuntimeSettings.xml

Save the RuntimeSettings.xml file.


Transfer Encryption Key

This functionality is only available on the following versions:

  • 2021.4.2 Patch 11+

  • 2022.1 Patch 9+

  • 2022.3 Patch 6+

  • 2023.1 Patch 2+

  • 2023.2 GA+


Please note that this requires the AlteryxService to be running on your original Server Controller node and your new Server will need to be able to access it over the network.

The steps in Encryption Key Transfer Process will allow you to transfer the encryption key from your existing controller to your new one.


Remain on the Command Line

Step 3 assumes you are in an Administrator command line in the  \Alteryx\bin folder.

Step 3: Recover MongoDB




Get MongoDB backup

Copy the Mongo backup from the original server to a MONGO_BACKUP folder on your new Server.


Restore to a new folder

Restore the Mongo database from the backup folder to a new restore folder. The final parameter, ,10, ensures lower memory usage by MongoDB during the restore. This reduces the chance of out-of-memory errors but might increase the time to restore. Leaving off the ,10 might lead to faster restores. In either case, review mongoRestore.log as described below to ensure the restore was successful.

AlteryxService.exe emongorestore="MONGO_BACKUP_FOLDER","MONGO_RESTORE_FOLDER",10


AlteryxService.exe emongorestore="D:\db_bkp","%ProgramData%\Alteryx\Service\Persistence\Mongo_Restore",10


Confirm the restore was successful

Confirm the restore was successful.


This is a necessary step as a restore failure will not be reported in the previous step and can lead to missing data on your Server. To do so, review the mongoRestore.log file in the MongoDB folder where the data was restored. Open mongoRestore.log and follow these steps:

  • Confirm that it reports #### document(s) restored successfully, 0 document(s) failed to restore on the last line.

  • Search for error, critical, fatal, and failed. If you are looking for failed, make sure the result is different from the sentence in the previous point, which contains 0 document(s) failed.

If the recovery has failed, or if you find any results when searching the key words listed above, please contact Support with all the information you have gathered.

Do not proceed if the MongoDB restore failed.


Set Mongo path in RuntimeSettings.XML

Edit RuntimeSettings.xml and enter the path to the MONGO_RESTORE_FOLDER in the <EmbeddedMongoDBRootPath> tag.


Set Mongo path in RuntimeSettings.XML

Save and close the text editor.


Start MongoDB

Enter the command

mongod ––dbpath "MONGO_RESTORE_FOLDER" ––auth ––port 27018


mongod ––dbpath "%ProgramData%\Alteryx\Service\Persistence\Mongo_Restore" ––auth ––port 27018

Do not close the command prompt window.

If you close the window from step 3.5, none of the subsequent steps will work.

<< Begin second Command Prompt section >>


Open second Command Prompt in bin folder

Open a SECOND Command Prompt As Administrator and navigate to the Alteryx\bin folder, enter the commands below (adjust based on your install location).

c: cd \Program Files\Alteryx\bin


Get Non-Admin Mongo password

Enter the command and copy your NON_ADMIN_MONGO_PASSWORD to Notepad

AlteryxService.exe getemongopassword


Start Mongo Command Line

Enter the command

mongosh mongodb://SERVER:PORT/AlteryxGallery -u user -p NON_ADMIN_MONGO_PASSWORD


mongosh mongodb://localhost:27018/AlteryxGallery -u user -p CCEC***33C0

On success you should see a ">" prompt.


Delete locks set by original Server

Enter the Mongo command


On success you should see: "writeResult({ “nRemoved” : N })", where N is a number between 0 and 3.


Quit Mongo Command Line and Command Prompt 2

Enter the command


Close Command_Prompt_2

<< End second Command Prompt section >>


Stop Mongo database

In the original command prompt, enter the keyboard command


one or more times until you exit MongoDB and return to a normal command prompt.

Close the command prompt.

Step 4: Restore Other Files and Settings





Did you have a Service Log On User on the original Server?

Set Service Log On User on new Server.

Windows Services app > right-click AlteryxService > Properties > Log On


Add data drivers and System DSNs.

Add same-version drivers and same-name System DSNs to match original Server,

Advanced issues that may not apply to your recovery:


In more secure environments, configure required Run As user permissions.

Ensure all credentials used to run workflows (Run As, Service Log On, or credential set when saving the workflow) have proper sufficient access, configure required run user permissions.


Restore System-based and In-DB Connection Aliases

System Data Connections:


System In-DB Data Connections:



Restore User-Based and User In-DB Connection Aliases

User Data Connections:


User In-DB Data Connections:



Do workflows use Connectors?

Copy Connector folders from your original server to


Contact Customer Support to enable Connectors on your new Server.


Do workflows use the Python Tool?

Re-install any Python packages that workflows had installed. See Server Upgrade Python Tool Environment Checklist.


Do workflows use the R Tool?

Coming soon.


Do you have a multi-node environment or user-managed Mongo?

(Coming soon) Contact your Account Executive or Customer Support.


Do you use SSL?

If you are recovering to a Sandbox Server for testing, use HTTP for testing.

If you are migrating to a new Server, re-establish your SSL:

Configure Server SSL/TLS

Configuring Alteryx Server for SSL Obtaining and Installing Certificates (15577)

Step 5: Start the Alteryx Server





Review Alteryx System Settings, suspend Schedules if desired.

Run Alteryx System Settings and step through each page confirming the settings (like the Controller Token) contain the values you expect.

If you do not want Schedules to run when the Service starts, uncheck:

Worker > General > Allow machine to run scheduled Alteryx workflows

When you select Finish,the AlteryxService should start and the Server should be available in a browser.


Pay extra attention to the Server UI Configuration settings as a new Server might have a different URL or might not have an SSL certificate.

System Settings, the Server UI configuration section.

Step 6: Test





Basic testing

Is the AlteryxService running?

Can you:

  • Access the Server UI URL?

  • Move around Admin pages and view Users, Collections, etc.?

  • Publish a workflow from Designer to the Server?

  • Run the workflow?

  • If your configuration allows, save and run a workflow specifying your credentials.


Workflow-specific testing

Can you run workflows that contain extensions or external connections, such as

  • Input/output to a network UNC path

  • Databases connections

  • Connector Tools

  • Location or Business Insights Datasets

  • Python Tool

  • R Tool