Connect to Zuora Data from PowerBuilder

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Zuora JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Zuora.



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

The CData JDBC Driver for Zuora 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 Zuora in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Zuora to retrieve data.

Connect to Zuora Data from PowerBuilder

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

      Zuora uses the OAuth standard to authenticate users. See the online Help documentation for a full OAuth authentication guide.

      Configuring Tenant property

      In order to create a valid connection with the provider you need to choose one of the Tenant values (USProduction by default) which matches your account configuration. The following is a list with the available options:

      • USProduction: Requests sent to https://rest.zuora.com.
      • USAPISandbox: Requests sent to https://rest.apisandbox.zuora.com"
      • USPerformanceTest: Requests sent to https://rest.pt1.zuora.com"
      • EUProduction: Requests sent to https://rest.eu.zuora.com"
      • EUSandbox: Requests sent to https://rest.sandbox.eu.zuora.com"

      Selecting a Zuora Service

      Two Zuora services are available: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

      DataQuery

      The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

      Limitations
      • The maximum number of input records per table after filters have been applied: 1,000,000
      • The maximum number of output records: 100,000
      • The maximum number of simultaneous queries submitted for execution per tenant: 5
      • The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
      • The maximum processing time for each query in hours: 1
      • The maximum size of memory allocated to each query in GB: 2
      • The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

      AQuADataExport

      AQuA API export is designed to export all the records for all the objects ( tables ). AQuA query jobs have the following limitations:

      Limitations
      • If a query in an AQuA job is executed longer than 8 hours, this job will be killed automatically.
      • The killed AQuA job can be retried three times before returned as failed.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.zuora.jar

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

      jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH
  5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Zuora 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 Zuora 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.zuora.ZuoraDriver',URL='jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH"; CONNECT USING SQLCA; dw_invoices.SetTransObject(SQLCA); dw_invoices.Retrieve();