Replication Bot
Last updated
Last updated
The DBSync Replication Bot is designed for scheduled data replication from cloud applications such as Salesforce into relational databases like PostgreSQL, Redshift, or SQL Server. It helps organizations maintain backups, support reporting needs, and meet data archival and compliance requirements.
After creating the project, you'll be redirected to the Automation Tab, where you can create a new automated task for replication by using the following steps
Select Automation Agent
Enter A suitable Name for your replication task, as per the flow (example: Salesforce to SQL)
To assign a bot to manage the replication, click Select Automation Agent. From the available options, choose Replication Bot. Once selected, click the Configure button to customize the replication settings.
Select App: In the Source App section, click Select App. A list of all support applications will be displayed; click on the application you want to designate as your data source.
This section fine-tunes how data is pulled from your source.
Use Bulk API: Enabling this will help users to use a specialized API designed for efficiently processing large volumes of data, typically thousands or millions of records, in a single operation.
Incremental Update Time Offset: This tells DBSync how far back to look for changes when it's only copying new or changed data (incremental updates).
Action: Select a time unit (Seconds, Minutes, Hours, Days, Months) from the dropdown, then enter a number in the box next to it
Salesforce API Calls Usage Limit: Type a number here (default is 100,000). This helps manage how many requests DBSync makes to Salesforce, keeping you within your Salesforce limits.
Test Connection: Always click this first! It checks if DBSync can connect to your source. You'll see a pop-up telling you if it worked.
Save: If the test is successful, click "Save" to remember your settings.
Next: After saving, click "Next" to go to the "Target" setup.
The dropdown will show the databases that you've already connected to in Cloud Workflow.
You'll also see an option called + Add New.
Action: If your target isn't listed, click + Add New. A new dropdown will appear, letting you configure all the databases supported by DBSync Cloud Replication.
To learn how to configure the database setup, please go to the following page: Target Database Setup
These settings fine-tune how data is written to your target.
This includes
File Download
Prefix Settings
Auto Rename
Database Logging
To learn how to configure the Advanced Settings, please go to the following page: Advanced Settings Configuration
Choose the specific objects (like tables) and their fields (like columns) that you want to replicate.
Click the objects icon in the top navigation bar.
On the left, you'll see a list of objects from your source app (example, Account, Contact, Opportunity).
Action: Check the box next to each object you want to copy.
Once you select an object, its Available Fields will appear in the middle section.
Action: Select the fields you want to copy. You can move fields to the Excluded Fields section if you don't want them copied.
Action: Click Add Data Mask.
Purpose: This lets you hide or scramble sensitive data (like phone numbers or names) in specific fields during replication. A pop-up will show you masking options.
Click Data Masking.
Select the object on which you want to apply the masking.
Select the field and turn ON masking for that object, and select the masking type from the dropdown.
Click Save to apply the masking and close the masking window.
To run replication, click on the run button at the top to select the command you want to execute
Once you click on run a dropdown will open where you can select the command you want to run
Select The Command and click on the Play button next to it to execute the command, and your replication will start, and you will get the following message on the screen
This message shows that your replication task has started. Click Ok to move to the logs page, where you can see the live progress of data movement