Knowledge Center

Knowledge Center > Reporting > Quick Reference > Reporting Overview > D Data Sources and Exports > Generate a Data Source Export

Generate a Data Source Export

Generating data source exports is available from the Zuora application or through the Export SOAP API.  This article describes how to generate data source exports from the Zuora application.  See Export ZOQL for more information about the Export SOAP API.

After generating a data source export, you can download the data source export from the Zuora application. Data source exports older than seven days are not available for download.

Data Source Exports

This procedure provides high-level steps on how to create a data export.  See Data Source Reference for a list of available data sources.

File Size Limitation

The maximum export file size is 2047MB. If you have large data requests that go over this limit, you will get the following 403 HTTP response code from Zuora:
  <security:max-object-size>2047MB</security:max-object-size>

Submit a request at Zuora Global Support if you require additional assistance.

We can work with you to determine if large file optimization is an option for you.

Create a Data Export

Navigation: Reporting > Data Sources

The following is an example of the Rate Plan data source selected for export:

Example of a Data Source Selection

To generate a data source for export:

  1. Select your base object for the data source in the Data Source drop-down.
  2. Select the fields that you want to use from the base object.
  3. Select related objects from the items to the left of the object fields.
  4. Select fields that you want to use from related objects.
  5. Specify filters that you want to apply.
  6. Specify the time frame.
  7. Select a file format:  CSV or CSV ZIP (a zipped CSV file).
  8. Click export.

The base object that you select can be joined only with any additional objects that are its parent.  For example, if you want to view a Subscription with charges,  select Rate Plan Charge as the base for the data source.

A data source export will remain in your Zuora tenant until you delete it.

Save Frequently Used Data Source Exports

Select Save As Default to save your data source configuration.  When you select Save As Default and export the data source, Zuora will save your fields and filters for the data source and will automatically apply those settings the next time you select that data source.  This allows you to create custom data source export configurations for future use.

Data Source Saved as a Default

Export an Encrypted Data Source

You can export a secure version of encrypted data source fields. Using this option, you can view and export the AchAccountNumber field of any PaymentMethod or DefaultPaymentMethod data source objects.

This is a Controlled Release feature. Contact Zuora Global Support for information about using this feature. To use this feature, you must sign a security contract with >Zuora and store your public key in the Zuora System. Zuora decrypts the fields and exports them to a file. Zuora then encrypts the file using your public key, ensuring that the fields are never available in plain text format.

To use this feature:

  • In the Zuora user interface, select Encrypt Export before making an export.
  • Using the Zuora API, when creating an Export object, set the Encrypted field to true.

Zuora will create a file with the .gpg extension. You can then use your private key to decrypt the file.

If you exported encrypted fields without specifying the encryption option (Encrypt Export or setting Encrypted to true), the encrypted fields are masked (replaced with ******).

If you delete the record, the exported file will be removed, but the export record is kept to track all encrypted export history. In the Export history, a lock icon in the File type indicates an encrypted record.

If this feature is not enabled for your tenant, you can use the API to set Encrypted to true, but the API will return an error message.

The encrypted fields are never selectable in a Commerce API query() operation. If you attempt to select an encrypted field, you will receive an "invalid field" error.

Last modified
21:04, 14 May 2017

Tags

Classifications

(not set)