Connect to Salesforce Data in Aqua Data Studio

The CData JDBC Driver for Salesforce integrates Salesforce data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Salesforce data through the connection manager and execute queries.

Getting Started

---

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Salesforce data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Salesforce.
   • Driver Location: Click the Browse button and select the cdata.jdbc.salesforce.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.salesforce.SalesforceDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:salesforce: and is followed by a semicolon-separated list of connection properties.

     There are several authentication methods available for connecting to Salesforce: OAuth, Login (or basic), and SSO. The Login method requires you to have the username, password, and security token of the user.

     OAuth Authentication (default)

     The default authentication mechanism (and the one preferred by Salesforce) is OAuth. To use OAuth with CData's embedded OAuth application, leave the connection properties blank. If you have configured your own custom OAuth application with Salesforce (see the Help documentation for more information), set OAuthClientId, OAuthClientSecret, and CallbackURL to the properties for you application. Set InitiateOAuth to the desired OAuth flow ("GETANDREFRESH" will have the connector manage the entire OAuth flow).

     Login (or Basic) Authentication

     If you do not wish do not wish to use OAuth authentication, you can use Login (or basic) authentication. Set AuthScheme to Basic, and set the User, Password, and SecurityToken properties. You can configure your security token in Salesforce.

     SSO (single sign-on) Authentication

     SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and SSOExchangeURL connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the Help documentation for more information.

     Multi-Factor Authentication (MFA)

     If your Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies to both OAuth and Login authentication flows.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Salesforce JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.salesforce.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

     jdbc:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Salesforce Data

You can now query the tables exposed.