Zuora Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8852 of the connector.

Get Started¶

Zuora Version Support

The connector leverages the Zuora API to enable bidirectional access to Zuora.

Establish a Connection¶

Connect to Zuora¶

In order to create a valid connection with Zuora, you must configure the Tenant property.

Choose the Tenant value that matches your account configuration. Available options:

• USProduction: Requests sent to https://rest.zuora.com (default)
• 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

After you configure the Tenant you must create a custom OAuth application to generate a token. This is a simple one-time operation. For further information, see Creating a Custom OAuth Application.

Authenticate to Zuora¶

Desktop Applications¶

To authenticate with the credentials for a custom OAuth application, you must create a custom application to get and refresh the OAuth access token.

After you do that, you are ready to connect.

Set the following connection properties:

• OAuthClientId: the client ID assigned when you registered your application.
• OAuthClientSecret: the client secret that was assigned when you registered your application.
• CallbackURL: the redirect URI that was defined when you registered your application.

When you connect, the connector opens Zuora's OAuth endpoint in your default browser.

Log in and grant permissions to the application. The connector then completes the OAuth process:

1. The connector obtains an access token from Zuora and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.
3. When the access token expires, the connector refreshes the access token automatically.

Select a Zuora Service¶

We utilize two Zuora services: 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

Select a Zuora Service¶

We utilize two Zuora services: 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.

Create a Custom OAuth Application¶

Create a Custom OAuth Application¶

All users authenticate to the Zuora via the OAuth 2.0 mechanism. The connector uses the client_credential grant type, which means that only the OAuthClientId and OAuthClientSecret are needed to generate a token. This is done via a single HTTP request. In order to obtain the OAuthClientId and OAuthClientSecret, you must first create a custom OAuth client in the Zuora UI.

Do the following:

1. Using an account that has administration privileges for your Zuora tenant, log in to the Zuora Profiles & Settings menu.

2. Navigate to Administration > Manage Users.

3. Create a user.

   Applications that use OAuth to authenticate to your Zuora tenant will perform actions as this user. Zuora recommends that you create an API user specifically for this purpose.

4. Navigate to your Zuora tenant's Users page.

5. Select the new user you just created, then create an OAuth client for that user.

6. Note the Client ID and Client secret for future use.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the Zuora connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Zuora and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views¶

The Zuora connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model¶

The connector dynamically extracts all relevant schema information from Zuora via the REST API. All Zuora entities will be exposed as views.

The Zuora connector models Zuora objects as relational tables and views. A Zuora object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Zuora APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Stored Procedures

Stored Procedures are function-like interfaces to Zuora. They can be used create schema files or get and refresh OAuth Access tokens for Zuora apps.

Views¶

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Zuora Connector Views¶

Account¶

An account is a customer account that collects all of the critical information about the customer, such as contact information, payment terms, and payment methods.

Columns¶

AccountingCode¶

Each row of this table represents an accounting code.

Columns¶

AccountingPeriod¶

Accounting periods match your financial periods.An accounting period holds the information you need to perform your company's bookkeeping activities, especially tracking and reporting financial activities such as earnings, expenses, and taxes.

Columns¶

Amendment¶

An amendment to a subscription.

Columns¶

ApplicationGroup¶

A group of payment, refund, and credit memo applications.

Columns¶

Attachment¶

The information of a file attached to a Zuora object.

Columns¶

BillingRun¶

Each row of this table represents a billing run.

Columns¶

ChargeMetrics¶

A charge metrics service for accessing the key metrics for Rate Plan Charges in Zuora.

Columns¶

Contact¶

A contact person. For example, the Bill To contact of a customer account

Columns¶

ContactSnapshot¶

A copy of the Bill To or Sold To contact information from a posted invoice.

Columns¶

CreditBalanceAdjustment¶

An adjustment to the credit balance of a customer account.

Columns¶

CreditMemo¶

A credit memo that is owned by a customer account.

Columns¶

CreditMemoApplication¶

A credit memo that is applied to an invoice or a debit memo.

Columns¶

CreditMemoApplicationItem¶

A credit memo that is applied to a line item in an invoice or a line item in a debit memo.

Columns¶

CreditMemoItem¶

A line item in a credit memo.

Columns¶

CreditMemoPart¶

An applied or unapplied portion of a credit memo.

Columns¶

CreditMemoPartItem¶

A portion of a credit memo that is applied to a line item in an invoice or a line item in a debit memo.

Columns¶

CreditTaxationItem¶

A taxation line item in a credit memo.

Columns¶

DebitMemo¶

A debit memo that is owned by a customer account.

Columns¶

DebitMemoItem¶

A line item in a debit memo.

Columns¶

DebitTaxationItem¶

A taxation line item in a debit memo.

Columns¶

DiscountAppliedMetrics¶

A discount rate plan charge that is applied to another rate plan charge.

Columns¶

DiscountApplyDetail¶

Details for the applied discount.

Columns¶

Feature¶

Each row of this table represents a feature.

Columns¶

FXCustomRate¶

A custom exchange rate.

Columns¶

Invoice¶

An invoice represents a bill to a customer.

Columns¶

InvoiceAdjustment¶

An adjustment to an invoice.

Columns¶

InvoiceItem¶

A line item in an invoice.

Columns¶

InvoiceItemAdjustment¶

An adjustment to a line item in an invoice.

Columns¶

InvoicePayment¶

A payment that is applied to an invoice.

Columns¶

JournalEntry¶

A journal entry.

Columns¶

JournalEntryItem¶

A line item in a journal entry.

Columns¶

JournalRun¶

A journal run.

Columns¶

OrderAction¶

An order action that is applied to a subscription.

Columns¶

OrderElp¶

An extended list price metric for an order action.

Columns¶

OrderItem¶

An order item.

Columns¶

OrderMrr¶

A monthly recurring revenue metric for an order action.

Columns¶

OrderQuantity¶

A quantity metric for an order action.

Columns¶

Orders¶

Each row of this table represents an order.

Columns¶

OrderTcb¶

A total contracted billing metric for an order action.

Columns¶

OrderTcv¶

A total contract value metric for an order action.

Columns¶

Payment¶

Each row of this table represents a payment.

Columns¶

PaymentApplication¶

A payment that is applied to an invoice or a debit memo.

Columns¶

PaymentApplicationItem¶

A payment that is applied to a line item in an invoice or a line item in a debit memo.

Columns¶

PaymentGatewayReconciliationEventLog¶

An event that was processed by a payment reconciliation job.

Columns¶

PaymentMethod¶

A payment method.

Columns¶

PaymentMethodSnapshot¶

A copy of the payment method that was used in a transaction.

Columns¶