Configure a Form Flow

   Journey Manager (JM) The transaction engine for the platform. |   Platform Developer |   22.04 This feature was updated in 22.04.

Manager allows you to configure a user flow for a form by specifying pages an application will go through, for example, user redirect to a custom URL when resuming a saved form. The form flow is configured on a form level and is therefore not versioned.

Depending on a form's configuration, an applicant, who is filling in the form, can be presented with different steps and options required for successful application submission. These steps and options represent a form flow, which may vary significantly from form to form. For example, a simple form may launch from a landing page and show a confirmation page after submission. A more complex form may have additional steps and options, both prior to a user filling in the form, such as a terms & conditions page, a user authentication page, as well as after the form is filled, such as saving and returning to form drafts, payment, attachments, signatures, availability of a receipt.

To configure a form flow:

1. Select Forms > Forms.
2. Locate a form and select the Flow Config tab.

   

   Note

   The options are listed in chronological order from a user's perspective when going through the application process. If a custom user form space is being used to host this form, not all form flow options may be supported. Here we assume that a fully features user form space is deployed.

Configure the User Flow options for the form

Manager supports legacy Composer SmartForms, so you will see the following additional options when configuring the flow of a Composer SmartForm:

3. Select the Show Landing Page checkbox to display the Form’s landing page. Otherwise, the form user is directed straight to the rendered form.  |  22.04 This feature was removed in 22.04
4. Select one of the following options from the Save Online dropdown list:
   • Disabled – to disable the save online feature.
   • Enabled – to enable the save online feature allowing a user complete the form later.
   • Authenticated Only – to enable the save online feature for authenticated users only.
5. Select the Show Terms and Conditions checkbox to display a Terms and Conditions page before the form user can access the form.  |  22.04 This feature was removed in 22.04
6. Select a display mode from the Form Display Mode dropdown list:
   • Direct Render – to display the form directly from the servlet.
   • Embed with DIV – to display the Form inside a <div> section of an HTML page.
   • Embed with iFrame – to display the form inside of an <iFrame> section of an HTML page.
7. Select one of the following signature options from the Form Signature Required dropdown list determines:
   • Wet Signature - to ask users to physically sign a form.  |  22.04 This feature was removed in 22.04
   • eSignature - to ask for an electronic signature by confirming a receipt, which is presented to the user after the form is submitted.

Submission Confirmation Options

Manager allows you to customize what happens when the user completes a submission for this form.

8. Select an option from the Send Confirmation Email to User dropdown to determine whether a confirmation email should be automatically sent to a user who submits the form and what is to be included:
   • None - to never send a confirmation email
   • Confirmation - to send the confirmation email only
   • Confirmation and Receipt Attachment - to send the confirmation email along with an attached PDF receipt of the form
   • Confirmation and Receipt Link - to send the confirmation email along with a secure URL for the form user to download the PDF form receipt
   Note

   You can also configure form submission options in Maestro by selecting Form Options > User Experience > Auto-Send Confirmation Emails. For more information, see user experience.

9. Select the Show Confirmation Page checkbox to display the form space’s confirmation page when a user has successfully submitted the form.
10. Select the Show PDF Receipts checkbox to offer PDF receipts to a user after submission. This is the default option.

Custom Page Flow Options

Manager handles the form flow when a user saves, submits or cancels a form. However, you can redirect the user to a custom location using the configuration below. You can use the following Velocity variables when constructing your custom URLs:

• $submission - the submission object. For example, ${submission.submitKey} will be substituted with the submit key (a GUID)
• $formDataMap - the map of submission data extract values. For example, ${formDataMap.firstName} will be substituted by the value in the map for the key firstName
• $request - the HTTP servlet request
11. Enter a custom URL in the Saved Page URL field to where the form user is redirected after saving the form entry. For example:
    • A current form version redirect URL, which uses all propertied configured for the current form version:

      ${submission.portal.contextPath}submission-saved.htm?submitKey=${submission.submitKey}

    • A non-current form version redirect URL, which uses all propertied configured for the specific form version:

      ${submission.portal.contextPath}submission-saved.htm?submitKey=${submission.submitKey}&tmFormVersion=${submission.version.versionNumber}

      Note

      If you don't specify tmFormVersion=${submission.version.versionNumber}, the current form version's properties will be used.

12. Enter a custom URL in the Confirmation Page URL field to where the form user is redirected after submitting the form entry.
13. Enter a custom URL in the Cancelled Page URL field to where the form user is redirected after canceling the form entry.
14. Click Save to update the changes. If you have entered custom page URLs, Manager will use them instead of redirecting to the corresponding form space page.
15. Click Form Page to test how the form is rendered when accessed via the form’s landing page.

Next, learn how to configure email verification.