User Guide: Configuring Source as MS-SQL Database or Oracle Database using Bizdata Universal API and Target as Salesforce
Overview
This user guide provides step-by-step instructions for configuring Bizdata Universal API to connect either an MS-SQL Database or an Oracle Database as the source and Salesforce as the target.
By following this guide, users can establish secure connectivity, retrieve data from the selected database, and transmit structured records to Salesforce using API-based integration.
When to Use
This configuration is recommended when database records must be synchronized with Salesforce for reporting, CRM operations, or data consolidation.
- When integrating MS-SQL or Oracle data with Salesforce
- When using Bizdata Universal API for database connectivity
- When automated data transfer is required
- When secure API-based authentication is mandatory
- When building scheduled integration workflows
How It Works
The integration follows a structured workflow to retrieve and transmit data.
- Configure Bizdata Universal API as the source
- Authenticate using API credentials
- Connect to MS-SQL or Oracle using JDBC
- Execute SQL queries
- Process data using operations
- Send formatted records to Salesforce
How to Configure
Data Source Configuration
Step 1: Select Source Type
On the Data Source page, select the source type as API.
Step 2: Select Product
Select Bizdata Universal API as the product.
Step 3: Select Business Object
Choose the appropriate business object based on the database type.
- For MS-SQL: MS-SQL Database (Version: 1.0) (Method: POST)
- For Oracle: Oracle Database (Version: 1.0) (Method: POST)
Step 4: Configure Authorization
After selecting the business object, configure authorization by entering the Bizdata Universal API username and password.
For credentials, contact the Bizdata support team.
Pass the credentials in the Request Token Endpoint Body using the following format.
{
"username": "xxxxxx",
"password": "xxxxxxxxxxxx"
}
Step 5: Configure Request Body
Select the Body header and configure the JSON request using the required connection keys.
Configuration Keys
The following keys are required to establish database connectivity.
- jdbc_string: JDBC connection string
- jdbc_path: Path to JDBC driver file
- jdbc_driver: JDBC driver class name
- username: Database username
- password: Database password
- query: SQL query
JDBC Connection String Format
The JDBC connection string must follow the format below.
jdbc:sqlserver://{{host_ip}}:{{port_number}};
databaseName={{schema_name}};
encrypt=true;
trustServerCertificate=true;
Replace placeholders with actual values:
- {{host_ip}}: Database host or IP address
- {{port_number}}: Database port
- {{schema_name}}: Database name
Note: If SSL encryption is not enabled, remove encrypt=true;trustServerCertificate=true;.
Sample Request Body
{
"jdbc_string": "jdbc:sqlserver://{{host_ip}}:{{port}};databaseName={{schema}};",
"jdbc_path": "/path/to/mssql-jdbc-10.2.0.jre8.jar",
"jdbc_driver": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
"username": "{{Username}}",
"password": "{{Password}}",
"query": "Select * from tablename"
}
Replace placeholders with valid database and driver details.
Data Operations
Operations can be applied according to business requirements to transform and prepare data before sending it to Salesforce.
For additional details, refer to the Bizdata Help page.
Data Target Configuration
Step 1: Select Target Type
Select the Target Type as API.
Step 2: Select Target Name
Choose Salesforce as the target name.
Step 3: Select Business Object
Select the Salesforce business object based on business requirements.
Step 4: Configure Target Details
After selecting the business object, all required headers and parameters are loaded automatically.
Modify the headers only if necessary.
Step 5: Submit Configuration
Navigate to the Summary page and click Submit to complete the configuration.
Troubleshooting
- Authentication Failed: Verify API credentials.
- Database Connection Error: Validate JDBC string and network access.
- Driver Not Found: Confirm JDBC driver path.
- Query Execution Failed: Review SQL syntax.
- Data Not Sent: Check target configuration.
Frequently Asked Questions
Can I connect both MS-SQL and Oracle using the same workflow?
No. Separate business objects must be selected for MS-SQL and Oracle configurations.
Is SSL encryption mandatory?
No. SSL encryption can be disabled by removing the encryption parameters from the JDBC string.
Can I use custom SQL queries?
Yes. Any valid SELECT query can be specified in the request body.
Where do I get API credentials?
API credentials are provided by the Bizdata support team.
Can this integration be scheduled?
Yes. Scheduling can be configured from the Summary page after submission.
Notes
- Secure all API and database credentials.
- Test connectivity before production deployment.
- Validate SQL queries for performance.
- Keep JDBC drivers updated.
- Monitor logs regularly.
This guide enables reliable integration between MS-SQL or Oracle databases and Salesforce using Bizdata Universal API.
