Connect to Zuora Data in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Zuora, HULFT Integrate can work with live Zuora data. This article walks through connecting to Zuora and moving the data into a CSV 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.

Enable Access to Zuora

To enable access to Zuora data from HULFT Integrate projects:

1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.zuora.jar (and cdata.jdbc.zuora.lic), to the jdbc_adapter subfolder for the Integrate Server
2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Zuora Data

Once you copy the JAR files, you can create a project with access to Zuora data. Start by opening Integrate Studio and creating a new project.

1. Name the project
2. Ensure the "Create script" checkbox is checked
3. Click Next
4. Name the script (e.g.: ZuoratoCSV)

Once you create the project, add components to the script to copy Zuora data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Zuora. Set the following properties:
   • Name: Zuora Connection Settings
   • Driver class name: cdata.jdbc.zuora.ZuoraDriver
   • URL: jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH
     
     

     Built-in Connection String Designer

     For assistance 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.

     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.
2. Write your SQL statement. For example:

   SELECT Id, BillingCity FROM Invoices

3. Click "Extraction test" to ensure the connection and query are configured properly
4. Click "Execute SQL statement and set output schema"
5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

1. Set a file to write the query results to (e.g. Invoices.csv)
2. Set "Input data" to the "Select SQL" component
3. Add columns for each field selected in the SQL query
4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
5. Click "Finish"

Map Zuora Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Zuora data into a CSV file.

Download a free, 30-day trial of the CData JDBC Driver for Zuora and start working with your live Zuora data in HULFT Integrate. Reach out to our Support Team if you have any questions.