Ready to get started?

Download a free trial of the Zuora ODBC Driver to get started:

 Download Now

Learn more:

Zuora Icon Zuora ODBC Driver

The Zuora ODBC Driver is a powerful tool that allows you to connect with live data from Zuora, directly from any applications that support ODBC connectivity.

Access Zuora data like you would a database - read, write, and update Zuora. through a standard ODBC Driver interface.

Import Zuora Data into FileMaker Pro



Create reports that integrate Zuora data in Filemaker Pro.

One of the strengths of the CData ODBC driver is its ubiquitous support across many applications and platforms. In this article, you will configure the ODBC driver in FileMaker Pro and create data visualizations with Zuora data.

Query Zuora Data in FileMaker Pro

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. See the "Getting Started" chapter of the help documentation for a guide to creating a DSN on Windows or Unix-based systems like Mac OS X and Linux.

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.

When you configure the DSN, 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.

You can then load Zuora data into tables in Filemaker Pro:

  1. In your solution, click File -> Import Records -> ODBC Data Source, and select the CData Zuora DSN.
  2. In the resulting SQL Query Builder wizard, select tables and columns and then click Insert into SQL Query. You can edit this query directly. For example:

    SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'

    You can use the UI to build filters in the WHERE clause by clicking the WHERE tab.

  3. In the resulting Import Field Mapping wizard, you can define mappings from columns in the data source to the columns in a destination table. To create a new table for the query results, select New Table ("CData Zuora Source") from the Target box, and click Import.

For more information on the SQL that the driver supports out of the box, see the help documentation.

Process Data at Design Time

You can sort and aggregate data, as well as calculate summary functions, while you browse tables. To manipulate the view of data at design time, first complete the two steps below:

  1. Switch to Browse mode: Click the Mode pop-up menu in the footer of the application.
  2. Switch to Table view: Click the table icon in the View As menu in the main toolbar of the application.

Aggregate and Summarize

Follow the procedure below to group column values and then display a summary, as shown in the screenshot below:

  1. Sort: Click the arrow in the Id column header and then click Sort Ascending in the resulting menu.
  2. Group: In the menu for the Id column click Add Trailing Group by Id to group the values and create a subsequent row where summary calculations can be inserted. Click Add Leading Group to introduce the group with a summary.
  3. Summarize: In the menu for a column that has been grouped, select a summary from the Trailing Subtotals menu.

the procedure below to create a simple bar chart that shows the total BillingCity for each Id.

  1. Click the arrow in the BillingCity column header and click "Chart by BillingCity" in the menu. If you have already grouped on a column in the Table view, Id, for example, you can select the option to chart BillingCity by Id.
  2. In the Chart Setup window, select columns to draw the chart: To add the column for the x-axis, click the button next to the Data box.

Selecting the x-axis and y-axis will draw the chart. You can also process data in the Chart Setup: Set the following options to create a basic chart.

  1. Click the button next to the Data box and select Specify Field Value. Select a column in the resulting dialog.
  2. Select a summary for the y-axis in the Summary menu.