Set up Data Sync

Set up a scheduler

Data Sync allows you to automate the process of syncing data in your app. Instead of manually performing data syncs, you can set up a Data Sync scheduler to update data automatically.

1. Create a Project from resource

To start, you need to create a project and select a resource from which you want to sync data.

  1. Go to Project page.

  2. Click Create Project.

  3. Fill in the Project name.

  4. Select the desired resource from the resources list.

  5. Click Create Project

2. Create a Workflow from Project

Next, you'll create a workflow for the project. There are two methods to accomplish this:

Method 1:

  1. Go to Workflow page.

  2. Click Create Workflow.

  3. Select the project from the project list.

  4. Click Create to create a new Workflow

Method 2:

  1. Open the project for which you want to sync data.

3. Set up Data Sync in Workflow

3.1 Enter the Workflow you just created and click on the Data Sync Button beside the resource that you wanted to sync data, assuming you want to sync resource data. You can also sync project table data if you need to.

3.2 Switch the status "PAUSED" TO "ENABLED" to start data syncing. A success message will pop up when the scheduler is enabled.

3.3 Data Sync Settings

  • Update Mode:

    1. Incremental: This mode only syncs the new or modified data since the last synchronization. It updates only the changes made to the data, resulting in faster sync times and optimized resource usage. It is useful when you have a large dataset and want to minimize the amount of data transferred during each sync.

    2. Full Refresh: Selecting this mode means that the entire dataset will be synced every time the scheduler runs. It ensures that all data in your app is up to date and consistent, but it may take more time and resources compared to incremental syncs. This mode is suitable when having a complete and current copy of the data is important.

  • Sync Frequency: determines how often the data synchronization will occur.

    1. Intraday: update the table every specific time interval within a day. The minimum time interval is 15 minutes.

    2. Daily: update the table at a specific time (such as 6 a.m.) every day.

    3. Custom: you can define the scheduler in a more flexible way.

  • At: The UTC time when the data is automatically synced. Sometimes, a several-minute delay might occur, and it is normal.

How to check if the scheduler is running?

You can go to Sync History to check when the table was updated last time.

How to check who requests Data Sync or sets up the scheduler?

You can go to User Actions in the Data Sync page. It records actions including setting up the scheduler and requesting to sync now.

Request to sync now

  1. Go to the table that you want to update and click the Request Data Sync Now button.

2. Specify to append rows based on which columns and click the Sync Now button. (The meaning of "Append new data by column" please see here)

3. The button will show a small mark "Syncing". It may take several minutes to update the table.

4. When Data Sync is finished, you will see a message on the top of the page.

Last updated