Connecting QuerySurge to Salesforce with the CData JDBC Driver

Versions: 8.0+

Salesforce is a prominent Client Relationship Management tool. QuerySurge requires a JDBC driver to connect to Salesforce, as do other tools, and the needs for a JDBC compliant driver has been filled by several different commercial drivers. One commercial driver that QuerySurge users have used to connect is available from CData. Setup details for using the CData JDBC driver to connect to QuerySurge follow.

Note: RTTS, the vendor of QuerySurge, partners with CData to make a broad range of JDBC drivers available to QuerySurge users. For information about our partnership, click here. See all of CData's JDBC offerings here. For questions related to ordering, contact us here.

Setting up a Connection to Salesforce with the CData JDBC Driver

Connecting to Salesforce with the CData JDBC driver is done using the Connection Extensibility feature of the QuerySurge Connection Wizard. What follows are the details you'll need to set up your QuerySurge Connection to Salesforce with this driver.

1. Download the driver from CData here.
   
   
2. Deploy the Salesforce JDBC driver to your Agent(s). The procedure for deploying a new driver to a QuerySurge Agent is here (for Agents on Windows) and here (for Agents on Linux).
   
   Note: CData requires that you run their driver installer in order for their JDBC driver to function properly, so the CData installer will have to run on every Agent box that you plan to use the driver on. However, once the driver is installed (regardless of where it is installed), you can copy the driver file(s) to the standard QuerySurge Agent jdbc folder, per the directions in the links above.
   
   
3. Log into QuerySurge as a QuerySurge Admin user, and navigate to the Admin view. Steps for using the Connection Extensibility feature can be found here. To use the Connection Extensibility option in the Connection Wizard with the CData driver, you'll need the following information:
   

   Driver Class: cdata.jdbc.salesforce.SalesforceDriver

   Connection URL: jdbc:salesforce:[User=<salesforce-user-name>;][Password=<salesforce-password>;]Security Token=<salesforce-api-token>
   

   
   Note that you'll need to provide the CData Salesforce driver with the proper values for the username, the password and the API token. Enter your information in the Connection Wizard, using the Authentication Info section for username and password instead of the URL, to keep your credentials secure:
   
   
   
   Note: As with most JDBC drivers, there are multiple property options for the URL. You may add any additional driver properties that may be necessary using as key-value pairs (key=value syntax), separated by a semicolon. A full list of available properties for the CData JDBC Driver for Salesforce can be found in the CData documentation. Following are a few properties that you might find useful:
   
   
   • For extra debug information, set a log and a verbosity level on your URL (once issues are resolved, it is advisable to remove the logging settings from the URL, to avoid generating large logs):
     
     

     jdbc:salesforce:Security Token=<salesforce-api-token>;Logfile=C:\Log.txt;Verbosity=3

   • To set a   Single Sign On URL, add the ssologinurl property with the URL: 
     
     

     jdbc:salesforce:Security Token=<salesforce-api-token>;ssologinurl=Your_SSO_login_url

   • To run your queries against your Salesforce sandbox, instead of your production instance, use:
     
     

     jdbc:salesforce:Security Token=<salesforce-api-token>;UseSandbox=TRUE

4. If you have a Test Query for Salesforce, feel free to enter it to help verify that your Connection parameters are correct. It should be a standard query that returns a small amount of information - one row/column is enough. Make sure that your login has permission to query the table that you use.
   
   
5. If you entered a Test Query, you can use the Test Connection button to test whether your Connection is set up properly:
   
   
   
   
6. Click the Save button.
   
   Once your driver is set up, you should be able to write SQL queries against your Salesforce data in QuerySurge.