Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Bridge Zuora Connectivity with Apache NiFi
Access and process Zuora data in Apache NiFi using the CData JDBC Driver.
Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData JDBC Driver for Zuora, NiFi can work with live Zuora data. This article describes how to connect to and query Zuora data from an Apache NiFi Flow.
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.
Connecting to Zuora Data in Apache NiFi
- Download the CData JDBC Driver for Zuora installer, unzip the package, run the .exe file to install the driver.
Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.zuora.jar (and cdata.jdbc.zuora.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.
On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData JDBC Driver for Zuora.
Start Apache NiFi by running the run-nifi.bat file in bin subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\bin.
(OR)
Use the command prompt to navigate to the particular directory and run the run-nifi.bat file for example:
cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin .\run-nifi.bat
Navigate to the Apache NiFi UI in your web browser: It should be https://localhost:8443/nifi.
Note: If users are utilizing an older version of Apache NiFi, they should access it via http://localhost:8080/nifi. In earlier versions, HTTP was the protocol employed. However, in the most recent version, HTTPS is the standard. By default, HTTP operates on port 8080, while HTTPS uses port 8443.
When accessing Apache NiFi via a URL, it prompts you to enter a username and password for login.
To retrieve login credentials, users should consult the 'App.log' file located within the log directory of their NiFi installation. This file typically contains the necessary details for accessing the NiFi interface.
- Click the (Configuration) button from the Operate sidebar under the "NiFi Flow" process group.
- In the NiFi Flow Configuration page, navigate to the "Controller Services" tab.
- Click the button to create a new controller service.
- In the Add Controller Service page, select "DBCPConnectionPool", and then click Add.
- In the Configure Controller Service page, navigate to the "Properties" tab.
- Click the gear button to configure the new DBCPConnection Pool.
Fill in the properties:
Property Value Database Connection URL jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH Database Driver Class Name cdata.jdbc.zuora.ZuoraDriver Database Driver Location(s) Path to your Apache NiFi's lib folder where the JAR files are present. 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.
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.
- To establish a connection and execute a select query, simply drag and drop the processor (indicated by the yellow highlight) into the workspace.
- Select the 'ExecuteSQL' processor and click the 'Add' button to make it visible in the workspace.
- Click on the added processor (ExecuteSQL)to open the connection page.
- Click on the Verify Properties button and verify to test the connection.
- Ensure that all the verification results are successful, and then click on APPLY.
- Activate the connection by clicking the small button at the right corner of the screen.
Your Zuora data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor (shown below).
Download a free, 30-day trial of the CData JDBC Driver for Zuora and start working with your live Zuora data in Apache NiFi. Reach out to our Support Team if you have any questions.