The CData API Server enables you to access SQL Server data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce1 Mobile App. In this article, you will use the API Server and Salesforce Connect to access SQL Server external objects alongside standard Salesforce objects.
Set Up the API Server
If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure SQL Server OData services:
Connect to SQL Server
To work with SQL Server data from Salesforce Connect, we start by creating and configuring a SQL Server connection. Follow the steps below to configure the API Server to connect to SQL Server data:
- First, navigate to the Connections page.
-
Click Add Connection and then search for and select the SQL Server connection.
👁 Selecting a data source (SQLite is shown)
-
Enter the necessary authentication properties to connect to SQL Server.
Connecting to Microsoft SQL Server
Connect to Microsoft SQL Server using the following properties:
- Server: The name of the server running SQL Server.
- User: The username provided for authentication with SQL Server.
- Password: The password associated with the authenticating user.
- Database: The name of the SQL Server database.
Connecting to Azure SQL Server and Azure Data Warehouse
You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:
- Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
- User: The name of the user authenticating to Azure.
- Password: The password associated with the authenticating user.
- Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.
SSH Connectivity for SQL Server
You can use SSH (Secure Shell) to authenticate with SQL Server, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).
SSH Connections to SQL Server in Password Auth Mode
To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:
- User: SQL Server User name
- Password: SQL Server Password
- Database: SQL Server database name
- Server: SQL Server Server name
- Port: SQL Server port number like 3306
- UserSSH: "true"
- SSHAuthMode: "Password"
- SSHPort: SSH Port number
- SSHServer: SSH Server name
- SSHUser: SSH User name
- SSHPassword: SSH Password
SSH Connections to SQL Server in Public Key Auth Mode
To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:
- User: SQL Server User name
- Password: SQL Server Password
- Database: SQL Server database name
- Server: SQL Server Server name
- Port: SQL Server port number like 3306
- UserSSH: "true"
- SSHAuthMode: "Public_Key"
- SSHPort: SSH Port number
- SSHServer: SSH Server name
- SSHUser: SSH User name
- SSHClientCret: the path for the public key certificate file
👁 Connecting to a datasource (SQLite is shown)
-
After configuring the connection, click Save & Test to confirm a successful connection.
Configure API Server Users
Next, create a user to access your SQL Server data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:
- On the Users page, click Add User to open the Add User dialog.
-
Next, set the Role, Username, and Privileges properties and then click Add User.
👁 Configure a new user
-
An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:
👁 API Server user settings
Creating API Endpoints for SQL Server
Having created a user, you are ready to create API endpoints for the SQL Server tables:
-
First, navigate to the API page and then click
Add Table
.
👁 Add tables
-
Select the connection you wish to access and click Next.
👁 Select the connection (SQLite is shown)
-
With the connection selected, create endpoints by selecting each table and then clicking Confirm.
👁 Adding tables from the connection (SQLite is shown)
Gather the OData Url
Having configured a connection to SQL Server data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:
👁 API Endpoints
Connect to SQL Server Data as an External Data Source
Follow the steps below to connect to the feed produced by the API Server.
- Log into Salesforce and click Setup -> Develop -> External Data Sources.
- Click New External Data Source.
- Enter values for the following properties:
- External Data Source: Enter a label to be used in list views and reports.
- Name: Enter a unique identifier.
- Type: Select the option "Salesforce Connect: OData 4.0".
URL: Enter the URL to the OData endpoint of the API Server. The format of the OData URL is https://your-server:your-port/api.rsc.
Note that plain-text is suitable for only testing; for production, use TLS.
- Select the Writable External Objects option.
Select JSON in the Format menu.
- In the Authentication section, set the following properties:
- Identity Type: If all members of your organization will use the same credentials to access the API Server, select "Named Principal".
If the members of your organization will connect with their own credentials, select "Per User".
- Authentication Protocol: Select Password Authentication to use basic authentication.
- Certificate: Enter or browse to the certificate to be used to encrypt and authenticate communications from Salesforce to your server.
- Username: Enter the username for a user known to the API Server.
- Password: Enter the user's authtoken.
👁 Configuration settings for the data source. (NetSuite is shown.)
Synchronize SQL Server Objects
After you have created the external data source, follow the steps below to create SQL Server external objects that reflect any changes in the data source. You will synchronize the definitions for the SQL Server external objects with the definitions for SQL Server tables.
- Click the link for the external data source you created.
- Click Validate and Sync.
- Select the SQL Server tables you want to work with as external objects.
👁 Image
Access SQL Server Data as Salesforce Objects
After adding SQL Server data as an external data source and syncing SQL Server tables with SQL Server external objects, you can use the external objects just as you would standard Salesforce objects.
Troubleshooting
You can use the following checklist to avoid typical connection problems:
- Ensure that your server has a publicly accessible IP address. Related to this check, but one layer up, at the operating system layer, you will also need to ensure that your firewall has an opening for the port the API Server is running on. At the application layer, ensure that you have added trusted IP addresses on the Settings -> Security tab of the administration console.
- Ensure that you are using a connection secured by an SSL certificate from a commercial, trusted CA. Salesforce does not currently accept self-signed certificates or internal CAs.
Ensure that the server you are hosting the API Server on is using TLS 1.1 or above. If you are using the .NET API Server, you can accomplish this by using the .NET API Server's embedded server.
If you are using IIS, TLS 1.1 and 1.2 are supported but not enabled by default. To enable these protocols, refer to the how-to on MSDN and the Microsoft technical reference.
If you are using the Java edition, note that TLS 1.2 is enabled by default in Java 8 but not in Java 6 or 7. If you are using these earlier versions, you can refer to this this Oracle how-to.
