Data Connector for Zuora

This Data Connector allows you to import Zuora Data Source objects into Treasure Data. There are 2 modes of import: base and full (see fetch_related config).

Table of Contents

Prerequisites

  • Basic knowledge of Treasure Data
  • Basic knowledge of Zuora

Option 1: Use Web Console

Create a new connection

Please visit Treasure Data Connections and search and select Zuora. The dialog below will open.



Please fill in your Zuora login information, click Next and give your connection a name:



Create a new transfer

Upon creating the connection above, you will be automatically taken to My Connections tab. Look for the connection you created and click New Transfer.



The dialog below will open. Please fill the details and click Next.



Duration to import: Please note that this option enables you to select the 'end_date' since 'start_date' of import.

  • If Start date is set to = 02/07/2017, 12:00 AM AND Number of Unit = 1 DAY, your data transfer will include all data available up until 02/08/2017, 12:00 AM.

In this example, the 'end_date' is calculated as follows:

'start_date' + 'number_of_unit' = 'end_date'
02/07/2017, 12:00AM + 1 DAY = 02/08/2017, 12:00AM
  • If the transfer is scheduled, the 'start_date' will be constantly changing based on the new 'end_date' since last import (as calculated above).

  • If incremental is not selected, will import from 'start_date' to now.

  • User timezone is reserved.

** We highly recommend you re-create a transfer if you’d like to change the 'start_date'. Editing an existing transfer will leave 'start_date' unaffected.

Next, you will see a Preview of your data similar to the dialog below. If you wish to change anything, please click on Advanced Settings or else click on Next.



Third step is to select the database and table where you want to transfer the data, as per the following dialog:



Finally, specify the schedule of the data transfer using the dialog below and click Start Transfer:



You will see the new data transfer in progress listed under the My Input Transfers tab and a corresponding job will be listed in the Jobs section.

Now, you are ready to start analyzing your data!

Option 2: Use Command Line

Step 0: Install ‘td’ command v0.11.9 or later

You can install the newest Treasure Data Toolbelt.

$ td --version
0.15.0

Step 1: Create Configuration File

Prepare configuration file (for eg: load.yml) like below, with your Zuora account access information.

in:
  type: zuora
  username: xxxxxxxx
  password: xxxxxxxx
  base_object: Account (required if fetch_related = false, see Appendix B)
  data_source: Account (required if fetch_related = true, see Appendix C)
  fetch_related: true (optional, default: false)
  from_timestamp: 12-05-2016T11:00:00.000Z
  incremental: true (optional, default: true)
  duration: { unit: DAY, num: 1 } (required if `incremental: true`)
out:
  mode: replace

This example dumps Zuora Account Data Source:

  • username and password: your login information.
  • base_object: name of Zuora SOAP (Base) Object you want to import, required if fetch_related: false
    • See Appendix B for list of available base_object.
  • data_source: name of Zuora Data Source you want to import, required if fetch_related: true
    • See Appendix C for list of available data_source.
  • fetch_related: you can choose to import base or full object (including all pre-joined objects), default as false
  • from_timestamp: from which moment data will be imported, format is: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
  • incremental: should data import be continuous or once, default as true. If true, duration is required
  • duration: for how long data will be imported, determined by UpdatedDate field of target object. unit has 3 options: DAY, HOUR, and MIN, default as DAY.

For more details on available out modes, see Appendix A

Step 2 (optional): Preview data to import

You can preview data to be imported using the command td connector:preview.

$ td connector:preview load.yml
+---------+--------------+------------------+----
| id:long | title:string | body_html:string | ...
+---------+--------------+------------------+----
| 1       | "33"         | <p>body_html<p>  |
| 2       | "34"         | <p>body_html<p>  |
| 3       | "35"         | <p>body_html<p>  |
| 4       | "36"         | <p>body_html<p>  |
| 6       | "37"         | <p>body_html<p>  |
+---------+--------------+------------------+----

Step 3: Execute Load Job

Finally, submit the load job. It may take a couple of hours depending on the data size. Users need to specify the database and table where their data are stored.

It is recommended to specify --time-column option, since Treasure Data’s storage is partitioned by time (see also architecture) If the option is not given, the Data Connector will choose the first long or timestamp column as the partitioning time. The type of the column specified by --time-column must be either of long and timestamp type.

If your data doesn’t have a time column you may add it using add_time filter option. More details at add_time filter plugin

$ td connector:issue load.yml --database td_sample_db --table td_sample_table --time-column updated_date

The above command assumes you have already created database(td_sample_db) and table(td_sample_table). If the database or the table do not exist in TD this command will not succeed, so create the database and table manually or use --auto-create-table option with td connector:issue command to auto create the database and table:

$ td connector:issue load.yml --database td_sample_db --table td_sample_table --time-column updated_date --auto-create-table
Untitled-3
You can assign Time Format column to the "Partitioning Key" by "--time-column" option.

Scheduled execution

You can schedule periodic Data Connector execution for periodic Zuora import. We take great care in distributing and operating our scheduler in order to achieve high availability. By using this feature, you no longer need a cron daemon on your local datacenter.

Create the schedule

A new schedule can be created using the td connector:create command. The name of the schedule, cron-style schedule, the database and table where their data will be stored, and the Data Connector configuration file are required.

$ td connector:create \
    daily_zuora_import \
    "10 0 * * *" \
    td_sample_db \
    td_sample_table \
    load.yml
Untitled-3
The `cron` parameter also accepts these three options: `@hourly`, `@daily` and `@monthly`.
Untitled-3
By default, schedule is setup in UTC timezone. You can set the schedule in a timezone using -t or --timezone option. Please note that `--timezone` option only supports extended timezone formats like 'Asia/Tokyo', 'America/Los_Angeles' etc. Timezone abbreviations like PST, CST are *not* supported and may lead to unexpected schedules.

List the Schedules

You can see the list of currently scheduled entries by td connector:list.

$ td connector:list
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+
| Name                  | Cron         | Timezone | Delay | Database     | Table           | Config                     |
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+
| daily_zuora_import    | 10 0 * * *   | UTC      | 0     | td_sample_db | td_sample_table | {"type"=>"zuora", ... }    |
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+

Show the Setting and History of Schedules

td connector:show shows the execution setting of a schedule entry.

% td connector:show daily_zuora_import
Name     : daily_zuora_import
Cron     : 10 0 * * *
Timezone : UTC
Delay    : 0
Database : td_sample_db
Table    : td_sample_table

td connector:history shows the execution history of a schedule entry. To investigate the results of each individual execution, please use td job <jobid>.

% td connector:history daily_zuora_import
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| JobID  | Status  | Records | Database     | Table           | Priority | Started                   | Duration |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| 578066 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-18 00:10:05 +0000 | 160      |
| 577968 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-17 00:10:07 +0000 | 161      |
| 577914 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-16 00:10:03 +0000 | 152      |
| 577872 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-15 00:10:04 +0000 | 163      |
| 577810 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-14 00:10:04 +0000 | 164      |
| 577766 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-13 00:10:04 +0000 | 155      |
| 577710 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-12 00:10:05 +0000 | 156      |
| 577610 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-11 00:10:04 +0000 | 157      |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
8 rows in set

Delete the Schedule

td connector:delete will remove the schedule.

$ td connector:delete daily_zuora_import

Appendix

A) Modes for out plugin

You can specify file import mode in out section of load.yml.

append (default)

This is the default mode and records are appended to the target table.

in:
  ...
out:
  mode: append

replace (In td 0.11.10 and later)

This mode replaces data in the target table. Please note that any manual schema changes made to the target table will remain intact with this mode.

in:
  ...
out:
  mode: replace

B) Available Base Object

Base Object Base Object Base Object
Account InvoicePayment RatePlan
AccountingCode Payment RatePlanCharge
AccountingPeriod PaymentMethod Refund
Contact Product RefundInvoicePayment
Feature ProductFeature Subscription
Invoice ProductRatePlan SubscriptionProductFeature
InvoiceItem ProductRatePlanCharge Usage

C) Available Data Source

Data Source Data Source Data Source
Account Payment Refund
AccountingCode PaymentMethod RefundInvoicePayment
Contact Product Subscription
Invoice RatePlan Usage
InvoicePayment RatePlanCharge

Last modified: Feb 24 2017 09:41:25 UTC

If this article is incorrect or outdated, or omits critical information, please let us know. For all other issues, please see our support channels.