Workflow Management

With the workflow open, follow these steps:

1. Click File > Save As.
2. Select the location where you want to save the workflow:
   File directory

   1. Click Browse.
   2. In Windows Explorer, go to the location where you want to save the workflow.
   3. Type the file name in File Name.
   4. Click Save.
   Alteryx Gallery or a private Gallery

   To save a workflow to the Alteryx Gallery, you must have a user account. The Alteryx Gallery URL is: https://gallery.alteryx.com. Go there to sign-up for an account.

   To save a workflow to your company's private Gallery, you must have a user account.

   1. Click Alteryx Gallery or private Gallery.
   2. Log in with your user name and password. (Optional) Select Keep me logged in keep your session active.
   3. In the Save Workflow window, type a name in Workflow Name.
   4. Location displays the Gallery studio to which the workflow will be saved.
   5. (Optional) In Details, type comments.
   6. (Optional) Click Workflow Options and select an option:
      Publish this version of the workflow

      Select to publish this version of the workflow as the version that is available to other users in the Gallery. This option is only available if the workflow has been to the Gallery before. Do not select this option if you do not want other users to use this version of the workflow.

      To update the workflow version in the Gallery, view app details and click Version # to view available versions. Select a version and click Make Published Version.

      Validate workflow then save

      By default, the option is selected. It validates the workflow to check if there are any tools or command are prohibited in the Gallery. If validation fails, the workflow requires an exemption to run in the Gallery.

      These tools require exemptions to be run in a Gallery: R Tool, Run Command Tool, Email Tool, and Download Tool.

      Also, a Gallery will not allow event or chained app execution. See Workflow Configuration and Interface Designer Window.

      See Save to Gallery Messages, for more on applying for an exemption.

      Manage workflow assets

      Click to view and manage the assets associated with the workflow.

      Group assets by tool: When the option is selected, all of the assets, or file dependencies for the workflow display. Select the option to display all of the assets grouped together with the tool they are connected to. Deselect an asset to omit it from the workflow package. Assets that include a constant in the input path display in the list of assets, but are not included in the workflow package.

      Enable workflow encryption

      Click to view encryption options for the workflow.

      • Restrict use to specific serial numbers: When selected, only the serial numbers in the list will be able to use the encrypted workflow. Each unique serial number should appear on its own line.
      • Set expiration for encrypted workflow: When selected, the encrypted workflow will expire on the selected date so that the workflow can no longer be run or used.

      See Workflow Encryption, for more details on encryption.

      Set workflow credentials

      Click this link to select the credentials for running the workflow.

      • User is not required to specify credentials: Run the workflow using the default server or studio credentials.
      • User must specify their own credentials: Prompt a user to enter their own credentials to run the workflow.
      • Always run this workflow with these credentials: Enter credentials to always use when the workflow is run.

   7. Click Save.

   See Save to Gallery Messages, for more on errors and warnings you may receive when trying to save a workflow to a Gallery.

   Add a Gallery

   1. Click Add Gallery.
   2. In URL, type the URL path to your company's Gallery.
   3. Click Connect.
   4. Based on the Gallery configuration, authentication steps vary:
      • Built-in authentication: Type your Gallery email and password in Email and Password. Select Keep me logged in, if desired. Then, click Connect.
      • Windows authentication: A user name displays. Click Continue to log in.
   5. Click the Gallery in the list and follow the steps to save the workflow to the Alteryx Gallery or a private Gallery.

Export a workflow if you want to save and share it with all of its dependencies. A workflow must be saved before it can be exported. Workflows are exported as a .yxzp package file.

Dependency file packaging

These assets are automatically included when a workflow is packaged:

• Input files
• Output references
• Macros
• Chained apps
• User-added files

By default, most files are included, except:

• Missing files
• Files identified as being part of the Alteryx installation
• Files referenced by a network path
• Input paths that contain a constant

The original file format of each file will be maintained. The folder structure of the assets included in the workflow will also be maintained as long as the files included are children of, or sibling to, the workflow file. Any other files are considered external and, if included with the package, will be placed in an "_externals" folder.

Use the Workflow Dependencies Window, to ensure that no paths will be broken when referencing missing files.

To export a workflow:

1. Click Options > Export Workflow.
2. In the Export Workflow window, Workflow displays the name of workflow and its file extension.

   Complete any of the available configuration options:

   • Encrypt: Click to create a copy of the workflow, app, or macro, that can be run, but not opened and edited in Designer. Encryption cannot be undone.
     • Enable encryption for this workflow: Select to enable encryption and enable more options.
       • Restrict use to specific serial numbers (one per line): (Optional) Type or paste the serial numbers of the licenses you want to be able to use the encrypted workflow. Each must be listed on a separate line.

         A serial number is used for each Alteryx install. To view your serial number go to Options > Manage Licensesand see Machine Serial Number.

       • Set expiration for encrypted workflow: (Optional) Select the date on which the workflow should expire. After a workflow expires, it can no longer be used.
   • Package Location: Click Browse to change the location where the file is saved.
   • Group assets by tool: Select to group the assets in the workflow by the tools in which they are used. If this option is not selected, assets are listed individually. Deselect an asset to exclude it from the workflow package. The asset will be referenced, but not included in the package.

     Assets that include a constant as part of an input path will display in the list of assets, but will not be packaged as part of the workflow.

3. Click Save.

See Workflow Encryption, for more information on encryption.

Open workflows from a file directory, the Alteryx Gallery, or from your company's private Gallery.

Click File > Open Workflow and select an option:

File directory

To open a saved workflow:

1. Click Browse.
2. In Windows Explorer, go to the location where the workflow is saved.
3. Double-click the file name to open it in Designer.

Additional steps are required if the workflow is an exported (.yxzp) file.

1. The Package Import message appears. Click Yes to import the workflow.
2. The Import Workflow Package window displays information and options:
   • Package File Name: Displays the complete path to the file.
   • Workflow: Displays the workflow name. The assets in the package display in the box.
   • Destination Directory: Displays the location where the package will be saved. To change the location, click and select a new location.
3. Click Import.
4. In the Workflow Import Progress window, click Yes to load the workflow. If the workflow failed to load properly try importing it again.

Alteryx Gallery or a private Gallery

To open a workflow saved to the Alteryx Gallery, you must have a user account. The Alteryx Gallery URL is: https://gallery.alteryx.com. Go there to sign-up for an account.

To open a workflow saved to your company's private Gallery, you must have a user account.

1. Click Alteryx Gallery or private Gallery.
2. Log in with your user name and password. (Optional) Select Keep me logged in keep your session active.
3. In the Gallery window, locate the workflow using Search, filters, and sorts.
4. (Optional) Click the Versions icon to the right of a workflow view previous versions. This option must be enabled in Gallery to be visible in Designer.
5. Click the workflow and click Open.

See Save to Gallery Messages, for more on errors and warnings you may receive when trying to save a workflow to a Gallery.

Add a Gallery

1. Click Add Gallery.
2. In URL, type the URL path to your company's Gallery.
3. Click Connect.
4. Based on the Gallery configuration, authentication steps vary:
   • Built-in authentication: Type your Gallery email and password in Email and Password. Select Keep me logged in, if desired. Then, click Connect.
   • Windows authentication: A user name displays. Click Continue to log in.
5. Click the Gallery in the list and follow the steps to open a workflow saved to the Alteryx Gallery or a private Gallery.