Schedule Flow Tasks


Note: With the 2024.1 release (March 24’), changes were introduced for flow schedules. The Schedules tab on the left navigation pane has been removed and you can now create custom schedules directly from your flows Scheduled Tasks tab. You can create a personalized schedule and choose from hourly, daily, weekly, or monthly frequencies. This feature is automatically enabled on your Tableau Cloud site.

Flows can be scheduled to run on Tableau Cloud using Tableau Prep Conductor. Prep Conductor is licensed through Data Management on a per deployment basis. You don't need the Data Management license to publish flows to the web. As a Creator, you can also create and edit flows directly on your server. For more information about authoring flows on the web, see Tableau Prep on the Web.

You can run flows as a single task or link flow runs together to run flows one after the other. After you schedule your flow runs you can monitor and view the performance of your flows. See Monitor Flow Health and Performance.

Scheduling flows that include parameters

You can include user parameters in your flows to make flows more dynamic. When the flow runs, you’re prompted to enter your parameter values. When setting up flows on a schedule, you specify parameter values at that time.

You must specify the parameter values for any required parameters. For optional parameters, you can enter those values as well, or accept the current (default) value for the parameter. For more information about running flows with parameters, see Create and Use Parameters in Flows in the Tableau Prep help.

You can apply date or time system parameters to flow output names for file and published data source output types. When the flow is run manually or using a schedule, the start time is automatically added to the flow output name.

Note: Your administrator must enable the Flow Parameter server and site settings on your server before you can run flows that include parameters in Tableau Cloud. For more information, see Create and Interact with Flows on the Web.

Scheduling flows using REST API

Use the Flow Task REST API methods to run a flow on a schedule or to run linked tasks using the flow methods Query Linked Tasks, Query Single Linked Tasks, and Run Linked Task Now. For more information, see Flow Methods(Link opens in a new window) in the Tableau REST API help.

Schedule a flow task

  1. To create a schedule for a single task, do one of the following:
    • From the Overview page for the flow, click the Scheduled Tasks tab, click New Task or click the drop-down and select Single Task.

    • From the Explore page, in List view, in the Actions menu, select Schedule Flow > Single Task. If you select a flow in the list, you can also use the top Actions menu.

  2. On the Single Task tab of the New Task dialog, click Define a schedule.
  3. Enter the frequency of the task, then click Save.

    4. You can set the frequency to run hourly, daily, weekly or monthly. The time and day intervals depend on the repeat frequency that you select as described below:

    • Hourly: The available frequency is every hour from a specific time to a specific time. This means that the task will run every hour during the specified time.
    • Daily: The available frequencies are every two, four, six, eight, or twelve hours, or just once a day. You can also choose one or more days of the week, in addition to start and end times. This means you can run a task on all or certain days of the week at specific hourly intervals or once a day.
    • Weekly: The available frequency is one or more days of the week at a specific time. This means you can run the task on certain days of the week, once a week at a certain time.
    • Monthly: You can set this up in two different ways:
      • You can select Day as the frequency interval which then allows you to select specific dates of the month. For example you can select the task to run on the 2nd, 15th and 28th of every month at 2:45 pm.
      • You can also choose the first, second, third, fourth, fifth, and the last day of the week at a specific time. For example you can choose to run the task every second Wednesday of the month at 2:45 pm.
  4. Select one of the following options:
    • Automatically include all output steps for this flow:(default) Select this option to include all current and future output steps for this flow in the scheduled task. As new output steps are added to the flow over time, they’re automatically included in the schedule when it runs.
    • Select the output steps to include in this task: Select this option and manually select the output steps to include in this scheduled task.

      To include all output steps in the flow task, select the check box next to Output Steps. This area can't be edited if the Automatically include all output steps for this flow radio button is selected. Select the other radio button to enable this section.

  5. Select a Refresh Type. For more information about these settings, see Refresh Flow Data Using Incremental Refresh(Link opens in a new window).

    Note: If one input is configured to use incremental refresh and it’s associated with multiple outputs, those outputs must be run together and must use the same refresh type. Otherwise the flow fails.

    • Full refresh (default): Refresh all data and create or append data to your table based on the flow output setting.
    • Incremental refresh: Refresh only the new rows and create or append data to your table based on the flow output setting. The incremental refresh option is only available when the flow is configured to use this refresh type.

      Note: Tableau Prep Conductor runs a full refresh for all outputs regardless of the run option you select if no existing output is found. Subsequent flow runs will use the incremental refresh process and retrieve and process only your new rows unless incremental refresh configuration data is missing or the existing output is removed.

  6. (optional) If you’re the flow owner, select Send email when done to notify users when the flow is successful. For more information about how to send email notifications on flow runs, see Notify Users of Successful Flow Runs.
  7. If your flows include parameters, enter any required or optional parameter values. You must enter required values for the flow to run.

  8. Click Create Task to create the scheduled task.

Schedule linked tasks

Linked tasks functionality is enabled by default. Server and Site Administrators can turn off this functionality on the Settings page and on flow schedules in the Schedules dialog.

Use the Linked Tasks option to schedule up to 20 flows to run sequentially, one after the other. Easily set up your flow list by selecting your schedule, then select downstream flows to run in the order you choose.

The duration of each individual linked task is counted towards the total flow runtime limit. If the runtime limit is reached when a flow task is run, the flow task will timeout, the linked task fails, and any downstream flows won't run. For more information, see Job Runtime capacity(Link opens in a new window).

Select the outputs that you want to include in the flow run and configure the settings to tell Tableau what to do with remaining flows in the schedule when the previous flow run fails.

  1. To create a schedule for a linked task, do one of the following:
    • From the Overview page for the flow, Scheduled Tasks tab, click New Task and select the Linked Task tab, or click the drop-down and select Linked Task.

    • From the Explore page, in List view, in the Actions menu, select Schedule Flow > Linked Task. If you select multiple flows in the list, you can also use the top Actions menu.

      • If the output step isn't assigned to a task, you can also create a new task from the Overview page. On that page, in the Schedules field, click Create new task.

  2. On the Linked Task tab of the New Task dialog, click Define a schedule.
  3. Enter the frequency of the task, then click Save.
  4. Click the Select output steps drop-down to select the flow outputs to run. By default, all flow outputs are included. To select specific outputs, clear the Include all current and future output steps for this flow check box.

    The flow where the task is initiated is automatically set as the first flow to run, but you can use the menu to change the run order after you add other flows to your list.

  5. Select your refresh type from the following options:

    Note: If one input is configured to use incremental refresh and it’s associated with multiple outputs, those outputs must be run together and must use the same refresh type. Otherwise the flow fails.

    • Full refresh (default): Refresh all data and create or append data to your table based on the flow output setting.
    • Incremental refresh: Refresh only the new rows and create or append data to your table based on the flow output setting. The incremental refresh option is only available when the flow is configured to use this refresh type. For more information, see Refresh Flow Data Using Incremental Refresh(Link opens in a new window).

      Note: If no existing output is found, Tableau Prep Conductor runs a full refresh for all outputs regardless of the run option you select. Subsequent flow runs use the incremental refresh process and retrieve and process only your new rows unless incremental refresh configuration data is missing or the existing output is removed.

  6. (optional) If you’re the flow owner, select Send email when done to notify users when the flow is successful. For more information about how to send email notifications on flow runs, see Notify Users of Successful Flow Runs.
  7. Set your flow failure options:
    • Add data quality warning: Select the check box to set a warning message on the flow so that users of the data are aware of issues. The message remains until the flow runs successfully. If the flow already has a data quality warning, this option shows selected and can't be turned off.

    • Stop remaining tasks: Select this option to prevent the downstream tasks in the list from being queued to run.
    • Email me: Email notifications are automatically sent to the flow owner and the linked task creator when the flow fails, is suspended, or is canceled.
  8. If your flows include parameters, enter any required or optional parameter values. You must enter required values for the flow to run.

  9. Click the drop-down for the second task to add your next flow. Flows that use the previous flow's outputs are shown automatically or click View all flows to see all available flows
  10. Select one or more flows and click Add or click Add Next Task to add more flow run tasks to your list.

    If you don't have permission to run the flow, you must contact the flow owner to grant permissions before adding the flow to your list.

  11. Repeat steps 4–6 to configure your flow run options.
  12. (Optional) Click the drop-down next to any numbered task to open the menu to change the order of your flow tasks or insert new tasks between existing tasks.

  13. Click Create Tasks to create the scheduled linked tasks.

Who can do this

  • The Server administrator can do this on all sites on the server. The Site administrator can do this on sites they have access to if the site settings to allow users to publish and schedule tasks is enabled.
  • For linked tasks, the Server administrator can do this on all sites where the server settings to allow users to schedule linked tasks is enabled. The Site administrator can do this on sites they have access to if the site settings to allow users to schedule linked tasks is enabled.
  • Flow owners and project leaders can create flow tasks for flows or projects that they own respectively.
Back to top
Thanks for your feedback!Your feedback has been successfully submitted. Thank you!