Alteryx Server Knowledge Base

Definitive answers from Server experts.
This article will help you configure dynamic e-mail attachments with output from a Gallery workflow that can change with each workflow run, such as when the output includes a timestamp.
View full article
Admin wants to set a specific time zone for all users or user is unable to set time zone manually.
View full article
This article outlines the general recommendations and checklists before an Alteryx Server Upgrade to help achieve a smoother upgrade
View full article
Application to be run prior to upgrading Server. Checks for common causes of upgrade failures.
View full article
Steps on how to find null users that will prevent the Server upgrade from completing correctly.
View full article
Steps on how to find null subscriptions that will prevent the Server upgrade from completing correctly.
View full article
Steps on how to identify and fix users with duplicate email addresses in MongoDB - Alteryx Server
View full article
Everything you need to get started with your own instance of Server!
View full article
This KB outlines how to enable MongoDB logs for troubleshooting purposes
View full article
The Composer File (pcxml)is a file type that contains a proprietary language used by Alteryx for reporting purposes. What this means for use in the Gallery is that an end user will have the ability to choose among XLSX, PDF, DOCX, ZIP and HTMLfile types for output.
View full article
When uploading a Workflow to the Gallery with Business Insights data, you will get an Error message saying that the "Datasets cannot be shared in public gallery". A Gallery Administrator can resolve this error by editing the Workflow Settings.
View full article
There are occasions where it is necessary to identify the ID of a Workflow or Schedule. These are easy to find in the URL.
View full article
How to determine which User deleted a Gallery application
View full article
Is it possible to query the data on the "View Schedules" tab of the scheduler?
View full article
Stop a Long Running App/Workflow on a Private Gallery
View full article
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:   Subscriptions 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.    Subscription Management Permission levels     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) Subscription Screen     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. Subscription Type 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.  Users 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 Users 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.   Workflows 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.   Districts 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.   Data Connections   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   Workflow Credentials 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")   Jobs 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.         Notifications 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   Best,   Jordan Barker Solutions Consultant
View full article
This is Part 4 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 2 Alteryx Gallery Series - The Lay of the Land 101: User Edition  Part 3 Alteryx Gallery Series: App Publishing & Version Control 101 - Alteryx Community    With the enormous potential of the Alteryx Gallery it is important to utilize all of its power into making better data driven decisions. But, what if you are unsure how to shape the Gallery for your particular use case? This article outlines a few of the potential ways you can do that.   Data Analyst This is a simple way of organizing the Gallery if you have a small groups of Alteryx Content creators who develop end solutions for Business Decision Makers in certain internal departments. You have a few Data Artisans who create, parametrize and upload the Applications (Gallery Admin will need to assign Data Artisan level permissions for these users) They all have private studios to develop in to push content up (Default) They have the ability to create Collections for end users and invite them to join (End users will need to have signed up to the Alteryx Gallery or be in the Domain where the Alteryx Gallery is hosted) The owner of the collection will then have to use the ‘users’ tab inside the collection to add the end user who will then be able to run the reports as a ‘Viewer’ of the Collection.   Departmental (Functional) You have a group of Alteryx creators who make custom applications for particular departments. You would like to share these applications across multiple users within that department. You have a few Data Artisans who create, parametrize and upload the Applications (Gallery Admin will need to assign Data Artisan level permissions for these users) The Gallery Admin has created a Studio (Subscription) for that particular department and given the Alteryx creators Artisan permissions to that studio. As Data Artisans can only belong to one studio at once, the application they build in the Alteryx Designer will now ‘land’ in that departments private studio. (Use this as a development platform). Once the application have been tested, the Gallery Admin can then assign the Data Artisans to a collection whereby they can upload the finished applications. The Gallery Admin can then add the end users to that collection to run the applications as “Viewers”   Departmental (Consumer) You have multiple different departments consuming these applications from one set of Alteryx creators. The end users just want to run the application without knowing any of the Alteryx behind the scenes logistics. As Data Artisans can only publish to one studio (subscription) at a time, it may be useful to have a cross-functional studio to house applications for different departments. The Gallery Admin know can just assign one subscription/studio key to each Data Artisan. The Data Artisan uploads to this one cross-functional studio Once the applications have been uploaded to the Studio they can then be published to the end users in the specific department collections. The users have already been invited to that collection by the Gallery Admin.   Hierarchy (Varied End Users) You have a range of end users requesting detailed reporting The Gallery Admin assigns a cross-functional studio for all Data Artisans. Analysts require a greater range of detail for their UI on their applications. Therefore, the Gallery Admin creates a collection for analysts and invites the Data Artisan to publish the more detailed applications here. Management require more cohesive and precise reporting so these application are hosted in a different collection for these users. All of the end users (analysts & management) are invited as viewers to just run the workflows.   Best,   Jordan Barker Solutions Consultant 
View full article
This is Part 3 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 2 Alteryx Gallery Series - The Lay of the Land 101: User Edition  Part 4 Alteryx Gallery Series: How to make the most of your Alteryx Gallery – Use Cases    The main draw of the Alteryx Gallery (other than scheduling) is the ability to create Analytic Applications!  Analytic Applications allow data analysts to parametrize Alteryx Designer workflows, so Business decision makers can interact with a user friendly interface and create custom reports faster on a daily, weekly or monthly basis.   Often these Applications need updating without interrupting end user interaction. Through the version control offered in the Alteryx Gallery, it makes it easier to track application development and prevent disruption for the end user. This article explains the conventions of uploading and apps and version control.   Before reading this article there a few pre-requisites to ensure you can publish apps: Your permission level is set as a Data Artisan in the Alteryx Gallery (You cannot publish up to the Alteryx Gallery without this permission level) The Analytic Application functions successfully from the designer   Publishing an Analytic App From the File Menu, go to Save As “My Company’s Gallery” You can then name the workflow and provide any comments or details specific to version being “saved” Once you click “Save”, Alteryx will publish the workflow and validate that it runs without errors in your gallery environment.   Upload to your Private Studio If you are a Data Artisan in the Alteryx Gallery you will have a Private Studio. If you have not already been added to another Studio, the Private Studio will be your default location when uploading an App from the Alteryx Designer. You can only belong to one Private Studio or Studio at a time.   You want to publish to a Studio (Subscription) The studio you belong to will populate in the ‘Location’ section when uploading to your company’s gallery. If this does not populate with the correct studio name you need to contact the creator of the studio or Gallery Admin. When you File>>Save As>>>Local Gallery from the Alteryx Designer you should see the studio (subscription) you are belong to.   You want to Publish to a Collection To publish to a collection you will need to have Data Artisan Permissions for the whole Gallery. If you are a Data Artisan in the Alteryx Gallery you will have your own private studio but you also have the ability to create collections. Other Artisans in your company’s Gallery can add you to collections they create. When you first upload your app to the Alteryx Gallery it will ‘land’ in your Private Studio (You only get a Private Studio if you are a Data Artisan). From your Private Studio you can click on your app and then there will be a ‘Sharing’ icon. You will then have the option to ‘Add to Collection’       This will then give you an option to select the collections you have access too or the option to create a new collection.     You want to publish to the Public Gallery If you choose to publish to the Public Part of your company’s gallery it will give access to everyone who can access your company’s gallery. Users often upload to the public gallery if they are testing proof of concepts or uploading demo version of Apps. To upload to the public gallery you can upload to your private studio and then choose to share the app in the public gallery.    I want to run this app with certain credentials  Within Alteryx Server 10.5+ there is the ability to manage certain 'Run As' credentials for certain Applications and Workflows ran on the Alteryx Server.  There are few different configurations you can select when setting up the Alteryx Gallery Speak to your Alteryx Server Gallery Admin if you are unsure which setting is available for you   What are the settings? These setting are found on the Gallery Admin page under 'System Settings'   Allow users to set options for credentials when saving a workflow 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).  'User must specify their own credentials' - When running the application from the Alteryx Gallery the users will have to enter in credentials    '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")   Always run workflows wither server or studio default credentials This will run any workflows with the default Alteryx Server user account (Predefined in the Alteryx Server System Settings) This could be a general account that allows all users to access the data they need to.  This is useful when testing out the Alteryx Server for scheduled workflows   Require users to enter their own credentials when running any workflows 'User must specify their own credentials' - When running the application from the Alteryx Gallery the users will have to enter in credentials        Version Control Workflows saved in the Alteryx Gallery can be shared with others who can then open them within the Alteryx Designer, make changes to them, and save them back to the Alteryx Gallery. When changes to a workflow are saved back to an Alteryx Gallery a new version of that workflow is created, and the previous version of the workflow is maintained.   IMPORTANT! To re-version an app you just need to hit the save icon in the Alteryx Designer once you have uploaded to the Alteryx Gallery for the first time. If you have already uploaded the app to the Alteryx Gallery and then go to File>>Save as>>>My Company’s Gallery, it will re-upload that same app twice. To see the version you can click on my company’s Gallery and it will populate with all the workflows, apps and macros. Within here you can click on the versions icon and it give you access to the various different versions for that workflow, app or macro.   Useful Links Are you are looking for more information on the Best practices for App Building? You may need to load the input files for your app if your Alteryx Server does not have access to these files. You can do this through adding files to the application you are uploading. What tools can be published within my app to the gallery I want to use the Gallery API to call on Apps, where can I find my API and Secret Keys   Best,   Jordan Barker Solutions Consultant     
View full article