Connect Zuora to IBM WebSphere Using the CData JDBC Driver

IBM WebSphere is a powerful application server that runs many enterprise level Java applications and services. When paired with the CData JDBC Driver for Zuora, IBM WebSphere applications can connect to Zuora and work with data using standard SQL queries instead of complex APIs. This simplifies integration, reduces development effort, and provides secure, real-time access to critical business data.

Prerequisites

1. Access to a Zuora account (with API permissions)
2. IBM WebSphere Application Server (configured and running)
3. CData JDBC Driver for Zuora
4. Java Servlet WAR application ready for deployment

Note: This article uses Salesforce as a demonstration data source, but the same steps can be followed to connect to any of the 250+ JDBC Drivers available in our portfolio.

Getting Started

Step 1: Download and install the CData JDBC Driver for Zuora

Download and install the CData JDBC Driver for Zuora, which provides a .jar file: cdata.jdbc.zuora.jar

Step 2: Install and configure IBM Websphere

1. Create an account in IBM WebSphere using the official IBM site.
2. Install and configure the IBM Websphere Application server in the local system using the documentation: IBM Websphere Application Server
3. Once the application server is installed, start the WebSphere Server using the Admin Console in your browser: https://your-server:9043/ibm/console

Step 3: Set up the JDBC provider and data source for Zuora

1. Go to Resources, expand the JDBC section, and then select JDBC providers to create a new provider

2. Select the appropriate scope from the drop down menu

3. Click New to add a JDBC provider
• Choose User defined as the database type
• Enter cdata.jdbc.zuora.ZuoraConnectionPoolDataSource as the implementation class name
• Type a name for the provider, for example User defined JDBC Provider
• Enter the full path of the JDBC driver JAR file in the classpath field
• Click Next, then Finish, and save the changes to the master configuration.

4. Once the JDBC provider is created, add a JDBC data source.
• Enter the basic details such as Data Source Name and JNDI name
• Select the existing JDBC provider created earlier (e.g., CData Zuora Provider)
• Provide the Implementation class name: cdata.jdbc.zuora.ZuoraConnectionPoolDataSource
• Add the Data Store Helper Class Name: com.ibm.websphere.rsadapter.GenericDataStoreHelper
• Configure security by setting authentication aliases if required
• Review the Summary page to verify all details and click Finish to complete the data source creation

5. Select the newly created data source from the list and open Custom properties
6. Add the JDBC connection string under the URL property and press OK. For example:

   jdbc:zuora:RTK=5246...;OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH;

   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.

   

   Note: If the URL property is not available, create it and then add the JDBC connection string.

   Tip: Always test the connection string with the driver before entering it in the URL property.
7. Now open the data source and choose Test Connection

Step 4: Build the web application

1. Build the web application using preferred Java framework (Servlet, JSP, or Spring). The resulting .war file will typically follow a structure like this:

		ZuoraServletApp.war
		|--webcontent
		|  |--index.jsp                 -- JSP page (entry point)
		|  |
		|  |--WEB-INF/                  --Hidden from direct browser access
		|     |--web.xml                 -- Deployment descriptor
		|     |
		|     |--classes/                  --Compiled .class files
		|       |--com/example/Zuora/
		|          |--ZuoraServlet.class
		|
		|--lib/                      --Dependency JARs
		|--cdata.jdbc.zuora.jar
	

2. Define the data access logic using JDBC or JPA, referencing the data source through a JNDI name
3. This article walks through JDBC connection setup and deploying a Java Servlet application
4. Package the project as a WAR (Web Application Archive) or EAR (Enterprise Archive) file for deployment
• In a terminal compile the java file using the command:

  			cd webcontent
  			jar cvf ..\ZuoraServletApp.war *
  		

Step 5: Deploy the Zuora application in WebSphere

1. In the WebSphere admin console, go to Applications and select Install New Application
2. Browse and upload the WAR file, then continue with the installation wizard.

Step 6: Retrieve Zuora data through WebSphere

1. Access the application using its context root: http://hostname:port/context-root/page
Note: Ensure the deployed application is started before opening it in the browser.

We can now view the retrieved data from the source. The data is accessible directly through IBM WebSphere. This setup demonstrates how a servlet can be deployed in WebSphere to retrieve Zuora data using the JDBC driver, creating a strong foundation for building advanced Zuora powered enterprise applications.

Get Started with Connecting Zuora to IBM WebSphere

Start connecting Zuora to IBM WebSphere with the CData JDBC Connector today. Download the free 30-day trial and explore how easy it is to enable secure, real-time data access for your applications. As always, our world-class Support Team is available to help with any questions you may have.