Create Zuora-Connected Dashboards in Grafana

Grafana is an open-source platform that allows users to analyze, monitor, and visualize telemetry from various data sources. When combined with CData Connect AI, you gain immediate access to Zuora data for business dashboards. This article outlines the process of connecting to Zuora using Connect AI and creating a basic dashboard from Zuora data within Grafana.

CData Connect AI offers a pure SQL Server, cloud-to-cloud interface for Zuora, enabling the creation of dashboards directly from live Zuora data within Grafana, all without the need for data replication to a native database. As you build visualizations, Grafana generates SQL queries to gather data. With its inherent optimized data processing capabilities, CData Connect AI efficiently channels all supported SQL operations, including filters and JOINs, directly to Zuora. This leverages server-side processing to swiftly deliver the requested Zuora data.

Configure Zuora Connectivity for Grafana

Connectivity to Zuora from Grafana is made possible through CData Connect AI. To work with Zuora data from Grafana, we start by creating and configuring a Zuora connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "Zuora" from the Add Connection panel
👁 Selecting a data source

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.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Zuora Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Zuora data from Grafana.

Visualize Live Zuora Data in Grafana

To establish a connection from Grafana to the CData Connect AI Virtual SQL Server API, follow these steps.

1. If you have not already done so, download and install Grafana for your operating system from the Grafana Website. Once installed, access Grafana at http://localhost:3000/.
2. Log in to Grafana with your username and password for Grafana. If this is your first time logging in, the username is admin and the password is admin.
3. On the navigation menu, click Sources > Add new connection. On this page, you can search for Microsoft SQL Server and select it as your data source. 👁 Adding a new Connection in Grafana
   
4. Select Microsoft SQL Server and click Add new data source. 👁 Adding a new Connection in Grafana
   
5. Enter a name for the new data source and then enter the following connection settings:
   • Host: tds.cdata.com:14333
   • Database: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Zuora1).
   • Username: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
   • Password: enter the PAT you previously generated.
   👁 Configure connection to the Connect AI Virtual SQL Server API. (Salesforce shown)
   
6. Click Save & Test. A Database Connect OK message appears when you have a successful connection established.

Create a Dashboard

Once you create the data source for Zuora, you can start building dashboards on Zuora data. Start in the navigation menu and click Dashboards

1. On the Dashboards page, click + Create dashboard, then click + Add visualization.
2. This opens the Select data source window where you can select your created connection. 👁 Select your connection. (Salesforce shown)
   
3. After selecting your connection, you can choose the tables and columns that you want to query for your visualization. Then press Run Query to run the generated query. 👁 Select the tables and columns you want to query. (Salesforce shown)
   
4. After running your query, the resulting data is populated above the query editor. Here you can select the visualization that you want to use to present your data on the dashboard panel. 👁 Visualize your queried data. (Salesforce shown)
   
5. When you have finished editing your panel, you can click Save dashboard to save the changes made to your Dashboard.

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!