Gallery

Version:
Current
Last modified: November 19, 2020

The Gallery is a cloud-based application for publishing, sharing, and executing workflows. It communicates with the service to manage and execute workflows. Gallery uses a MongoDB persistence layer for state maintenance. This allows you to deploy the Gallery across multiple servers behind a load balancer (not provided as part of the architecture) to support horizontal scalability.

The Gallery is a private website, hosted on your server infrastructure that allows internal users to share workflows, apps, and macros. Alteryx also offers a Public Gallery (https://gallery.alteryx.com/) where users can sign up and share workflows, apps, and macros.

Configure the Gallery component on the Gallery screens in System Settings. The Gallery screens are available for configuration if you've selected 1 of these options on the Environment > Setup Type screen: 

  • Complete Alteryx Server
  • Custom > Enable Gallery

Gallery General

The Gallery General screen has configuration options, such as where you want to store temporary files and log files.

Gallery Workspace

The Gallery Workspace is the location where the Gallery stores temporary files. By default, it is a folder within the global workspace folder. This path should point to a location that is safe to store large amounts of files.

  • Logging Directory: This is the location where you want to store Gallery log messages. Visit Configure and Use Server Logs for more info. 
  • Base Address: This is the URL that users use to go to the Gallery. 
    • We recommend a base address that contains either
      • The Server machine IP address (for example, http://[IP_Address]/gallery/).
        OR
      • A resolvable host name supported by internal DNS services (for example, http://[Host_Name]/gallery/).
    • Note, if you leave the default (http://localhost/gallery/), notification emails sent to Gallery users won't resolve properly.
  • Enable SSL: Enabling SSL changes the URL in the Base Address field to https. If your certificate is set to a port other than the default 443, include the port in the URL (for example, https://localhost:445/gallery/). See Enable Gallery SSL.
  • Default Run Mode: Run Mode determines the workflows that Gallery users can run. Use Default Run Mode to block workflows with specific tools or directory access from running in the Gallery.

    Semi-safe and Safe are only available if you have enabled the Run As setting in System Settings on the Worker > Run As screen or if you have specified Run As. See Worker and Credentials for more information.

    If your Default Run Mode is Safe or Semi-safe, Gallery admins can change the run mode in each workflow on the Workflows page in the Gallery Admin interface. See Workflows.

    • Unrestricted: Gallery users can run any workflow.
    • Semi-safe: Block Gallery users from running workflows that read data from or write data to a location that isn't within the workflow staging directory (workspace).
    • Safe: Block Gallery users from running workflows that read data from or write data to a location that isn't within the workflow staging directory (workspace). Gallery users are also blocked from running workflows that use specific tools, events, and data connectors. Visit 

      Safe and Semi-safe Run Modes: Blocked Tools, Events, and Data Connectors for more info.

Gallery Authentication

The Gallery Authentication screen has configuration options for the type of authentication you want to use to access the Gallery. Server supports built-in authentication, integrated Windows authentication with or without Kerberos support, and SAML authentication. Visit Set Up Gallery Authentication for detailed steps for setting up your Gallery's authentication.

Gallery SMTP Configuration

The SMTP screen has configuration options for enabling SMTP. The information on the SMTP page is required for Server to send email notifications for various events, such as registering your Gallery account, changing your password, or sharing a workflow. Visit Configure SMTP for steps to set up SMTP.

Gallery Persistence

On the Gallery Persistence screen, specify where you want to store Gallery information, like users, collections, etc.

By default, both Web Persistence and Search Persistence are set to use the same settings as those specified for the controller on the Controller > Persistence screen. See Controller.

Use Advanced Connections

Select Use Advanced Connections if you don't want to use the same location as specified for the controller or if you require support for these.

  • TLS/SSL
  • Replica Sets
  • Sharding
  • MongoDB Atlas

If you were using replica sets before the availability of the connection string option (2020.1 release), you have to change to a connection string.

When you select. Use Advanced Connections, the Web Persistence and Search Persistence sections display a Connection field for you to specify your MongoDB connection string. Visit the Advanced Connection String help page for tips and examples on specifying connection strings. 

Screenshot of gallery persistence settings with Used Advanced Connections option selected

Web Persistence

Select Use Controller Persistence Settings to use the same location as specified for the controller on the Controller > Persistence screen. This is the default option for Gallery web persistence. See Controller.

If you want the Gallery to use a different MongoDB connection than the controller, chose 1 of these:

  • Select Use Advanced Connections and specify a Connection. Visit the Advanced Connection String help page for tips and examples on specifying connection strings. 

OR

  • Uncheck Use Controller Persistence Settings and specify the Host, Database nameUsername, and Password.

Search Persistence

Indices for search functionality within the Gallery are also stored in the MongoDB.

Select Same settings as Web Persistence to use the same location as specified for web persistence. This is the default option for Gallery search persistence.

If you want the search indices to use a different MongoDB connection than web persistence, chose 1 of these:

  • Select Use Advanced Connections and specify a Connection. Visit the Advanced Connection String help page for tips and examples on specifying connection strings. 

OR

  • Uncheck Same settings as Web Persistence and specify the Host, Database Name, Username, and Password.

What's Next?

Configure Engine.

Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.