Replication Bot
Introduction
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.
Initiate a New Automated Task
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.
Configure Source Application
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.
Advanced Settings
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.
Configure Target Application
Adding New Databases (For first-time users)
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.
Enter Connection Details: Click the Host field. Enter the IP address of your SQL Server.
Enter the post value in the Port field.
Click the User Name field. Enter your SQL Server username in the User Name filed. For example, sample.
Enter your SQL Server password i nthe Password field.
Click the "Database Name" field. Type the name of your target database in the Database Name field. For example, demo.
These settings fine-tune how data is written to your target.
File Download Tab (If your data includes files, like attachments)
Download dropdown: Choose where to store files (example, None, Local File System, AWS S3).
Keep Multiple Versions of Files: Check this box if you want to keep older versions of files when new ones are downloaded. This renames old versions.
Prefix Settings Tab
Action: Enter prefixes for Table Prefix and Column Prefix.
Purpose: This adds a short identifier (like "SF_") to your table and column names in the target. It's good for organizing and avoiding name conflicts.
Auto Rename Columns Tab
Action: Check Enable Auto-Rename of Columns.
Purpose: Databases have limits on how long table and column names can be (e.g., Oracle only allows 30 characters for Salesforce custom fields). This feature automatically shortens long names and adds a unique number (like _001) to prevent data from being lost or having duplicate names.
Database Logging Tab
Action: Check this box.
Purpose: This creates a special table named SFLOG__C in your target database. It records details about your replication, letting you track logs like Server, Info, or Warning levels directly in your database.
Test Connection: Click this to ensure DBSync can connect to your target.
Save: Save your target configurations.
Next: Click Next to move to the "Objects" tab.
Configuring Object
Choose the specific objects (like tables) and their fields (like columns) that you want to replicate.
Step 1: Go to the Objects Tab
Click the objects icon in the top navigation bar.
Step 2: Select Your Objects
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.
Step 3: Select Which Fields 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.
Step 4: Step 6: Add Data Masking (Protect Sensitive Info)
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.
Step 5: Run Your Replication Job
Last updated