Edit and Search External SQL Server Objects in Salesforce Connect

CData Connect AI, enables you to access SQL Server data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce Mobile App. In this article, you will use CData Connect AI and Salesforce Connect to access external SQL Server objects alongside standard Salesforce objects.

Connect to SQL Server from Salesforce

To work with live SQL Server data in Salesforce Connect, we need to connect to SQL Server from Connect AI, provide user access to the connection, and create a Workspace for the SQL Server data.

Connect to SQL Server from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "SQL Server" from the Add Connection panel

3. 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
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add SQL Server Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure SQL Server Endpoints for Salesforce Connect

After connecting to SQL Server, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the SQL Server connection (e.g. SQL1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to SQL Server data from Salesforce Connect.

Connect to SQL Server Data as an External Data Sources

Follow the steps below to connect to the feed produced by Connect AI.

1. Log into Salesforce and click Setup -> Integrations -> External Data Sources.
2. Click Now External Data Sources.
3. Enter values for the following properties:
   • External Data Sources: 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 Connect AI: https://cloud.cdata.com/api/odata/{workspace_name}
4. Select the Writable External Objects option.
5. Select JSON in the Format menu.
6. In the Authentication section, set the following properties:
   • Identity Type: If all members of your organization will use the same credentials to access Connect AI, 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 a CData Connect AI username (e.g. [email protected]).
   • Password: Enter the user's PAT.

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.

1. Click the link for the external data source you created.
2. Click Validate and Scan.
3. Select the SQL Server tables you want to work with as external objects.

Access SQL Server Data as Salesforce Objects

After adding SQL Server data as an external data source and syncing SQL Server tables as external objects, you can use the external SQL Server objects just as you would standard Salesforce objects.

• Create a new tab with a filter list view:

  

• Create reports of external objects:

  

• Create, update, and delete SQL Server objects from the Salesforce dashboard:

  

Simplified Access to SQL Server Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to live SQL Server data from Salesforce. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Salesforce, refer to our Connect AI page.