Workflows: Admin Interface

Workflow creators can publish Designer workflows to the Gallery to share with other users. This article covers the options available to Curators (Gallery Admins) on the Workflows page of the Gallery Admin interface. To learn more about workflows for users within the Gallery, see the Workflows: User Interface article.

On the Workflows page of the Gallery Admin interface, you can add workflows to the Gallery and manage their settings. You can also add apps and macros to the Gallery via the Workflows page; however, you can only run workflows and apps in the Gallery. Curators can also create and apply tags to workflows to improve search results and group similar workflows into districts. See Districts.

To manage workflows, select Workflows on the Admin toolbar.

Add a Workflow

1. Begin by saving your workflows as an Alteryx workflow package (.yxzp) file to upload to the Gallery.
2. On the Workflows page, select Add New Workflow.
3. Select the workflow on your computer or a shared location.

The workflow will display in your list on the Workflow page. Apps and macros can also be upload via these steps.

Add a Tag

Assign tags to workflows to assist with workflow organization. Only Curators (Gallery Admins) can assign tags flagged as Admin Only to workflows.

1. On the Workflows page, scroll to the Tags section.
2. Enter a tag in the Tag field and click Add New.
3. Select Admin Only to make the tag only available to Curators (Gallery Admins) to assign to workflows.

Edit Workflow Options

On the Workflows page, select a workflow. Make changes to the following workflow settings. Select Save when you finish making changes. 

• Tags: To add a new tag, select Add Tags and select the tags you wish to apply. To remove an icon, select the X icon on the tag you wish to remove. 
• Icon: To change the workflow icon, select Change Icon and browse for a new icon.
• Description: Enter the workflow description in the Description field. 
• Run Mode: Use Run Mode to block specific tools or access. The Server admin selects the Default Run Mode during server configuration. See Gallery. To change the Run Mode for the workflow, select a setting from the drop-down. 
  • Unrestricted: Gallery users can run the workflow regardless of tools or access. 
  • Semi-safe: Blocks Gallery users from running the workflow if it reads data from or writes data to a location that is not within the directory or sub-directory of the workflow staging directory (workspace).
  • Safe: Blocks Gallery users from running the workflow if it reads data from or writes data to a location that is not within the workflow staging directory (workspace). Gallery users are also blocked from running the workflow if it uses specific tools, events, and data connectors. See 

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

    Semi-safe and Safe are only available if the Server admin has enabled the Run As setting in System Settings on the Worker > Run As screen or if a Run As user is specified. See Worker and Credentials for more information.

• Worker Assignment: To change the worker that runs the workflow, select a worker from the drop-down. If a worker is not assigned, the worker assigned to the studio will run the workflow. 
• Requires Private Data Setting: Indicates the workflow requires licensed data to run. Select Yes, if the workflow requires licensed data, or No if the workflow does not require licensed data.
• Private Data Exemption Setting: Give an exemption to allow a workflow with private data to run. Select Yes, to allow an exemption or No to deny an exemption.
• Place in My Company's Gallery: Select Yes, to share the workflow in your company's Gallery, or No, to remove the workflow from your company's Gallery. Removing the workflow from your company's Gallery does not remove the workflow from the user's studio.
• Ready for Migration Setting: This option is only available when the Enable workflows to be marked as ready for migration to separate environment option is enabled in Gallery Admin > Workflows. Select Yes to mark workflows and apps for migration. You can then use an API endpoint to move workflows from one environment into the appropriate subscription (studio) of another environment. See Workflow Migration. 

Enable Users to Run Workflows

By default, only users signed in to the Gallery can run workflows. To change this setting, select Yes for Enable unregistered users to run Public Gallery workflows.

Workflow Migration

You can manage workflow deployments during development and testing phases by migrating workflows from one Alteryx Server environment to another using a series of endpoints.

Once you mark workflows for migration, you can then use a series of API endpoints to publish them from the source environment into the appropriate subscription (studio) of the target environment.

Enable Workflows for Migration

Mark workflows for migration in two places.

1. Enable migration for all workflows: 
   • On the Workflows page of the Gallery Admin interface, select Yes for Enable workflows to be marked as ready for migration to a separate environment.
     
2. Mark a specific workflow for migration:
   • On the Workflows page of the Gallery Admin interface, select a workflow, and select Yes for This workflow is ready to be migrated.
     

Migrate Workflows

Step 1. Get a List of Workflows Ready to Migrate

Next, get a list of workflows ready to migrate using the following endpoint:

• Environment: Source
• Method: GET
• Endpoint: api/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/

Include a comma-separated list of subscriptionIds as a query parameter. Subscription IDs identify a specific studio.

The return is an array of workflows marked as ready to migrate under the specified subscription (studio). If no subscriptionsIds are provided then all workflows marked as ready to migrate are returned. The return includes three properties: appId, the currently published revision ID, and the subscriptionID the workflow belongs to.

Step 2. Download Workflow/s from the Source Environment

The following endpoint downloads the workflow as a .yxzp file.

• Environment: Source
• Method: GET
• Endpoint: api/admin/v1/{appID}/package/

Include an appID as a path parameter. The return will be a download of the entire workflow as a package.

Step 3. Publish Workflow/s in the Target Environment

The following endpoint publishes the downloaded workflow to the target environment.

• Environment: Target
• Method: POST
• Endpoint: api/admin/v1/workflows/

Arguments

Argument	Description	Type	Required
file	The filename of the new workflow.	String	True
name	The new workflow name.	String	True
owner	The owner of the newly migrated workflow. The email address must exist in the target environment.	String	True
validate	Flag to validate the workflow upon migrating to the target environment.	Boolean	True
isPublic	Flag to set workflow to public to show in “My Company’s Gallery” in the target environment.	Boolean	True
SourceId	This is the Source environment appId of the workflow to be migrated. If a workflow with the same sourceId already exists, this will replace that workflow in the target environment. Otherwise, a new workflow will be generated. (Send empty string ""  if you do not wish to specify an appID)	String	True
workerTag	Add a worker tag to the workflow to have a specific worker to run the workflow.  (Send empty string ""  if you do not wish to specify worker.)	String	True
canDownload	Flag to set the workflow as available for download by other users in the target environment.	Boolean	True

(Optional) Step 4. Reset Migration Setting Workflow/s in the Source Environment

If you wish, the following endpoint toggles the This workflow is ready to be migrated setting on a specific workflow to No in the source environment after workflow migration in the target environment.

• Environment: Source
• Method: PUT
• Endpoint: api/admin/v1/workflows/migratable/{appID}/