Page History
...
HTML Wrap | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Related topics: |
Excerpt | ||
---|---|---|
| ||
Supported with EE |
The Form module allows you to create Web forms that visitors can fill in. The module provides components for easy creation of standard forms, like contact forms. You can group related form elements such as address fields together visually. Form data can be validated using configurable validators. By default, submitted form data is sent by email. You can process form data with pluggable data processors which allow customization without changing the Magnolia core system. Magnolia forms are fully HTML5 compliant.
...
Add the Form component to any area of a new or existing template.
Example: Addingform
component tomain
area of a new template.Localtab Group activeLocaltab true title YAML file Code Block language js title /my-module/templates/pages/form.yaml templateScript: /my-module/templates/pages/form-page-template.ftl renderType: freemarker visible: true title: Form Template dialog: my-module:pages/form areas: main: availableComponents: form: id: form:components/form
Localtab title JCR node Advanced Tables - Table Plus heading 0 multiple false enableHeadingAttributes false enableSorting false class m5-configuration-tree enableHighlighting false Node name Value
my-moduleMgnl f
templatesMgnl f
pagesMgnl f
formMgnl n
areasMgnl n
mainMgnl n
availableComponentsMgnl n
formMgnl n
idMgnl p form:components/form
dialogMgnl p my-module:pages/form
renderTypeMgnl p freemarker
titleMgnl p Form Template
templateScriptMgnl p /my-module/templates/pages/form-page-template.ftl
visibleMgnl p true
- Create a new page based on the template that contains the Form component (created in 1. above).
- Open the page, add the Form component and configure the form settings. Form settings define the title and name of the form, and where the collected information should be submitted.
Add a fieldset to the form.
Info You can have multiple field sets in one form. This helps to groups them visually. For example contact details in one set and feedback message in another etc.
- Add a field set.
- Add fields inside the field set.
- View the form.
Creating forms for handling personal data
With Magnolia you can create forms for the purposes of handling personal data, for example for the requirements of General Data Protection Regulation (GDPR).
Magnolia provides the following pre-configured GDPR-related form templates as samples you can build on:
...
Store data form
...
Double opt-in forms.
See an example of creating a form with double opt-in functionality on the Creating a GDPR-compliant form page.
...
Confirm data form
...
Get visitor data form
...
Forget me form
...
Delete visitor form
...
- Create a new page based on the template that contains the Form component (created in 1. above).
- Open the page, add the Form component and configure the form settings. Form settings define the title and name of the form, and where the collected information should be submitted.
Add a fieldset to the form.
Info You can have multiple field sets in one form. This helps to groups them visually. For example contact details in one set and feedback message in another etc.
- Add a field set.
- Add fields inside the field set.
- View the form.
Creating forms for handling personal data
With Magnolia you can create forms for the purposes of handling personal data, for example for the requirements of General Data Protection Regulation (GDPR).
Magnolia provides the following pre-configured GDPR-related form templates as samples you can build on:
Sample form (GDPR) | Use to create | Provided by |
---|---|---|
Store data form | Double opt-in forms. See an example of creating a form with double opt-in functionality on the Creating a GDPR-compliant form page. | privacy-sample module |
Confirm data form | ||
Get visitor data form | Forms where the user can request a zipped report listing their personal data stored by the site. | privacy-form module |
Forget me form | Forms where the user can request deletion of their personal data. | |
Delete visitor form | Forms where the user can confirm a request for deletion of the user's personal data |
Personal data form processors
To implement the above functions, the magnolia-privacy
module provides the following form processors:
Personal data form processors
To implement the above functions, the magnolia-privacy
module provides the following form processors:
: Updates a visitor's consent.Javadoc resource link className info.magnolia.privacy.form.processor.AddConsentFormProcessor renderType asynchronous
: Extends the functionality of the AddConsentFormProcessor processor. It also stores the data into a JCR workspace. The data is stored in an intermediate workspace so that the data cannot be used unless the visitor confirms consent. Under the processor define:Javadoc resource link className info.magnolia.privacy.form.processor.JcrStoreFormProcessor renderType asynchronous workspace
- the name of the intermediate workspace.nodeNameProperty
- the node name of the data to be stored.nodeType
- the node type of the data to be stored.rootPath
- the path to the node (default is "/
").
: Moves data from the intermediate workspace to the target workspace. Configure the intermediate and target workspaces under the processor using theJavadoc resource link className info.magnolia.privacy.form.processor.JcrMoveFormProcessor renderType asynchronous sourceWorkspace
andtargetWorkspace
properties.
: Confirms a visitor's consent.Javadoc resource link className info.magnolia.privacy.form.processor.ConfirmConsentFormProcessor renderType asynchronous
: Collects all data belonging to a visitor and provides a weblink where the visitor can download this data.Javadoc resource link className info.magnolia.privacy.form.processor.GetVisitorDataFormProcessor renderType asynchronous
: Updates Requests the deletion of all a visitor's consentdata (via aJavadoc resource link className info.magnolia.privacy.form.processor.AddConsentFormProcessorDeleteVisitorFormProcessor renderType asynchronous deletionId
).
JcrStoreFormProcessorJavadoc resource link className info.magnolia.privacy.form.processor.
: Extends the functionality of the AddConsentFormProcessor processor. It also stores the data into a JCR workspace. The data is stored in an intermediate workspace so that the data cannot be used unless the visitor confirms consent. Under the processor define:ConfirmVisitorDeletionFormProcessor renderType asynchronous workspace
- the name of the intermediate workspace.nodeNameProperty
- the node name of the data to be stored.nodeType
- the node type of the data to be stored.rootPath
- the path to the node (default is "/
").
: Moves data from the intermediate workspace to the target workspace. Configure the intermediate and target workspaces under the processor using theJavadoc resource link className info.magnolia.privacy.form.processor.JcrMoveFormProcessor renderType asynchronous sourceWorkspace
andtargetWorkspace
properties.
: Confirms a visitor's consent.Javadoc resource link className info.magnolia.privacy.form.processor.ConfirmConsentFormProcessor renderType asynchronous
: Collects all data belonging to a visitor and provides a weblink where the visitor can download this data.Javadoc resource link className info.magnolia.privacy.form.processor.GetVisitorDataFormProcessor renderType asynchronous
: Requests the deletion of all a visitor's data (via aJavadoc resource link className info.magnolia.privacy.form.processor.DeleteVisitorFormProcessor renderType asynchronous deletionId
).
: Confirms the deletion request.Javadoc resource link className info.magnolia.privacy.form.processor.ConfirmVisitorDeletionFormProcessor renderType asynchronous
See GDPR and forms too.
Creating a multistep form
Info |
---|
See an example multistep form on the "Book your tour" page of the Travel demo. |
Splitting a large form into multiple steps allows the visitor to focus on one step at a time. The substeps are detected automatically. Visitors can move forward and backwards between steps without losing entered data. Each step is validated individually. The form module also allows users to upload files, but the upload field should only be included as the last step of the process.
Add the Form Step component to an area of a template.
Example: Adding formStep
component to main
area in a new template.
...
Localtab | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
...
title | JCR node |
---|
...
heading | 0 |
---|---|
multiple | false |
enableHeadingAttributes | false |
enableSorting | false |
class | m5-configuration-tree |
enableHighlighting | false |
...
Mgnl f |
---|
...
Mgnl f |
---|
...
Mgnl f |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl p |
---|
...
form:components/formStep
...
Mgnl p |
---|
...
my-module:pages/form
...
Mgnl p |
---|
...
freemarker
...
Mgnl p |
---|
...
Form Step Template
...
Mgnl p |
---|
...
/my-module/templates/pages/formStep-page-template.ftl
...
Mgnl p |
---|
...
true
...
- Configure the form settings.
- Add a field set component
- Add fields inside the field set. The Submit button field will automatically navigate to the next step. Conditional steps can be set in the Next step condition component.
...
- Add field sets and fields on the substep forms. Submit button fields will automatically navigate to subsequent or conditional steps and the final button will submit the form.
Configuring form settings
Form settings are configured in the Form component.
Form tab
...
Field
...
Description
...
Title
...
Title displayed above the form. For example "Contact Us".
...
Form name
...
Internal name that allows you to reference the form by name, for example from JavaScript.
...
Text
...
Introductory text displayed below the form title.
...
Marker for required fields
...
Character displayed next to required fields. Asterisk by default.
...
Text for required symbol
...
Text that explains what the required marker means, displayed near the top of the form. For example "Required fields".
...
Step-by-step navigation
...
When checked displays step-by-step breadcrumb navigation that allows the user to navigate the steps of multistep forms.
Submit settings tab
...
Field
...
Description
...
Error title
...
Title displayed when an error occurs, for example "There was a problem with your booking."
...
Success title
...
Title displayed when the form is submitted successfully, for example "Your tour is booked"
...
Text
...
Text displayed when form is submitted successfully, for example "Details are on their way to your inbox."
...
Page displayed after submission
...
Select a page to display after submission. If no page is selected, the user stays on the current page and the success title and text are displayed instead.
...
Track mail
...
Logs the information submitted in the form to magnolia-form.log
file.
Make sure the trackEMail
form processor is also enabled. See Logging form data.
Email tab
...
Field
...
Description
...
From
...
Email address displayed in the From field of the outgoing message. This can be any address as it is not the account used to send the mail. The mail is sent using the account in SMTP configuration .
...
To
...
Email address the data is sent to. You can use form field names with Freemarker tags. Typically you would ask the submitting user for their email address on the form and repeat it here with a Freemarker tag such as ${email}
assuming the email field is named email
.
...
Subject
...
Email subject line. You can use form field names with Freemarker tags such as ${subject
}.
...
Available fields for Freemarker syntax
...
Form field names that can be used in Freemarker tags.
...
Type
...
Radio button to select the message type for the email body.
...
text
...
Displays a text field to compose the email template. You can use form field names with Freemarker tags such as ${subject
} and ${message
} to write the data collected on the form into the message.
...
html
...
Confirmation email tab
...
Field
...
Description
...
Send confirmation
...
Sends a confirmation mail to the submitting user.
Make sure the SendConfirmationEMailProcessor
form processor is also enabled.
...
From
...
Email address displayed in the From field of the outgoing message. You might want to use a customer support address here in case the user has further questions or a no-reply address. You can use form field names with Freemarker tags.
...
To
...
Email address the data is sent to. You can use form field names with Freemarker tags such as ${email}
.
...
Subject
...
Email subject line, for example "We have received your feedback." You can use form field names with Freemarker tags such as ${subject
}.
...
Available fields for Freemarker syntax
...
Form field names that can be used in Freemarker tags.
...
Mail type
...
Radio button to select the message type. For code and text you can use form field names with Freemarker tags such as ${subject
} and ${message
} to write the data collected on the form into the message. This can be a simple acknowledgement that data was submitted or you can summarize the collected data.
...
code
...
text
...
Displays a Text field to compose the email template.
...
page
...
- Confirms the deletion request.
See GDPR and forms too.
Creating a multistep form
Info |
---|
See an example multistep form on the "Book your tour" page of the Travel demo. |
Splitting a large form into multiple steps allows the visitor to focus on one step at a time. The substeps are detected automatically. Visitors can move forward and backwards between steps without losing entered data. Each step is validated individually. The form module also allows users to upload files, but the upload field should only be included as the last step of the process.
Add the Form Step component to an area of a template.
Example: AddingformStep
component tomain
area in a new template.Code Block language js title /my-module/templates/pages/form.yaml templateScript: /my-module/templates/pages/formStep-page-template.ftl renderType: freemarker visible: true title: Form Step Template dialog: my-module:pages/form areas: main: availableComponents: form: id: form:components/formStep
- Create a new page based on a template that contains the Form component. This is the first page of the form.
- Configure the form settings.
- Add a field set component
- Add fields inside the field set. The Submit button field will automatically navigate to the next step. Conditional steps can be set in the Next step condition component.
- Create subpages based on the template that contains the Form Step component (created in 1. above) for the subsequent steps of the form.
- Add field sets and fields on the substep forms. Submit button fields will automatically navigate to subsequent or conditional steps and the final button will submit the form.
- Add field sets and fields on the substep forms. Submit button fields will automatically navigate to subsequent or conditional steps and the final button will submit the form.
Configuring form settings
Form settings are configured in the Form component.
Form tab
Field | Description |
Title | Title displayed above the form. For example "Contact Us". |
Form name | Internal name that allows you to reference the form by name, for example from JavaScript. |
Text | Introductory text displayed below the form title. |
Marker for required fields | Character displayed next to required fields. Asterisk by default. |
Text for required symbol | Text that explains what the required marker means, displayed near the top of the form. For example "Required fields". |
Step-by-step navigation | When checked displays step-by-step breadcrumb navigation that allows the user to navigate the steps of multistep forms. |
Submit settings tab
Field | Description |
Error title | Title displayed when an error occurs, for example "There was a problem with your booking." |
Success title | Title displayed when the form is submitted successfully, for example "Your tour is booked" |
Text | Text displayed when form is submitted successfully, for example "Details are on their way to your inbox." |
Page displayed after submission | Select a page to display after submission. If no page is selected, the user stays on the current page and the success title and text are displayed instead. |
Track mail | Logs the information submitted in the form to |
Email tab
Field | Description |
From | Email address displayed in the From field of the outgoing message. This can be any address as it is not the account used to send the mail. The mail is sent using the account in SMTP configuration . |
To | Email address the data is sent to. You can use form field names with Freemarker tags. Typically you would ask the submitting user for their email address on the form and repeat it here with a Freemarker tag such as |
Subject | Email subject line. You can use form field names with Freemarker tags such as |
Available fields for Freemarker syntax | Form field names that can be used in Freemarker tags. |
Type | Radio button to select the message type for the email body. |
text | Displays a text field to compose the email template. You can use form field names with Freemarker tags such as |
html | Displays a Rich text field to compose the email template. You can use markup that will be escaped. |
Confirmation email tab
Field | Description |
Send confirmation | Sends a confirmation mail to the submitting user. |
From | Email address displayed in the From field of the outgoing message. You might want to use a customer support address here in case the user has further questions or a no-reply address. You can use form field names with Freemarker tags. |
To | Email address the data is sent to. You can use form field names with Freemarker tags such as |
Subject | Email subject line, for example "We have received your feedback." You can use form field names with Freemarker tags such as |
Available fields for Freemarker syntax | Form field names that can be used in Freemarker tags. |
Mail type | Radio button to select the message type. For code and text you can use form field names with Freemarker tags such as |
code | Displays a Code field (includes syntax highlighting) to compose the email template. |
text | Displays a Text field to compose the email template. |
page | A page in the site that the user is sent to after successful submission. |
Field sets
The purpose of a field set is to group fields that logically belong together:
- Before you can add any fields on the form you need to add at least one field set component.
- You can add as many field sets as necessary.
- Use the Title field to distinguish field sets or include introductory text.
- Individual fields components are added as subcomponents in a field set.
- Component definition:
formGroupFields
Fields
Field components are added within a field set.
Available fields:
Field | Description | Image | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Input |
Advanced options: Not all input types and attributes are supported in all browsers.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Number or date |
Advanced options: Not all input types and attributes are supported in all browsers.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Text field group |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Selection |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
File |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Submit button |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Hidden |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Honeypot |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Form summary |
|
Info |
---|
Users are allowed to enter HTML-like characters such as ampersand (&) into fields. Use the noHTML validator to prevent this. You can control HTML escaping with the |
Conditional steps
The Condition list component provides optional, additional business logic to a multistep form .
- The component is added automatically after a Submit button field, as an optional area.
- Allows you to set conditions for subsequent steps in a multistep form.
Allows you to define the page the user is directed to, dependent on their entry in a former step.
Field validators
Validators are used to ensure that form data is entered in the correct format. For example, an email address should follow established syntax where a local part is followed by the @ character and a domain: john.doe@example.com
.
Choose a validator for appropriate fields in the Validation field.
When field validation passes, the value is submitted. When field validation fails, the field is highlighted in red and when the user attempts to submit the form a notification message identifies the problem.
Validators are configured in /modules/form/config/validators/
:
Properties:
validators | required Validator configuration node |
| required Name of the validator. |
| required Validator class that performs the validation. |
| required/optional Available properties depend on the validator class. |
Validator configurations:
email | Value needs to be a valid email address. Properties:
| ||||||||||
number | Value needs to be a number, specifically an integer. No decimals separated with period or comma or fractions are accepted. Properties:
| ||||||||||
noHTML | Value cannot any have HTML markup. This ensures that users can only enter plain text. Creating links and formatting text is prevented. Property:
| ||||||||||
password | Validates that the password entered into two password fields match. Used to eliminate typos. Property:
| ||||||||||
fileUpload | Validates against a list of allowed mime types and a max file size. Properties:
| ||||||||||
empty | No validation. Used for Honeypot field only. Properties:
| ||||||||||
username | Verifies that the entered username does not exist in the system. This validator is added by the Public User Registration (PUR) module.
| ||||||||||
uniqueEmail | Verifies that the entered email does not exist in the system. This validator is added by the Public User Registration (PUR) module.
|
Form processors
Form processors configured in the module are responsible for sending submitted form data by email. The processors are executed when the form is submitted. The email content corresponds with the settings configured in the relevant tabs of the Form component.
Processors are configured in /modules/form/templates/components/form/formProcessors
.
Properties:
formProcessors | required Form processor node. | ||||||||||||||||||
| required Name of the form processor. | ||||||||||||||||||
| required
| ||||||||||||||||||
| optional , default is Enables and disables the processor | ||||||||||||||||||
| required The logger name. Only relevant for |
Creating a custom form processor
The three example form processors above send the form data in email, but you can write a custom form processor to do almost anything. If you need to store the data in a database or process it in another way, write your own form processor. You can also try the Form2DB App that is a community developed app that saves form data via form processor into the JCR and allows for export to XLS.
Info |
---|
Create a new form component definition for your custom processor. If you simply add the custom processor to the default component definition it will be executed for all forms. |
For more examples see Form processors in the PUR module.
You can also create a form processor with server-side JavaScript.
Form components
The form components are configured in /modules/form/templates/components
.
Field sets
The purpose of a field set is to group fields that logically belong together:
- Before you can add any fields on the form you need to add at least one field set component.
- You can add as many field sets as necessary.
- Use the Title field to distinguish field sets or include introductory text.
- Individual fields components are added as subcomponents in a field set.
- Component definition:
formGroupFields
Fields
Field components are added within a field set.
Available fields:
...
- Single line text input or text area.
- Maximum input length option.
- Component definition:
formEdit
.
Advanced options: Not all input types and attributes are supported in all browsers.
...
Color
...
...
...
...
Password
...
...
Search
...
Text
...
Url
...
...
Placeholder
...
...
Pattern
Regular expression that the input value is checked against. For example [A-Za-z]{3}
for a three letter country code.
Please note that this attribute has no effect at this time. We are aware of this issue and working on a bugfix for this. Jira server Magnolia - Issue tracker columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 500b06a6-e204-3125-b989-2d75b973d05f key MGNLFORM-296
As a temporary workaround, you can configure the regex expression as a separate validator for the field under
/modules/form/config/validators
.
...
...
Pattern description
...
Read only
...
Disabled
...
...
Autofocus
...
Autocomplete
...
...
...
- Number or date field.
- Maximum input length option.
- Component definition:
formNumber
(extendsformEdit)
.
Advanced options: Not all input types and attributes are supported in all browsers.
...
Date
...
...
Datetime
...
<input type = datetime>
. To enter or select a date and time with a timezone.
This type is no longer supported by the latest HTML standards, see
- https://html.spec.whatwg.org/dev/input.html#the-input-element
- https://www.w3.org/TR/html5/sec-forms.html#the-input-element
Modern browsers may differ in how they render this type, most of them displaying a simple textfield instead.
...
...
Datetime-local
...
...
Month
...
...
Number
...
...
Phone number
...
Range
...
...
Time
...
...
Week
...
...
Read only
...
Disabled
...
Autofocus
...
Autocomplete
...
Minimum
...
Maximum
...
Step
...
...
- Groups text fields next to each other.
- The Group dialog has a single field that does not display on the page. Assign this name to reference the group with FreeMarker tags.
- The subcomponents are Text fields, i.e. Input fields without advanced options.
- Component definition:
formGroupEdit
that nestsformGroupEditItem
...
...
- Checkbox, select and radio buttons.
- Multiple selection, default value and orientation options.
- Component definition:
formSelection
.
...
...
- Upload file component.
- In multistep forms this is only available on the last step.
- Component definition:
formFile
.
...
...
- Submits the form.
- Can be labelled as required.
- Cancel button and Back button (mulitstep forms) options.
- Component should be added at the end of the form.
- Component definition:
formSubmit
.
...
...
- Single hidden line input or text area.
- Does not display on the page.
- Used to pass on values to the form processors in the same way as other data entered by a user.
- Component definition:
formHidden
.
...
- This is an invisible field that you can add to the page to intercept bot attacks.
- Component definition:
formHoneypot
.
...
...
- Displays a table with parameters and/or values of the steps in a multistep form.
- Component definition:
formSummary
Info |
---|
Users are allowed to enter HTML-like characters such as ampersand (&) into fields. Use the noHTML validator to prevent this. You can control HTML escaping with the |
Info |
---|
5.4.4+ Password field is deprecated. Use two Input fields with input type Password instead. Validate the second field using the Password validator. |
Conditional steps
The Condition list component provides optional, additional business logic to a multistep form .
- The component is added automatically after a Submit button field, as an optional area.
- Allows you to set conditions for subsequent steps in a multistep form.
Allows you to define the page the user is directed to, dependent on their entry in a former step.
Field validators
Validators are used to ensure that form data is entered in the correct format. For example, an email address should follow established syntax where a local part is followed by the @ character and a domain: john.doe@example.com
.
Choose a validator for appropriate fields in the Validation field.
When field validation passes, the value is submitted. When field validation fails, the field is highlighted in red and when the user attempts to submit the form a notification message identifies the problem.
Validators are configured in /modules/form/config/validators/
:
...
heading | 0 |
---|---|
multiple | false |
enableHeadingAttributes | false |
enableSorting | false |
class | m5-configuration-tree |
enableHighlighting | false |
...
Mgnl f |
---|
...
Mgnl f |
---|
...
Mgnl f |
---|
...
Mgnl n |
---|
...
Mgnl p |
---|
...
Mgnl p |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl p |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
Properties:
validators | required Validator configuration node |
| required Name of the validator. |
| required Validator class that performs the validation. |
| required/optional Available properties depend on the validator class. |
Validator configurations:
...
Value needs to be a valid email address.
Properties:
class | required
| ||||
expression | required Validity is checked with regular expression |
...
Value needs to be a number, specifically an integer. No decimals separated with period or comma or fractions are accepted.
Properties:
class | required
| ||||
expression | required Validity is checked with regular expression |
...
Value cannot any have HTML markup. This ensures that users can only enter plain text. Creating links and formatting text is prevented.
Property:
class | required
< > ). |
...
Validates that the password entered into two password fields match. Used to eliminate typos.
Property:
class | required
password and passwordConfirmation . |
...
Validates against a list of allowed mime types and a max file size.
Properties:
class | required
| ||||
maxFileSize | optional, default is Max file upload size | ||||
allowedMimeTypes | optional Content node for list of allowed mimeTypes. Add a property for each additional type. By default, |
...
No validation. Used for Honeypot field only.
Properties:
class | required
| ||||
expression | required
|
...
Verifies that the entered username does not exist in the system. This validator is added by the Public User Registration (PUR) module.
class | required
|
...
Verifies that the entered email does not exist in the system. This validator is added by the Public User Registration (PUR) module.
class | required
|
Form processors
Form processors configured in the module are responsible for sending submitted form data by email. The processors are executed when the form is submitted. The email content corresponds with the settings configured in the relevant tabs of the Form component.
Processors are configured in /modules/form/templates/components/form/formProcessors
.
...
heading | 0 |
---|---|
multiple | false |
enableHeadingAttributes | false |
enableSorting | false |
class | m5-configuration-tree |
enableHighlighting | false |
...
Mgnl f |
---|
...
Mgnl f |
---|
...
Mgnl f |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl p |
---|
...
Mgnl p |
---|
...
Mgnl n |
---|
...
Mgnl p |
---|
...
Mgnl p |
---|
...
Mgnl n |
---|
...
Mgnl p |
---|
...
Mgnl p |
---|
...
Mgnl p |
---|
...
Properties:
...
required
Form processor node.
...
<form processor name>
...
required
Name of the form processor.
...
class
...
required
info.magnolia.module.form.processors.SendContactEMailProcessor
(
): Sends form data in email to the address specified in the To field. The processor extracts values from the From, To, Subject and Text fields and creates an email message in plain text or HTML format depending on form settings. Any uploaded files are sent as attachments.Javadoc resource link className info.magnolia.module.form.processors.SendContactEMailProcessor renderType asynchronous info.magnolia.module.form.processors.SendConfirmationEMailProcessor
(
): Sends a confirmation email. The processor first verifies if the Send confirmation checkbox is checked and sends a message to the address specified in the To field. By default, this processor is not enabled. This is the case even if the Send confirmation checkbox is checked in form settings. To enable it, add anJavadoc resource link className info.magnolia.module.form.processors.SendConfirmationEMailProcessor renderType asynchronous enabled
property under the processor and set the value totrue
.info.magnolia.module.form.processors.TrackEmailProcessor
(
): Writes the content of the submitted form toJavadoc resource link className info.magnolia.module.form.processors.TrackEmailProcessor renderType asynchronous magnolia-form.log
file if the Track Mail checkbox is checked. By default, this processor is not enabled. This is the case even if the Track Mail checkbox is checked in form settings. To enable it, add anenabled
property under the processor and set the value totrue
.
...
enabled
...
optional , default is false
Enables and disables the processor
...
loggerName
...
required
The logger name. Only relevant for trackEmail
processor.
Creating a custom form processor
The three example form processors above send the form data in email, but you can write a custom form processor to do almost anything. If you need to store the data in a database or process it in another way, write your own form processor. You can also try the Form2DB App that is a community developed app that saves form data via form processor into the JCR and allows for export to XLS.
Info |
---|
Create a new form component definition for your custom processor. If you simply add the custom processor to the default component definition it will be executed for all forms. |
For more examples see Form processors in the PUR module.
You can also create a form processor with server-side JavaScript.
Form components
The form components are configured in /modules/form/templates/components
.
...
heading | 0 |
---|---|
multiple | false |
enableHeadingAttributes | false |
enableSorting | false |
class | m5-configuration-tree |
enableHighlighting | false |
...
Mgnl f |
---|
...
Mgnl f |
---|
...
Mgnl f |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
...
Mgnl n |
---|
Mgnl n |
---|
...
Info | ||||||
---|---|---|---|---|---|---|
|
...