Overview: Export Report workflow module (Console)

This article explains the Export Report workflow module in Console.

In this article

Overview

The Export Report workflow module is used to export a report during a workflow. This module is most commonly used in scheduled workflows to periodically share a report with one or more recipients. 

With the Export Report module, you can export a report as a shareable URL to share with your coworkers. Alternatively, you can also use this module to place the report on an SFTP server.

To learn more about exporting reports, see: Overview: Exporting reports (App).

How it works

Exporting a report transfers the data contained within the report to another destination (like a URL hosted by our system or a remote SFTP server). Once a report has been exported, the data can be imported into another tool like Microsoft Excel, Google Sheets, or another piece of software that accepts CSV and/or JSON imports.

Once you’ve selected what kind of file you want to export (CSV or JSON), you can select how you want the file to be exported. The options include:

• URL (create a publicly-available URL to share with others so that they can download the file)

• SFTP (Secure File Transfer Protocol to a server) 

Use case: Exporting a report as a URL

With a scheduled workflow, you can periodically generate a URL to share a report with your coworkers. When they click the link, the file (either CSV or JSON) will download to their computer. To accomplish this, configure a scheduled workflow to export a report on a time interval (every day, every week, every month, etc.). 

With the Export Report module, you can generate a URL to the report. You can send this URL to your coworkers through email, chat, or SMS.

Use case: Exporting a report to an SFTP server

With a scheduled workflow, you can periodically send a report file to an SFTP server. To accomplish this, configure the report settings of the report you want to export for SFTP. Then, configure the Export Report module to upload via SFTP. You can then link the Export Report module to a Send Chat Message module, similarly to the scenario described above.

Visual breakdown

• Report: The Report dropdown menu is where you select the report you want to export.

• Export Type: The Export Type menu is where you select the file format for the export. You can either export the report as a CSV or as a JSON file.

• SFTP Upload: The SFTP Upload toggle specifies whether the Export Report module should export the file via an SFTP connection. The SFTP connection must be configured in the report settings.

• Decrypt Values: The Decrypt Values toggle specifies whether the values in the exported report should be decrypted. When toggled off, all of the values in the report will be encrypted. The report will need decryption before anyone can read it.When toggled on, the values of the report are not encrypted, so they will appear as they do when reading the report in the system.

• URL Never Expires: The URL Never Expires toggle specifies whether the URL generated by the module ever becomes invalid, or “expires”. When toggled off, two additional fields appear called Amount and Unit that let you define the amount of time the link remains valid before becoming unusable, or “expired”.

• File URL Variable Name: The File URL Variable Name field allows you to create a variable containing the URL generated by the module. This is useful for sending the generated URL to a recipient as a chat message or email.