Skip to main content

​
Overview

This document details the states and transitions of sync operations, organizing the sync process into specific statuses and run states. These categories are vital for managing data flow during sync operations, ensuring successful and efficient execution.

​
Sync Status Definitions

Each sync run operation can be in one of the following states, which represent the sync run’s current status:
Note: Ensure that sync configurations are regularly reviewed to prevent prolonged periods in the Disabled or Failed states.

​
Sync State Transitions

The following describes the allowed transitions between the sync states:
  • Pending ➔ Healthy: Occurs when a sync run completes successfully.
  • Pending ➔ Failed: Triggered if a sync run fails or is aborted.
  • Failed ➔ Healthy: A successful sync run after a previously failed attempt.
  • Any state ➔ Disabled: Reflects the manual disabling or enabling of the sync operation.

​
Sync Run Status Definitions

​
Sync Run State Transitions

The following describes the allowed transitions between the sync run states:
  • Started ➔ Querying: Transition post-initiation as data retrieval begins.
  • Querying ➔ Queued: After staging data in the “SyncRecord” table, indicating readiness for transmission.
  • Queued ➔ In Progress: Commences as the sync operation begins writing data to the destination, based on availability of system resources.
  • In Progress ➔ Success: Marks the successful completion of data transmission.
  • In Progress ➔ Paused: Triggered by a temporary interruption in the sync process.
  • Paused ➔ In Progress: Signifies the resumption of a sync operation post-interruption.
  • In Progress ➔ Aborted/Failed: Initiated when an error prevents the successful completion of the sync operation.