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.
How To: Modify Gallery Session Timeout
This article shows how to modify the session timeout for the Gallery. A session timeout specifies the number of minutes that a Gallery session can remain idle (inactive) before the session will be terminated. The default session timeout value is 60 minutes. When the session timeout occurs the user will be returned to the Sign In page:
Note: This setting applies to Built-in or SAML authentication only. When using Integrated Windows authentication Alteryx does not enforce a session timeout as the user has a valid Windows session.
Authentication Type: Built-in or SAML
If you have a multi-machine Server environment, the following steps should be performed on the Gallery node(s) only.
Open Windows File Explorer and navigate to %PROGRAMDATA%\Alteryx\.
Create a backup of the RuntimeSettings.xml file.
Open the RuntimeSettings.xml file in an editor and add the following line in the Gallery section:
Example RuntimeSettings.xml file with a 20 minute session timeout.
Save the file and restart the AlteryxService.
Gallery System Settings
The Alteryx Analytic Gallery
What is an Analytic Application?
Pre-packaged data and analytic integration published to the Alteryx Analytics Gallery by Data Artisans to answer specific strategic analytics questions. What is the Analytics Gallery?
The Analytics Gallery is a publicly hosted web service where applications can be published, securely shared, and run in the cloud.
What is a Viewer?
A Viewer is a free user of the Analytics Gallery. A Viewer can run all applications published in the Public Gallery.
What is a Member?
A Member is a user who can run applications that are shared privately through Collections. A Membership is granted by a Data Artisan. A Member also shares the privileges of a Viewer to run all applications published in the Public Gallery.
What is a Data Artisan?
A Data Artisan is a user who creates analytic applications using the Alteryx Designer Desktop and then shares them publicly and/or privately in the Analytics Gallery. A Data Artisan also shares the privileges of a Member.
What is required to run applications in the Public Gallery?
Anyone can sign up and become a Viewer, with the ability to run all applications in the Public Gallery, for free. As soon as you confirm your email, you will have access to the Public Gallery.
What is required to run an application in a private Collection?
You must be a Member to run applications shared in private Collections. Memberships are granted by Data Artisans, who create and share applications.
What is required to build applications?
Applications are built with Alteryx Designer Desktop. Download the Designer Desktop Free Trial.
What is required to publish applications in the Analytics Gallery?
Applications are published from the Alteryx Designer Desktop into a private Studio.
A Studio is automatically created for license holders of the Designer Desktop.
Trial users of the Designer Desktop can set up a Studio with a 30-Day Studio Free Trial
A user with the Designer Desktop and a private Studio is known as a Data Artisan.
How do I run an application?
Click on the title of an application to view application details and click the Run button; or simply click the icon.
Configure the application to suit your needs. Depending upon the application, you might be prompted to enter an address for geocoding, to input a customer file for demographic analysis, or to select data from a range of choices that apply to your business.
Click the Run button at the bottom of the application.
What are the results of running an application?
Applications can be authored to create a variety of different reports and data outputs. When the application processing finishes, the results will appear in the same window as the questions you answered before running the application.
Reports can be previewed after an application has completed by clicking on the Preview link.
Additionally, results for applications that have been run can be found in the application detail view and the "App Results" tab on the left of the screen.
What kinds of reports can an application create?
Depending upon how the application was built, it may produce Word, Excel, HTML, and/ or PDF files, containing a variety of text, tables, charts, and maps.
What kinds of tabular and spatial data output can an application create?
Depending upon how the application was built, it may produce CSV, MDB/ ACCDB, DBF, FlatFile, MID/ MIF, SHP, TAB, YXDB, and/or KML files.
I ran an application but I closed the window before it finished running. How can I view the results?
Application results are stored with your account and can be accessed at any time. As long as you are signed in, the results of any applications that have finished running can be found in two places:
Under the application details page for an application.
Under "App Results" (visible on the left side of the screen when you are signed in).
How can I view more details about an application?
Click on the name of an application to view details, such as the upload date, description, author, studio, copyright, and number of times run. The application details page also includes buttons enabling you to Run, Share, and (if enabled) Download the application.
What browsers are supported by the Analytics Gallery?
We always test and support the latest versions of the most popular web browsers. For more detail about specific browser versions see ‘System Requirements’ of the Technical Specifications page.
How can I find the applications I need?
Each section of the Analytics Gallery features a context-sensitive Search field you can use to find applications.
Searching in the Public Gallery returns applications in the Public Gallery.
Searching in the Studio tab returns applications in your Studio.
Searching in a Collection returns applications in the Collection.
Additionally, a Collection created by you will offer a second search window, which allows you to find applications in your Studio and add them to your Collection
Publishing and Sharing Applications
What is a Studio?
A Studio contains all of the applications published by the Data Artisans within an organization.
Who has access to the applications published in a Studio?
All of the Data Artisans within an organization, and only those Data Artisans, can view and run any applications in their Studio.
How can I rename my Studio?
Click on your User Name to go to your Settings.
Select the Studio Tab.
Enter a new name in the Studio Name field.
Click the save button.
How can an application be shared?
When an application is published in a Studio, all Data Artisans belonging to that Studio can access it.
An application in a Studio can also be shared to the Public Gallery, where anyone can access it.
An application in a Studio can also be shared in a Collection. Any users added to the Collection can access it.
As a Data Artisan, how can I share an application privately with someone?
Publish an application from the Designer Desktop to your private Studio.
Add the application to a Collection.
Add the User to the Collection. In order to run the application, the user must be a Member.
As a Data Artisan, how do I grant a Membership to someone?
Click on your User Name to go to your Settings.
Select the Studio Tab.
In the Members section, enter an Email address or User Name.
As a Data Artisan, how can I tell how many Memberships I have to distribute?
Click on your User Name to go to your Settings.
Select the Studio Tab.
Find "Memberships available to distribute" in the Members section.
How can I purchase additional Memberships?
Please contact Sales@Alteryx.com.
What applications can be added to a Collection?
Only applications published in the Data Artisan's Studio may be added to a Collection. Applications in the Data Artisan's Studio may also (at their discretion) be shared in the Public Gallery. However, applications in the Public Gallery that were published from other Studios cannot be added to a Collection.
Can an application be added to more than one Collection?
As a Data Artisan, do I also need a Membership?
No, Data Artisans are also Members.
I am a Data Artisan or Member. I want to run an application shared with me from a different organization. Do I need a Membership from that organization? No. A single Analytics Gallery Membership entitles you to run private applications shared from any Collection.
As a Data Artisan, how can I add another Data Artisan to my Studio?
Please contact firstname.lastname@example.org for assistance.
My organization has more than one Data Artisan. Who controls the distribution of Memberships?
At present, all Data Artisans have equal access to Membership distribution under Studio Settings.
What types of users can be added to a Collection?
Data Artisans, Members, and Viewers can all be added to a Collection. You can even enter the email address of someone who has not yet visited the Analytics Gallery.
Can a Viewer who is added to a Collection run the applications in the Collection?
Only those applications in the Collection that have also been shared in the Public Gallery by the Data Artisan can be run by the Viewer.
What types of users can run private applications in a Collection?
If an application in a Collection has not been shared in the Public Gallery, Viewers (who have been invited to join the Collection) can view the application, but cannot run it. Only Data Artisans and Members can run the application.
How can I find users to add to a Collection?
Select the Collection and use the Search Users field on the right. Any registered users of the Analytics Gallery that match your search terms will be returned.
Additionally, you can add someone who has not registered with the Alteryx Analytics Gallery by entering a valid email address. An invitation will be sent.
Is there a limit to the number of applications or users I can add to a Collection?
When I add a new application to a Collection, are the users in that Collection notified?
Can I allow users within my Collection to share it with others?
Each Collection includes a checkbox on the upper right that states "Other users may share this collection." When this box is checked, anyone in the Collection will have the ability to add other users to the Collection.
The Data Artisan who created the Collection will see the names of any additional users who are added to the Collection, and can remove them.
I published an application and shared it in a Collection (or in the Public Gallery). Since then, I have made changes to the application in the Designer Desktop. Can I update it? First, select the original version and delete it. Next, re-publish the application and add it to your Collection (or to the Public Gallery)
How can I share an application in the Public Gallery?
Click on the name of an application to view the application details page. Click the Sharing button and choose "Place in Public Gallery."
How can I remove an application from the Public Gallery?
Click on the name of an application to view the application details page. Click the Sharing button and choose "Remove from Public Gallery."
How can I share an application through email or social media?
(Public Gallery applications only) Click on the name of an application to view the application details page. Click the Sharing button to share via email, Twitter, Facebook, and Google+.
What is "private data?"
A license of the Alteryx Designer Desktop may include a variety of private data sets, including demographic data, psychographic data, business list and consumer list.
Can I publish applications using private data?
Yes, applications using private data can be published in your private Studio and can be shared in Collections. They cannot be shared in the Public Gallery.
What data is allowed in the Public Gallery?
Please see Alteryx Analytics Gallery Data Inventory
What capabilities in the Designer Desktop cannot be used in the Analytics Gallery?
The following tools are prohibited in applications published in the Analytics Gallery.
Run Command tool
Run Command event
R tool (Macros included in the Designer Desktop that use the R tool are permitted.)
Send Email event
I built an application that uses a prohibited tool in a safe manner. How can I apply for an exemption?
Email email@example.com and explain how and why each prohibited tool is used, along with the general purpose of the application.
Publish the application in your Private Studio and check the box "Others may download this application."
Add the application to a Collection and share it with firstname.lastname@example.org.
Your application will be reviewed and an exemption may be made to allow it to be run.
What tool configurations or question types cannot be used in the Analytics Gallery?
Input and output files referenced by Tools must be in the same directory as the application.
The application Question type "Folder Browse" cannot be used in applications published to the web.
In the application Question type "File Browse," the "Save As Dialog" configuration cannot be checked.
Application results (under analytic application properties) cannot include Browse tools.
Are there limits to the file size of applications and/or data published in the Analytics Gallery?
Yes, applications and data are limited to 100MB.
What are my options if I want to publish an application and data that exceed 100MB?
Please use the Cloud Connector tools within the Designer Desktop to host your data on the cloud.
Are chained applications supported in the Analytics Gallery?
At present, chained applications are not supported.
I forgot my password. How can I reset it?
Click Sign In and click the Forgot Password link. Enter the email address associated with your account and a new password will be emailed to you.
Can I download an application?
Yes, many applications can be downloaded. View application details and click the Download button. Use the Alteryx Designer Desktop to open the *.YXZP files that are downloaded. Go to Designer Desktop Free Trial to get started if you're not already an Alteryx customer.
I need help with my account. Who should I contact?
Please log a case at www.alteryx.com/community.
I found a bug on the Analytics Gallery or in an application. Who should I contact?
Please log a case at www.alteryx.com/community.
How can I purchase additional Memberships, Data Artisan accounts, or extend my subscription?
Please contact Sales@alteryx.com.
How can I recommend a feature for the Analytics Gallery?
Please send your feedback to GalleryFeedback@alteryx.com.
Where can I connect with other Alteryx users to ask questions and learn about best practices?
Who is the better captain, Kirk or Picard?
Workflows have moved to a different Private Studio
This is a hidden feature designed to allow workflows to be moved between studios. It's a holdover from our Public Gallery which is the original base for Alteryx Server.
Workflows disappeared from a Private Studio and are now in another one
Product - Alteryx Gallery
The following conditions being met will result in the workflow moving.
Source studio = free
Target studio = paid
User is last one in source studio
User is moved to target studio via access key (admin or user invoked)
All workflows move with the user regardless of ownership
There is no way to reverse the move of these workflows. The best defensive measure is to take regular backups of MongoDB, as restoring the database is the only way to revert the change.
Alteryx Server Backup and Recovery: Part 1
How To Deactivate Users on Gallery (An Alternative to Deleting Users)
If Gallery Admins would like to rescind access for specific Users on a Gallery, two methods are recommended. Deleting Users from Gallery is not supported and there is no Admin option available to delete Users entirely. The options outlined below will deactivate or revoke access.
Product - Alteryx Server
Procedure A: Built-In Gallery
1. Navigate to the Subscription page under the Gallery Admin portal -> Subscriptions. Add a new subscription, specific for Deactivated Users.
2. Add the User to the subscription by click either the Add Artisan or Add Member button.
3. Navigate to the Users page under Gallery Admin portal -> Users. Change the role of the User to No Access.
**To see the 2018.4 version layout, select the Profile Button on the User. To revoke access, switch the Active button to No.
Procedure B: Windows Authentication Gallery
1. Navigate to the Subscription page under the Gallery Admin portal -> Subscriptions. Add a new subscription, specific for Deactivated Users.
2. Add the User to the subscription by click either the Add Artisan or Add Member button.
3. Navigate to the Permissions page under Gallery Admin portal -> Permissions. Search for the User and choose No Access.
SAML (Security Assertion Markup Language) is a standardized way for exchanging authentication and authorization credentials between different parties. The most common use for SAML is in web browser single sign ons. Starting in 2018.2, Alteryx Server supports SAML. So far, SAML in Alteryx Server has been specifically validated on two providers; Ping One and Okta. In this article we will review how to configure SAML on your Alteryx Server for PingOne.
The Alteryx Service is unable to start, and/or the Gallery fails to load in the browser.
The message Gallery Service failed to start in a timely fashion can be found in the Server's Service logs.
AlteryxService_LogStartupError: There was an error starting the Alteryx Service <Gallery Service failed to start in a timely fashion, exiting.>
Alteryx Service cannot start.
Alteryx Gallery fails to load.
Alteryx Service starts and then stops after a short time. The Service logs will have an error message of Gallery Service failed to start in a timely fashion.
Alteryx Gallery starts and then disconnects after a short time. The Service logs will have an error message of Gallery Service failed to start in a timely fashion.
The Service is unable to ping the Gallery endpoint. This can happen for a variety of reasons.
The gallery URL is misconfigured.
A proxy is intercepting communication between the Service and Gallery.
Traffic is not being properly routed back to Gallery (e.g. machine is being a load balancer and traffic is not coming back to Gallery).
Isolating a misconfigured gallery URL
The following base URL for Gallery can be configured as:
If this not working, please go to Solution C
2. Machine Name with Fully Qualified Domain Name (FQDN)
If (1) works and (2) does not, please go to Solution A
3. Domain Name System (DNS)
If (1) and (2) works and (3) does not, please go to Solution A
4. SSL Enabled (Compatible with all previous setups)
If (2) and (3) work, but (4) does not work, please go to Solution A
To identify which component is causing the issue, a general recommendation is to downgrade to setup (1) and move up in complication until the issue replicates.
Additionally, a common practice to isolate if the gallery is properly resolving to the correct IP address is to use “nslookup” and “ipconfig /all”.
1. Open a command prompt as administrator
2. Type "nslookup gallerywebsite.com"
**Do not include http:// or https://
The Domain Name Server and its IP address of the address that is provided (the gallery URL) will be listed
3. Type "ipconfig /all"
The Domain Server Name information and the IP address of the current machine will be listed.
If these do not match up, then this can be a source to begin troubleshooting.
Isolating a proxy
Generally, IT or the Server Admin will know if a proxy is being used on the Server.
Check cURL environment variables are configured properly.
Go to Solution B if a proxy is affecting your Gallery
Traffic is being properly routed back to Gallery
Generally, IT or the Server Admin will know of any certain setups, such as load balancers, that can affect reroutes. Wireshark traces may be obtained to get more information.
Please go to Solution A if your Gallery URL is being redirected
Check with your IT to ensure that the Server can be recognized on the company’s network or that any third party entities are properly set up (DNS, SSL, etc.)
While we do not support or recommend any specific SSL cert software, please reference the Community article Configuring Alteryx Server for SSL: Obtaining and Installing for details on how to properly sign and bind a certificate to the Alteryx Server.
Ensure that cURL environment variables are configured properly.
Common variables to check that can be the source if the traffic goes to the proxy and does not come back are: http_proxy, https_proxy, all_proxy
localhost can be affected if it is not set as a no_proxy exclusion
To set environment variables please see this article.
If any additional assistance is required, please open a ticket with Alteryx Support through the Case Portal.
SAML (Security Assertion Markup Language) is a standardized way for exchanging authentication and authorization credentials between different parties. The most common use for SAML is in web browser single sign ons. Starting in 2018.2, Alteryx Server supports SAML. So far, SAML in Alteryx Server has been specifically validated on two providers; Ping One and Okta. In this article we will review how to configure SAML on your Alteryx Server for Okta.
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.
The Alteryx Gallery can support custom reports in .rptx format. If a workflow or app is uploaded to the gallery without taking the following steps, there will be an error stating that it can not find the .rptx file. The key is to make sure to save a copy of the .rptx file in the same location as the App so that the allocate report configuration is not lost. Then make sure to add the RPTX file as an asset attached to the Allocate Report tool before publishing to the gallery. To do this, first make sure that the Display Asset Management in Properties Window option is checked in Designer User Settings:
Now click on the Assets icon on the left side of the Allocate Report configuration window, and add RPTX file:
It is important to know that Custom VVFs are not supported in the Gallery. If there is a custom variable that you would like to include, it must be calculated inside the .RPTX file itself. Calculating a Variable inside an RPTX: Opening an RPTX in the Composer will display the code that drives the custom report by adding code similar to the following, a new variable can be calculated within the RPTX itself. <td align="Left" width="17%">My Variable </td> <td align="Right" width="8%"> <all:app class="__format2" formula="(XCYFEM + XCYMALE)" /> </td>
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.
This is the second article in a series on Alteryx Server backup and recovery. You can find Part 1 at: Alteryx Server Backup & Recovery Part 1: Best Practices As long as a backup of the Mongo database is available, you can get Alteryx Server back up and running. Luckily, backing up the embedded MongoDB is pretty simple, and can be done with a few console commands. I would recommend creating a batch file or script to perform the process. Doing so will allow you to schedule the backup using Windows Task Scheduler. The actual steps to perform a MongoDB backup are covered in detail in the online help under the server configuration section or at this direct link. I will also outline the steps below for completeness. To create a backup of the MongoDB: Stop AlteryxService. Execute the following command to save a backup of the database in the specified folder: alteryxservice emongodump=<path to backup location> Restart AlteryxService You can easily script this to a batch file with a few simple console commands. Keep in mind that paths may vary on your server, but it should look something like this. Example: "C:\Program Files\Alteryx\bin\AlteryxService.exe" stop "C:\Program Files\Alteryx\bin\AlteryxService.exe" emongodump=Z:\Path\MongoBackup "C:\Program Files\Alteryx\bin\AlteryxService.exe" start You can add additional features, such as logging and date/time stamps, to the backups. As an example of additional useful features to include with your backups, I have included the code for a batch script I created that adds the following information: logging with date/time stamping, a backup that is also date/time stamped, automated archival of the backup, copying the archive to a network location, and cleanup of the temp files. Once you have a batch file or other script to perform your backups, you need to test the script to ensure it works properly. Once testing is done, the next step is to schedule the backup. The easiest way to do this is to use Windows Task Scheduler. To create a scheduled task on Windows 2012 Server, follow these steps: Create a scheduled task: Open Task Scheduler and click on “Create Task” On the General tab, enter “Name”, “Description”, select “Run whether user is logged in or not", and select "Run with highest privileges" On the Triggers tab, click “New” A dialogue box will appear. Define the schedule (daily, weekly, etc...) on which you want the backup to run and click “OK” On the Actions tab click “New” On the dialogue window, make sure “Start a Program” is selected and click “Browse”. Select the batch file you created and click “Open”. Then click “OK”. Click “OK” on the Create Task window to finalize the creation of the backup task. Now that you have successfully implemented backup procedures and scheduled a task to automate the backups, it is time to discuss database restoration from a backup. The good news is that restoring the database is just as simple as backing it up. Assuming that 1) the server is functioning, 2) Alteryx Server is installed, and 3) you have a valid backup available, you can follow these simple steps outlined below. To restore a backup of the MongoDB: Stop AlteryxService Execute the following command to restore the backup: alteryxservice emongorestore=<path to backup location>,<path to restore to> Restart AlteryxService This simplicity and same focus on command line statements means that we can also script recovery. However, since recovery actions are much less frequent, it probably isn't necessary. Instead, you would just connect to the server, open a command prompt and, following our backup example above, execute the following commands: Example: "C:\Program Files\Alteryx\bin\AlteryxService.exe" stop "C:\Program Files\Alteryx\bin\AlteryxService.exe" emongorestore=Z:\Path\MongoBackup,C:\ProgramData\Alteryx\Service\Persistence\MongoDB "C:\Program Files\Alteryx\bin\AlteryxService.exe" start For Alteryx Server we also recommend backing up the controller token and some settings files. While the server can be recovered without these files. Having a backup of them can expedite the recovery process, and they will also ensure you will be able to decrypt any sensitive data in the database. The settings files we recommend backing up are: C:\ProgramData\Alteryx\RuntimeSettings.xml C:\ProgramData\Alteryx\Engine\SystemAlias.xml C:\ProgramData\Alteryx\Engine\SystemConnections.xml Again, please keep in mind the exact paths may vary depending on the server configuration and where the backup is located. This example also assumes the backup isn't compressed/archived. If you are using a backup script that archives the backup and copies it to network storage, you will need to copy the backup file to the server and decompress the archive before running the recovery commands above. Below is the code for my sample batch script: ::----------------------------------------------------------------------------- :: :: AlteryxServer Backup Script v.2.0.2 - 01/04/19 :: Created By: Kevin Powney :: :: Service start and stop checks adapted from example code by Eric Falsken :: ::----------------------------------------------------------------------------- @echo off ::----------------------------------------------------------------------------- :: Set variables for Log, Temp, Network, and Application Paths :: :: Please update these values as appropriate for your environment. Note :: that spaces should be avoided in the LogDir, TempDir, and NetworkDir paths. :: The trailing slash is also required for these paths. ::----------------------------------------------------------------------------- SET LogDir=C:\ProgramData\Alteryx\BackupLog\ SET TempDir=C:\Temp\ SET NetworkDir=\\ServerName\SharePath\ SET AlteryxService="C:\Program Files\Alteryx\bin\AlteryxService.exe" SET ZipUtil="C:\Program Files\7-Zip\7z.exe" :: Set the maximium time to wait for the service to start or stop in whole seconds. Default value is 2 hours. SET MaxServiceWait=7200 ::----------------------------------------------------------------------------- :: Set Date/Time to a usable format and create log ::----------------------------------------------------------------------------- FOR /f %%a IN ('WMIC OS GET LocalDateTime ^| FIND "."') DO SET DTS=%%a SET DateTime=%DTS:~0,4%%DTS:~4,2%%DTS:~6,2%_%DTS:~8,2%%DTS:~10,2%%DTS:~12,2% SET /a tztemp=%DTS:~21%/60 SET tzone=UTC%tztemp% echo %date% %time% %tzone%: Starting backup process... > %LogDir%BackupLog%datetime%.log echo. >> %LogDir%BackupLog%datetime%.log ::----------------------------------------------------------------------------- :: Stop Alteryx Service ::----------------------------------------------------------------------------- echo %date% %time% %tzone%: Stopping Alteryx Service... >> %LogDir%BackupLog%datetime%.log echo. >> %LogDir%BackupLog%datetime%.log SET COUNT=0 :StopInitState SC query AlteryxService | FIND "STATE" | FIND "RUNNING" >> %LogDir%BackupLog%datetime%.log IF errorlevel 0 IF NOT errorlevel 1 GOTO StopService SC query AlteryxService | FIND "STATE" | FIND "STOPPED" >> %LogDir%BackupLog%datetime%.log IF errorlevel 0 IF NOT errorlevel 1 GOTO StopedService SC query AlteryxService | FIND "STATE" | FIND "PAUSED" >> %LogDir%BackupLog%datetime%.log IF errorlevel 0 IF NOT errorlevel 1 GOTO SystemError echo %date% %time% %tzone%: Service State is changing, waiting for service to resolve its state before making changes >> %LogDir%BackupLog%datetime%.log SC query AlteryxService | Find "STATE" timeout /t 1 /nobreak >NUL SET /A COUNT=%COUNT%+1 IF "%COUNT%" == "%MaxServiceWait%" GOTO SystemError GOTO StopInitState :StopService SET COUNT=0 SC stop AlteryxService >> %LogDir%BackupLog%datetime%.log GOTO StoppingService :StopServiceDelay echo %date% %time% %tzone%: Waiting for AlteryService to stop >> %LogDir%BackupLog%datetime%.log timeout /t 1 /nobreak >NUL SET /A COUNT=%COUNT%+1 IF "%COUNT%" == "%MaxServiceWait%" GOTO SystemError :StoppingService SC query AlteryxService | FIND "STATE" | FIND "STOPPED" >> %LogDir%BackupLog%datetime%.log IF errorlevel 1 GOTO StopServiceDelay :StopedService echo %date% %time% %tzone%: AlteryService is stopped >> %LogDir%BackupLog%datetime%.log ::----------------------------------------------------------------------------- :: Backup MongoDB to local temp directory. ::----------------------------------------------------------------------------- echo. >> %LogDir%BackupLog%datetime%.log echo %date% %time% %tzone%: Starting MongoDB Backup... >> %LogDir%BackupLog%datetime%.log echo. >> %LogDir%BackupLog%datetime%.log %AlteryxService% emongodump=%TempDir%ServerBackup_%datetime%\Mongo >> %LogDir%BackupLog%datetime%.log ::----------------------------------------------------------------------------- :: Backup Config files to local temp directory. ::----------------------------------------------------------------------------- echo. >> %LogDir%BackupLog%datetime%.log echo %date% %time% %tzone%: Backing up settings, connections, and aliases... >> %LogDir%BackupLog%datetime%.log echo. >> %LogDir%BackupLog%datetime%.log copy %ProgramData%\Alteryx\RuntimeSettings.xml %TempDir%ServerBackup_%datetime%\RuntimeSettings.xml >> %LogDir%BackupLog%datetime%.log copy %ProgramData%\Alteryx\Engine\SystemAlias.xml %TempDir%ServerBackup_%datetime%\SystemAlias.xml copy %ProgramData%\Alteryx\Engine\SystemConnections.xml %TempDir%ServerBackup_%datetime%\SystemConnections.xml %AlteryxService% getserversecret > %TempDir%ServerBackup_%datetime%\ControllerToken.txt ::----------------------------------------------------------------------------- :: Restart Alteryx Service ::----------------------------------------------------------------------------- echo. >> %LogDir%BackupLog%datetime%.log echo %date% %time% %tzone%: Restarting Alteryx Service... >> %LogDir%BackupLog%datetime%.log echo. >> %LogDir%BackupLog%datetime%.log SET COUNT=0 :StartInitState SC query AlteryxService | FIND "STATE" | FIND "STOPPED" >> %LogDir%BackupLog%datetime%.log IF errorlevel 0 IF NOT errorlevel 1 GOTO StartService SC query AlteryxService | FIND "STATE" | FIND "RUNNING" >> %LogDir%BackupLog%datetime%.log IF errorlevel 0 IF NOT errorlevel 1 GOTO StartedService SC query AlteryxService | FIND "STATE" | FIND "PAUSED" >> %LogDir%BackupLog%datetime%.log IF errorlevel 0 IF NOT errorlevel 1 GOTO SystemError echo %date% %time% %tzone%: Service State is changing, waiting for service to resolve its state before making changes >> %LogDir%BackupLog%datetime%.log SC query AlteryxService | Find "STATE" timeout /t 1 /nobreak >NUL SET /A COUNT=%COUNT%+1 IF "%COUNT%" == "%MaxServiceWait%" GOTO SystemError GOTO StartInitState :StartService SET COUNT=0 SC start AlteryxService >> %LogDir%BackupLog%datetime%.log GOTO StartingService :StartServiceDelay echo %date% %time% %tzone%: Waiting for AlteryxService to start >> %LogDir%BackupLog%datetime%.log timeout /t 1 /nobreak >NUL SET /A COUNT=%COUNT%+1 IF "%COUNT%" == "%MaxServiceWait%" GOTO SystemError :StartingService SC query AlteryxService | FIND "STATE" | FIND "RUNNING" >> %LogDir%BackupLog%datetime%.log IF errorlevel 1 GOTO StartServiceDelay :StartedService echo %date% %time% %tzone%: AlteryxService is started >> %LogDir%BackupLog%datetime%.log ::----------------------------------------------------------------------------- :: This section compresses the backup to a single zip archive :: :: Please note the command below requires 7-Zip to be installed on the server. :: You can download 7-Zip from http://www.7-zip.org/ or change the command to :: use the zip utility of your choice as defined in the variable above. ::----------------------------------------------------------------------------- echo. >> %LogDir%BackupLog%datetime%.log echo %date% %time% %tzone%: Archiving backup... >> %LogDir%BackupLog%datetime%.log %ZipUtil% a %TempDir%ServerBackup_%datetime%.7z %TempDir%ServerBackup_%datetime% >> %LogDir%BackupLog%datetime%.log ::----------------------------------------------------------------------------- :: Move zip archive to network storage location and cleanup local files ::----------------------------------------------------------------------------- echo. >> %LogDir%BackupLog%datetime%.log echo %date% %time% %tzone%: Moving archive to network storage >> %LogDir%BackupLog%datetime%.log echo. >> %LogDir%BackupLog%datetime%.log copy %TempDir%ServerBackup_%datetime%.7z %NetworkDir%ServerBackup_%datetime%.7z >> %LogDir%BackupLog%datetime%.log del %TempDir%ServerBackup_%datetime%.7z >> %LogDir%BackupLog%datetime%.log rmdir /S /Q %TempDir%ServerBackup_%datetime% >> %LogDir%BackupLog%datetime%.log ::----------------------------------------------------------------------------- :: Done ::----------------------------------------------------------------------------- echo. >> %LogDir%BackupLog%datetime%.log echo %date% %time% %tzone%: Backup process completed >> %LogDir%BackupLog%datetime%.log GOTO :EOF :SystemError echo. >> %LogDir%BackupLog%datetime%.log echo %date% %time% %tzone%: Error starting or stopping service. Service is not accessible, is offline, or did not respond to the start or stop request within the designated time frame. >> %LogDir%BackupLog%datetime%.log
Have you ever built an Alteryx App only to realize that some part of the process must remain in Excel? Instead of abandoning your Alteryx App all together, you may be able to use the Alteryx API and call your app from Excel. We’ve put together all the necessary VBA code so that it should be quick and easy for you to call an Alteryx App from Excel and get the results back. The Alteryx app for our sample, API Tester.yxzp, has been included in case you want to upload it to your private gallery and test out the Excel to Alteryx API using your Alteryx server.
SAMPLE EXCEL FILE - Input
We are going to be working with the attached “Reverse String.xlsm” to demonstrate the API. Suppose you wanted to reverse a string in excel (“Hello World” should be converted to “dlroW olleH”). You can’t quite get it in Excel, but you could quickly use the ReverseString function in Alteryx. Now the only trick is getting your data from Excel to Alteryx and back to Excel. We’ll have the user enter the string on cell E5 and then hit the Run Alteryx Button. Cell E6 will then be the results we get back from Alteryx
HOW TO SETUP THE VBA
When working with the Alteryx API, you need to setup some settings/configurations in your excel file before you can deploy it. If you open up the VBA editor (Alt + F11), there is Sub called Doer where we will have to enter a few key settings that apply to your Alteryx App. This is a one time setup for each different application that you setup.
strKey – this is your unique Alteryx Key. It is unique to all the apps in your private studio. It can be found here for the Alteryx public gallery
strSecret – this is your unique Alteryx Secret. It is unique to all the apps in your private studio. It can be found here for the Alteryx public gallery
strAppID – this is your app’s unique ID. When you look at your app in a browser, the appID is the unique ID at the end of the URL. For our sample, our AppID “589b70eceffc2a0bb0a2d530” can be found at the end of the App’s URL
AlteryxURL – this is the base URL where the app resides. For the public gallery, it is : https://gallery.alteryx.com. You would switch this your URL if you were going to use your private gallery. A private gallery would be of the format resembling: https://server.domain.com/gallery.
Data – Any data that needs to be passed from Excel to Alteryx can be saved as string variables in the VBA. For our simple app, we’re only passing one item, the string that we want reversed. In order to pass more complex data, we’ve found it easier to save the data to a .csv and then have the Alteryx App read the .csv as part of the app.
strQuery – This is the entire set of information that is being sent from Excel to the API for processing. It’s in JSON format. For each item, you need a name and value. The name corresponds to the interface tool’s name in your Alteryx App. The value corresponds to the value that want to set. From our Alteryx App, you can see that we’ve given our textbox tool the name “input_string”. For the value, we’ll be passing whatever string the user enters into excel.
To see all the questions for a given app, the API documentation is immensely helpful. After you enter your key and secret, you would go to the second GET, type in the appID, and then try it out to get a list of the name value pairs that we must send from Excel to Alteryx. Note that you only send the name and value fields from the response body.
Save – This variable is a Yes or No answer for whether or not you want to save the data coming back from Alteryx. In this case we would say Yes. For more complex apps, we may have our Alteryx workflow save the data to a network folder that our excel VBA would go grab once Alteryx is done. That post run coding would be added under the Part_Deux sub in the VBA editor. There we would have Save=”No”
Output_Name – this is the column name of the output data that we want to retrieve from Alteryx. In our sample, the column Name is “Output_String”. This only applies if Save=”Yes”
SaveLocation – this is the cell range where the output should be written. This process currently only supports writing one cell of data back to excel. Anything more complicated should be handled through custom VBA in the Part_Deux sub. This only applies if Save=”Yes”
NOTES ABOUT WHAT IS GOING ON BEHIND THE SCENES
While I won’t go through everything that is going on in the background, here are some key points:
Ensure that you have references to Microsoft XML, 6.0 if any errors pop up.
The VBA takes all the settings and adds the time and a random string before posting a request to the Alteryx Server to run the job in the RunAlteryx sub. It has to combine all these items, URL encode certain parts, create a base64 hash, and send this to the Alteryx server in just the right order.
It then makes a Get request to check the status. If the status is complete, then the VBA moves on to get the results; otherwise, the VBA creates another request to check the status in 1 second. Note that Excel will be operational during this time since it’s not during any work. This loop will continue until the status is either completed or error. Note that it will update the status on the bottom left of your screen to indicate that Excel is waiting on Alteryx to run the job.
Once the Alteryx app returns a completed status, the VBA will then make another get request for the output that you’ve requested (only if save=”Yes”). If Save=”Yes”, the VBA then saves the output to the specified cell.
If you want to write any of your own code that should execute when the code is done, place it in the part_Deux sub. For example, perhaps you have a private server setup where the Server will write an output file to a network folder that excel can read in from. The code in part_Deux might look something like the below:
Dim ActBook As Workbook
Dim FromAlteryx As String
FromAlteryx = "\\server\" + Environ$("username") + "_out.csv"
Set ActBook = ThisWorkbook
On Error GoTo 0
Selection.PasteSpecial Paste:=xlPasteValues, Operation:=xlNone, SkipBlanks _
Workbooks(Environ$("username") + "_out.csv").Close
SAMPLE EXCEL FILE - Output
Assuming we have everything setup correctly, our app should return the reverse of the string that is input:
The Visualytics Insight tool was first introduced with Alteryx 2018.3. Insights allow users to create visual, interactive dashboards to gain deeper insights into your data and can be shared through an Alteryx Private Gallery. In order to have Insights load successfully on your Gallery, there are a few changes you need to make to your Server System Settings.
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!
This is Part 2 of the Alteryx Gallery Series - The Gallery Series only refers to the Alteryx Server where you can host your Private Alteryx Gallery. This Article with refer to 'Alteryx Gallery' as a privately hosted Gallery on the Alteryx Server.
Part 1 Alteryx Gallery Series - The Lay of the Land 101: Gallery Admin Edition
Part 3 Alteryx Gallery Series: App Publishing & Version Control 101 - Alteryx Community
Part 4 Alteryx Gallery Series: How to make the most of your Alteryx Gallery – Use Cases
Each section of the user interface is outlined and described below:
Often utilizing and navigating the Private Alteryx Gallery for the first time (or even for veterans) can be difficult. This article aims to make this process simpler by giving a step-by-step guide on where to find the main areas of the Alteryx Gallery, as well as those hidden features.
Finding the Alteryx Gallery
The URL is typically the ServerMachineName(or IP)/Gallery unless another domain has been defined.
**** Speak to your IT or Alteryx Server Contact to find URL address.
If it is an internal server, the user will need to be logged into your organization’s VPN before accessing the Gallery.
Accessing the Gallery
User visits the Gallery on their own:
Depending on your pre-defined user authentication setting, the user may be granted access to the Gallery the first time he or she visits the URL.
If your Gallery utilizes Windows Authentication, a Gallery Account is automatically created when a new user visits the site.
If your Gallery utilizes Built-In Authentication, the new user may create their own Account profile by “Joining” the Gallery from the Gallery home page.
Gallery Admin invites user to the Gallery:
The Gallery Administrator may invite users to join the Gallery. This allows the Administrator to set up all of the users specific privileges before that user views the site.
If your Gallery utilizes Windows Authentication, the admin would enable “No Access”. You will receive no notification from Gallery once you have registered.
If your Gallery utilizes Built-In Authentication, the admin would disable the “Sign-Up Form” (Link to gallery admin page). The user will receive an invitation email and be asked to validate their account.
Lay of the Land: Everyday Gallery User
“HOME is where the heart is”
When you create a workflow, macro or app in the Alteryx Designer and upload in to the Alteryx Gallery you can CHOOSE to share your workflow to the Public Gallery (Home). You will need to be a Data Artisan to publish to the Alteryx Gallery (Link Permissions page).
Users with access to your Gallery URL may access the Public Gallery section. External users cannot view and run workflows in the Public Gallery unless they have been invited by an Admin and have network rights to access the Gallery website.
Users often upload proof of concepts or demo applications to the Alteryx Gallery which other users can use for reference.
Public Gallery section that have been tagged (after publishing) with a specific keyword set by the Gallery Administrator.
“The last of the thirteen DISTRICTS of Panem”
Districts are Alteryx workflows shared in the Public Gallery section that have been tagged (after publishing) with a specific keyword set by the Gallery Administrator.
Districts are used for housing macros which are used within different internal departments.
“Welcome to my Private Studio”
A user will ONLY receive their own Private Studio if their user permission level (set by the Alteryx Gallery Admin at sign up or before) are designated an Data Artisan User. This will allow them to publish Alteryx workflows from their Desktop Designer.
By default, a Data Artisan will only see the workflows they have published themselves in the Private Studio section. To see content created by other Data Artisans, a workflow may be shared in the Public Gallery or via a Collection or Studio.
"Brand new Insights"
New feature added in the Alteryx Server 2018.2 allowing you publish interactive charting directly into a web browser
This dashboarding features offers users the ability to filter and drill down into Analytical Insights
“You’re the chosen one, welcome to my Collection”
Collections are a means for ensuring only specific users may access workflows to which they are assigned.
Collections are managed by users NOT by the Gallery Administrator.
Collections are tied to one Private Studio only.
A user must have their own (paid) Private Studio OR be a member of another Private Studio in order to run workflows shared via a Collection.
Data Artisans can invite Users to a collection through the users tab inside of the collection. These Users will have to sign up to the Alteryx Gallery or be users in the same domain as the Alteryx Gallery is hosted on.
You can have Multiple Admins for collections
“Let’s see these Workflow Results”
Gallery Users may view the results/output of their own previous workflow executions.
You can never see the results of other user’s executions via the Gallery.
'Let's automate that for you' - Scheduler
In Alteryx 11.0 the gallery Admin can allow users to schedule directly from the Alteryx Gallery.
You can click on the scheduler tab and schedule your workflow by choosing the workflow and frequency you wish to run the schedule on.
You then get visibility to your schedules only, and have the ability to edit the schedule and remove the schedule from being run.
This is Part 1 of the Alteryx Gallery Series - The Gallery Series only refers to the Alteryx Server where you can host your Private Alteryx Gallery. This Article with refer to 'Alteryx Gallery' as a privately hosted Gallery on the Alteryx Server.
Part 2 Alteryx Gallery Series - The Lay of the Land 101: User Edition Part 3 Alteryx Gallery Series: App Publishing & Version Control 101 - Alteryx Community
Part 4 Alteryx Gallery Series: How to make the most of your Alteryx Gallery – Use Cases
The Lay of the Land 101: Gallery Admin Edition
The Gallery Admin is the Godfather of a Alteryx Gallery. The Admin is less involved with the workflow content of the site and more involved with management of users and their overall experience on the Gallery. This article will help the Gallery Admin navigate the Admin settings within the Private Alteryx Gallery.
Each section of the Admin interface is outlined and described below:
A Subscription is another name for a Studio. A Studio allows Alteryx Designer users to publish and share workflows privately within their organization.
Each user that creates a Gallery account is automatically given their own subscription which can become a Private Studio if the user permission level is designated an Artisan. As a Gallery Admin you will have to make this user an Artisan, take a look at the ‘users’ section below which details how to do this.
Each Studio includes a limited number of artisans and members – assigned by the Gallery Admin.
Once a subscription has been created, it can be deactivated but not deleted. Gallery Admins are the only ones with permissions to create subscriptions.
Creating and adding users to Private Studios
To create a studio (subscription) click on ‘subscription tab’ and click on ‘Add New Subscription’. You will now have the ability to create a studio (subscription)
This will be the subscription screen below:
Gallery Admin can create studios as well as manage the users and workflows assigned to them.
There are numerous options when creating a Subscription or Studio:
Private Studio Name: The name for the studio, which displays at the top of the page when the user clicks “Private Studio” on the left menu of the Gallery page.
Contact Name: The person who owns and manages the studio.
Free: Artisans and Members who are part of the studio can run workflows in the Public Gallery
Paid: Artisans who are part of the studio can publish and run workflows in that studio and Members can run workflows
Artist Seats: The number of Artisan seats available in the studio. Artisans can publish, run, and share workflows.
Member Passes: The number of Member seats available in the studio. Members can run workflows in studios for which they have been assigned.
Expiration Date: The date the Paid subscription expires. When a paid subscription expires it is downgraded to a Free subscription.
API Enabled: Access to the Private Server Gallery API is enabled by default. The Gallery API supports the ability to authenticate, list apps, run apps, and retrieve app results using an API Key and Secret which are accessible via Gallery Settings.
Disable user sign-ups: Limits who can sign up for your Gallery. Forces users to be “invited” to join the Gallery.
Allow anyone to run public workflows without singing in: If this option is selected, anyone with access to your Gallery URL may run workflows that are available on the Home Page.
This is how to add a user to a studio (Subscription). You need to take the subscription key from the ‘subscription’ section (above screenshot) and add this into the studio key within the User profile below.
When a user now publishes from there Alteryx Designer to the Alteryx Gallery they will see the studio name they are associated with. This is linked by the same subscription and studio key.
Users can only be part of one Studio at a time.
Gallery Admins can add users directly to the Gallery or they can send an email inviting user to log in and add themselves via the Join now form on the main page of the Gallery.
User permissions are managed in the users profile (or in “Permissions” if using Windows Auth) as well as in their assigned studio.
The new user is added to the Users page. The users name, email (for Built-In Auth), and name of their studio display in the user box as well as icons that represent their permissions.
When using Built-In Authentication, the Gallery Admin can designate the permission level of users before they sign up to Alteryx Gallery on the users tab
Built-in Permissions Screen (Users permission level for the whole Alteryx Gallery)
Windows Auth Permissions screen (Users permission level for the whole Alteryx Gallery)
Gallery Admins can manage user permissions in the Permissions page when using Windows Authentication only.
A default permission level (No Access, Viewer, Artisan, Curator) can be set for any new or existing user who joins the Gallery.
Admin Tip: Set the default permission to No Access or Viewer if Content Security is of chief concern. This will require users to be invited to run workflows on the Gallery
Once a user has been created, it can be deactivated but not deleted.
Gallery Admins can add workflows, apps, and macros to the Gallery and manage their icon, description, Run Mode settings, and exemptions.
Admins can also create “tags” and associate them to workflows so searches within the Gallery return better results.
Run Mode: Determines the level that workflows are permitted to run in the Gallery. Workflows that contain certain tools or access may need to be blocked. The default Run Mode is selected when the server is configured.
Unrestricted: Any workflow can be run.
Semi-Safe: Workflows using Run Command, Download, Email, “R”, or Events will be blocked.
Safe: Workflows using above tools or accessing/storing data on non-local drives will be blocked.
Requires Private Data: Indicates if the workflow requires licensed data to run.
Private Data Exemption: An exemption can be given to a workflow with private data so that it can be run.
Gallery Admins can create new districts and modify the district name, description, and icon image. Once the District has been created, it will be displayed below the “Home Page” menu option on the Gallery.
This tab within the Gallery Admin section is only available for Alteryx Server Version 11.0 and above
This tab will give you the option to pre-define credentials that can be sent down to designer users
This will help when managing access and Alias creation on both Designer & Server
DSN-less connections will run straight away. DSN connections will need to be set up on the location machine and server machine
Set workflow credentials which can be use when running a workflow from the server. These will also appear in the designer when uploading/scheduling a workflow
Click on 'change; and you get the following options
Use Default Credentials
This will use the server service account details to run workflows if nothing has been set in the 'Run As' section of the Server System Settings
Require User Credentials
When running the application from the Alteryx Gallery the users will have to enter in credentials
Allow users to set options for credentials option
The best practice would be to ask users for their credentials so they can only access the data they have privileges for within your internal IT environment.
The interface will look like the screenshot below. When uploading an App from your Alteryx Designer (File>>Save as>>>My Company's Gallery) you can click on 'Workflow Options' & 'Set Workflow Credentials'.
This will give the user three options
'User is not required to specify credentials' - The application/workflow will run as the default Alteryx Server user account (Run As settings in system settings on server config).
'Always run this workflow with these credentials' - The user can enter the credentials at this point, however preset credentials can be added within the Alteryx Gallery Admin section ("Workflow Credentials")
This is where you can give users permission to schedule workflows they upload to the Alteryx Gallery. This will allow all artisans to schedule workflows.
The server can send email notifications for various events. The SMTP server information is entered when the server is configured. Gallery Admins can manage the types of notifications and the message text.
Admin Tip: Disable notifications so your users don't get spammed by the Gallery.
Customize your Alteryx Gallery!
Banner Ads can be added to be displayed below the search bar on the Home page. Uploaded Files can be added to the site to which Gallery Users can access via Links.
You have the ability to change the Gallery Name, Logo and Color Scheme within the web Browser.
This is often used to house FAQs, Help & Links
Add link to your Page or URL in the Header or Footers.
If you have any outstanding questions please reach out to our Alteryx Support