This site uses different types of cookies, including analytics and functional cookies (its own and from other sites). To change your cookie settings or find out more, click here. If you continue browsing our website, you accept these cookies.
This is the second article in a series to explore the Alteryx Server System Settings in depth to gain a deeper knowledge of what these settings are used for, and to provide a bit more context to help you determine the appropriate settings for your environment. The first article in this series is: Alteryx Server System Settings Deep Dive - Engine. In this article we will focus on the Worker. The Alteryx Service Worker is responsible for executing analytic workflows, servicing Insights, and rendering map tiles. There must be at least one machine enabled as a worker to execute workflows through the Service.
We’ll explore the Worker settings in sections matching how they are displayed in the System Settings wizard.
Worker - General
The Workspace is where the worker stores temporary or cache files, and unpackaged workflows for use when executing workflows. By default it is the same as the controller folder. This path should point to a location that is safe to store large amounts of files.
The same recommendations from the Engine “Temporary Directory” setting apply here:
It is highly recommended to set the Workspace to a different drive than your system boot drive (C:\). If the C:\ drive on Windows fills up, the system can become unresponsive or even unstable. If an additional drive (D:\) fills up, no harm is done to Windows and the system will remain functional.
The Workspace is used for frequent I/O operations to read and write data. Configuring this directory on Flash/SSD storage is a great way to improve performance by minimizing the wait times for those read & write operations to complete. See the Measuring and Scaling a Private Server blog post for more information.
Allow machine to run scheduled Alteryx workflows
Enabling this machine to run scheduled Alteryx workflows allows it to take requests to run workflows from the Scheduler or from the Gallery. In multi-node deployments, you may want to uncheck this option if you have another machine that will be running workflows, and want this machine to process map requests only.
Note, this setting needs to be enabled for the Worker to process either scheduled jobs, or manual jobs from users submitted through the Gallery.
Ensure you have at least 1 Worker configured to run scheduled Alteryx workflows.
In most cases all Workers should have this setting enabled. The exception would be if the Worker is to be used for Insights or Map Rendering only, which are covered below.
Workflows allowed to run simultaneously
This is the maximum number of scheduled workflows that are allowed to run simultaneously on this machine. You may want to increase this number to improve the responsiveness of scheduled jobs, but the overall processing time may be increased.
This is a very important setting for the success of an Alteryx Server deployment. The default value is 1. A higher value allows more workflows to run concurrently. However, it could also mean workflows take longer to process due to shared system resources. The blog post Measuring and Scaling a Private Server does a great job at explaining this in detail.
The general recommendation is to set the number of Workflows allowed to run simultaneously to ½ the number of physical cores. Many cloud providers list the number of “vcpus” or virtual cpus associated with instances, which can be misleading. The correct way to identify the true number of physical cores associated with a Windows Server (whether physical or virtual machine) is the following Powershell command:
Get-WmiObject -Class Win32_Processor | Select-Object -Property Name, Number*
Example machine with 4 physical cores and 8 virtual/logical cores
There is no one size fits all recommendation here as the best results will depend on the data sizes, types of tools in the workflow, and underlying hardware. Below are some general recommendations.
A good starting point is ½ the number of physical cores and this should be used in most situations.
If jobs are queueing, but overall system utilization (CPU & Memory) is looking good, consider increasing the setting by 1 and observe the effects. If workflow runtimes are impacted or system utilization becomes too high revert to the original setting.
If workflows are all In-Database then the Worker can likely handle a higher setting.
In rare situations, it may be beneficial to leave the default of 1. An example might be when processing extremely large data sets with Spatial tools. In that scenario allowing the system to dedicate all resources to processing a single workflow may produce faster execution times.
This setting should be in balance with the Engine Sort/Join Memory setting documented in the Engine Deep Dive Settings article.
Review this configuration with your Alteryx representative to determine an appropriate value.
Maximum sort/join memory usage (MB)
This restricts the amount of memory Alteryx uses when encountering Sort or Join tools in a workflow. A general rule for an appropriate setting is to be ½ the amount of system memory available, divided by the number of simultaneous workflows allowed to run.
Note, this setting was removed in 2019.3 as seen from the screenshot above.
Cancel jobs running longer than (seconds)
If you do not want jobs to run for an extended period of time, use this setting to force jobs to cancel after a certain amount of time has passed. This helps free up system resources that might otherwise be taken up by unintentionally long running jobs. This setting only applies to scheduled jobs and does not affect manual runs from the Gallery.
This setting is disabled by default and should only be enabled to prevent long running scheduled Gallery jobs. Note, the checkbox must be selected and a valued provided to enable this setting. If the timeout is reached an error will be displayed:
Quality of Service (Job Priority)
In an environment where multiple workers are deployed, selecting a priority level can determine which jobs are run by each worker. For normal operation with one machine configured as a worker, set this value to 0.
The Server doc describes the use of this setting well under the “Job Priority” section:
When a job request is handled by a worker, it compares the priority level of the job to the Job Priority value for the worker. Jobs that have a value greater than or equal to the Job Priority for the worker will be handled by that worker. For example, if a worker has a Job Priority of 0 and is available, the worker will handle any request. However, a worker with a Job Priority of 3 will only handle jobs that have a value of 3 or higher. This allows resources to be reserved for higher priority requests.
In a single Worker environment, leave the default value of 0.
In an environment with a separate Controller, consider enabling the Controller also as a Worker and setting this value to 6. This will allow the Controller machine to process workflow validation requests only. Workflow validations occur when saving a workflow from Designer to the Server. Having the Controller process these jobs allows the Workers to remain focused on processing actual jobs, and ensures the workflow validations complete quickly since they aren’t queued up waiting for a busy Worker to finish processing a job.
For more details and recommendations, see the Job Prioritization and Worker Node Assignment article.
A specific worker can be assigned to run a job. First, add a job tag for the worker, and then select that job tag when creating a schedule or running a workflow.
Run unassigned jobs : Select this option to use the worker to run jobs that have not been assigned a job tag.
Job tags : Add words that can be used to assign a specific worker to run a job. Separate multiple job tags with a comma. The same job tag can be added to multiple workers.
At least one worker should have the "Run unassigned jobs" option checked. Otherwise any jobs that are submitted without a job tag will sit in the job queue indefinitely.
If Job tags are used in a multi-Worker environment, consider placing each job tag on at least 2 Workers to eliminate a single point of failure.
For additional details on these settings and Job tags recommendations, see the Job Prioritization and Worker Node Assignment article.
Worker – Run As …
Run as a different user
If a worker machine needs to run workflows that access files or data from a location that requires specific credentials to access it, the machine can be configured to run the workflows as a specified user or account. To have the machine run as a different user, enter the Domain, Username, and Password.
If no specific credentials are provided, then by default workflows will be executed by the Alteryx Engine process using the SYSTEM user. Providing credentials allows the running workflow to access file locations that might be protected by specific permissions. It’s also possible to access databases that use trusted Windows Authentication. Any workflow credentials entered when executing from the Gallery, or default workflow credentials assigned to a workflow or subscription will override what is specified in this setting. The article How Workflow Credentials Work on a Private Gallery explains this setup in great detail.
Worker - Mapping
Allow machine to render tiles for mapping
Enabling this machine to act as a Map Worker will allow it to render map tiles for Map Questions and the Map Input Tool. In multi-node deployments, you may want to uncheck this option if you have another machine that will process map tile requests, and if this one will be dedicated to running scheduled workflows.
When Map Questions or Map Input Tools are processed in the Gallery, the map tiles are built via a Map Render Worker. At least one Worker must be configured as a Map Render Worker for map tiles to be built. The map tiles are cached for faster response times on the Controller machine according to the Controller’s Mapping settings.
Max number of render workers
You can specify the number of processes to be used for map tile rendering. The more processes allowed, the more simultaneous tiles can be rendered, but it will take up more system resources.
For a configured Map Render Worker, you can control the number of processes that can render Map tiles. The default setting is 2, and the maximum is 10. This configures the number of Map Render Worker processes as shown below:
These processes are idle taking up very little resources until map tiles are requested. When map tiles are requested, they can consume a small amount of CPU and memory and then quickly release those resources when the job is complete.
Configure at least 1 Worker to act as a Map Render Worker in the event map tiles are requested.
Keep the default value of 2 Render Worker processes unless heavy map tile usage is needed.
If extensive Map Questions and Map Input Tools will be used, consider configuring a separate Worker just as a Map Render Worker with a large number of Render Worker processes, but not to process Scheduled jobs or Insights. This will allow the machine to dedicate all resources to rendering map tiles and not conflict with running workflows.
If map tiles that have been previously loaded are taking a long time to load, consider increasing the Memory Cache and Disk Cache sizes on the Controller Mapping settings.
Worker - Insights
Enable Insight Worker
The machine can be configured to act as an Insight Worker and render insights, which are interactive dashboards created in Alteryx Designer and published in a Gallery.
In order to execute and display Insights, at least one Worker must be configured as an Insight Worker. Unlike Map Rendering where the Worker processes the Map Tiles and the Controller caches them, with Insights the Worker performs both duties. The Worker both loads the Insights and caches them for fast response times on future requests to the same Insight. In the case of a multi-Worker deployment, if an Insight is cached, all future requests for the Insight will be processed by the Worker which has cached that Insight.
In a multi-Worker environment, configuring one Worker as an Insight Worker is probably sufficient.
If heavy Insight usage is expected, multiple Insight Workers are recommended.
Insights allowed to run simultaneously
The maximum number of insights that can run simultaneously on the machine. The more insights that can be run simultaneously, the more system resources used.
Insights are built and cached via python processes. This setting controls the number of python processes which can run simultaneously. The minimum is 2 and the maximum is 10. Example processes are below:
Note, these python processes are only launched if an Insight is requested. Each Insight process may consume roughly 64 MB of memory.
In most situations the default value of 2 should be used.
If Insights are going to be used frequently, the total number of Insights allowed to run simultaneously across all Insight Workers should be equal to the number of expected concurrent Insight requests from Gallery users.
Max Cache Size (# of Cache Directories)
The maximum number of insights cached on a worker machine. Each insight consists of a description and data file, so each insight cache is a directory that contains those files.
The default value is 20. This means that up to 20 Insights can be cached on this Worker and then quickly loaded for future requests. The maximum value allowed is 100. If you need to cache more than 100 Insights then multiple Insight Workers are needed.
The sum of the Max Cache Size across all configured Insight Workers should be greater than the number of Insights in the Gallery. This ensures that all Insights can be cached for fast response times.
Max Port, Min Port
The range of port numbers designated for use when rendering insights.
Each of the python processes needs a port for passing the Insight to the Gallery. This controls the range of ports to allow. The default range is 100. However, only up to the number of configured Insights allowed to run simultaneously will ever be used. So for example in a default configuration with 2 Insights allowed to run simultaneously, only ports 8700 and 8701 would be used.
An Alteryx Server Worker has many settings that can impact behavior, user experience, and resource consumption. Understanding how each of these settings are used by the Server, and how some settings even impact others, will allow administrators to configure Alteryx Server optimally for their environment and usage. It’s important to note that any changes to the System Settings will perform an Alteryx Server restart on the respective machine. So, plan any changes carefully.
Help: Worker System Settings
Job Prioritization and Worker Node Assignment
Measuring and Scaling a Private Server
How Worfklow Credentials Work on a Private Gallery
Alteryx Server System Settings Deep Dive - Engine
Troubleshooting: Workflow was not saved Unknown Error XmlException
When trying to save a workflow to Gallery, the below error is observed:
Workflow was not saved Unknown Error XMLException RequestID...
Does the file name of the workflow contains an URL restricted character (i.e. an ampersand "&")? If so, see Solution A.
Does an Interface tool contain a URL restricted character in it's message section? (i.e. an ampersand "&")? If so, see Solution B.
Delete the URL restricted character in the file name and re-upload the workflow. Please note that as a best practice no special characters should be used in workflow file names.
Delete the URL restricted character in the message section of the Interface tool in the workflow and re-upload the workflow.
As always if you encounter issues and require further assistance please feel free to reach out to Customer Support.
Cannot Access Gallery from Server Machine Using FQDN or IP
When attempting to save a workflow to the Gallery or access the Gallery via FQDN (e.g., ayx.domain.com) or IP in the browser, you are continuously prompted for Windows credentials. This article refers to situations where this behavior occurs ONLY on the Server machine itself; but you are able to access Gallery and save workflows from remote machines using the same credentials.
Windows Authentication enabled
To ensure this issue is isolated to the Server machine, verify that you can access the Gallery via FQDN or IP in the browser and save a workflow to the Gallery from other machines (not the Server) with the same credentials.
Additionally, you should be able to access Gallery via the Server machine using "localhost".
Certain versions of Windows include a security feature called loopback check functionality.
Follow the instructions from this Microsoft KB article and choose either Method 1 (recommended) or Method 2:
Method 1: Create the Local Security Authority host names that can be referenced in an NTLM authentication request
Method 2: Disable the authentication loopback check
Error message when you try to access a server locally by using its FQDN or its CNAME alias
Schedules Disabled - "Logon Failure: the User has not been Granted the Requested Logon Type at this Computer"
A change in Run As credentials or workflow credentials can lead to the user(s) losing access to his/her workflows.
When clicking on a workflow the below error appears:
Error: Logon failure: the user has not been granted the requested logon type at this computer. (1385)
Apps appear in state 'Disabled'
When trying to access apps the above error message appears
This error occurs when the Run As User credentials or the workflow credentials do not have sufficient permissions on the server. More specifically, 'Allow log on locally' or 'Log on as a batch job' group policy permission are required for the user to log onto the server. If neither is granted to user the above error appears.
Check that that Run As credentials are set correctly. Refer to Help doc page - Set Required Run As User Permissions.
Specifically, 'Allow log on locally' or 'Log on as a batch job' group policy permission are required.
How Workflow Credentials Work on a Private Gallery
Troubleshoot "Invalid Username or Password" Error - Setting Up Workflow Credentials
Troubleshooting "Entering credentials has been disabled", "Credential usage is disabled"
Schedules stop functioning or error shows when disabling schedule
This occurs on 2019.3 and only appears if there is a Schedule with a Next Run time between 12-2 AM on 11/3 for the US and on 10/29 for Europe. This is due to the time change, and the Gallery is not able to determine the time zone the Workflow should run in.
Other symptoms which customer may report or describe: scheduled jobs are active/queued but not running.
There are two errors that can appear. The below will show in the Service Log soon after service start-up.
ServiceScheduler_DoWork_StdError: Fatal top-level error
The following error will show when attempting to disable an affected Schedule.
Schedules may show a Next Run date and time equal to the Last Run date and time which may be in the past.
Product - Alteryx Server and Alteryx Designer with Automation
This is caused by the Time Zone functionality not being able to recognize what time zone the Schedule is set for since the time it is scheduled for will 'repeat' with the end of Daylight Savings. It is recommended not to schedule anything for this time to avoid this issue.
Now that the time has changed, it should only be necessary to Restart AlteryxService.
If that does not resolve the issue then:
Delete the Schedules between 12 AM and 2 AM on the date of the time change (11/3 for NA and 10/29 for Europe)
Issue: Error '"You are attempting to upgrade from an unsupported version" when upgrading to 2019.3'
During the upgrade of Alteryx Server to 2019.3, you may encounter the following error once you attempt the migration of the Mongo database:
You are attempting to upgrade from an unsupported version. Upgrade to Alteryx Server version 2018.1 or later to attempt to upgrade to your desired version, or contact Alteryx Customer Support for assistance.
Alteryx Server 2018.1+
If you are running a version pre 2018.1, please upgrade to version 2018.1+ before attempting to upgrade to 2019.3. Do not continue further in this article.
If you are in fact running version 2018.1 or newer, confirm that your database is version 3.4.10 with the following steps:
Check which storage engine you are running:
The first step is to identify which storage engine you are using. You can easily identify which storage engine is being used by reviewing the file system:
Open the Alteryx System Settings
Navigate to the Controller > Persistence page
Copy the Data Folder path.
Open Windows Explorer (File Browser)
Paste the Data Folder path copied in Step 3 in the Address Bar of Windows Explorer
If you see a series of "NS File" and "0 File" file types, as shown below, MongoDB is running using the MMAP storage engine.
If you see a series of "WT File" file types and a file named "WiredTiger", as shown below, MongoDB is running using the wiredTiger storage engine.
Start the Mongo daemon:
1. Open command prompt as an Administrator
2. Change directories to the location of the Alteryx bin folder. The default location is "C:\Program Files\Alteryx\bin"
cd "C:\Program Files\Alteryx\bin\"
3. If you are using the wiredTiger storage engine, run the following command, replacing the dbpath location with your Data Folder path:
mongod3_4.exe --dbpath "C:\ProgramData\Alteryx\Service\Persistence\MongoDB_34" --port 27018
3b. If you are using the MMAP storage engine, run the following command, replacing the dbpath location with your Data Folder path:
mongod3_4.exe --dbpath "C:\ProgramData\Alteryx\Service\Persistence\MongoDB_34" --port 27018 --storageEngine mmapv1
4. You should see a message that says 'waiting for connections on port 27018'. Leave this window open and proceed with the next steps.
Connect to the Mongo shell:
1. Open another command prompt as an Administrator
2. Change directories to the location of the Alteryx bin folder.
cd "C:\Program Files\Alteryx\bin\"
3. Get the MongoDB password by running the following:
Copy the Non-Admin password.
4. Run the following to connect to the Mongo shell:
- Enter the password from above after -p
mongo3_4 -u user -p YOUR_PASSWORD --host localhost:27018 AlteryxService
5. Run the following command to retrieve the version:
If your version says 3.4.10, see Solution below.
The ASMongoDBVersions.bin file contains the wrong version.
1. Confirm the AlteryxService is stopped
2. Navigate to the Data Folder path in Windows File Explorer. Locate the ASMongoDBVersions.bin file
3. Replace the content of the file with just the following, and Save:
3.4.10 Example of a corrected ASMongoDBVersions.bin file
3. Re-run the MongoDBUpgradeTo30.exe found in the Alteryx bin folder in the installation directory
4. You should now be presented with the following screen. Continue through the prompts to migrate the database.
5. If you run into issues with the migration, please see the article under Additional Resources below, or contact Alteryx Support
Troubleshooting a failed MongoDB migration - Server 2019.3
How To : Safely change the Global Workspace of an Alteryx Server
The Global Workspace is a path used as the base for configuration options that determine where temporary files, log files, and database files are stored.
Sub-folders for the specific items can be created to use the global workspace or can be customized later to write to a different location. This path should point to a location that is safe to store large amounts of files.
Server admins wanting to change it to to a different location can use this resource to safely perform this change.
Product - Alteryx Server
All permissions on the future Global Workspace
Backup your Alteryx Server (procedure outlined here)
Alongside the backup of done in the previous step, keep a copy of the below elements:
RuntimeSettings.xml (this file can be found in %ProgramData%/Alteryx/)
Controller Token (can be copied into a text file from the Alteryx System Settings > General)
Stop the Alteryx Service
Open the Alteryx System Settings ans navigate to Environment > Workspace
Change the Global Workspace to the desired directory :
Navigate through each screen of the Alteryx System Settings to confirm that:
The paths of the sub-directories include the new Global Workspace's root path
The other settings remain unchanged
Do not hit hit "Finish" on the last screen of the Alteryx System Settings:
But instead copy the below folders from the previous Global Workspace to the new Global workspace:
After the copy, you can hit "Finish" to apply the changes and start the Alteryx Service
Log into the Gallery Admin and validate that every elements are available (users, workflows, schedules...)
If the validation is confirmed, remove the below folders from the previous Global Workspace:
Help Pages - Configure Server
Help Pages - Environment
As always, don't hesitate to contact us over at Customer Support if you run into any trouble.
Alteryx Server System Settings Deep Dive - Engine
This is the first in a series of articles to explore the Alteryx Server System Settings in depth to gain a deeper knowledge of what these settings are used for, and to provide a bit more context to help you determine the appropriate settings for your environment. Every organization's deployment, use cases, and business requirements are different and thus there is no single configuration to fit all. Having an understanding of the implications of each setting is vital in setting up your Alteryx Server for success.
We’ll explore the system settings for Alteryx Server as of 2019.2, through a series of articles for each component, starting with the Engine. The Alteryx Engine consumes Alteryx workflows and provides high-speed data processing and analytics functionality. This process can be entirely self-contained in Alteryx Designer, scaled across an organization by the Alteryx Service, or deployed in the cloud by the Alteryx Gallery.
The Alteryx Server System Settings configuration wizard allows end users to modify the Engine configuration settings:
Any changes to the configuration settings in the System Settings wizard are applied to the RuntimeSettings.xml file, found at:
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.
“The Engine Temporary Directory is the place where temporary files used in processed workflows and apps will be placed. This setting should point to a location that is safe to write large amounts of files.”
The Engine Temporary directory is a parent directory in which each workflow executed creates a sub directory for storing data needed during the processing of the workflow. Below is not an exhaustive list, but includes the most common types of data stored in the Engine temporary directory:
Browse Tool Support - Every Browse Tool in the workflow creates a separate Alteryx Database file (.yxdb) that stores the contents of the data you see in the Browse’s Results and Configuration windows. The Browse Tool allows you to view all the data as opposed to a sample, and therefore the created .yxdb files could be quite large if the data sets being processed are large. Therefore, the number of Browse Tools should not be prolific. NOTE: The temporary .yxdb files are only created when an Alteryx Workflow is run in Designer. When workflows are executed through the Gallery or a schedule, browse tools are disabled.
Browse Everywhere Support – The Browse Everywhere features allows you to click on the output anchor of a given tool and see a sample of the data at that point in the workflow. All the data viewable in the various output anchors across a workflow is stored in one Alteryx Browse Everywhere file (.yxbe). The size of this file is determined by how many tools are in the workflow multiplied by the “Memory Limit Per Anchor” size which will be discussed later in this article. NOTE: The temporary .yxbe file is only created when an Alteryx Workflow is run in Designer. When worfklows are executed through the Gallery or a schedule, Browse Everywhere is disabled.
Tool Specific Support – Some tools create temporary files as part of their processing, for example the Download and Spatial Match tools.
Paging / Swap Space – When the Engine's memory processing requirements exceed that of the “Default sort/join memory usage” setting (covered later in the article), temporary files (.tmp) are created to retain data that can be quickly retrieved later. The number and size of these temp files is determined by the size of the data sets being processed, and the types of tools in the workflow. The Engine 101 Basics blog does a great job of describing how certain “blocking” tools need access to all rows of a dataset to process it. The presence of these blocking tools will drive up the likelihood that the Engine will need to use temporary files to complete its processing.
Example Engine Temp directory for a running workflow where the files described above are evident.
These files are all deleted when the workflow processing is complete. For a Designer user, this means when the Workflow is closed or upon initiating another execution of the Alteryx Workflow in Designer. For a Server user, this means upon completion of the workflow execution. Note, the Engine Temporary Directory is used when running workflows from Alteryx Designer. When running on an Alteryx Server, the Worker’s “Workspace” directory is used to store these temporary files.
It is highly recommended to set the Temporary Directory to a different drive than your system boot drive (C:\). If the C:\ drive on Windows fills up, the system can become unresponsive or even unstable. If an additional drive (D:\) fills up, no harm is done to Windows and the system will remain functional.
The Temporary Directory is used for frequent I/O operations to read and write data. Configuring this directory on Flash/SSD storage is a great way to improve performance by minimizing the wait times for those read & write operations to complete. See the Measuring and Scaling a Private Server blog post for more information.
When running in Designer, minimize the use of Browse Tools when working with large data sets to reduce workflow processing times and keep the Temp directory from filling up.
Understand that temporary directories can grow quite large during processing if working with large data sets and doing lots of sorts, joins, or other blocking operations. As an example, we saw a temporary directory grow over 150GB in size processing a 12GB data set. Your mileage will certainly vary based on data set sizes and tools used.
Memory Limit Per Anchor
“Define the maximum amount of memory to use to consume data for each output anchor for tools in a workflow. The default value typically does not need to be changed.”
This setting applies when running in Designer only as mentioned in the Browse Everywhere section. The Browse Everywhere feature allows a user to see a sample of the data (up to Memory Limit Per Anchor in size) at the output anchor of every tool. The default value is 1024 KB (1MB).
This workflow would produce a .yxbe file of approximately 12MB.
This is a great way to analyze your data without using the Browse tools which will write the entire dataset contents to disk.
A sample of the data can be seen in the output anchor of each tool.
In the event of the Temporary Directory not having enough space to create the .yxbe file, the following will be logged:
Warning - Alteryx: Disk space on temp drive running low. No browse everywhere data created.
Keeping the default Memory Limit per Anchor setting makes sense for most scenarios.
In situations where you are building a workflow with a very large data set, and the 1 MB sample just isn't enough to give you the information you need, but the full Browse tool is too heavy, it might make sense to increase this value. However, make this change on the local Designer (laptop/desktop) and not the Server which is used by many end users. This change can be made in Designer under Options -> User Settings -> Edit User Settings:
Designer users can override the Memory Limit per Anchor in the Advanced User Settings.
Default sort/join memory usage
"This is the minimum amount of memory that the Engine will consume while performing operations such as Sorts and Joins within a workflow or app. Generally, this value should not be changed.”
The Engine "Default sort/join memory usage" setting and the Worker “ Maximum sort/join memory usage ” setting have generated a lot of questions that I hope this section clears up. There are three key points to clarify:
If making changes, the Engine "Default sort/join memory usage" is the setting that should always be specified and what we'll focus on in this article. For Designer users, this value can be specified in the Options --> User Settings --> Edit User Settings wizard: The Default Dedicated Sort/Join Memory Usage setting
This setting is both a minimum and a maximum.
It's a minimum in that this amount of memory will be "committed" to each Engine process (running workflow) regardless of how much memory the Engine actually consumes processing the workflow. Therefore this amount of memory is reserved for each Engine process and not usable by other applications.
It's a maximum in that the Engine process will not consume more memory than this value. If the Engine needs more resources than the setting specified, it will start utilizing the temp (swap) space as described earlier. If the workflow launches additional processes, such as from the Run Command tool, or R by the use of Predictive Tools, those processes are NOT controlled by this setting.
Other processes are not controlled by the Engine Default Sort/Join Memory Usage setting
The setting is not specific to Sorts and Joins. As described in the Engine 101 Basics blog, “blocking” tools require access to all data for execution. This drives up memory consumption. Sort, Join, and Summarize operations are the most commonly used blocking tools but there are many others, easily identifiable with a red border in the Periodic Table of Alteryx Tools . Any workflow executing these blocking tools with high row count data sets (millions of rows) will consume lots of memory.
If the Sort/Join memory setting requested exceeds the amount of physical RAM available, Alteryx will revert to a lower value that is safe to commit. In that case a message like the following will be logged in the Alteryx Engine logs: 00:00:0.003 - Alteryx: Allocating requested dedicated sort/join memory would be more than available physical memory. Reverting to 2912MB of memory.
Only make changes to the Engine "Default sort/join memory usage" setting if necessary. The default value works well for most scenarios, and we routinely see problems occur when this value is changed without understanding when and how to configure it.
The below recommendations are just starting points. It is always recommended to configure and then test with representative workflows and usage patterns. Then reconfigure and repeat the process until the optimum values are identified.
To properly calculate a reasonable Sort/Join Memory value, we must know how many workflows will be configured to run simultaneously. This number should be determined by a server sizing exercise, and for existing customers, also take into account data from the Server Usage Report, such as queue times and job execution times. For Designer only users the number of simultaneous workflows will be 1.
For Alteryx Server machines that act as both a Worker and a Controller with the Embedded MongoDB, a good starting point is:
For standalone Workers, more memory can be allocated to running workflows. In that case a good starting point would be: The 4GB reservation ensures the OS and other system services are not starved of memory.
If predictive tools will be frequently used then lower your calculated values from above as additional memory should be reserved for the R processes.
The expectation is that the machine will only be used for Alteryx processing and not shared with other applications. If other applications will also be running, then their memory requirements need to be factored into the equations above.
Again, the above recommendations are just starting points. It is always recommended to configure and then test with representative workflows and usage patterns. Then reconfigure and repeat the process until the optimum values are identified.
Default number of processing threads
“Define the number of processing threads tools or operations can use. The default value is the number of available processor cores plus one. Generally, this value should not be changed.”
This setting is determining the number of processing threads that multi-threaded tools can use. The multi-threaded tools are identifiable in the Periodic Table of Alteryx Tools . (Sort and some Spatial tools highlight the list). Configuring a higher value here may facilitate more parallelism which may result in faster completion times in the execution of these multi-threaded tools, assuming the machine has the capacity to use the specified number of threads. Specifying a higher than needed thread pool size can lead to an over-committed system in which the CPU is constantly context switching between threads which may produce longer processing times.
In Windows Task Manager, the "Logical processors" metric shows us the maximum number of concurrent processing threads on that server:
To reduce workflow run times using multi-threaded tools, set the Default number of processing threads equal to the number of Logical processors.
If the server will be executing multiple workflows simultaneously, consider using a lower value to ensure that no workflows are starved of CPU.
Run engine at a lower priority
“Select if you are running other memory intensive applications simultaneously. It is also recommended that this setting be checked for a machine configured to run the Gallery.”
The Windows Scheduling Priorities doc is a great resource to understand why this setting is important. To summarize, Windows assigns time slices of CPU time to processes based on their priority level. Applications with a higher priority will be given more CPU time than applications with a lower priority. This ensures higher priority applications get more processor time when the system is heavily utilized.
Most applications default to “Normal” priority. Some critical Windows processes have a “High” priority, such as the logon and desktop window manager processes. Alteryx installs all Server components (AlteryxService, Gallery, Designer, etc…) with the “Normal” priority. By default, this includes the Engine as well. This could lead to a scenario where resource intensive workflows are running, and the Alteryx Service layer, the Gallery, or even Designer are struggling to get CPU time since they all share the same priority level. This also could inhibit mouse & keyboard inputs, and background disk flushing.
Running the Engine at a lower priority will allow these components to remain responsive even during periods of heavy workload processing.
This setting should be enabled in all Server deployments (Controller, Worker, Gallery) to ensure Windows components, and the Alteryx Server components always get priority over intensive Engine processes.
The Alteryx Engine has many settings that can impact workflow performance and resource consumption. Understanding how each of these settings are used by the Engine, and how some settings even impact others, will allow administrators to configure Alteryx Server optimally for their environment and usage.
Alteryx Service Fails to Start when Mongo Fails with Error - “Input string was not in a correct format”
When trying to start the Alteryx Service, the following error can be seen in the Alteryx Service Logs:
FATAL,1,,RegisterClasses,,,,Axx-xxxxx100,,,,,,Input string was not in a correct format.,
Windows Operating System
This error message is coming directly from MongoDB and while very generic, it is telling us that the driver is unable to handle the data that is being sent to MongoDB. The Alteryx Service will fail to start and you will most likely get some sort of popup error when trying to start the service from the Windows Services menu.
Is FIPS enabled on your machine? If so, See Solution A.
Are you in a multi-node environment? If you are unable to start the Alteryx Service on a node that is not the Controller, see Solution B.
FIPS is enabled on the Machine
This error occurs because the encryption Alteryx Server uses for inter-service communication won't happen if FIPS is enabled because .NET will block the requests.
Per this article :
“FIPS Compliance Encryption Issues In the .NET framework, three different versions of the SHA256 hashing algorithm, each having different security levels and speed are available. The fastest one among them has not yet been submitted for validation. However, it is believed that it is as secure. Enabling FIPS mode in systems with Microsoft OS will break the .NET applications as they probably use latest cryptography algorithms that are more efficient. And, if the .NET applications must necessarily work then a slower, much less efficient cryptography algorithm must be used.”
The Alteryx Gallery uses .NET completely for communication with MongoDB, there is not another option for communication.
There is currently no workaround to get the Alteryx Service to start with FIPS enabled. FIPS must be disabled completely on the server machine to get the Alteryx Gallery to communicate with Mongo correctly and get the service running. The impacted policy is named System cryptography: Use FIPS compliant algorithms for encryption, hashing, and signing.
To get to this setting:
1. Open the Local Security Policy window from the Windows Start menu
2. Navigate to Local Policies > Security Options
3. Select the correct policy
Make sure that group policy does not enforce FIPS after reboot. To verify that FIPS has been disabled, make sure that the “Enabled” registry key located here HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Lsa\FipsAlgorithmPolicy is set to “0”:
Generic failed Connection to MongoDB (Not FIPS).
The error states that for whatever reason, MongoDB is not able to understand the information that is being sent. A failed connection to MongoDB can also cause this error, though it can be difficult to pinpoint the root cause. There are a few things that you will want to check to see if they are causing the issue:
1. If you have a multi-node environment and are configuring the Gallery, confirm the following in the Alteryx System Settings under Gallery > Persistence.
1. Confirm the password is correct. This password should be the user (not-admin) password from the System Settings on the Controller.
2. Confirm you have the port appended to the hostname (default port for embedded MongoDB is 27018)
2. Enable Mongo logging and see if MongoDB gives more details on why the error is occurring
3. Test connecting to MongoDB through another source (such as Robo 3t) and see if this gives more detail on why the error is occurring.
When trying to enter Workflow Credentials from the Administration section of the Gallery, the credentials do not save and the message 'Validating' shows perpetually. The credentials are not saved.
You may also see this issue when trying to update the password for an existing credential.
You will find the below errors in the logs:
ERROR,,ErrorHandler,HandleError,,,::1,xxx-xxx,,,GET,/gallery/api/apps/pubKey/,400,14,Exception caught by ErrorHandler and marshalled to client,"AlteryxService_Client.Net.AlteryxServiceException: Credential usage is disabled as a result of encryption configuration. Please contact your server administrator.-> at AlteryxService_Client.Net.EncryptedStorageWrapper.GetPublicKeyParams(String server, String secret, String sValue)-> at Alteryx.Cloud.Server.Services.AppService.GetPublicKey()-> at SyncInvokeGetPublicKey(Object , Object , Object )-> at System.ServiceModel.Dispatcher.SyncMethodInvoker.Invoke(Object instance, Object inputs, Object& outputs)-> at System.ServiceModel.Dispatcher.DispatchOperationRuntime.InvokeBegin(MessageRpc& rpc)-> at System.ServiceModel.Dispatcher.ImmutableDispatchRuntime.ProcessMessage5(MessageRpc& rpc)-> at System.ServiceModel.Dispatcher.ImmutableDispatchRuntime.ProcessMessage11(MessageRpc& rpc)-> at System.ServiceModel.Dispatcher.MessageRpc.Process(Boolean isOperationContextSet)"
ERROR,,AlteryxService,AlteryxService_GetPublicKeyParams,,,,,,,"CredentialHandler_ReadBody_Error: <Credential usage is disabled as a result of encryption configuration. Please contact your server administrator.>"
The Alteryx Service account has insufficient permissions to the server's machine key directory (%ProgramData%\Microsoft\Crypto\RSA\MachineKeys) or specifically the Alteryx Machine Key which is used to encrypt/decrypt user credentials and Gallery data connections.
Please see the solution in this article.
How Workflow Credentials Work on a Private Gallery
Troubleshooting "Invalid Username or Password" Error - Setting Up Workflow Credentials
Access is Denied on the Alteryx Server
Guide to Gallery Data Connections - FAQ
Creating a Gallery Data Connection will allow ease of access for Alteryx users to connect to databases. The feature also allows the Alteryx Gallery and Database Administrators more governance over what connections are being made as well as who are making the connections.
What are the advantages of using a Gallery Data Connection?
Centralized area for Administrators to create and share database connections
Avoids the need for IT to create database connections on each users machine individually
Easy permissions management - access to the connections can be enabled or disabled instantly
Users no longer need to know the connection information to connect to their data
What actually happens when you create the connection on the Gallery?
When you create a Gallery Data Connection, a record is created in MongoDB under the AlteryxGallery > dataConnections collection.
"_id" : ObjectId("5a5882573b910b5758cdd7e2"),
"ConnectionString" : "4D35F08105015D7A81E5E274760D1C3529146D9516CACD028F1A353994C7DFB2ABAC8A99B1F284CCB7935B96F0FBD2EC9A9239B3305D4DE60D1C749C4E7BC65A597ED943742FB057EDD0F1882FFF98D6ED7888312215761DB1FA02B0EF425F9F98E645E73FB98481AC130D05F1A0CC0DBD42D4AC1F38E8DF8CA5759A6A4823F86C6FC212BD93263F83B90515DF6926B934FA086466A70992DF984C297A47C1DFFD749A642A6267B9FFC87B766127CE6C3D945FC64A8A25A2414DB2450AD6CAAD8D9202BFEBAF22C91B1371E1BA4C9CEB6E454B46B3BF4417D5280E53BCB5BE6AA734B",
"PasswordSecured" : "",
"ConnectionName" : "SQL_on_Gallery",
"Subscriptions" : ,
"Users" : [
Once the connection is shared, it is also attached to that person's entry in AlteryxGallery > users collection.
"_id" : ObjectId("503bac145031af11f8f8e479"),
"Curator" : true,
"Anonymous" : false,
"LicenseCurator" : false,
"Sponsor" : "",
"Email" : "email@example.com",
"FirstName" : "Ash",
"LastName" : "Ketchum",
"DataConnections" : [
"CanSchedule" : true,
"CanSetPriority" : false,
"CanSetWorkerTag" : true,
"RecaptchaResponse" : null
What happens when the connection is used in Designer?
The user is authenticated. With Windows Authentication, the user who is logged into the machine/running Designer is authenticated automatically - it is not possible to change this. This means that this user must be a domain account that can authenticate to that server, and only that user's connections will be synced.
As soon as a user links their Gallery to Designer, a sync takes place that grabs all the connections they have access to and creates a file called GalleryAlias.xml in the user's* profile:
C:\Users\USERNAME\AppData\Roaming\Alteryx\Engine *99% of the time this will be the user logged into the machine, but there is also the possibility that the user is right-clicking and running Designer as a different user.
This file will be updated/synced when you:
Open the Manage Data Connection window from Options > Advanced Settings > Manage Data Connections.
Click Sync All in the Manage Data Connections Window:
What happens when you execute a workflow on the gallery that uses a Gallery Data Connection?
The Gallery 'translates' the connection from an XML file. One of the following will be used:
The Gallery performs a permissions check.
The permissions check ONLY applies to the user who uploaded the workflow. If the connection has not been shared with the uploader, it will error:
Unable to translate alias SQL_on_Gallery
The workflow is executed and the connection to the database is attempted. Any further errors will be around the connection string/driver itself, i.e.
Error SQLDriverConnect: [Microsoft][ODBC Driver Manager] Data source name not found and no default driver specified.
What does 'translate the alias' mean?
This refers to the unpackaging and reading of the XML file to take the alias name (SQL_on_gallery) to the actual connection string. This must first happen before the connection to the database will even be attempted.
If this fails for any reason, you get the following error:
Unable to translate alias X
What is the __TemporaryAlias.xml file, and when is it used?
When you publish a workflow to the Gallery that contains one of these connections, a file called __TemporaryAlias.xml is packaged with the workflow.
You can see this file when you click Manage workflow assets during publication:
By default, this asset is checked - it should be checked so that the workflow can use this XML to translate the alias.
Once the workflow runs, it is pulled down and unpackaged into the Staging folder.
Which of the two XML files are used?
The Designer first will try to use the __TemporaryAlias.xml file. This is the preferred way, because as mentioned this XML file is packaged with the workflow,, meaning it can successful translate on whatever machine (worker) it runs on:
If you don't package the __TemporaryAlias file, it will then try to use the GalleryAlias.xml file. As mentioned, since this is in the User's profile, you would need the Run As user to have this file synced and available in their profile. This method is not preferred. Another issue with this method is that the file will need to be synced on all worker machines.
What are the most important things to know to make sure my workflow will run successfully on the Gallery?
Always package the connection when publishing to the Gallery.
From a permissions perspective, once the workflow is on the Gallery, it doesn't matter who runs the workflow for the translation to happen. Only the uploader of the workflow needs to have the connection shared with them.
How To: Enable MongoDB logs in RuntimeSettings.xml When trying to troubleshoot Server/Gallery issues, it can be useful to gather logs to determine if the cause is with your MongoDB. These steps will show you how to enable Mongo logging. Prerequisites Alteryx Server Embedded MongoDB Administrative Rights Procedure ALWAYS BACK UP FIRST. Make sure to make a copy of your RuntimeSettings.xml as well as your MongoDB. See this article for Backup & Recovery Best Practices Stop your Alteryx Service Open File Explorer and navigate to %PROGRAMDATA%\Alteryx Open RuntimeSettings.xml in a text editor Under the Controller section add EmbeddedMongoDBLogPath as a key Add a directory as the value with .txt file extension. **OPTIONAL If you would like to have the logs with increased verbosity** Under the Controller section add EmbeddedMongoDBArguments as a key Add --vv as the value Start your Alteryx Service and Mongo logs should be generating
Some users can experience the below error when working with numeric data:
FormatException RequestID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
In Alteryx Designer
When publishing workflows to a Gallery:
On the Gallery
When running a workflow, it will first display the below error message:
We are unable to get the status of your workflow results at this time. You can close this view and check the Workflow Results page later.
Trying to view the Workflow's results will display the below error message:
Error Getting Job Results
Unknown error. FormatException RequestID:
Version ≥ 2018.4 to version 2019.3
Microsoft Windows Server with European regional Settings
Open the Control Panel -> Clock and Region -> Region settings on the server:
On the new window, open the Additional Settings:
Under the "Numbers" tab, verify what symbol has been set for "Digit grouping symbol":
If it is left blank or set to a space (" "), refer to the Solution at the end of the article.
The Alteryx Server expects there is a character present for the Digit Grouping Symbol, this will be fixed in a future release (DE18733).
If the Decimal Symbol is set to a period (.) :
Change the "Digit grouping symbol" from a space to a comma (,)
If the Decimal Symbol is set to a comma (,) :
Change the "Digit grouping symbol" from a space to a period (.)
Save the changes
Apply it to the system account through the below:
Control Panel -> Clock and Region -> Region settings -> Tab "Administrative" -> Copy settings -> Check “Welcome screen and system accounts” -> Ok
Restart the Alteryx Service
As always, don't hesitate to contact us over at Customer Support if you run into any trouble.
Have you ever needed to see your shared gallery connections and who they are shared with? This week, with the help of @MattH, we put together a simple workflow that queries your MongoDB and matches Connections to Users and Subscriptions they are shared with.
I’ve attached a workflow template to the post. All that you need to do is update the MongoDB input tools to point to your Alteryx Server.
Update the Server, User Name, and Password with the same credentials that you use for the Server Usage Report:
You might notice the secret ingredient here is to use “Include Mongo_id Field” to match the Users and Subscriptions.
The user name can generally be left as user and password comes from you Server System Settings here:
And the final output looks like this!
The workflow output is a Browse Tool, but you can update the workflow to output however you choose.
Hoping this can help some other folks with Server Administration!
"Invalid Username or Password" Error When Setting Up Workflow Credentials
The below error can occur when trying to set up Workflow Credentials. There are two possible root causes.
Invalid username or password
The actual error in Gallery Admin will look as below.
Product - Alteryx Server
System Settings (Workflow Credentials are set up)
Check whether the workflow credentials used work as a local login for the user on the server. If no, proceed with cause A. Else go to cause B.
The workflow credentials are incorrect. This can have various reasons for instance a changed password or a locked account. Your IT team should be able to double check whether this is the case. Refer to solution A.
The workflow credentials used are indeed correct. However, the permissions of the user account are not sufficient for impersonation purposes.
Together with your IT team make sure the correct credentials are being used.
As always if the issue persists feel free to reach out to Alteryx Customer Support.
This case is commonly caused by group policy settings on the server denying the user either to log on locally or to log on as a batch job. To correct this the user account used workflow credentials have been set up for needs to be given the same permissions required for a Run As User. For details of the required permissions refer to the online server help documentation - https://help.alteryx.com/server/current/admin/Configuration/RunasPermissions.htm .
Please note that the referenced permissions do not allow logon via remote desktop.
As always if the issue persists feel free to reach out to Alteryx Customer Support.
Server KB article on how Workflow Credentials work vis-a-vis other permission settings available on Server - https://community.alteryx.com/t5/Alteryx-Server-Knowledge-Base/How-Workflow-Credentials-Work-on-a-Private-Gallery/ta-p/176171
Online server help documentation on setting up Workflow Credentials - https://help.alteryx.com/server/current/admin/Administration/WorkflowCredentials.htm
Server KB article on Admin Gallery including section on Workflow Credentials - https://community.alteryx.com/t5/Alteryx-Server-Knowledge-Base/Alteryx-Gallery-Series-The-Lay-of-the-Land-101-Gallery-Admin/ta-p/24213
Online server help documentation on required permissions for user used for workflow credentials - https://help.alteryx.com/server/current/admin/Configuration/RunasPermissions.htm .
Unknown error. SerializationException RequestID when adding workflow to a Collection
When trying to add a workflow to a Collection, or create a new Collection, the following error is observed:
Unknown error. SerializationException RequestID: xxxxxxx
This prevents the workflow from being added to a collection.
Additionally, you may notice that when you click on a Collection you see a 'Page Not Found' error.
Confirm you have recently upgraded your Server from version 2019.1 or lower to version 2019.2.
In 2019.2, a new interface for Collections, as well as some additional functionality for Collections, was added to the Gallery. A hard refresh is needed for this to render properly and your Collections to appear.
On the home page of your Gallery, perform a hard refresh by clicking Shift + F5
Confirm you now see the new grid interface for collections:
How To: Manage a Collection
If you are upgrading your Alteryx Server from an older version to 2018.1 or greater, your MongoDB will be migrated from Mongo 3.0 to Mongo 3.4 as part of the process. This article details how to troubleshoot a potentially failed migration.
How To: Adding a Worker Node
Many customers need to expand their Alteryx Server environment to support a growing number of users, additional departments, increased data sizes, frequent job queuing, or a myriad of other reasons. This document walks through the process of adding a Worker Node to an Alteryx Server environment. These steps apply regardless of the size of the existing Alteryx Server environment.
Product - Alteryx Server
Additional required assets:
Alteryx Server and Data installs
Provision a new physical or virtual machine meeting the Alteryx Server minimum requirements, which are 4 cores, 16GB RAM, and 1 TB Disk. It is recommended to w ork with your Alteryx representative to understand what is an optimal system setup for your use cases, data set sizes, and business requirements.
Install applicable ODBC Drivers and configure System or User DSNs to match the existing Worker(s). In-Database connections should also be created for any data sources where In-Database processing is being used.
Install Alteryx Server and any Data packages using the same install files from your existing Alteryx Server environment. This ensures version compatibility between the Controller and the new Worker Node. There are a couple of ways to verify the same version is being used.
Check the version reported in Gallery at https://MyGalleryHostname.com/#!help/version
Check the version reported by Alteryx Designer running on the existing Alteryx Server machine.
Ensure this matches the version reported by the file name of the Alteryx Server installable on the new Worker node.
On the Alteryx Server Controller machine, open the System Settings and navigate to the Controller -> General section. Copy the Controller Token and save it for step 6.
On the new Worker Node where Alteryx Server has been installed, launch the System Settings wizard. For the Environment Setup Type, choose Custom - Enable Worker.
Continue to the Controller -> Remote section. Enter your Controller Hostname and paste the Controller Token saved in step 4. Click Test to ensure the Alteryx Server version, Controller Hostname and Token match.
Configure the Worker and Engine settings as desired. Typically this involves matching the settings of an existing Worker but there are situations where it makes sense to have different settings across Workers, such as the number of workflows allowed to run simultaneously, QoS settings, Job tags, Map Rendering, etc... An example Worker Configuration
Complete the System Settings wizard and validate the AlteryxService is Running on the new Worker node.
Validate the new Worker shows up in the Gallery Admin -> Diagnostics page in the Workers panel.
Ensure the new Worker has access to any locally stored Macros or data sets. It is recommended to move all locally stored Macros and data sets to a network share or similar storage device that is accessible by all Workers, and then update Workflows based on the new locations. Storing files locally and copying to all Workers isn't recommended as it requires a method to keep them all in sync, increases data storage requirements, and introduces version differences across the environment.
Finally, run a few representative workflows through the new Worker to verify everything is working as expected.
With just a few simple steps a new Worker node can be added to an Alteryx Server environment to provide redundancy, higher throughput, shorter job queue times, and many more benefits.
Worker System Settings
Considerations for Scaling Alteryx Server
Measuring and Scaling a Private Server
Scaling a Private Server: Five steps to greater throughput
Configuring SAML on Alteryx Server for Active Directory Federation Services (ADFS)
Alteryx Server has the ability to use most identity providers that support the SAML 2.0 standard, and from my testing, ADFS is no exception! The following information will assist with configuring Alteryx Server to be functional with ADFS.
Please note the following information is based on third-party software and processes may be slightly different on older or newer versions of the software. The following was created against ADFS v4.0 running on Windows Server 2016 and Alteryx Server 2019.2.
AD FS Server
Account with access to perform administration tasks
All users that will login must have an email address attribute
Alteryx Server >= 2018.2
Account with access to perform administration tasks
SSL/TLS Certificate Installed on Alteryx Server (Self-Signed certificate is not recommended)
Verify that your Alteryx Server's Gallery function has been configured with SSL/TLS enabled on each Gallery node in the environment and that a proper SSL certificate is installed. Instructions are provided in the link above.
This and following steps will require an ADFS administrator. Open the AD FD Management utility (Start > Windows Administrative Tools > AD FS Management)
Click Relying Party Trusts from the console, then click Add Relying Party Trust...
Click Enter data about the relying party manually and click Next.
Type a Display name for the trust. I placed "Alteryx Server" here, but you can use a name that best identifies the connection for you, such as a server name or other easily identifiable name. Then click Next.
Click Next on the Configure Certificate page.
Check the box for Enable support for the SAML 2.0 WebSSO protocol. Type the URL of the Alteryx Server's SAML endpoint in the Relying party SAML 2.0 SSO service URL box, which typically will be the base URL of Alteryx Gallery with the addition of "/aas/Saml2". Once you have added the proper URL, click Next. Note: this endpoint may be case sensitive depending on settings in your environment. I would recommend entering it with the capitalization as shown in the screenshot and example below. Example: Gallery URL: https://trn-srv-07.cs.alteryx.com/gallery SAML Endpoint: https://trn-srv-07.cs.alteryx.com/aas/Saml2
In the Relying party trust identifier, type the same SAML endpoint as the previous step and click Add to add the URL to the list below. Click Next.
Select Permit everyone from the Access Control Policy and click Next. Note: You may wish to configure this option differently depending on the environment and whom you wish to be able to authenticate with Alteryx Gallery, or you may wish to setup Multi-Factor Authentication (MFA). Specific access permissions and these types of setup are outside the scope of this article.
Click Next on the Ready to Add Trust page.
Check the box next to Configure claims issuance policy for this application and click Close.
Within the new Claim Issuance Policy window, click Add Rule...
Verify the Claim rule template is set to Send LDAP Attributes as Claims and click Next.
Type a desired name for the rule within the Claim rule name box. From the Attribute store drop-down, choose Active Directory.
Using the following table, set the appropriate options within the Mapping of LDAP attributes to outgoing claim types box. Click Finish. Note: The following outgoing values are case sensitive and will need to be typed except for "SAM-Account-Name".
Outgoing Claim Type
On the Claim Issuance Policy window, click Apply to apply the settings, then click OK.
You will now need an administrator with access to the Alteryx Server machine(s) running the Gallery for your environment. Connect to the machine remotely via Remote Desktop.
Open the Alteryx System Settings application, then click Next until you are at the Gallery > Authentication page.
From the Authentication Type box, click the radio button next to SAML authentication. In the Select an option for obtaining metadata required by the IDP, click the radio button next to IDP Metadata URL. !Warning!: It is not recommended to change the authentication type once you have established the persistence layer (e.g. MongoDB) and started using a particular authentication method in your environment. Differences in user account structure will be likely to result in errors in the Gallery if the authentication method is changed in an established environment. If you are changing authentication methods, it is recommended to create a new persistence database!
From the SAML IDP Configuration box, set the ACS Base URL to the root of the Gallery URL plus "/aas". Example: Gallery URL: https://trn-srv-07.cs.alteryx.com/gallery ACS Base URL: https://trn-srv-07.cs.alteryx.com/aas
Set the IDP URL (also known as Entity ID) to the Federation Service identifier value from ADFS. Example: https://sts1.cs.alteryx.com/adfs/services/trust Note: If you are not positive on the value for this, ask your ADFS administrator or download the metadata XML with the link you are using in the next step and look for the "entityID".
Set the IDP Metadata URL to the location of the Federation Metadata xml file provided by the ADFS server. Example: https://sts1.cs.alteryx.com/FederationMetadata/2007-06/FederationMetadata.xml Note: If you are not positive on the value for this, ask your ADFS administrator.
Click Verify IDP. If all goes well, you should receive a message similar to the following: Note: See the Common Issues section below for tips on troubleshooting!
Click Next through the remainder of the System Settings dialogs, then click Finish.
(Optional) Return to Step 17 if you have additional Gallery node(s) to configure.
Once all Gallery node(s) are configured, attempt to access your private Alteryx Gallery and log in with your fresh new SAML configuration!
AlteryxAuthorizationService.exe has stopped working or there is a failure to set the Default Gallery Administrator -Turn off IE Enhanced Security Configuration on the Alteryx Server if you have crash errors while verifying the IDP information. This feature can be turned back on once you have the configuration in a functional state. https://www.limestonenetworks.com/support/knowledge-center/17/70/how_do_i_disable_internet_explorer_enhanced_security.html -Verify that the values in the SAML IDP Configuration are correct for your ADFS server. -Verify that the ADFS server was configured with the correct claim attributes. -Check the AlteryxAuthorizatonService.exe logging directory (%PROGRAMDATA%\Alteryx\Logs) for any clues. -Open Event Viewer within Windows and look for errors that may be of use in the Application log. -If still stuck, reach out to our Support team. I'd suggest providing the following: 1. Values set in the Alteryx System Settings application for SAML 2. AAS log files (found in %PROGRAMDATA%\Alteryx\Logs\) 3. Configuration screenshots for ADFS
Platform Product: Server/Gallery/Scheduler Issues – Working with Alteryx Customer Support Engineers (CSEs) (for use by CSEs and Alteryx Customers)
To EXPEDITE the resolution of your case, please include the below information.
Server/Gallery/Scheduler- Requested Information
*** Suggestion: Copy/Paste the questions below and email to firstname.lastname@example.org
1. Detailed description of the Issue
2. Is this a Production Issue? What is the urgency?
3. Have there been any changes made recently? Update to Alteryx, Server, etc.?
4. Alteryx Version
5. Screenshot of Error
6. Gallery/Service/Engine Logs
7. Runtime Settings.xml
8. Check for LastStartupError.txt file (may not be there)
9. Screenshot of System Settings
10. Windows Event Logs
11. System Info – File Save - .nfo
Server/Gallery/Scheduler – Requested Information (Detailed Instructions):
1. Detailed Description of the Issue – What issues are you having? Has it worked in the past? When did the issue start? Are all users affected or just some? What are the steps to reproduce your issue? What have you tried to resolve the issue? Have you searched the Alteryx Community ?
2. Is this a Production Issue? What is the urgency? How many people is this affecting? Are you able to complete most of your work? Do you have a time frame that you need to resolve the issue?
3. Have there been any changes made recently? Update to Alteryx Designer, Server, etc.? What do you think may have caused the issue? What have you done to try to resolve the issue?
4. Alteryx Version – Our Customer Support Engineers need to know the precise version so we can replicate any issues. In Alteryx, click Help > About and provide a screenshot, or the exact version number.
5. Exact Text of Error or Screenshot of error- Click CTRL-Print-screen to capture the error and paste into your e-mail. Note: You may wish to Google the error text research the issue. The Knowledgebase is also a great place to search the error text as well! Where was the error encountered? Gallery?
6. Gallery, Service and Engine Logs are the best way for us to get to the root of the problem. We look at errors and warnings. For the Alteryx logs (Gallery, Service, and Engine), please include the logs that reflect the time of the error/crash (the logs immediately before and after the error/crash). Before sending the logs, recreate the issue, and then send the latest logs. Use Alteryx App - Server Logs the easy way! OR…
Default Paths: Gallery Logs (\ProgramData\Alteryx\Gallery\Logs) Service Logs (\ProgramData\Alteryx\Service\AlteryxServiceLog.log) *** Send several .log files. Engine Logs (\ProgramData\Alteryx\ErrorLogs)
If you have Server, and do not have logs in the pathways above, click Options >> User Settings >> System Settings, and note the paths that the logs are written to. Navigate to that location and collect the logs. If the path is not yet set, pick a path, rerun the workflow to create the error, and then send the logs.
Locating the path of your Engine logs:
Note: it’s important to note that by default Engine logs do not generate, therefore this field will be empty for most users. If a user wants to enable Engine Logging, then they will need to set a directory of their choosing in this field.
Locating the path of your Service logs:
Locating the path of your Gallery logs:
If you aren't using Server, you're probably using a Desktop Automation/ Scheduler installation that has logs located in C:\Program Data\Alteryx\Engine. However, if you have Desktop Automation/ Scheduler and do not have logs in this pathway, click Options >> User Settings >> System Settings, and note the paths that the logs are pointed to. Then locate and send the logs.
If the path is not set yet, pick a path, rerun the workflow to create the error, and then send the logs. If there is not a directory, check "Override System Settings", and enter a path for “Logging Directory." Rerun your workflow to create the error and send the new log files.
Check out this resource for more information on Alteryx logs!
7. RuntimeSettings.xml – This file gives us helpful information about your specific instance configuration and the default location will be in the directories shared above, unless you have a custom installation. You should have a RuntimeSettings.xml file, even if it is not in the default directory, and should be able to recover it for sharing with a disk search of the file name.
File Location: C:\ProgramData\Alteryx\RuntimeSettings.xml
Note: This search will find two RuntimeSettings.xml. One will be from the Program Files Directory. We do not want this file, only the one from C:\ProgramData
This file outlines the configuration of your Server and will provide Support critical information on how the node is configured. In a multi-node environment, we will need this file from each node. This file will only exist for Server installations and Desktop Automation/Scheduler installations. Regular Non-Admin Designer installations will not have this file available.
8. Check for LastStartupError.txt file
This file will be in the same path as set in the System Settings: Controller >> General >> Logging
Default is: C:\ProgramData\Alteryx\Service
May contain helpful messages to identify your issue.
9. Screenshot of System Settings – Click Control Panel >> All Control Panel Items >> System. We need your system settings to replicate issues you are having on a similar configuration.
This information in conjunction with the RuntimeSettings.xml will help Support be sure that your Server is properly configured for the amount of resources that are available.
10. Windows Event Logs (Optional)- Event logs provide historical information that can help you track down system and security problems. Provide System and Application logs in evtx format.
From the Windows Start menu, search for “event” and choose Event Viewer.
Expand the Windows Logs and right-click on ‘Application’ and select ‘Save All Events As…’ and save as *.evtx file
Right-click on ‘System’ and select ‘Save All Events As…’ and save as *.evtx file
11. System Info - Records events logged by the operating system or its components, such as the failure of a service to start at bootup. System Information shows details about your computer's hardware configuration, computer components, and software, including drivers.
System Information will provide Support with the detailed specifications of your Server that will be very helpful when troubleshooting complex issues. This will provide us with information about the Services that are running, specific information around the CPU and memory of the system, available drive space, and other information that can be very useful for identifying potential problems.
Click Start and in the Search Programs and Files Field, type msinfo32.exe. Click File >> Save and save as .nfo file.
Alteryx Server Knowledge Base Alteryx Server Backup & Recovery Part 1: Best Practices
Alteryx Server Backup & Recovery Part 2: Procedures Analytic Gallery FAQ's Alteryx Gallery Series - The Lay of the Land 101: Gallery Admin Edition