Zuora Collect Slice

Overview

Zuora is an enterprise software company that creates and provides software for businesses to launch and manage their subscription-based services. Zuora’s applications are designed to automate recurring billing, collections, quoting, revenue recognition, and subscription metrics.

The Datacoral Zuora slice collects data from a Zuora API and writes it to S3 and a warehouse of your choice.

Steps to add this slice to your installation

The steps to launch your slice are:

  1. Generate Zuora API keys
  2. Specify the slice config
  3. Add the Zuora slice

1. Generate Zuora API keys

Setup requirements

Before getting started please make sure to have the following information:

  • Access to an active Zuora account

Setup instructions

The Zuora slice requires a Client ID and Client Secret to collect data. A Client ID and Client Secret can be obtained from Zuora through the following steps:

  1. Click your username at the top right and navigate to Administration > Manage Users. The Users page opens.
  2. Locate the user in the table, then check that the user's status is Active. If the user's status is not Active, you must either activate the user or choose a different user.
  3. Click the user's First Name, Last Name, or User Name. For the OAuth client to be permitted to write data using the REST API, the user must have a Platform role that includes the "API Write Access" permission.
  4. In the OAuth Clients section, enter a name for the OAuth client.
  5. If you have the Multi-entity feature enabled, select which entities the OAuth client will be permitted to access.
  6. Click "create". Zuora displays the Client ID and Client Secret for the OAuth client. This is the only time you can see the Client Secret.
  7. Copy Client ID and Client Secret
  8. Click "OK".

2. Specify the slice config

To get a template for the Zuora slice configuration save the output of the describe --input-parameters command as follows:

datacoral collect describe --slice-type zuora \
--input-parameters > zuora_parameters_file.json

Necessary input parameters:

  • client_id - your Zuora user Client ID
  • client_secret - your Zuora user Client Secret

Optional input parameters:

{
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"host": "https://rest.zuora.com/v1/",
"wsdl_version": "97"
}

Modify the zuora_parameters_file.json file to add the token generated from Zuora

3. Add the Slice

datacoral collect add --slice-type zuora --slice-name <slice-name> --parameters-file <params-file>
  • slice-name Name of your slice. A schema with your slice-name is automatically created in your warehouse
  • parameters-file File path to your input parameters file. Ex: path/to/zuora_parameters_file.json

Supported load units

Slice output

Output of this slice is stored in S3 and your desired warehouse.

AWS S3 Data stored in AWS S3 is partitioned by date and time in the following bucket s3//:customer_installation.datacoral/<sliceName>

Target Warehouse: Schema - schema name will be same as a slice-name. Tables produced by the slice are:

- schema.accounts
- schema.invoice_items
- schema.invoices
- schema.invoice_item_adjustments
- schema.subscriptions
- schema.payments
- schema.refunds
- schema.credit_balance_adjustments

Questions? Interested?

If you have questions or feedback, feel free to reach out at hello@datacoral.co or Request a demo