Managing form submissions

This topic describes how to set a retention policy, and how to view, export, and delete form submissions.

Setting a retention policy

By setting up a retention policy, you can control how long form submissions are stored in Episerver. The retention policy is set on the form so you can have different retention policies for different forms. You can also have different settings for finalized form submissionsA website visitor has gone through all steps of a form and submitted the form. and for partially submitted form dataA website vistor has gone through some of the form steps but has not reached the final step and has not submitted the form. The entered data is considered partially submitted form data..

Image: Retention policy

Form submission data is stored in a database, and expired submissions are cleaned up by a scheduled job running on a regular basis. As a consequence, previously stored data might be removed as well. The scheduled job can be enabled and disabled by your administrator in admin view > Submission Cleanup Job Scheduler. Expired submissions will not be removed if the job is disabled.

To set up a retention policy for a form's partially submitted form data:

  1. Open the form's All properties view and go to the Retention Policy tab.
  2. Select one of the three options:
    • Default (keep for 30 days): Any partial submission of this form will be retained for a default period of time. This value is normally 30 days but this can be modified by a developer.
    • Keep for (days): This option allows you to customize the retention period (in number of days) by entering a numeric value.
    • Keep Forever: Select this option to keep the partially submitted form data permanently.
  3. Publish the form. Your settings do not take effect until the form has been published.

To set up a retention policy for a form's finalized submissions:

  1. Open the form's All properties view and go to the Retention Policy tab.
  2. Select one of the three options:
    • Default (keep for 90 days): Any finalized submissions of this form will be retained for a default period of time. The value is ‘forever’ by default but this can be modified by a developer.
    • Keep for (days): This option allows you to customize the retention period (in number of days) by entering a numeric value.
    • Keep forever: Select this option to keep the finalized form submissions permanently.
  3. Publish the form. Your settings do not take effect until the form has been published.

Viewing form submissions

Note:   If your system is set up to encrypt form submissions, you need access rights to view the form submissions.

To view form submissions, open a form and select Form submissions from the Select View menu, or from the form's context menu in the Forms gadget. 

Image: Select view menu option Image: Form element context menu

The Form submissions view appears with data submitted from the form.

Image: Form submissions view

The displayed columns in the Form submissions view depend on which form elements the form contains. You can click on each column header to sort the information. If the form data is encrypted, you can only sort on columns containing text, not numerical values.

Searching in form submissions

You can use the search functionality in the Form submissions view to find submitted data from a specific time period, or from a specific visitor based on, for example, name or email address etc. Use the different search criteria and click Search or press Enter.

Property Description
Full-text field Use this field to perform a text search in the form submissions. You can combine this text search with the other search criteria.
drop-down list Use the drop-down list to search in only one of the columns. If no column is selected in the drop-down list, all columns are searched.
From date and To date Specify a From date and To date to show form submissions for that time period.
Finalized Only This option can be used for multi-step forms. Select Finalized Only and click Search to show data from finalized forms only. If you leave this unselected, you will see form submissions from users who have abandoned the form before all steps were finalized.

Note:  If your system is set up to encrypt form submissions, only finalized forms are saved.

Image: Form submission search results

Exporting form submissions

Open the form submissions view and select the form submissions you want to export. You can select all submitted records or individual records. Click Export and select one of the available file formats to export to:

Image: Export form submissions menu option

Note:   If your system is set up to encrypt form submissions, you need access rights to view the form submissions. In that case, you will also have the option Decrypted CSV which lets you export decrypted form data.

Deleting form submissions

Open the form submissions view and select the form submissions you want to delete. You can select all submitted records or multiple individual records. Click Episerver imageDelete.