Skip to main content

Download reports

Zuora

Download reports

After you run a report, you have the option to download the current report immediately or schedule the report to run on a regular basis in the future for download. If the report file is large, it is also recommended to enable the compressed format for the report file before you submit or schedule a download.

Enable file compression for report download

If the report file is large, it is also recommended to enable the compressed format for the report file before you submit or schedule a download.

The following instruction applies to version 37.002.00.00 and later versions. If you use a version earlier than 37.002.00.00, the Compress Report Output toggle switch is not available.

To enable file compression for a report, complete the following steps:

  1. Navigate Reports > Run Reports.
  2. Locate the specific report on the Run Reports page by using one of the following methods: 
    • Click the report category tab to view all available reports of this category and find the specific report.
    • Type part of the report name in the search box and locate the specific report.
  3. Click Edit Report. The Edit Report window is displayed.
  4. Toggle the Compress Report Output switch to Yes.
  5. Click the save icon icon-save.png to save your changes. 

Now, you have enabled report file compression. When you download the report, the file will be compressed and then downloaded.

Submit a report download

After you run a report, use the Submit Download option to download the report immediately.

When you want to submit a report download request, an enhanced deduping process is introduced. This new deduping process will check whether a duplicate download request has been submitted for the same report with the same filter criteria (without changes in the underlying data). If yes, you will be prompted to choose whether to use the existing download or submit a new one. The introduction of the deduping process can help avoid the waste of resources due to duplicate download requests.

The following instruction applies to version 37.002.00.00 and later versions. If you use a version earlier than 37.002.00.00, Step 2 will be skipped.

Complete the following steps to download a report from the UI:

  1. After the report is successfully run, on the report details page, click icon-report-menu.png  to expand the report menu and then click Submit Download
  2. If a previous report download is completed or is in progress for the same report with the same filter criteria, the Confirm window is displayed to show you the details of the previous report download. Complete the following steps: 
    1. In the Confirm window, click the appropriate one among the following options:
      Option Explanation
      Use Existing Output This option is available when the previous report download already exists and is completed. Choose this option to go to the My Downloads page, which lists the last successful submission.
      Use Existing Output Once Available This option is available when a previous report download has been submitted and is in progress. The previous download request might be submitted by you, or submitted by another user and shared with you. Choose this option to go to the In-Progress page to view the on-going report download.
      Submit New Download

      This option is always available when a previous report download exists. Choose this option to submit a new download request.

      • If the previous report download is submitted by you, the previous request will be canceled.  
      • If the previous report download is submitted by another user, the previous report download is retained. Another download request is submitted by you.
    2. If you click Use Existing Output or Use Existing Output Once Available in the previous step, you can download the report file either on the My Downloads page or on the Shared Downloads page.
    3. If you click Submit New Download in the previous step, proceed to Step 3.

      The following graphic displays the Confirm window when a duplicate report download request has been submitted and is working in progress.

      confirm-window.png

  3. (Optional): In the Subscribers windows, click icon-add-green.png to add subscribers.
  4. Click Submit Downloads. A message indicating that the request is submitted successfully with a submission ID is displayed, and you are redirected to the My Downloads page.
  5. On the My Downloads page, locate the corresponding submission ID, hover your mouse over the line, and click  to download the report data. The report will be exported as a CSV file.

Schedule a report download

After you run a report, use the Schedule Reports option to schedule a report to run on a regular basis and make it available for download later.

  1. After the report is successfully run, on the report details page, click icon-report-menu.png to expand the report menu and then click Schedule Reports.
  2. In the Schedule Reports window, specify the values for the following fields.
    Field name Description
    Resubmit Interval

    Select a time interval from the following options from the dropdown list:

    • Minute(s)
    • Hour(s)
    • Day(s)
    • Week(s)
    • Month(s)
    Resubmit Code Based on this value, the report resubmission will be triggered.
    Resubmit Type

    The scheduling of the report is dependent upon itself. Select one of the following options:

    • From the Start of the prior run
    • From the Completion of the prior run
  3. Click  to save the configuration. 

A message indicating that the request is submitted successfully with a submission ID is then displayed. Scheduled reports will appear on the Scheduled Jobs page.

Download an available report

After you submit or schedule a report download, use the Download Reports option to find the available reports to download.

  1. Navigate to Reports > Download Reports. The My Download page is opened by default.
  2. (Optional): To view report submission details, click side-menu-open.png to open the side menu, and use one of the following options:
    • Shared Downloads: Displays the reports that are shared with you for downloads and are in the Available status.
    • In-Progress: Displays the reports that are currently being downloaded and are in the Submitted status.
    • Erroneous Submissions: Displays the reports that did not successfully complete and are in the Error status.
  3. On the My Downloads page or Shared Downloads page, hover the mouse over the line of the report that you want to download and click . The selected report is then exported as a CSV file.

    Only reports in the Available status can be downloaded. 

The selected report is then exported as a CSV file.