Configuring a Connection
After Installing the Connector you can connect and create a Data Source for data in Zuora.
Setting Up a Data Source
Complete the following steps to connect to the data:
- Under Connect | To a Server, click More....
- Select the data source called Zuora by CData.
- Enter the information required for the connection.
- Click Sign In.
- If necessary, select a Database and Schema to discover what tables and views are available.
Using the Connection Builder
The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.
There are two ways to access the connection builder:
- On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for Zuora folder.
- You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.
In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.
Connecting to Zuora
In order to create a valid connection with Zuora, you must configure the Tenant property. Choose the Tenant value that matches your account configuration. Available options:- USProduction: Requests sent to https://rest.zuora.com. (default)
- 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"
After you configure the Tenant you must create a custom OAuth application to generate a token. This is a simple one-time operation. For further information, see Creating a Custom OAuth Application.
Authenticating to Zuora
Desktop Applications
To authenticate with the credentials for a custom OAuth application, you must create a custom application to get and refresh the OAuth access token. After you do that, you are ready to connect.Set the following connection properties:
- OAuthClientId: the client Id assigned when you registered your application.
- OAuthClientSecret: the client secret that was assigned when you registered your application.
- CallbackURL: the redirect URI that was defined when you registered your application.
Log in and grant permissions to the application. The connector then completes the OAuth process:
- The connector obtains an access token from Zuora and uses it to request data.
- The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.
- When the access token expires, the connector refreshes the access token automatically.
Selecting a Zuora Service
We utilize two Zuora services: 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
Selecting a Zuora Service
We utilize two Zuora services: 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.
Next Step
See Using the Connector to create data visualizations.