You can import Zuora Data Source objects, such as accounts and invoices, into Treasure Data. The modes of import:
In fetch related import, you can specify the import of Full objects, which includes all pre-joined objects.
Basic knowledge of Treasure Data
Basic knowledge of Zuora
Use TD Console
Create a new connection
Go to Integrations Hub > Catalog and search. Select Zuora.
Complete the Zuora login information, click Next and provide a connection name:
Create a new transfer
After creating the connection, you are automatically taken to the Authentications page. Look for the connection you created and click New Transfer.
Provide information details and click Next.
Fetch related objects: Most of Zuora’s data sources provide related business objects, which eliminates the need to construct nested queries and improves performance. If you need the related business objects data, check the box and select the data source you want to query.
API Version (default v85): Zuora API Version. Keep the default value v85 (v84 will be deprecated soon).
Duration to import: This option enables you to select the 'end_date' based on the '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 includes all data available up until 02/08/2017, 12:00 AM.
In this example, the 'end_date' is calculated as follows:
If the transfer is scheduled, the 'start_date' constantly changes based on the new 'end_date' since the last import (as calculated previously).
If incremental is not selected, import is from 'start_date' to now.
User timezone is reserved.
We highly recommend you re-create a transfer if you’d want to change the 'start_date'. Editing an existing transfer does not affect the 'start_date'.
Preview your data. If you want to change anything, click Advanced Settings or else click Next.
Select the database and table where you want to transfer the data:
Specify the schedule of the data transfer 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.
Use Command Line
Install ‘td’ command v0.11.9 or later
You can install the newest TD Toolbelt.
Create Configuration File
Prepare configuration file (for eg:
load.yml), as shown in the following example, with your Zuora account access information.
This example dumps Zuora Account Data Source:
username and password: your login information.
describe_api_verion: Zuora Describe API version, See Zuora Describe API
base_object: name of Zuora SOAP (Base) Object you want to import, required if fetch_related: false
See the Appendix for list of available base objects.
data_source: name of Zuora Data Source you want to import, required if fetch_related: true
See the Appendix for list of available data sources.
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 will data be imported, determined by UpdatedDate field of target object. unit has 3 options: DAY, HOUR, and MIN, default as DAY.
Some Limited Availability objects from Zuora require additional configuration settings. The following is a list of additional configuration settings for Billing Preview Run
from_timestamp : When used with Billing Preview Run, this is the Target Date for the preview run.
include_evergreen_sub : Indicate whether to include the evergreen subscription. The default is ‘false’
batch : Specify customer batch to include in this preview run
assume_renewal : Whether to assume renewal for the accounts. Valid value is All, None or Autorenew. The default is ‘None’.
charge_type_to_exclude : The charge types to exclude from the forecast run. Possible values: OneTime, Recurring, Usage, and any comma-separated combination of these values.
For more details on available out modes, see the Appendix.
Preview data to import
You can preview data to be imported using the command td connector:preview.
Execute Load Job
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, because Treasure Data’s storage is partitioned by time (see also data partitioning). If the option is not given, the Data Connector chooses 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 can add it using add_time filter option. More details at add_time filter plugin
The connector:issue 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, the command fails, 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:
You can assign Time Format column to the "Partitioning Key" by "--time-column" option.
You can schedule periodic Data Connector execution for periodic Zuora import. The load distribution and operation of Treasure Data’s scheduler is optimized to achieve high availability. By using Treasure Data’s scheduler, you no longer need a cron daemon on your local data center.
Create the schedule
A new schedule can be created using the td connector:create command. Specify the name of the schedule, the cron-style schedule, the database and table where the data will be stored, and the Data Connector configuration file. The values are required.
The 'cron' parameter also accepts these three options: '@hourly', '@daily' and '@monthly'.
By default, schedule is setup in UTC timezone. You can set the schedule in a timezone using -t or —timezone option. 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 scheduled entries by
Show the Setting and History of Schedules
td connector:show shows the execution setting of a schedule entry.
td connector:history shows the execution history of a schedule entry. To investigate the results of each individual execution, use td job <jobid>.
Delete the Schedule
td connector:delete removes the schedule.
Modes for out plugin
You can specify file import mode in out section of load.yml.
This is the default mode and records are appended to the target table.
replace (In td 0.11.10 and later)
This mode replaces data in the target table. Any manual schema changes made to the target table remains intact with this mode.
Available Base Object
Available Data Source
Configure excluded fields for Base Object
When you import data for Base Object, some special fields are excluded by default.
This is due to limitations or restrictions applied on each Base Object by Zuora.
RatePlanCharge DiscountAmount can not be queried together with the following fields: Price, IncludedUnits, DiscountPercentage, OveragePrice. The plugin defaults to exclude the fields. You can change the excluded fields list in the Advanced Configuration UI. Advanced Configuration automatically populate the list of Base Object excluded fields.
Steps to change exclude fields:
In base object preview screen, choose Advanced Settings.
The Advanced Settings contains a list of predefined excluded fields, if any exist. You can replace or change the fields as well. But be aware that some fields cannot be included together.
Note: Excluded fields configuration only works with Base Object targets, and will be ignored for Data Source targets.
Customize timestamp column
The Timestamp column is the Zuora object column that the data connector uses to apply a time range filter. The column defaults to UpdatedDate or a pre-configured column in plugin internal configuration.
All other supported Zuora objects that are not listed in the preceding table use the default column UpdatedDate.
Customize timestamp column
Sometimes you might want to use a different column as a timestamp column. You can specify a column through the Timestamp column configuration in Advanced Configuration screen.
The parameter value will have the same format with Zuora ZOQL filter, ObjectName.ColumnName, Example : RatePlanCharge.UpdatedAt, RatePlan.UpdatedAt, RatePlanChargeTier.UpdatedAt.
The Column used as a timestamp column must have a DateTime data type in Zuora.