Version 22.0.8483


A Sync job is a unit of execution that includes the source connection, the destination connection, and a set of one or more tasks that represent data flows for different tables. All the tasks within a job are executed sequentially, which enables you to order data flows as you see fit. The Jobs page in the admin console provides a list of each configured job in the Sync application. From there, you can easily manage and monitor existing jobs while you add new jobs to the application.

Creating a New Job

Creating a job requires pre-configured source and destination connections. See Connections for more information about creating your source and destination connections. After you define a source connection to your data source and a destination connection to your database, follow these steps to create a new job.

  1. Click Add Job. This action opens the Create New Job modal.

  2. Enter your job name and select your source and destination connections in the modal.

  3. Select a replication type (optional):

    • Standard: Creates a single LoadFolder task that loads files continuously from a directory or bucket into a single destination table. See Load from Folder for more details.

    • Sync all tables: Automatically adds all available tables as replicate tasks in your job. See Sync All for more details.

  4. Click Create.

Creating a Job from an Existing Job

Instead of creating an entirely new job, you can create one by copying the settings and tasks from an existing job:

  1. Click Add Job to open the Create New Job modal.

  2. Click the Create From Existing Job tab.

  3. Enter a name for your job.

  4. Select a job that you want to copy from the Copy from Existing drop-down list.

  5. Select any of the following optional settings that you want:

    • Choose a different Source and Destination: This option enables you to choose a different source and destination than what the original job uses. However, the connection type for the new source and destination must match that of the original job.

    • Copy Tasks: This option copies tasks from the original job. Note: If you use a different source connection, you must validate that all tables that you added as tasks exist in your source before you run the job.

    • Copy Events: This option copies events from the original job.

    • Copy Additional Settings: This option copies notification, schedule, logging, events, and advanced settings from the original job.

  6. Click Create.

After you click Create, the application opens the Job Settings page for your new job. On this page, you can add new tables, set a schedule, view the run history, and set any additional replication settings for your job.

Specifying Job Settings

On the main Jobs page, clicking the edit icon next to a job (far right of the job name) opens the Job Settings page for that specific job.

  • The top panel, Connections, contains the source and destination connections for your job. You can view and edit the settings for both the source and destination connections by clicking the edit icon to the right of the source and destination names.

  • The bottom panel, Job Settings, contains different settings to control the data flow of the job.

Enabling the Scheduler

The Schedule tab enables you to run your job on an automated schedule. Choose one of the preconfigured intervals or create a custom cron statement to control how often your job runs. See Scheduling Jobs for information about the scheduling options.

Setting Up Notifications

The Notifications tab enables you to configure Sync to configure transformations to send email notifications on completion of a job.For information about configuring your mail server, See Notifications.

Monitoring your Jobs

The Logging & History tab enables you to monitor current job runs and review previous runs. See Logging and History for more information about what information each level of verbosity contains and how to retrieve your log files.

Additional Settings

  • See Events for information about creating events that execute before and after a job run.

  • See Advanced Job Options for information about how different options affect the data-flow process.

Managing Jobs

After you create jobs, the Jobs page provides an overview of each job’s status. You can perform the following actions on a job by hovering your cursor over the entry for the job:

  • Click the arrow next to Status to show or hide the status for each query in the job.

  • Click the edit icon to view the job settings.

  • Click the play button to start a job run.

  • Click the stop button to cancel a running job.

  • Click the delete icon to remove a job from the Sync application.