VOOZH about

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

⇱ Connect to Zuora Data from Crystal Reports

Connect to Zuora Data from Crystal Reports

👁 Mohsin Turki
Mohsin Turki
Technical Marketing Engineer
Use CData Connect AI to connect to and report on live Zuora data from Crystal Reports.

Crystal Reports is a business intelligence application by SAP designed to help you analyze your data with well-formatted, pixel-perfect, and multi-page reports. When paired with CData Connect AI, Crystal Reports gets access to live Zuora data. This article demonstrates how to connect to Zuora using Connect AI and report on Zuora data in Crystal Reports.

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 Crystal Reports

Connectivity to Zuora from Crystal Reports is made possible through CData Connect AI. To work with Zuora data from Crystal Reports, 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
  2. Select "Zuora" from the Add Connection panel
    3. 👁 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 Crystal Reports.

Connect to Zuora from Crystal Reports using Connect AI

To establish a connection from Crystal Reports to CData Connect AI, you will need to download the JDBC driver.

  1. Open the Client Tools page of CData Connect AI.
  2. Search for and select JDBC.
  3. Download and run the setup file.
  4. When the installation is complete, locate the JDBC Connect JAR file in the JDBC driver's installation directory, for example, C:\Program Files\CData\JDBC Driver for CData Connect\lib.
  5. Copy the JDBC Connect JAR file (cdata.jdbc.connect.jar).

After copying the JDBC CData Connect JAR file, you will need to paste it into the Crystal Reports installation location and configure the connection to Connect AI.

  1. Find the installation directory for Crystal Reports, for example, C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java\lib
  2. Paste the JDBC Connect JAR file into the Crystal Reports installation directory.
  3. Go to the parent java folder. For example, C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java This folder should contain a CRConfig file. 👁 Locating the CRConfig file in the Crystal Reports installation directory.
  4. Open CRConfig in a text editor.
  5. Add the path to the JDBC CData Connect JAR file in the
  6. Log into Crystal Reports and start a blank report.
  7. In the Database Expert dialog, click Create New Connection.
  8. Select the JDBC data source and the tables you want to add. Click OK. 👁 Selecting the JDBC data source.
  9. In the Connection dialog, enter the Connection URL (e.g. jdbc:connect:AuthScheme=Basic;user=username;password=PAT;) and Database Classname (e.g. cdata.jdbc.connect.ConnectDriver). 👁 Configuring the connection.
  10. Click Finish. The Database Expert dialog displays all available connections. 👁 Browsing the available data from Connect AI.

You can now create reports with the connected data.

Get CData Connect AI

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