Publish and Share Zuora Data Dashboards with Tableau Server

Ready to get started?

Download for a free trial:

Download Now

Learn more:

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.



The CData ODBC driver for Zuora enables you integrate Zuora data into Tableau dashboards.

Integrate connectivity to Zuora data into your enterprise reporting capabilities. The CData ODBC Driver for Zuora enables you to access live Zuora data in business intelligence tools like Tableau Server. Connectivity to Zuora APIs enables you to monitor changes to your data in real time. Other members of your organization can access your dashboards from a Web browser and get updates from their mobile phone.

This article walks through the process of configuring a DSN on the client and server machines, publishing a data source for Zuora to Tableau Server, and publishing an entire Workbook to Tableau Server (including the data source). If you publish a data source, you will be able to create new, refreshable workbooks in Tableau Server.

Connect to Zuora as an ODBC Data Source

To create a data source or workbook in Tableau Desktop and publish the data source or workbook to Tableau server, you will need to configure a DSN on each machine (Desktop and Server), specifying connection properties and creating DSNs using the same name on each machine. Information for connecting to Zuora follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

If you are installing the CData ODBC Driver for Zuora on Windows, DSN configuration is the last step of the driver installation. If you already have the driver installed, or you wish to configure new DSNs, you can use the Microsoft ODBC Data Source Administrator.

Linux

If you are installing the CData ODBC Driver for Zuora in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData Zuora Source] Driver = CData ODBC Driver for Zuora Description = My Description OAuthClientID = MyOAuthClientId OAuthClientSecret = MyOAuthClientSecret Tenant = USProduction ZuoraService = DataQuery

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Publish the Zuora Data Source to Tableau Server

With the connections to Zuora data configured, you are ready to publish a Zuora data source on Tableau, ready to be leveraged by users in your organization to create workbooks based on Zuora data.

Create and Publish a Data Source

  1. In the Connect pane, click More -> Other Databases (ODBC). Select CData Zuora Sys, the system DSN.

    The driver installation automatically creates matching user and system DSNs: The system DSN is needed to connect from Tableau Server.

  2. In the Database menu, select CData.
  3. In the Table box, enter a table name or click New Custom SQL to enter an SQL query.
  4. Drag the table onto the join area.
  5. From the Server menu, click Publish Data Source -> (YOUR DATA SOURCE).
  6. Enter the URL to the server. For most instances, you will authenticate with the Tableau Server username and password. Other authentication scenarios can be found below:
    • If Tableau is configured to use Kerberos and your computer has valid Active Directory credentials, Tableau connects to the server.
    • If Tableau is configured to use SAML, a login prompt for your external identity provider is displayed.
    • If Tableau is configured to use Active Directory, enter your Windows username and password.
  7. In the resulting dialog, set the Project, Data Source, and other properties. If you want to schedule refreshes, select Embedded Password in the Authentication menu. Click Publish.

You and other users in your organization can now create and share workbooks based on the published data source.

Refresh Workbooks

With a system DSN configured on the client (Tableau Desktop) machine and server (Tableau Server) machine, you can refresh workbooks connected to the Zuora data source. From the Web interface for Tableau Sever, click Data -> (YOUR DATA SOURCE) -> Refresh.

Publish a Completed Workbook with Zuora Data to Tableau Server

If you have a specific Workbook that you wish to share with your organization, you can create the Workbook on Tableau Desktop and publish the Workbook directly to Tableau Server.

  1. To connect to Zuora and select data, follow steps 1-5 above.
  2. Click Server -> Sign in and configure the connection to the server. For most instances, you will authenticate with the Tableau Server username and password. Other authentication scenarios can be found below:
    • If Tableau is configured to use Kerberos and your computer has valid Active Directory credentials, Tableau connects to the server.
    • If Tableau is configured to use SAML, a login prompt for your external identity provider is displayed.
    • If Tableau is configured to use Active Directory, enter your Windows username and password.
  3. With the data selected, select dimensions and measures to visualize and select a type of chart or graph to build your visualization(s).
  4. Once the Workbook is complete, click Server -> Publish Workbook to publish the Workbook to Tableau Server.
  5. In the resulting dialog, set the Project, Name, Description and other properties. If you want to schedule refreshes, click Edit under Data Sources and change the Authentication option to Embedded Password. Click Publish.

You and other users in your organization can now review the published workbook from Tableau Server.