Form Container Component (v1) form-container-component-v1

The Core Component Form Container Component allows for the creation of simple submission forms.

Usage usage

The Form Container Component enabled the building of simple information submission forms and features by supporting simple WCM forms and by using a nested structure to allow additional form components.

By using the setting dialog the content editor can define what type of action form submission triggers, where the submitted content should be stored, and if a workflow should be triggered. The template author can use the design dialog to define the allow components and their mappings similar to the design dialog for the standard layout container in the template editor.

Version and Compatibility version-and-compatibility

This document describes v1 of the Form Container Component, originally introduced with release 1.0.0 of the Core Components with AEM 6.3.

The following table lists the compatibility of v1 of the Form Container Component.

AEM Version
Form Container Component v1
6.3
Compatible
6.4
Compatible
CAUTION
This document describes v1 of the Form Container Component.
For details of the current version of the Form Container Component, see the Form Container Component document.

Settings Dialog settings-dialog

The settings dialog allows the content author to define what actions are taken when the component is submitted.

Depending on the selected Action Type, the available options within the container will change. The available action types are:

Regardless of the type, there are general settings that apply to each action.

Mail mail

When the form is submitted, the mail action type will send an email to designated recipients.

  • Subject - The subject of the email that will be sent on form submission

  • From - The from email address of the email that will be send on form submission

  • To - The addresses of the recipients who will receive an email upon form submission

    • Tap or click the Add button to add additional addresses
    • Tap or click the Delete button to remove an email address
  • CC - The addresses of recipients who will receive a carbon copy the email sent upon form submission

    • Tap or click the Add button to add additional addresses
    • Tap or click the Delete button to remove an email address

Store Content store-content

When the form is submitted, the content of the form will be stored in a designated repository location.

  • Content Path - Content repository path where submitted content is stored
  • View Data - Tap or click to view stored submitted data as JSON
  • Start Workflow - Configure to start a workflow with the stored content as payload upon form submission

Submit Order submit-order

When the form is submitted, the order will be submitted.

Update Order update-order

When the form is submitted, the order will be updated.

General Settings general-settings

Regardless of the action type selected, a thank you page can always be defined.

The user will be redirected to the specified page after completion of the form submission.

  • Use the Selection Dialog to select a resource within AEM.
  • If the thank you page is not in AEM, specify the absolute URL. Non-absolute URLs will be interpreted relative to AEM.
  • Leave blank to re-display the form after submission.

Design Dialog design-dialog

The design dialog allows the template author to define the allowed components and their mappings for the container similar to the design dialog for the standard layout container in the template editor.

Technical Details technical-details

The latest technical documentation about the Form Container Component can be found on GitHub.

The entire core components project can be downloaded from GitHub.

Further details about developing Core Components can be found in the Core Components developer documentation.

recommendation-more-help
d2be9096-a81e-404b-9952-d8925af7219c