Connect to SuiteCRM Data from PowerBuilder



This article demonstrates how to access SuiteCRM data from PowerBuilder using the SuiteCRM JDBC Driver.

The CData JDBC driver for SuiteCRM 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 SuiteCRM in PowerBuilder.

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

Connect to SuiteCRM Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for SuiteCRM. 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.suitecrm.SuiteCRMDriver
    • URL: Enter the JDBC URL.

      The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example http://suite.crm.com.

      Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.suitecrm.jar

      Fill in the connection properties and copy the connection string to the clipboard. A typical JDBC URL is below:

      jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;
  5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using SuiteCRM 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 SuiteCRM 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.suitecrm.SuiteCRMDriver',URL='jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;"; CONNECT USING SQLCA; dw_accounts.SetTransObject(SQLCA); dw_accounts.Retrieve();

Ready to get started?

Download a free trial of the SuiteCRM Driver to get started:

 Download Now

Learn more:

SuiteCRM Icon SuiteCRM JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SuiteCRM account data including Leads, Contacts, Opportunities, Accounts, and more!