Overview
Export submission or data table data to a CSV file by specifying query parameters and selecting desired columns.
Attach this report to an email or HTTP request.
Include it in a scheduled job for automated reporting.
Include it in a form's workflow for report generation at the time a form transition/transaction runs.
Submission to CSV Configuration
To export submission data to a CSV report, follow the below steps:
Select Submission Request Type
In an Integration Action of type Submission Request, select 'Query to CSV' as the request type.
Specify Form Definition
Select the relevant form definition that contains the submissions you want to export.
You can also select All Definitions (any fields you want to add as CSV Columns must be header fields on all definitions).
Set CSV File Key
To enable referencing the exported CSV file by other actions, assign a unique file key.
Define Query Parameters
Define query parameters to filter submissions based on criteria such as creation date or status.
Select CSV Columns
Select the specific fields to include as columns and rename columns for clarity, clicking the blue + button to add columns directly from the list of fields in the selected form definition.
Test CSV Export
To verify your CSV export configuration, test the action to download a sample CSV report and confirm your selections and query parameters.
Data Table to CSV Configuration
Setting up an action to generate a report from data table data is very similar to the example we walked through above related to submission data.
The main differences are:
You'll need an Integration Action of type Data Table Request, instead of Submission Request
Select a Data Table instead of a Form Definition
Query is a Data Table Query instead of a Submission Query
CSV Columns come from the selected Data Table's schema instead of the Form Definition's fields
Send the Report via Email or HTTP Action
Create Email Notification or HTTP Action
To send the generated report via email, create an email notification action and configure its subject, body, and recipients.
To send the generated report through an HTTP request, configure an HTTP integration action.
Add CSV File Attachment
Add an attachment in the Attachments section at the bottom of the request
Select Type = File from Action
Select the File Key that was configured in the 'To CSV' action
Provide a File Name (make sure to end it in ".csv"!)
This action simply picks up the CSV report generated by the 'To CSV' action. Thus, testing this action in the TEST tab will NOT generate a report.
Send the Report on a Schedule
Create a Scheduled Job
To automate the regular delivery of your CSV report, create a scheduled job.
Add CSV Export Action to Schedule
Add the 'To CSV' action to your scheduled job.
Add the email action to your scheduled job, ensuring it follows the CSV export action.
Order Matters!
When scheduling, ensure the action that creates the CSV report runs before the action that emails it to guarantee the report is available for sending.
In the SCHEDULES tab, you can set up schedule(s) on which this job runs.
Send the Report from a Form's Workflow
Add 'To CSV' and Email/HTTP Action to Form Workflow
Very similar to in Scheduled Jobs, you can add the combination of (1) a 'To CSV' action and then (2) an Email or HTTP action in order to generate a CSV report and then send it somewhere.
Order of the actions ('To CSV' first) matters here as well as stated in above caution callout.
If you want the report to have data only from the submission which is running the transition/transaction
In the 'To CSV' action, the Query Parameters will be simply Submission Id equals Input Parameter:
In the Designer, map the Submission Id input parameter to the calculation "form-id".