Create Reports with Zuora Data in SAP Crystal Reports

Crystal Reports has many options for offloading data processing to remote data; this enables real-time reporting. The CData ODBC Driver for Zuora brings this capability to Crystal Reports. This article shows how to create a report on Zuora data that refreshes when you run the report.

Refer to the given table for the tools and versions used for this article:

Connect to Zuora Data

If you have not already, specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

• 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:

• 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.

When configuring the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Design a Report in SAP Crystal Reports

Follow the procedure below to use the SAP Crystal Reports tool to create the Zuora connection and Design a Report.

1. File -> New -> Standard Report.
2. Expand the ODBC (RDO) node under Create New Connection and double-click on "Make a New Connection". Select CData Zuora Sys or any other source to prepare the report. Click on NEXT and FINISH.
3. Configure the data source by selecting the tables needed in the report and clicking NEXT.
4. You can also link tables from the Zuora data in SAP Crystal Reports. Click on NEXT after adding the links between tables.
5. After the tables are selected, select the fields you want displayed in the report from the selected table, followed by NEXT.
6. Select the "Group By" field to group the information on the report.
7. Sort the groups based on summarised totals and click on NEXT.

Create a Chart

After selecting a column to group by, the Standard Report Creation Wizard presents the option to create a chart. Follow the steps below to create a chart aggregating the Id column's values.

1. In the Standard Report Creation Wizard, select the Bar Chart option and select the column you grouped by in the "On change of" menu.
2. In the Show Summary menu, select the summary you created.
3. Select filters and a template, as needed, to finish the wizard.

Select a template for the report to preview the finished report and view the chart populated with your data.

The Final Report

You can now see that the report contains all the fields specified.

Working with Remote Data

To ensure that you see updates to data, click File and clear the "Save Data with Report" option. As you interact with the report, for example, drilling down to hidden details, Crystal Reports executes SQL queries to retrieve the data needed to display the report. To reload data you have already retrieved, refresh or rerun the report.

You can offload processing onto the driver by hiding details elements and enabling server-side grouping. To do this, you need to select a column to group by in the report creation wizard.

1. Click File -> Report Options and select the "Perform Grouping On Server" option.
2. Click Report -> Section Expert and select the Details section of your report. Select the "Hide (Drill-Down OK)" option.

When you preview your report with the hidden details, Crystal Reports executes a GROUP BY query. When you double-click a column in the chart to drill down to details, Crystal Reports executes a SELECT WHERE query that decreases load times by retrieving only the data needed.

At this point, you have created a SAP Crystal report built on top of live Zuora data using SAP Crystal Reports and CData ODBC Driver. Learn more about the CData ODBC Driver for Zuora and download a free trial from the CData ODBC Driver for Zuora page. Let our Support Team know if you have any questions.