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.

Create an SAP BusinessObjects Universe on the CData ODBC Driver for Zuora



Provide connectivity to Zuora data through an SAP BusinessObjects universe.

This article shows how to create and publish an SAP BusinessObjects universe on the CData ODBC Driver for Zuora. You will connect to Zuora data from the Information Design Tool as well as the Web Intelligence tool.

Connect to Zuora as an ODBC Data Source

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. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Create an ODBC Connection to Zuora Data

This section shows how to create a connection to the Zuora ODBC data source in the Information Design Tool. After you create a connection, you can analyze data or create a BusinessObjects universe.

  1. Right-click your project and click New -> New Relational Connection.

  2. In the wizard that is displayed, enter a name for the connection.
  3. Select Generic -> Generic ODBC datasource -> ODBC Drivers and select the DSN.

  4. Finish the wizard with the default values for connection pooling and custom parameters.

Analyze Zuora Data in the Information Design Tool

In the Information Design Tool, you can use both published and local ODBC connections to browse and query data.

  1. In the Local Projects view, double-click the connection (the .cnx file) to open the Zuora data source.

  2. On the Show Values tab, you can load table data and enter SQL queries. To view table data, expand the node for the table, right-click the table, and click Show Values. Values will be displayed in the Raw Data tab.

  3. On the Analysis tab, you can drag and drop columns onto the axes of a chart.

Publish the Local Connection

To publish the universe to the CMS, you additionally need to publish the connection.

  1. In the Local Projects view, right-click the connection and click Publish Connection to a Repository.

  2. Enter the host and port of the repository and connection credentials.

  3. Select the folder where the connection will be published.

  4. In the success dialog that results, click Yes to create a connection shortcut.

Create a Universe on the ODBC Driver for Zuora

You can follow the steps below to create a universe on the ODBC driver for Zuora. The universe in this example will be published to a repository, so it uses the published connection created in the previous step.

  1. In the Information Design Tool, click File->New Universe.

  2. Select your project.

  3. Select the option to create the universe on a relational data source.

  4. Select the shortcut to the published connection.

  5. Enter a name for the Data Foundation.

  6. Import tables and columns that you want to access as objects.

  7. Enter a name for the Business Layer.

Publish the Universe

You can follow the steps below to publish the universe to the CMS.

  1. In the Local Projects view, right-click the business layer and click Publish -> To a Repository.

  2. In the Publish Universe dialog, enter any integrity checks before importing.

  3. Select or create a folder on the repository where the universe will be published.

Query Zuora Data in Web Intelligence

You can use the published universe to connect to Zuora in Web Intelligence.

  1. Open Web Intelligence from the BusinessObjects launchpad and create a new document.

  2. Select the Universe option for the data source.

  3. Select the Zuora universe. This opens a Query Panel. Drag objects to the Result Objects pane to use them in the query.