Build Semantic Layer Views for Zuora Data in APOS Live Data Gateway

APOS Live Data Gateway (LDG) is a data connection and data transformation solution that enables live data connectivity and expanded data source options for SAP Analytics Cloud and other SAP solutions. When paired with CData Connectors, users can build semantic layer views for live Zuora data, enabling real-time analytics on Zuora just like working with a relational database.

With built-in optimized data processing, the CData Connector offers unmatched performance for interacting with live Zuora data. When you issue complex SQL queries to Zuora, the driver pushes supported SQL operations, like filters and aggregations, directly to Zuora and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Zuora data using native data types.

Download and Install the Connector Files

In order to access Zuora data through the APOS Live Data Gateway, you will need to download the connector files from APOS and install them on the machine hosting the Live Data Gateway. An APOS representative can deliver the necessary files.

• Install the CData DLL file (System.Data.CData.Zuora.dll) to the APOS Live Data Gateway installation directory (C:\Program Files\Live Data Gateway\Admin\ by default).
• Install the CData JAR file (cdata.jdbc.zuora.jar) to the ConnectionTest_lib folder in the installation directory (C:\Program Files\Live Data Gateway\Admin\ConnectionTest_lib\ by default).
• Install the CData JAR file (cdata.jdbc.zuora.jar) to the lib folder in the Web UI installation directory (e.g.: C:\LDG_WebUI\lib\)

Configuring the Zuora Connection String

Before establishing the connection to Zuora from the APOS Live Data Gateway, you need to configure the Zuora JDBC Connection String.

Built-in Connection String Designer

For assistance in constructing the JDBC Connection String, use the connection string designer built into the Zuora JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

Fill in the connection properties and copy the connection string to the clipboard.

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.

Your connection string will look similar to the following:

Connecting to Zuora & Creating a Semantic Layer View

After installing the connector files and configuring the connection string, you are ready to connect to Zuora in the Live Data Gateway Admin tool and build a semantic layer view in the Live Data Gateway Web UI.

Configuring the Connection to Zuora

1. Log into your APOS Live Data Gateway Manager
2. If you haven't already, update your APOS LDG license file
   1. Click File -> Configurations
   2. Click on the "..." Menu for the License
   3. Select the license file from the APOS team that includes your CData Connector license
3. In the APOS Live Data Gateway Manager, click "Add"
4. In the APOS Live Data Gateway On the Connection tab, configure the connection:
   • Set Data Source to "Database"
   • Set Database to "CData Drivers"
   • Set Database CData Drivers to "Zuora"
   • Set Connection String to the connection string configured earlier (e.g.: jdbc:Zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;
   • Set Driver Class to "cdata.jdbc.zuora.ZuoraDriver" (this should be set by default)
5. Click Test Connection
6. Click Save
7. Give your connection a unique prefix (e.g. "zuora")
8. Highlight the newly created connection and click File -> "Approve Users For Web UI"
9. Approve the appropriate DB users to create views and click "Save"

At this point, we are ready to build our semantic layer view in the Live Data Gateway Web UI.

Creating a Semantic Layer View

1. In your browser, navigate to the APOS Live Data Gateway Portal
2. Select a Connection (e.g. "zuora")
3. Since Zuora does not require a User or Password to authenticate, you may use whatever values you wish for User Name and Password
4. Click "Login"
5. Once connected, click "Semantic Layer" to create a new semantic layer view
6. Click "New Semantic Layer View"
7. Set the Semantic Layer View Prefix and Semantic Layer View Name
8. Click "Step 2"
9. Select the table(s) and column(s) you wish to include in your view
10. Click "Step 3"
11. Select the Measures from the available table columns
12. Click "Step 5" (we skipped the "Extra Dimensions" step)
13. Add any Variable Prompts
14. Click "Step 6"
15. Define any Table Joins
16. Click "Review"
17. Review you semantic layer view and click "Save"

With the Semantic Layer View created, you are ready to access your Zuora data through the APOS Live Data Gateway, enabling real-time data connectivity to Zuora data from SAP Analytics Cloud and other SAP solutions.

More Information & Free Evaluation

Please visit APOS Systems - APOS Solutions - Request Evaluation Software to request evaluation software or email [email protected] for more information on working with your live Zuora data in APOS Live Data Gateway.