Access Live Zuora Data in TIBCO Data Virtualization

TIBCO Data Virtualization (TDV) is an enterprise data virtualization solution that orchestrates access to multiple and varied data sources. When paired with the Zuora Tibco DV Adapter, you get federated access to live Zuora data directly within TIBCO Data Virtualization. This article explains how to deploy an adapter and create a new data source based on Zuora.

With built-in optimized data processing, the CData TIBCO DV Adapter offers unmatched performance for interacting with live Zuora data. When you issue complex SQL queries to Zuora, the adapter pushes supported SQL operations, like filters and aggregations, directly to Zuora. Its built-in dynamic metadata querying allows you to work with and analyze Zuora data using native data types.

Deploy the Zuora TIBCO DV Adapter

1. In a console, navigate to the bin folder in the TDV Server installation directory. If there is a current version of the adapter installed, you will need to undeploy it.

   .\server_util.bat -server localhost -user admin -password ******** -undeploy -version 1 -name Zuora
   

2. Extract the CData TIBCO DV Adapter to a local folder and deploy the JAR file (tdv.zuora.jar) to the server from the extract location.

   .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.zuora.jar
   

You may need to restart the server to ensure the new JAR file is loaded properly, which can be accomplished by running the composite.bat script located at: C:\Program Files\TIBCO\TDV Server <version>\bin. Note that reauthenticating to the TDV Studio is required after restarting the server.

Sample Restart Call

.\composite.bat monitor restart

Authenticate with Zuora Using OAuth

Since Zuora authenticates using the OAuth protocol and TDV Studio does not support browser-based authentication internally, you will need to create and run a simple Java application to retrieve the OAuth tokens. Once retrieved, the tokens are used to connect to Zuora directly from the adapter.

Create the Java Application

1. Create a new Java file with preferred name for example GenOAuthSettings.java. This Java file leverages the ZuoraOAuth class contained within the TDV Adapter JAR to initiate a test connection and perform the required OAuth authentication flow
2. Copy and insert the following code into the .java file:

public class GenOAuthSettings {
 public static void main(String[] args) {
 try {
 	 if (args.length != 2) {
 			throw new Exception("Input must have two arguments: 'data source', 'connection string'");
 		}
 
 		String source = args[0].replace(" ", "").toLowerCase();
 		String connectionString = args[1];
 		String prefix;
 
 		if (source.equals("zuora")) {
 			prefix = "jdbc:zuora:";
 
 			com.cdata.cis.zuora.ZuoraOAuth oauth = new com.cdata.cis.zuora.ZuoraOAuth();
 
 			if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
 			oauth.generateOAuthSettingsFile(connectionString);
 		}
 		// More sources can be added below using the same format. You must add the import statement and ensure the jar file resides in the classpath
			// else if (source.equals("googlebigquery") || source.equals("bigquery")) {
			// prefix = "jdbc:googlebigquery:";
			//
			// com.cdata.cis.googlebigquery.GoogleBigQueryOAuth oauth = new com.cdata.cis.googlebigquery.GoogleBigQueryOAuth();
			//
			// if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
			// oauth.generateOAuthSettingsFile(connectionString);
			// }
 		else {
				throw new Exception("Data Source not supported. Available Data Sources: Zuora");
			}
			
			System.out.println("Test Connection Successful!");
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

3. Place the .java file in the same directory as the tdv.zuora.jar file. This is required to prevent classpath resolution errors during compilation and execution

Build and run the Java Application

1. Open Console and navigate to the directory containing the .java file and adapter jar
2. Compile the Java file using the following command:

javac -cp .;tdv.zuora.jar GenOAuthSettings.java

3. Execute the application using one of the following commands:

java -cp .;tdv.zuora.jar GenOAuthSettings "Zuora" "connection string"

This command initiates the OAuth authentication flow and generates the OAuth settings file at the location specified in the OAuthSettingsLocation parameter. Once you deploy the adapter and authenticate, you can create a new data source for Zuora in TDV Studio.

Create a Zuora Data Source in TDV Studio

With the Zuora Tibco DV Adapter, you can easily create a data source for Zuora and introspect the data source to add resources to TDV.

Create the Data Source

1. Right-click on the folder you wish to add the data source to and select New -> New Data Source
2. Scroll until you find the adapter (e.g. Zuora) and click Next
3. Name the data source (e.g. CData Zuora Source)
4. Fill in the required connection properties

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.

NOTE: Ensure that the OAuthSettingsLocation property in the DV Adapter is set to the same file path used during the OAuth authentication process. Additionally, set the InitiateOAuth property to REFRESH so that the adapter can automatically handle OAuth access-token refreshes in the background without requiring any user action.

👁 Filling in Connection Information (Salesforce is shown.)

5. Click Create & Close.

Introspect the Data Source

Once the data source is created, you can introspect the data source by right-clicking and selecting Open. In the dashboard, click Add/Remove Resources and select the Tables, Views, and Stored Procedures to include as part of the data source. Click Next and Finish to add the selected Zuora tables, views, and stored procedures as resources.

After creating and introspecting the data source, you are ready to work with Zuora data in TIBCO Data Virtualization just like you would any other relational data source. You can create views, query using SQL, publish the data source, and more.