◄Show Table of Contents

Schedule Workflows

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

To schedule a workflow, open the workflow you want to schedule and click on the toolbar, or Options > Schedule Workflow.

To schedule an app or workflow package, go to the View Schedules window. See Manage Schedules.

ClosedSchedule to a Gallery

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

If you have connected to your company's Gallery in Alteryx Designer, the Gallery will appear in the list. If you need to schedule to another Gallery, you can add a new Gallery. Workflows can only be scheduled to run in a Gallery in which scheduling is enabled. Contact your Gallery Administrator to enable scheduling in a Gallery.

ClosedPrecautions
  • 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, click and select an option in the Set Schedule Location window:
    • Existing Gallery: a Gallery to which you previously connected
    • Add Gallery: connect to a Gallery that is not in the list
      ClosedAdd 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.
      ClosedSave workflow to Gallery

      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. Log in with your user name and password. (Optional) Select Keep me logged in keep your session active.
      2. In the Save Workflow window, type a name in Workflow Name.
      3. Location displays the Gallery studio to which the workflow will be saved.
      4. (Optional) In Details, type comments.
      5. (Optional) Click Workflow Options and select an option:
        ClosedPublish 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.

        ClosedValidate 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.

        ClosedManage 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.

        ClosedEnable 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.
        ClosedSet 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.

      6. Click Save.
  2. (Optional) In Create Schedule, type a name for the schedule in Schedule Name.
  3. Select schedule occurrence: Once, Recurring, or Custom.
    ClosedOptions
    • Once: Run the workflow once at the time which you began scheduling the workflow, or select a date and time.
    • Recurring: Select a daily, weekly, monthly, or quarterly re-occurrence.
    • 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 an occurrence.

    Scheduled workflows will 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. (Optional) Type comments in Comments.
  6. (Optional) If the workflow must be run as a specific user to access data, click Edit Credentials.
    1. In Schedule as, type or select workflow credentials from the drop-down.
    2. Type the password in the box, if necessary.
  7. Click Done.

Scheduled workflows display on the Schedules page.

ClosedSchedule to a controller

Scheduling to a controller is only available if you have Alteryx Server. This option schedules a workflow to run on a controller. It is recommended that you schedule workflows to run in your Gallery if you have Alteryx Server. See Schedule to Gallery.

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.

ClosedPrecautions
  • 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 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 to a controller:

  1. With the saved workflow open, click and select an option:

    • Existing controller: connect to a controller you connected to before
    • Add Controller: connect to a new controller
      ClosedAdd a controller
      1. In Machine Name, type the server name.
      2. In Controller Token, type the controller token provided by the Alteryx Server Administrator at your company.
      3. Click OK.

  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 schedule frequency.
  4. Complete the schedule date and time details.

    Scheduled workflows will 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. Click OK.
ClosedSchedule to my computer

Scheduling to My Computer is the only option available to users of Alteryx 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.

To schedule a workflow to run on your computer:

  1. With the saved workflow open, click and click My Computer.
  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.

      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.

      Alteryx recommends 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\.

    • 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.
  4. Complete the schedule date and time details.

    Scheduled workflows will 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. Click OK.

Schedules can be viewed in the View Schedules window. See Manage Schedules.

 

Alteryx.com | Community | Customer Support | Documentation Feedback

©2018 Alteryx, Inc., all rights reserved. Allocate®, Alteryx®, Guzzler®, and Solocast® are registered trademarks of Alteryx, Inc.