Scheduler

The Scheduler app lets you schedule flows repeatedly at a specific time. Scheduler supports scheduling flows on fixed intervals such as daily orhourly. Scheduler also supports scheduling using cron expression format which you can use to schedule at finer intervals, such as at 7 p.m. Monday-Friday.

Scheduler is useful for automating repetive tasks. For example, you can use Scheduler to trigger to a batch-processing flow once a day at a specific time, automate monitoring of jobs or send daily status reports.

To manage scheduling jobs programmatically, use Scheduler APIs.

Schedule jobs

To schedule a flow, click on the Create Job button.

Configure the job with the following fields:

  • Name: Required. A user-specified job name.

  • Schedule: Required. An interval of time when the job runs.

  • Binary program: Required. The path to the Flow Binary .iflowbin file.

  • Input directory: Required. The folder that contains the data to run the Flow on.

  • Authentication token: Required. An API access token for the app. See Creating API access token for more information.

  • Create output run ID: Optional. Whether output should be written into a directory with a unique, timestamped run_id. Defaults to false.

  • Overwrite previous output: Optional. Whether to delete any existing content in the output folder, before running the binary. Is a no-op if output_has_run_id is true. Defaults to false.

  • Tags: Optional. List of string tags to attach with this Flow run. Flow runs can be later searched using these tags using the Flow Dashboard or using the List API.

  • Step Timeout: Optional. Timeout in seconds for each Flow step. When set to 0, the platform picks an appropriate timeout for each step; when set to -1, step timeouts are disabled. Defaults to 0.

  • Pipeline: Optional. Associate current Flow run with a pipeline. Takes a list of pipeline ids retrieved from Flow Pipeline APIs.

  • Notification emails: Optional. A comma-separated list of email addresses to send notifications to.

  • Webhook URL: Optional. A user-defined HTTP callback URL.

  • Webhook headers: Optional. Dictionary of headers for the notification event.

  • Runtime configs: Optional. A JSON object passed into the Flow to allow a pre-built Flow Binary to perform custom actions at runtime.

Viewing jobs

The scheduled job views are shown by user.

  • For users, the default view of the Scheduler app shows all jobs.

  • For admins, the default view shows all scheduled jobs for all users. Uncheck the Show all users’ jobs checkbox to view only your scheduled jobs.

The table of jobs shows the scheduled job name, enabled status, the schedule the job runs on, the user who created the job, and the scheduled job create time stamp, and the last time a job was run. If results exist, a link to view results shows.

Trigger job

Click the play icon to trigger the scheduled job. Use this to test if the scheduled flow works without having to wait for it to be scheduled.

Editing scheduled jobs

Click the pencil icon to edit a scheduled job.

Enable or disable scheduled jobs

Use the toggle to enable or disable a scheduled job.

Delete scheduled jobs

Click the trash icon to delete a scheduled job.