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:
- Generate Zuora API keys
- Specify the slice config
- Add the Zuora slice
1. Generate Zuora API keys
Before getting started please make sure to have the following information:
- Access to an active Zuora account
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:
- Click your username at the top right and navigate to Administration > Manage Users. The Users page opens.
- 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.
- 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.
- In the OAuth Clients section, enter a name for the OAuth client.
- If you have the Multi-entity feature enabled, select which entities the OAuth client will be permitted to access.
- 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.
- Copy Client ID and Client Secret
- 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:
Necessary input parameters:
client_id- your Zuora user Client ID
client_secret- your Zuora user Client Secret
Optional input parameters:
schedule- in cron format
host- API url
wsdl_version- Zuora WSDL versions Reference
zuora_parameters_file.json file to add the token generated from Zuora
3. Add the Slice
slice-nameName of your slice. A schema with your slice-name is automatically created in your warehouse
parameters-fileFile path to your input parameters file. Ex:
Supported load units
accounts: API Reference
invoice_items: API Reference
invoice_item_adjustments: API Reference
invoices: API Reference
subscriptions: API Reference
payments: API Reference
refunds: API Reference
credit_balance_adjustments: API Reference
Output of this slice is stored in S3 and your desired warehouse.
Data stored in AWS S3 is partitioned by date and time in the following bucket
Target Warehouse: Schema - schema name will be same as a slice-name. Tables produced by the slice are: