Explains the process for scheduling a flow.
Prerequisites
A flow has been created in the system using flow editor.
How to schedule a flow
- From eaConnect side navbar, click on “Manage”. It will expand and show sub menu. Click on “Schedules” -
- To create a schedule, click on “Create New” -
- From the available flows, click on the desired flow. It will open the flow in flow editor
- Enter following details on the screen –
| Schedule Name | Name of the Schedule |
| Description | Description of the Schedule |
| Select Flow | Select the flow to be executed from the dropdown |
| Cron Pattern | Specify time and frequency using Cron Pattern (See below for details on CRON PAttern and scheduling) |
| Select Timezone | Choose Timezone from the dropdown |
| Error Email | Email id for receiving email on error |
| Success Email | Email id for receiving email on success |
- Press “Save” Button to save the schedule
Example
Cron job format and time zone
Cron jobs are scheduled at recurring intervals, specified using a format based on unix-cron. You can define a schedule so that your job runs multiple times a day or runs on specific days and months.
Note: If you disable the Cloud Scheduler API while a running job is scheduled and then re-enable it later, any job that fails to run in the interim will run at the next scheduled time.
Cron job format
A schedule is defined using the unix-cron string format (* * * * *), which is a set of five fields in a line, indicating when the job should be executed.
You can use either the Google Cloud console, the Google Cloud CLI, or the Cloud Scheduler REST API to set your schedule.
The time fields have the following format and possible values and must follow this order:
| Field | Format of valid values |
|---|---|
| Minute | 0-59 |
| Hour | 0-23 |
| Day of the month | 1-31 |
| Month | 1-12 (or JAN to DEC) |
| Day of the week | 0-6 (or SUN to SAT; or 7 for Sunday) |
- Minute: indicates how far past the top of the hour your job runs, in minutes. For example, if the minute is set to 0, then the job runs at the top of the hour (because that is 0 minutes after the hour). So if the hour is 8:00 AM, the job runs at 8:00 AM.
- Hour: The hour indicates how far past midnight your job runs, in hours (rounded down to the nearest hour, because remaining minutes are indicated in the minute field). Midnight is 0 and noon is 12. For example, if the hour is set to 0, then the job runs in the midnight hour (because that is 0 hours after midnight).
- Day of the month: indicates the calendar date of the month. For example, 1 for the first day of the month. Cloud Scheduler does not support L to mean the last day of the month.
- Month: indicates the month. Specify the month number or the first three letters of the month name in uppercase. For example, 1 for January, or equivalently, JAN.
- Day of the week: indicates the day of the week. Monday is 1, Tuesday is 2, and so on. Either0or 7 can indicate Sunday. Specify the day of the week either by number or by the first three letters of the weekday name in uppercase (for example SUN for Sunday).
- This field is evaluated as an inclusive OR with the day of the month field, unless one of these fields is marked as unrestricted by the asterisk (*). For example, if the day of the month is set to 1 and the day of the week is set to SAT, the job runs on the first day of the month and on every Saturday of the month, even if the first day of the month is not a Saturday. If the day of the week is unrestricted (set to *), the job runs only the first day of the month.
Matching all values
To match all values for a field, use the asterisk: *. When a field is set to the asterisk, the field matches all valid values for that field whenever the other field conditions are satisfied. Setting a field to the asterisk is sometimes referred to as leaving the field unrestricted, because it is not restricted to a specific value.
Here are two examples in which the minute field is left unrestricted:
- * 0 1 1 1: the job runs every minute of the midnight hour on January 1st and Mondays.
- * * * * *: the job runs every minute (of every hour, of every day of the month, of every month, every day of the week, because each of these fields is unrestricted too).
The asterisk is equivalent to a special case of a range, where the range starts at the first valid value for the field, and ends at the last valid value for the field (for example, 0-59 for the minute field).
Matching a range
To match a range of values, specify your start and stop values, separated by a hyphen (-). Do not include spaces in the range. Ranges are inclusive. The first number must be less than the second number. If you are using abbreviated names for the month or weekday (for example, JAN instead of 1 for the first month of the year), the first value must come earlier in the month or week than the second value.
The following equivalent examples run at midnight on Mondays, Tuesdays, Wednesdays, Thursdays, and Fridays (for all months):
- 0 0 * * 1-5
- 0 0 * * MON-FRI
Matching a list
Lists can contain any valid value for the field, including ranges. Specify your values, separated by a comma (,). Do not include spaces in the list.
Examples:
- 0 0,12 * * *: the job runs at midnight and noon.
- 0-5,30-35 * * * *: the job runs in each of the first five minutes of every half hour (at the top of the hour and at half past the hour).
Skipping values in a range
You can skip values in a range by specifying a rate at which to step through the range. This is sometimes referred to as using a step function (or step value or rate expression). To do so, specify the range, followed by the forward slash (/) and the rate at which you want to skip through the range.
You can use the asterisk (*) to indicate the range of all values for the field. When you use the asterisk, the first value in the range is: 0 for the minute, hour, and day of the week (Sunday) fields, and 1 for day of the month and the month fields.
The step value cannot be larger than the largest possible value for the field. The default step is 1, so the step function /1 is the same as not using a step function at all.
Example ranges that use step functions:
- */2: this is a valid step function for any field. For the minute field, it matches 0, 2, 4, ... , 58. For the hour, it matches 0, 2, 4, ... , 22. For the day of the month, it matches 1, 3, 5, ... , 31 (for a month with 31 days). For the month, it matches 1, 3, 5, ... , 11. For the day of the week, it matches 0, 2, 4, 6.
- 0-12/2: this is a valid step function for the minute and hour fields. It matches 0, 2, 4, ... , 12.
Example schedules using step functions:
- */2 * * * *: the job runs every two minutes.
- 0 0-12/2 * * *: the job runs every two hours, on the hour. The first run is at midnight. The last run is at noon.
Sample schedules
The following table shows some sample cron job schedules and their description:
| Schedule | Cron job format | Explanation |
|---|---|---|
| Every minute | * * * * * | Runs on the minute. For example, 9:00 AM, 9:01 AM, :02 AM, and so on. |
| Every hour | 0 * * * * | Runs on the hour. For example, 9:00 AM, 10:00 AM, 11:00 AM, and so on. |
| Every day | 0 0 * * * | Runs at 12:00 AM (00:00 in 24-hour format) every day. |
| Every weekday (Mon-Fri) |
The following are equivalent:
|
Runs at 12:00 AM (00:00 in 24-hour format) on Mondays, Tuesdays, Wednesdays, Thursdays, and Fridays. |
| Every week |
The following are equivalent:
|
Runs on Sundays at 12:00 AM (00:00 in 24-hour format). |
| Every month | 0 0 1 * * | Runs at 12:00 AM (00:00 in 24-hour format) on the first day of the month. |
| Every quarter |
The following are equivalent:
|
Runs at 12:00 AM (00:00 in 24-hour format) on the first day of the quarter, for a standard quarterly schedule: January 1st, April 1st, July 1st, and October 1st. |
| Every year |
The following are equivalent:
|
Runs at 12:00 AM (00:00 in 24-hour format) on the first day of the first month of the year (January 1st). |
Time zone
You can select the time zone for evaluating the schedule either in the Google Cloud console (on the Create a job page, select a Timezone from the list), or through the gcloud --time-zone flag when you create the job. The default time-zone is Etc/UTC.
For some time zones, daylight saving time can cause jobs to run or not run unexpectedly. This is because Cloud Scheduler runs on wall clock time. In instances where a time can occur twice (such as the case when clocks go backwards) and your job is scheduled at this time, your scheduled job might observe execution anomalies.
If your job requires a very specific cadence, you might want to consider choosing a time zone that does not observe daylight saving time. Specifically, UTC is recommended for Cloud Scheduler to avoid the problem completely.