Build AI/ML Models with Live Zuora Data using Dataiku

Dataiku is a data science and machine learning platform used for data preparation, analysis, visualization, and AI/ML model deployment, enabling collaborative and efficient data-driven decision-making. When paired with the CData JDBC Driver for Zuora, Dataiku enhances data integration, preparation, real-time analysis, and reliable model deployment for Zuora data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Zuora data. When you issue complex SQL queries to Zuora, the driver pushes supported SQL operations, like filters and aggregations, directly to Zuora and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Zuora data using native data types.

This article shows how you can easily integrate to Zuora using CData JDBC Driver for Zuora in Dataiku DSS (Data Science Studio) platform, allowing you to prepare the data and build custom AI/ML models.

Preparing the Dataiku DSS environment

In this section, we will explore how to set up Dataiku, as previously introduced, with Zuora data. Be sure to install Dataiku DSS (On-Prem version) for your preferred operating system, beforehand.

Install the CData JDBC Driver for Zuora

First, install the CData JDBC Driver for Zuora on the same machine as Dataiku. The JDBC Driver will be installed in the following path:

Connecting the JDBC Driver in Dataiku DSS

To use the CData JDBC driver in Dataiku, you must create a new SQL database connection and add the JDBC Driver JAR file in the DSS connection settings.

1. Log into Dataiku DSS platform. It should open locally in your browser (e.g. localhost:11200)
2. Click on Navigate to other sections of Dataiku menu on the top right section of the platform and select Administration.
3. Select the Connections tab.
4. In Connections, click on New Connections button.
5. Now, scroll down and select Other SQL databases.

6. Generate a JDBC URL for connecting to Zuora, beginning with jdbc:zuora: followed by a series of semicolon-separated connection string 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.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Zuora JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.zuora.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   A typical JDBC URL is given below:

   jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH
7. On the New SQL database (JDBC) connection screen, enter a name in the New connection name field and specify the basic parameters:
   • JDBC Driver Class: cdata.jdbc.zuora.ZuoraDriver
   • JDBC URL: JDBC connection URL obtained in the previous step
   • Driver jars directory: the folder path where the JAR file is installed on your system

   Next, select the SQL dialect of your choice. Here, we have selected 'SQL Server' as the preferred dialect. Click on Create. If the connection is successful, a prompt will display, saying 'Connection OK'.

8. The Data Catalog window will appear. Select the desired connection, catalog, and schema from the Connection to browse, Restrict to catalog, and Restrict to schema dropdowns, then click on List Tables. The Dataiku platform will list all the required tables.
9. Select any table from the list and click Preview to view the table data. Click Close to exit the window.

Creating a new project

To prepare data flows, create dashboards, analyze the Zuora data, and build AI and ML models in the Dataiku DSS platform, you need to first create a new project.

1. Select Projects from the Navigate to other sections of Dataiku menu.
2. In the Projects screen, click New Project and select + Blank Project.
3. In the New Project window, assign a Name and Project Key. Click Create. The new project dashboard opens up.
4. Select Notebooks from the menu at the top of the project screen.
5. Click on + Create Your First Notebook dropdown menu and select Write your own option.
6. In the New Notebook window, select SQL.
7. Now, select the required connection from the Connection dropdown and enter a name in the Notebook Name field.

Testing the connection

To test the Zuora connection and analyze the Zuora data, write a query in the query compiler and click Run. The queried/filtered Zuora data results will then appear on the screen.

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for Zuora to integrate with Dataiku, and effortlessly build custom AI/ML models from Zuora data.

Reach out to our Support Team if you have any questions.