2022
...
The below tables explains the various model schema and attributes which form the model class
Database Params
Parameter | Description | DataType |
Salesforce (optional) | The salesforce credentials which are required to connect to the Salesforce instance | Salesforce |
Database (optional) | The database credentials which are required to connect to supported databases | Database |
Objects (optional) | The salesforce object which a client to replicate | Array Table |
Logs (optional) | The parameters related to Log settings and specific to DBSync | Log properties |
Run (optional) | The parameters related to run settings and specific to DBSync | Run properties |
Database Params
Parameter | Description | DataType |
SoapEndpoint (optional) | The URL to access the Salesforce application | string |
bulkApiEnable (optional) | The possible values are True and false which enables and disables the bulkapi calls | boolean |
callbackurl (optional) | The DBSync call back URL | string |
consumerkey (optional) | Its a consumersecretkey generated from salesforce oauth | string |
ConsumerSecret (optional) | It's a consumerSecret generated from the salesforce oauth | string |
password (optional) | The password of the Salesforce instance | string |
username (optional) | The username of the Salesforce instance from which the user wishes to retrieve information for replication | string |
Database Params
Parameter | Description | DataType |
filereplication (optional) | The possible values are true and false to enable and disable the file replication | boolean |
s3 (optional) | The possible values are true and false, true if hosted on aws | boolean |
awsaccesskey (optional) | awsaccess key if db is hosted on aws, can be retrieved from the aws instance | string |
awsBucketName (optional) | awsBucketName if db is hosted on aws, can be retrieved from the aws instance | string |
awsRegion (optional) | awsRegion if db is hosted on aws, can be retrieved from the aws instance | string |
consumerSecret (optional) | ConsumerSecret if db is hosted on aws, can be retrieved from the aws instance | string |
database (optional) | Name of the database Eg: Sqlserver/Oracle/Mysql | string |
host (optional) | The location of the database for instance localhost | string |
password (optional) | the password of the database if any | string |
port (optional) | port number the database instance which uses | string |
schema (optional) | The name of the database | string |
type (optional) | Specify the database that is being used Eg: Oracle | string |
URL (optional) | The URL of the database which is generated by the replication in the connection string | string |
username (optional) | The username of the database | string |
Database Params
Parameter | Description | DataType |
excludes (optional) | If the user wishes to remove any of the fields from the selected object in salesforce then he can use this parameter | Array[string] |
filter (optional) | The filter parameter is used to specify the condition to read data from Salesforce | string |
name (optional) | Name of the object that needs to be retrieved from the salesforce | string |
Log Properties Params
Parameter | Description | DataType |
emailerror (optional) | The possible values are true and false to enable them and disable the email notification from DBSync replication tool | boolean |
database (optional) | The possible values are true and false to enable them and disable the email notification of database from DBSync replication tool | boolean |
dir (optional) | The directory name if the database if flat file database | string |
emailreceipents (optional) | The email id of the recipient to who the system is intended to send out the logs / notifications | Array[string] |
emailsender (optional) | The email id of the sender can be also be passed to identify the from address | string |
callbackURL (optional) | The DBSync URL which sends the email notifications | string |