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.
We hope that you are as excited about this new feature as we are! The new Database Connection Share is a feature that will allow ease of access for your Alteryx users to your 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.The Admin of the Gallery can create and manage their users' data connections.
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 email@example.com
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
How To: Update the Time Zone Database for the Alteryx Gallery
In the Alteryx Server 2019.3 release, we introduced the ability for users of the Alteryx Gallery to set the time zone they work out of. This created the ability for users to schedule their Gallery workflows to execute according to their time zone, rather than the Alteryx Server's. As countries may decide to update the current time zone they are in, this can cause scheduled workflows to run outside of the time they were set. The following "How-To" article provides our procedure for updating your Alteryx Server instance with updated time zone data.
Product - Alteryx Server 2019.3+
Stop the AlteryxService Note: If on a multi-node deployment, stop the service on each server in the recommended order: 1. Gallery nodes 2. Worker nodes 3. Controller node
Download the latest Data Only Distribution Time Zone Database from https://www.iana.org/time-zones
Extract the downloaded file to a folder on the Desktop
Rename the extracted folder from tzdata<version> to tzdata
Open a web browser and go to https://github.com/unicode-org/cldr/blob/master/common/supplemental/windowsZones.xml
Right click the Raw button found above and to the right of the actual XML document and click Save link as
Save the windowsZones.xml file into the tzdata folder on your Desktop
Open a Windows File Browser and navigate to the Alteryx RuntimeData directory. On a default installation this will be found in C:\Program Files\Alteryx\bin\RuntimeData
Rename the tzdata folder in this directory to tzdataBackup
Copy the extracted tzdata folder from your Desktop into the RuntimeData directory.
If you have set up a multi-node deployment repeat steps 2 - 10 on all Alteryx Nodes
Restart the AlteryxService Note: If on a multi-node deployment, start the service on each server in the opposite order: 1. Controller node 2. Worker nodes 3. Gallery nodes
DST changes in Windows for Brazil and Morocco
Alteryx Server 2019.3 Release Notes
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)
We receive quite a few questions on how to properly chain workflows together. We have a few options that depend on what Alteryx type you are using. If you have Designer only, your options are to use the Crew Macros which are found on the Community. No link provided as the tools get updated. Please use the Community search for the latest Crew Macros. In the Crew Macros set, the tools that you will be looking to use are the Runner Tools. You can find a description of the tools here Runner Tools. Note: You will have to create another workflow using these macros to execute the workflows. If you have Designer with Scheduler, you can use the Crew Macros on the Scheduler, but they are not recommended or supported in this configuration. Using Runner Macros on an Alteryx Server or Gallery can risk over-utilization of resources and cause instability in an Alteryx Server or Gallery environment and thus Runner Macros are not supported on Alteryx Server. There are other options that will allow you to use the workflow on the Gallery or Scheduler. When you have Scheduler or Server you have access to the Alteryx Engine Command. This will allow Alteryx to run workflows through the command line to execute additional workflows or programs. In most cases, the AlteryxEngineCmd.exe will be located in C:\Program Files\Alteryx\bin\AlteryxEngineCmd.exe. Great, so what do I do with it? In your Workflow Configuration window, you have a tab called Events. In that tab you can add a Run Command event. You can choose to run the command as: In the Command: you can either browse to your AlteryxEngineCmd.exe or type in the location like so - C:\Program Files\Alteryx\bin\AlteryxEngineCmd.exe In the Command Arguments [Optional]: You will add the location of the 2nd workflow along with the name of the workflow and file type. example: "C:\temp\NHL2.YXMD" VERY IMPORTANT: Notice in the example above that we have quotations around the string. The reason for this is that the command has difficulty with spaces in the directory paths. By putting quotes around the string, this tells the command to essentially ignore the spaces. However, best practice is to not have spaces in your directory paths when using this command. Sample: Note: This method is a great method, but can be finicky. if you are running other command process or do not have admin access to the folders it can cause issues. You have another option as well! You can turn your workflows into apps for either Gallery or Scheduler use and have them run consecutively. When you drag an Interface Tool onto the canvas your workflow will automatically change to an App. If you don't want to use an Interface tool you can still change the workflow to an app to use the chained app option. Once you change the workflow to an app, you can use the Interface Designer window to chain the apps together. Note: When creating chained workflows to use in the Scheduler and Gallery, the workflows and Assets for the workflow must be placed on the Server. Also, the Server will need to have access to any database connections, file directories, and input files. Want to know more about the Interface Designer? Interface-Designer-Part-1 Want to schedule workflows to run consecutively? Check out this article - Scheduling-Workflows-Using-Event-Run-Command
Scheduling a workflow, application, or package on your company's Gallery allows you to automate a process at a given frequency, date, and/or time. Because your asset is running on a server machine, it will not matter if your computer is connected to a network, or even turned on. In this article, we will describe how to schedule a workflow on a private Gallery.
I had a user recently ask about having an app on their Gallery run, produce an output, and have a second workflow send an email with the output from the app. There are a couple of ways to accomplish this, but I came up with an idea that I thought would be useful to share with the Community as they may find this feature useful for many situations.
The idea was to make it simple for the user so that they didn't have to use a chained app. The user just wanted the second workflow to run, but not put the Email tool on the Server. The solution is to use the Events > Run Command in the Workflow Configuration to schedule the email workflow after the app is run.
To accomplish the task, you can use a command line option that will add a specified workflow to the scheduler queue.
Scheduling a workflow via the Command Line:
The Run Command is in the Events tab; click on your Alteryx canvas and in the Workflow Configuration window select Events > Add > Run Command:
Run Event When: to "After Run"
C:\Program Files\Alteryx\bin\AlteryxService.exe (This may not be exactly where your company has the AlteryxService.exe saved. Please check with your Server Admin.)
Command Argument [Optional]:
addtoqueue=C:\location\of\workflow\to\schedule.yxmd,Server name,Controller Token,true
C:\Program Files\Alteryx\bin\AlteryxService.exe addtoqueue=C:\Temp\simpleoutput.yxmd,dib-ps-tst-12,3EA75D9170E4956DC3583C23224BA0898A98376D,true
Where to find Server name:On the machine the holds the server - Windows Start>Control Panel>System>Computer Name
Where to find the Controller Token: Open your Alteryx System setting on the Server and click Next until you reach the General screen under the Controller section. Click View to see the Controller Token and copy the token.
Once the first workflow is run, the Scheduler will queue up the scheduled workflow and run the workflow on the Scheduler immediately.
Hopefully, this will give you some creative ideas to use this operation!
One common reason why the Alteryx Service appears stuck in the 'Stopping' state is when the service is trying to stop but the AlteryxEngineCmd.exe process is running. In other words, a workflow is running. The Alteryx Service cannot be stopped when a workflow is running due to a schedule or a Gallery run.
Assets are an important part of your workflows in Alteryx. Assets will need to be included if you want to share, schedule, and publish your workflows to your Gallery. We run into many cases where users are able to run workflows on their Designer but they fail on Scheduler and Gallery. In a lot of cases it is due to the pieces of the workflow are not all there in the Scheduler and Server database. In this article, we will talk about when you need assets, how to package the assets, and what assets you want to make sure are a part of your workflow.
When You Need Assets:
When building and using workflows in the Alteryx Designer you don’t need to do anything with your assets as they are a part of your workflow locally, but if you want to move the workflow somewhere or to someone, you will need to package the workflow.
When sharing your workflow with another user, the workflow will need to be packaged with those assets so that the user can run the workflow without error. This would include input files as well as macros. If the workflow is connected to a database or using Alteryx Data, the user will not be able to run the workflow successfully unless they have access to those data sources on their own machine.
If you have Server or Desktop Automation, the Scheduler will be using a database separate from your Designer. If you have Server you will be using a MongoDB and if you have automation you will be using a SQLite database. This would mean that any macros that are not on the server or SQLite database would need to be added. By packaging the workflow and scheduling the package, the Scheduler will be able to access any custom macros or macros not included with Alteryx. This would include Predictive as well unless you have installed the predictive tools to your Server. If you have version 11.0 Server or later, you can send your workflows to your private gallery and schedule them on your server. When you do that, Alteryx will package the workflow the same as if you were sending an app or workflow to the Gallery as below.
The Gallery works a little different than packaging a workflow or Scheduled workflow. The difference is that the Assets will need to be on the Alteryx Server along with the workflow for the app, macro, or workflow to be used on the Gallery. Basically, the Save As option to the Gallery of your choice will start the packaging process of your workflow and Assets. The Save As a workflow window will appear with information about your workflow that you are sending to the Server Gallery. Select Workflow Option. Below the Workflow Options you will select Manage workflow Assets. This is where you can include and exclude information being sent to the Gallery.
Packaging the Assets:
Select in the tool bar Options ->Export Workflow. This will then launch a window that will show the name of your workflow, the location where the package will be stored, and the list of workflow assets.
When sending your workflow to the Gallery, you will do a Save As to and the Company’s Gallery. A window will open and you will see Workflow Options at the bottom of the page.
Select Workflow Options
You will then reach the Assets window which is similar to the packaged Assets window above.
You also have a second option when sending workflow to the gallery. In the Workflow Configuration window, select the Events tab, Select Add, Run Command. You will see a tab called Assets where you can add assets to the workflow. This is especially helpful when you are adding a chained app to the gallery. Check out Jordan’s article for the step by step: Adding-Files-to-the-Gallery.
What Assets Do I Need:
Great! I found the assets, but why are some missing, some checked, some not checked and which ones do I really need and what don’t I need?
You may see that you have Input and Output assets. When you are packaging a workflow to send to a user, you can include those assets if the user does not have those files to run the workflow. If the user does have the files or they are going to update the Input files or Output files, then you would not include them. The Input and Output assets will never include database connections only files.
The .yxmc files can be an important part of your workflow. Many of the Alteryx tools are .yxmc files and if these macros are a part of the Designer package, you won’t need to include them in the package as Alteryx knows that these tools will be in the workflow (example Report Header Tool is a macro). If macros are downloaded from the Alteryx Gallery, custom created, or sent from another user, these macros will need to be included as Assets.
How do you reserve port 80 on a server for a reverse proxy that Alteryx Server would sit behind? Ideally, anything off the box could still connect using 80, but locally it would be configured it to use a different port.
The Service Port can be currently only be modified by manually editing a key configuration file called "RuntimeSettings.xml." It's important to note that there are two files with this name installed on a Server:
There is a read-only file called RuntimeSettings.xml installed in the root Alteryx installation folder, which by default is C:\Program Files\ Alteryx\bin\RuntimeData\RuntimeSettings.xml . This is the core settings configuration file used by Alteryx and must never be edited .
There is a second file called RuntimeSettings.xml located at C:\ProgramData\Alteryx\RuntimeSettings.xml. This file is created and modified by the Alteryx System Settings dialog, and contains settings overridden from the base configuration file in (1).
**Please note that the settings should only ever be modified using the Alteryx System Settings dialog, as incorrect or incomplete settings could prevent your server from running correctly.**
Please reach out Alteryx prior to performing any manual modification of your Server configuration. This is especially important if you are running a multiple-node Server installation, as all nodes will need their Controller information updated. Similarly, Alteryx Designer users using the Scheduler will also be impacted by the change.
If you "must" change the Service Port be sure to:
Schedule planned Server downtime with your Server users
Stop the Server (using the Service Control Manager or Services tab in Task Manager)
Navigate to C:\ProgramData\Alteryx\
Create a copy of the file RuntimeSettings.xml
A an Administrator, start Notepad and open RuntimeSettings.xml
Under the "Controller" section of the XML, add the tag <ServicePort>your_desired_service_port</ServicePor t>
Save the RuntimeSettings.xml file
Open Alteryx System Settings and add the port to the Base Address like so: http://localhost:your_desired_service_port/gallery/
Start the Server (using the Service Control Manager or Services tab in Task Manager)
Verify Server operation