Build Zuora-Connected Web Apps in Servoy

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for Zuora, users can build Zuora-connected apps that work with live Zuora data. This article describes how to connect to Zuora from Servoy and build a simple web app to display and search 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 lets you work with Zuora data using native data types.

Connect to Zuora in Servoy Developer

To build Zuora-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for Zuora.

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.zuora.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
3. Open Servoy Developer.
4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
   1. Name the server.
   2. Click to show the advanced server settings.

      • Set the URL, for example: jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH

        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.
      • Select the Driver class you just copied, for example, cdata.jdbc.zuora.ZuoraDriver

Build a Zuora-Connected Web App

Once you have configured the connection to Zuora in the Servoy Developer resources, you are ready to build apps with access to live Zuora data.

Create a New Solution

1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
2. Name the solution.
3. Select the checkbox to include the "search" module.
4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

1. Name the form.
2. Select a Datasource.
3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.

2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the Zuora "table" (e.g., Id from the Invoices table).

   Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

1. Drag a Text Field component onto the Form.
2. Right-click the Form and select "Open in Script Editor."
3. Create a new variable (JavaScript) to hold the search value:

   var searchText = '';
   

4. Back on the Form, in the Text Field properties:
   1. Set the "dataprovider" property to the Form variable you just created.
   2. Double-click to add a method for the onAction event.
   3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
   4. Click "OK & Show."
5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData JDBC Driver for Zuora and start building Zuora-connected apps with Servoy. Reach out to our Support Team if you have any questions.