Schedule Workflows

Version:
Current
Last modified: June 17, 2020

Schedule workflows, apps, or packages to run automatically at a selected frequency, date, and time. Depending on your company's configuration, you can schedule workflows to run in different locations:

  • Alteryx Server: Schedule to your company's Private Gallery, or to a controller.
  • Designer plus Desktop Automation (Scheduler): Schedule to your computer.

To schedule a workflow, open the workflow you want to schedule and select the Add Workflow to Schedule icon at the top of the canvas, or go to Options > Schedule Workflow. To schedule an app or workflow package, go Options > View Schedules. See Manage Schedules.

Schedule to Gallery

The option to schedule to a Gallery is only available if you have Alteryx Server. This option schedules a workflow to run in your company's Private Gallery.

If you have connected to your company's Gallery in Designer, the Gallery appears in the list on the Set Schedule Location window. If you need to schedule to another Gallery, you can add a new Gallery. You can only schedule workflows to run in a Gallery where scheduling is enabled. Contact your Gallery Administrator to enable scheduling in a Gallery.

  • A copy of the workflow must be saved to the Gallery where you want the schedule to run.
  • A URL or file path location used in a tool must be accessible outside of your Windows account. For example, WebDAV paths are not supported.

To schedule to a Gallery...

1. With the workflow open, select the Add Workflow to Schedule icon and select an option in the Set Schedule Location window:

  • Existing Gallery: A Gallery to which you've previously connected.
  • Add Gallery: Connect to a Gallery that is not in the list.

Add a Gallery

  1. Select Add Gallery.
  2. In URL, enter the URL path to your company's Gallery.
  3. Select Connect.
  4. Based on the Gallery configuration, authentication steps vary:
    • Built-in authentication: Enter your Gallery email and password in Email and Password. Select Keep me logged in, if desired, then select Connect.
    • Windows authentication: A user name displays. Select Continue to sign in.
  5. Select the Gallery in the list. If the workflow is not saved to the selected Gallery, you are prompted to save it to the Gallery. After the workflow is saved, the Gallery opens to Create Schedule. If the workflow is saved to the Gallery, the Gallery opens to Create Schedule.

    To save a workflow to a Gallery...
    1. Sign in with your user name and password. (Optional) Select Keep me logged in to keep your session active.
    2. In the Save Workflow window, enter a name in Workflow Name.
    3. Location displays the Gallery studio to which the workflow will be saved.
    4. (Optional) In Details, enter comments.
    5. (Optional) Select 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 select Version # to view available versions. Select a version and select 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 commands that are prohibited in the Alteryx Public Gallery (gallery.alteryx.com). If validation fails, the workflow requires an exemption to run in the Alteryx Public Gallery (gallery.alteryx.com). These tools require exemptions to be run in a Gallery: R toolRun Command toolPython toolEmail tool, and Download tool. Also, a Gallery does not allow event or chained app execution. See Workflow Configuration and Interface Designer Window. See Save to Gallery Messages for additional information about applying for an exemption.

        AMP Engine

        If your workflow is using the e2/AMP engine but your controller is not, workflow validation is disabled and cannot be enabled. To enable workflow validation, enable the e2 engine on the controller or change your workflow to run on the original engine via Workflow Configuration.

        To learn more about the AMP engine, visit these resources:

      • Manage workflow assets: Select 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. Uncheck 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.

        This setting organizes the assets for each tool so that information is easier to parse visually—it does not change how the .yxzp file is created.
         
      • Enable workflow encryption: Select 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.
      • Set workflow credentials: In order for this option to be available, a Curator (Gallery Admin) must select the Allow users to select credentials option setting in Gallery via Admin > Credentials > Change. Once enabled, users can 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.
    6. Select Save.

2. The Schedule page for your workflow opens in your Private Gallery. Enter a name for the schedule in Schedule Name (optional).

3. Select schedule frequency:

  • Once: Run the workflow once at the time which you began scheduling the workflow, or select a date and time.
  • Recurring: Select an hourly, daily, weekly, or monthly frequency.
  • Custom: Select a custom schedule option (for example, schedule a workflow to run by a fiscal calendar).

4. Complete the scheduling details that appear after you select a frequency.

Scheduled Workflows and Timezones

Scheduled workflows run at the scheduled time in the time zones in which the server is located. Workflows scheduled to run at 1:30 am or 2:30 am may run multiple times and at a time later than you selected due to daylight saving time.

5. Enter comments in Comments (optional).

6. If you must run the workflow as a specific user to access data, select Edit Credentials. In Schedule as, enter or select workflow credentials from the dropdown, then enter the password in the box, if needed.

7. Select Save.

Scheduled workflows display on the Schedules page.

Schedule to Controller

The option to schedule to a controller is only available if you have Alteryx Server. This option schedules a workflow to run on a controller. We recommend that you schedule workflows to run in your Gallery if you have Alteryx Server.

A controller is a machine that runs and manages schedules for your organization. An Alteryx Server Administrator at your company sets up the controller and gives you the token needed to connect to the controller.

  • The workflow, app, or package must be saved to a location that can be accessed by the controller.
  • All file inputs, outputs, and other workflow dependencies must be saved to a location that can be accessed by the controller.
  • A URL or file path location used in a tool must be accessible outside of your Windows account. For example, WebDAV paths are not supported.
  • If a workflow, app, or package includes database connections or In-DB tools, set the password encryption type to Hide. Machine and user-based encryption options cause the workflow to fail when it is run on any computer other than one on which it was created. See Password Encryption.
  • The computers you use to create, schedule, and run the scheduled workflow, app, or package must use the same version of Alteryx.

To schedule a controller...

  1. With the saved workflow open, select the Add Workflow to Schedule icon and select an option:
    • Existing Controller: Connect to a controller you connected to before.
    • Add Controller: Connect to a new controller. To add a controller...
      • In Machine Name, enter the server name.
      • In Controller Token, enter the controller token provided by the Alteryx Server Administrator at your company.
      • Select OK.

      AMP Engine

      If your workflow uses the AMP engine but your controller does not, this error message displays:

      The selected controller is not enabled to run AMP Engine workflows. Enable your controller for the AMP Engine or change your workflow to run without it.

      To enable your controller for the AMP engine, see System Settings: Controller. To change your workflow to run on the original engine, see Workflow Configuration.

      To learn more about the AMP engine, visit these resources:

  2. Select a run option: 
    • Run a copy of the workflow stored in the Scheduler DB: Creates a copy of the workflow and saves it to the Scheduler database where it is run. The Scheduler database is a shared location. The only way to edit the copy in the database is to save a revised version of the workflow to the database. If your workflow includes data files, output locations, or other workflow dependencies, save the workflow as a package (.yxzp file) and schedule from the View Schedules window. See Manage Schedules.
    • Run the workflow from its original location on disk: Saves the workflow and schedules it to your computer. You can edit the workflow without needing to update the schedule, but removing, moving, or renaming the workflow will cause the schedule to fail.
  3. Select a schedule Frequency.
  4. Complete the schedule date and time details. Scheduled workflows run at the scheduled time in the time zones in which the server is located. Workflows scheduled to run at 1:30 am or 2:30 am may run multiple times and at a time later than you selected due to daylight saving time.
  5. Select OK.

Schedule to My Computer

The option to schedule to My Computer is the only option available to users of Designer plus Desktop Automation (Scheduler). This option is not recommended if you use Alteryx Server.

Scheduling to My Computer schedules the workflow to run on your computer. The workflow that you schedule can be saved on your computer, or you can save a copy of the workflow to the Scheduler DB.

When you schedule a workflow to your computer, the computer must be awake in order for the job to run. The job will not run if your computer is in sleep mode or shut down.

To schedule a workflow to run on your computer...

  1. With the saved workflow open, select the Add Workflow to Schedule icon and select My Computer.

    AMP Engine

    If your workflow uses the AMP engine but your controller does not, this error message displays:

    The selected controller is not enabled to run AMP Engine workflows. Enable your controller for the AMP Engine or change your workflow to run without it.

    To enable your controller for the AMP engine, see System Settings: Controller. To change your workflow to run on the original engine, see Workflow Configuration.

    To learn more about the AMP engine, visit these resources:

  2. In the Schedule Workflow window, select a run option:
    • Run a copy of the workflow stored in the Scheduler DB: Creates a copy of the workflow and saves it to the Scheduler database where it is run. The Scheduler database is a shared location. The only way to edit the copy in the database is to save a revised version of the workflow to the database. It is recommended that you back up Scheduler (SQLite) database. To back up SQLite, you can zip up or copy the Persistence folder found in \ProgramData\Alteryx\Service\. If your workflow includes data files, output locations, or other workflow dependencies, save the workflow as a package (.yxzp file) and schedule from the View Schedules window. See Manage Schedules.
    • Run the workflow from its original location on disk: Saves the workflow and schedules it to your computer. You can edit the workflow without needing to update the schedule, but removing, moving, or renaming the workflow will cause the schedule to fail.
  3. Select schedule Frequency:
    • Once
    • Minutes / Hours
    • Days / Weeks
    • Months
    • Custom
  4. Complete the schedule date and time details.

    Scheduled Workflows and Timezones

    Scheduled workflows run at the scheduled time in the time zones in which the server is located. Workflows scheduled to run at 1:30 am or 2:30 am may run multiple times and at a time later than you selected due to daylight savings time.

  5. Select OK.

You can view schedules in the View Schedules window. See Manage Schedules.

Was This Helpful?

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