Feed Zuora Data into FineReport

The CData JDBC Driver for Zuora fully implements the JDBC standard and can provide Zuora data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set Zuora data as JDBC data source in FineReport and view Zuora data as a table in the Report Designer.

Set Up a JDBC Data Source of Zuora Data

Follow the instruction below to set Zuora data as a FineReport database connection.

1. Copy the cdata.jdbc.zuora.jar file from the lib folder in the CData JDBC Driver for Zuora installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.zuora.lic file as well.
2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

1. Database: Others
2. JDBC Driver: cdata.jdbc.zuora.ZuoraDriver
3. URL: A standard JDBC connection string using semicolon-separated connection properties.

   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.

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   A typical JDBC URL is below:

   jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;
4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to Zuora set up, you can use it as FineReport data source.

Select Zuora Data in the Report Designer.

1. Click to add a new template data set and select DB query to open the database query window.
2. Choose the JDBC connection that you created from the dropdown list.
3. The Zuora entities will appear as tables on the left pane.
4. Write a SELECT statement for the Zuora data tables and columns that you want to load.
5. Click preview and data is shown as table.

With these simple steps, Zuora can be used as a JDBC data source in FineReport.