This section describes how to edit the DSN configuration and then authenticate and connect to Zuora APIs.

DSN Configuration

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the installation process creates a both a user DSN and a system DSN, as described in Installing the Connector.

Note: The connector stores connection information in the Windows registry. To ensure that the connector can write to the registry, either run Power BI as an administrator or use a User DSN for your connection instead of a System DSN.

User DSN

Complete the following steps to edit the DSN configuration:

1. Select Start > Search, and enter ODBC Data Sources in the Search box.
2. Choose the version of the ODBC Administrator that corresponds to the bitness of your Power BI Desktop installation (32-bit or 64-bit).
3. Select the system data source and click Configure.
4. Edit the information on the Connection tab and click OK.

System DSN

Configure the system DSN the same way as the user DSN, except you will need to switch to the System DSN tab before performing Step 3.

If you're using Power BI's On-Premises Data Gateway with Standard mode, you must use the system DSN.

You must also specify a valid location for OAuthSettingsLocation (a path where OAuth credentials are locally stored to avoid repeated OAuth prompts).

This is because the Standard mode runs on service mode and can only access permitted locations, such as C:\Windows\ServiceProfiles\PBIEgwService\AppData\Local\Microsoft\On-premises data gateway.

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.

When you connect, the connector opens Zuora's OAuth endpoint in your default browser.

Log in and grant permissions to the application.

Headless Machines

If you need to authenticate via OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

• Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
• Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Do the following:

1. Set the following properties:
   • InitiateOAuth: OFF.
   • OAuthClientId: the client Id assigned when you registered your application.
   • OAuthClientSecret: the client secret assigned when you registered your application.
2. Log in and grant permissions to the connector. You are redirected to the redirect URI.
3. Record the code parameter that is appended to the redirect URI. You will use it later, when you set up the OAuthVerifier connection property.
4. To exchange the OAuth verifier code for OAuth refresh and access tokens, set the following connection properties, which provide the OAuth authentication values:
   • InitiateOAuth: REFRESH.
   • OAuthVerifier: the noted verifier code (the value of the code parameter in the redirect URI).
   • OAuthClientId: the client Id in your custom OAuth application settings.
   • OAuthClientSecret: the client secret in the custom OAuth application settings.
   • OAuthSettingsLocation: persist the encrypted OAuth authentication values to the specified file.
5. Test the connection to generate the OAuth settings file, then re-set the following properties to connect:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: the client Id assigned when you registered your application.
   • OAuthClientSecret: the client secret assigned when you registered your application.
   • OAuthSettingsLocation: the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Before connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as previously described above, in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is "OAuthSettings.txt".

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set the following connection properties:

• InitiateOAuth: REFRESH.
• OAuthClientId: the client Id assigned when you registered your application.
• OAuthClientSecret: the client secret assigned when you registered your application.
• OAuthSettingsLocation: the path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the connector.

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.