Connect to Salesforce Data from PowerBuilder via JDBC

The CData JDBC driver for Salesforce is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for Salesforce in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Salesforce to perform reads and writes.

Getting Started

---

Connect to Salesforce Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for Salesforce. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

   Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

2. Click Tools -> Database Painter.
3. Right-click the JDBC node and click New Profile.
4. In the Database Profile Setup dialog, enter the following:
   • Profile Name: Enter a user-friendly name for the profile.
   • Driver Name: Enter the class name of the driver, cdata.jdbc.salesforce.SalesforceDriver
   • URL: Enter the JDBC URL.

     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. A typical JDBC URL is below:

     jdbc:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode

   👁 The JDBC data source defined in the Database Profile Setup dialog. (Salesforce is shown.)
   
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Salesforce Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve Salesforce data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC"
SQLCA.AutoCommit = False
SQLCA.DBParm = "Driver='cdata.jdbc.salesforce.SalesforceDriver',URL='jdbc:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode";
CONNECT USING SQLCA;
dw_account.SetTransObject(SQLCA);
dw_account.Retrieve();