Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: All examples are invalid syntax

The following is an example of the syntax you add to your workflow definition to run the workflow everyday at 12AM.Treasure Data supports these flexible scheduling options:

  • daily
  • weekly
  • monthly
  • start date
  • end date

Info
When you add a schedule to your workflow, if you attempt to select New Run to run the workflow immediately, you

...

will likely

...

get an error. The workflow must run at the specified scheduled time.

Set a Daily Schedule

Info

If a daily workflow schedule does not progress as expected, it might be due to one of two things:

  1. You didn't set a timezone, and therefore the default timezone of UTC is changing the daily schedule.
  2. An existing daily session has already started, and therefore, your daily schedule will run the next day. Learn more at TD Workflow FAQs.


In the following example, the workflow runs every day.

Numbered Headings
start-numbering-with1
start-numbering-ath5
Open TD Console
Navigate to Data Workbench > Workflows.

...

  1. Add the following code to the workflow definition:

Code Block
linenumberstrue
timezone: America/Chicagoschedule: daily>: 00:00:00

...

Open an existing workflow or create a new one.
Select Launch Project Editor.

Code Block
firstline1
linenumberstrue
_export:
  td:
    database: workflow_time

timezone: America/Chicago

schedule:
  daily>: 07:00:00


Set a Weekly Schedule

In the following example, the workflow runs every Sunday at 09:00.

Numbered Headings
start-numbering-with1
start-numbering-ath5
Open TD Console
Navigate to Data Workbench > Workflows.
Open an existing workflow or create a new one.
Select Launch Project Editor.

Code Block
firstline1
linenumberstrue
_export:
  td:
    database: workflow_time

timezone: America/Chicago

schedule:
  weekly>: Sun,09:00:00


Set a Monthly Schedule

In the following example, the workflow runs on the 1st day of every month at 10:00.

Numbered Headings
start-numbering-with1
start-numbering-ath5
Open TD Console
Navigate to Data Workbench > Workflows.
Open an existing workflow or create a new one.
Select Launch Project Editor.

Code Block
firstline1
linenumberstrue
_export:
  td:
    database: workflow_time

timezone: America/Chicago

schedule:
  monthly>: 1,10:00:00


Set a Start Date

In the following example, the workflow run starts on 2022-10-05 and runs daily at 7:00 a.m.

Numbered Headings
start-numbering-with1
start-numbering-ath5
Open TD Console
Navigate to Data Workbench > Workflows.
Open an existing workflow or create a new one.
Select Launch Project Editor.

Code Block
firstline1
linenumberstrue
_export:
  td:
    database: workflow_time

timezone: America/Chicago

schedule:
  daily>: 07:00:00
  start: 2022-10-05


Set an End Date

Setting an end date can help you end campaign workflows on a set schedule, so there is no accidental running of a workflow after completing a campaign.

How End Dates Work

  • The workflow scheduler stops scheduling the workflow past YYYY-MM-DD.  
  • The time for the end schedule always defaults to "end date HH:MM:SS"; the user-defined date and not exceeding "end date 23:59:59".

Example

In the following example, the schedule runs the workflow daily from 7:00 a.m until 2022-10-04. 

Numbered Headings
start-numbering-with1
start-numbering-ath5
Open TD Console
Navigate to Data Workbench > Workflows.
Open an existing workflow or create a new one.
Select Launch Project Editor.

Code Block
firstline1
linenumberstrue
_export:
  td:
    database: workflow_time

timezone: America/Chicago

schedule:
  daily>: 07:00:00
  end: 2022-10-05