VOOZH about

URL: https://www.cdata.com/kb/tech/zuora-cloud-datapine.rst

⇱ Build Zuora-Connected Visualizations in datapine


Build Zuora-Connected Visualizations in datapine

πŸ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Use CData Connect AI and datapine to build visualizations and dashboards with access to live Zuora data.

datapine is a browser-based business intelligence platform. When paired with the CData Connect AI, you get access to your Zuora data directly from your datapine visualizations and dashboards. This article describes connecting to Zuora in CData Connect AI and building a simple Zuora-connected visualization in datapine.

CData Connect AI provides a pure SQL Server interface for Zuora, allowing you to query data from Zuora without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Zuora, leveraging server-side processing to return the requested Zuora data quickly.

Configure Zuora Connectivity for datapine

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

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "Zuora" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. 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)
  6. Click Save & Test
  7. 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 datapine.

Connecting to Zuora from datapine

Once you configure your connection to Zuora in Connect AI, you are ready to connect to Zuora from datapine.

  1. Log into datapine
  2. Click Connect to navigate to the "Connect" page
  3. Select MS SQL Server as the data source
  4. In the Integration step, fill in the connection properties and click "Save and Proceed"
    • Set the Internal Name
    • Set Database Name to the name of the connection we just configured (e.g. Zuora1)
    • Set Host / IP to "tds.cdata.com"
    • Set Username to your Connect AI username (e.g. [email protected])
    • Set Password to the corresponding PAT
    • Set Database Port to "14333"
    πŸ‘ Configuring the connection to CData Connect AI
  5. In the Data Schema step, select the tables and fields to visualize and click "Save and Proceed" πŸ‘ Selecting tables and fields to visualize (Salesforce is shown)
  6. In the References step, define any relationships between your selected tables and click "Save and Proceed" πŸ‘ Defining foreign key relationships
  7. In the Data Transfer step, click "Go to Analyzer"

Visualize Zuora Data in datapine

After connecting to CData Connect AI, you are ready to visualize your Zuora data in datapine. Simply select the dimensions and measures you wish to visualize!

πŸ‘ Visualizing data in datapine (Salesforce is shown)

Having connect to Zuora from datapine, you are now able to visualize and analyze real-time Zuora data no matter where you are. To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from datapine, try CData Connect AI today!