Integrate Zuora with External Services using SnapLogic

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including Zuora, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Zuora data. When platforms 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 lets you work with Zuora data using native data types.

Connect to Zuora in SnapLogic

To connect to Zuora data in SnapLogic, download and install the CData Zuora JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData JDBC Driver for Zuora/lib by default).

Upload the Zuora JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to Zuora.

1. Navigate to the Designer tab
2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer
3. Click Add Account (or select an existing one) and click "Continue"
4. In the next form, configure the JDBC connection properties:
   • Under JDBC JARs, add the JAR file we previously uploaded
   • Set JDBC Driver Class to cdata.jdbc.zuora.ZuoraDriver

   • Set JDBC URL to a JDBC connection string for the Zuora JDBC Driver, for example:

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

     NOTE: RTK is a trial or full key. Contact our Support team for more information.

     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.

     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.
5. After entering the connection properties, click "Validate" and "Apply"

Read Zuora Data

In the form that opens after validating and applying the connection, configure your query.

• Set Schema name to "Zuora"
• Set Table name to a table for Zuora using the schema name, for example: "Zuora"."Invoices" (use the drop-down to see the full list of available tables)
• Add Output fields for each item you wish to work with from the table

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

Once you confirm the results are what you expect, you can add additional snaps to funnel your Zuora data to another endpoint.

Piping Zuora Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
2. Add an account to connect to Google Sheets
3. Configure the Worksheet Writer snap to write your Zuora data to a Google Spreadsheet

You can now execute the fully configured pipeline to extract data from Zuora and push it into a Google Spreadsheet.

More Information & Free Trial

Using the CData JDBC Driver for Zuora you can create a pipeline in SnapLogic for integrating Zuora data with external services. For more information about connecting to Zuora, check at our CData JDBC Driver for Zuora page. Download a free, 30 day trial of the CData JDBC Driver for Zuora and get started today.