Skip to content
Sync or Swim

Getting Started

This guide will walk you through setting up your first data synchronization between two systems using Sync or Swim.

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have:

  • Access to the Sync or Swim Control Center
  • Administrator credentials for the systems you want to sync
  • Network connectivity between Sync or Swim and your data sources

Setup Process

Section titled “Setup Process”

  1. Create Your Workspace

    Sign up for Sync or Swim and create your team workspace in the Control Center. This is where you’ll manage all your synchronization deployments.

  2. Deploy a Sync Engine

    From the Deployment Dashboard, launch a new Sync Engine. You can choose:

    • Cloud-hosted - We manage the infrastructure
    • Self-hosted - Deploy on your own servers

  3. Connect Your First Data Source

    Add your first connection. For this guide, we’ll use PostgreSQL:

    • Navigate to Connections in your Sync Engine
    • Click Add Connection
    • Select PostgreSQL
    • Enter your connection details (see PostgreSQL Setup)
    • Test the connection

  4. Connect Your Second Data Source

    Add your destination system. Let’s connect Salesforce:

    • Click Add Connection again
    • Select Salesforce
    • Complete the OAuth flow (see Salesforce Setup)
    • Authorize the connection

  5. Create a Sync Configuration

    Now connect your two data sources:

    • Navigate to Syncs
    • Click New Sync
    • Select your source (PostgreSQL) and destination (Salesforce)
    • Choose your sync mode (System of Record or External ID)

  6. Map Your Fields

    Define how data flows between systems:

    • Select the tables/objects to sync
    • Map fields between source and destination
    • Configure any transformations
    • See Field Mapping for details

  7. Start Syncing

    • Review your configuration
    • Click Start Sync
    • Monitor the initial sync in the activity log

What Happens Next

Section titled “What Happens Next”

Once your sync is running:

  1. Initial Sync - All existing records are synchronized based on your configuration
  2. Continuous Sync - Changes are detected and synced in real-time (or near-real-time depending on your adapters)
  3. Monitoring - View all sync activity in the logs

Common First Steps

Section titled “Common First Steps”

After your initial setup, you may want to:

  • Add filters - Only sync records that match certain criteria
  • Configure conflict resolution - Define what happens when both systems change the same record
  • Set up alerts - Get notified of sync errors or issues
  • Add more connections - Sync additional tables or objects

Troubleshooting

Section titled “Troubleshooting”

Connection Issues

Section titled “Connection Issues”

If you can’t connect to your data source:

  1. Verify your credentials are correct
  2. Check network/firewall settings allow the connection
  3. Ensure the user has necessary permissions
  4. Review the specific adapter documentation for requirements

Sync Not Starting

Section titled “Sync Not Starting”

If your sync won’t start:

  1. Check both connections show as “Connected”
  2. Verify field mappings are complete
  3. Look for validation errors in the configuration
  4. Check the error log for details

Next Steps

Section titled “Next Steps”