Analyze Zuora Data in Infragistics Reveal

Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Zuora data. The CData API Server generates an OData API for Zuora, which is natively consumable in Reveal. In this article, we walk through connecting to Zuora in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to Zuora from API Server

CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Open API Server and click Settings -> Connection -> Add Connection
2. Select "Zuora"
3. Enter the necessary authentication properties to connect to Zuora.

   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.
   

Add Zuora Resource Definitions in API Server

After connecting to Zuora, create Resources, which represent API endpoints for Zuora data.

1. Click Settings -> Resources -> Add Resource
2. Select the Zuora connection
3. Select the table you wish to retrieve and click Next
4. (Optional) Edit the resource to select specific fields and more
5. Save the settings

Add an API Server User

Create a User to connect to Zuora from Reveal through API Server.

1. Click Settings -> Users
2. Click Add
3. Configure a User with access to the Zuora Connection and Resource(s)

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.

• Enable cross-origin resource sharing (CORS): ON
• Allow all domains without '*': ON
• Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
• Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Create a Dashboard in Reveal

With the API Server configured, we can visualize Zuora data in Reveal.

1. Log into Reveal and click Dashboards -> New
2. Click Data Source -> OData Feed
3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
4. Select Generic Credentials and specify the API Server username and authentication token
5. Select the entity you wish to visualize
6. Select fields and choose a chart type

More Information & Free Trial

At this point, you have created a simple dashboard from live Zuora data. For more information on creating OData feeds from Zuora (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Zuora data in tools that consume OData APIs.