Import Real-Time Zuora Data via JDBC in ColdFusion to Build Applications

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST.

When ColdFusion is paired with the CData JDBC Driver for Zuora, you can link your ColdFusion web and mobile applications to operational Zuora data. This allows for your applications to be more robust and complete. This article details how to use the JDBC driver to create a table populated with Zuora data from within a ColdFusion markup file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Zuora data. When you issue complex SQL queries to Zuora, the driver pushes supported SQL operations, like filters and aggregations, directly to Zuora and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Zuora data using native data types.

Configuring the Connection to Zuora

You will need a JDBC connection string to establish a connection between Coldfusion and Zuora.

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

👁 Using the built-in connection string designer to generate a JDBC URL (zuora is shown.)

Adding a Data Source and Creating a Table

After configuring the connection, follow the steps below to add the CData JDBC Driver to ColdFusion's lib directory, add a new data source, test the connection, create a ColdFusion markup file, and, finally, make a real-time connection with Zuora data and display it in a table written in the ColdFusion Markup Language, or CFML:

1. Copy the JDBC Driver for Zuora and lic file from "C:\Program Files\CData[product_name]\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib".

    cdata.jdbc.zuora.jar
    cdata.jdbc.zuora.lic
    

   Note: If you do not copy the .lic file with the jar, you will see a licensing error that indicates you do not have a valid license installed. This is true for both the trial and full versions.

2. From the ColdFusion administrator interface, choose Data & Services. 👁 Selecting Data & Services
   
3. Here, we can "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our JDBC driver, choose "other", then click the "Add" button. 👁 Adding Data Source Name
   
4. Next, populate the driver properties.
   • JDBC URL will need to be in the format: jdbc:zuora:|connectionString|.
   • A typical connection string looks like this:

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

   • The Driver Class is: cdata.jdbc.zuora.ZuoraDriver
   • The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
   👁 Populating driver properties
   
5. Now, test the connection by clicking the check mark to the left of the CDataZuoraJDBC data source you just created. When the data source reports an "OK" status, it is ready for use. 👁 Testing the connection
   
6. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

   The following code queries the data source:

    
    <cfquery name="ZuoraQuery" dataSource="CDataZuoraJDBC"> 
    SELECT * FROM Invoices 
    </cfquery> 
    

   And a CFTable can be used to quickly output the table in HTML:

    
    <cftable 
    query = "ZuoraQuery" 
    border = "1" 
    colHeaders 
    colSpacing = "2" 
    headerLines = "2" 
    HTMLTable 
    maxRows = "500" 
    startRow = "1"> 
   
    <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/> 
   
    <cfcol header="<b>BillingCity</b>" align="Left" width=15 text="BillingCity"/> 
   
    ...
   
    </cftable> 
    

   Full code, including the HTML portion is available below:

    
    <html> 
    <head><title>CData Software | Zuora Invoices Table Demo </title></head> 
    <body> 
    <cfoutput>#ucase("Zuora Invoices Table Demo")#</cfoutput> 
    <cfquery name="ZuoraQuery" dataSource="CDataZuoraJDBC"> 
   
    SELECT * FROM Invoices 
   
    </cfquery> 
    <cftable 
    query = "ZuoraQuery" 
    border = "1" 
    colHeaders 
    colSpacing = "2" 
    headerLines = "2" 
    HTMLTable 
    maxRows = "500" 
    startRow = "1"> 
    <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/> 
   
    <cfcol header="<b>BillingCity</b>" align="Left" width=15 text="BillingCity"/> 
   
    ...
   
    </cftable> 
    </body> 
   
    </html> 
    

7. Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with Zuora data! 👁 Running the code
   

As a note, the CData JDBC Drivers also support parameterized queries using the cfqueryparam element. For example:

SELECT * FROM Account WHERE name = 

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for Zuora and start building Zuora-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.