Connect to Zuora Data in NetBeans

The CData JDBC Driver for Zuora integrates connectivity to live Zuora data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Zuora data in NetBeans. You will create a connection and load Zuora data in the Table Editor.

Create a JDBC Data Source for Zuora in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

• Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.zuora.jar file. The driver JAR is located in the lib subfolder of the installation directory.
• Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.zuora.ZuoraDriver from the menu.
• Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

1. In the Service window, right-click the Database node and click New Connection.

2. In the New Connection Wizard, enter the following connection properties:

   • Driver Name: In the menu, select the CData JDBC Driver for Zuora.
   • User Name: Enter the username. This can also be defined in the JDBC URL.
   • Password: Enter the password. This can also be defined in the JDBC URL.

   • JDBC URL: Specify 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 the following:

     jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH

Query Zuora Data

To connect to Zuora data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data..