Establishing a Connection
Configure a Connection Profile
From the CData ribbon, click Get Data and select From Zuora connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Zuora Connection button. Here you can set the connection settings, test the connection, and save the connection profile.
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.
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.
Connection Properties
The Connection properties describe the various options that can be used to establish a connection.
Managing Connections
After successfully authenticating to Zuora you will be able to customize the data you are importing. To learn more about this, see Managing Connections.
See Also
- Querying Data: Use the data selection wizard to pull data into a spreadsheet. You can also configure scheduled data refresh here.
- Using the Excel Add-In: Find other ways to interact with Zuora data, such as using the available CData Excel Functions.