Looking for a comprehensive walkthrough of RuntimeSettings.xml

Question

I would love to know what each and every line of the ~200 lines of RuntimeSettings.xml do. I can see that many lines can be manipulated through the Alteryx System Settings and the names match up fairly well. There are still some lines that guides and the community state should be manipulated directly in RuntimeSettings.xml, therefore these lines do not exist in the System Settings GUI. There seem to be some missing pieces of the puzzle. Does anyone have a definitive breakdown of each line, what it does, what are the possible settings, are they manipulated directly in the xml or in System Settings, what are the best practices, etc?

ntobon · Answer

@seven

1. The following Knowledge Base article provide information about the Alteryx Server System Settings which are stored in the RuntimeSettings.xml file:

Alteryx Server System Settings Deep Dive - Engine
https://community.alteryx.com/t5/Alteryx-Server-Knowledge-Base/Alteryx-Server-System-Settings-Deep-Dive-Engine/ta-p/421508

This article says:

"Note, this file should never be modified through an editor unless specifically requested from Alteryx Customer Support.

A few of these settings are self-explanatory and sufficiently described in the Help. However, many of these can often be confusing, and some have performance implications that aren’t well understood. The subsequent sections will dive into these settings in more detail."

2. Some options that can be configured using the RuntimeSettings.xml:

https://help.alteryx.com/current/server/control-designer-access-gallery

https://help.alteryx.com/current/server/server-host-recovery-guide

How To: Enable MongoDB logs in RuntimeSettings.xml
https://community.alteryx.com/t5/Alteryx-Server-Knowledge-Base/How-To-Enable-MongoDB-logs-in-RuntimeSettings-xml/ta-p/393659

How To: Modify Gallery Session Timeout
https://community.alteryx.com/t5/Alteryx-Server-Knowledge-Base/How-To-Modify-Gallery-Session-Timeout/ta-p/430981

Running Alteryx Server on a port other than 80
https://community.alteryx.com/t5/Alteryx-Server-Knowledge-Base/Running-Alteryx-Server-on-a-port-other-than-80/ta-p/30674