HomeGuidesRecipesAPI
HomeGuidesAPILog In

Form Summary Action

Overview

The Form Summary Action automatically generates a document based on all answers provided by the user or a JSON file with the form summary configuration.

📘

Note

The JSON output will produce a configuration file which will not include track changes.

Like the Form Summary Question, the summary can be created without special configuration. It is also possible to email the summary as an attachment using the Send Email action.

Features

  • Automatically generate a summary document based on form answers, without mapping placeholders
  • Customise the pages included in the summary document
  • Create the summary document as PDF, docx, Html, or Json

📘

Note

Only the first three display fields of a data question will show in the summary document.

Using the action in Design

Once you’ve added the Form Summary Action to your project, either on the Finish page or on a workflow transition, use the following table to configure any action attributes that you require.

779

Action Attributes

NameDescription
Exclude PagesEnter a list of page names to exclude from the summary. Note that the page the custom question is on is automatically excluded, and does not need to be on this list. Separate items with a pipe (|) character e.g. 'page1|page2'.
Include All Multiple Choice AnswersSet to 'true' to show both selected and unselected items for multiple choice questions, highlighting selected items. If set to 'false', only the selected item(s) will be included in the summary.
Include generated timeAdds the time the form was generated at the top part of the form summary output document.
Include userAdds the user name at the top part of the form summary output document.
Output Format Specify the output format for the generated summary document. If not specified, a PDF document will be generated. The valid options are Pdf, Docx, Html and Json.
Output Filename Specify the filename for the generated summary document. If not specified the project's Default Answer File Name will be used.
Show Password Text Set to 'true' to show the actual characters entered into a Password text field question. By default this is 'false' so that the Password summary is masked.
Include CommentsDisplay question comments in the summary

Question summary settings

Individual questions can override the settings on a summary question to control how they appear.

Use the Summary Settings icon to open the options for each question. Depending on the question type, not all options will be available.

In order to fit within a document, answers from Data Questions will only show the first three columns.

490
NameDescription
IncludeOverride the default include logic for this question. Possible values are: Visible, Active, Include and Exclude
TitleOverride the question text that is displayed on the summary
Show AllMultiple choice can override the Include All Multiple Choice Answers setting for this question

Page summary settings.

Pages can also override the settings on a summary question.

Use the Summary Settings icon to open the options for each page.

465
NameDescription
IncludeOverride the default include logic for this page. Possible values are: Include or Exclude
CollapsibleOverride the Collapsible Pages setting for this page