Form component
in Common Forms

main container component to configure a form

  • set Action Type on submit
  • define form layout / style
  • e-mails configuration
  • define Next Step Page

The Form component serves as container for all Common Forms components. Its settings define the Style, sent e-mails, Action Type and Next Step Page.

on this page:

Introduction

The Form component is the most important component when creating a form. Its settings define what action is taken on a submit, the e-mails sent are configured and the general style is set. This means that every form must contain the Form component. It also serves as the container where all Common Forms component must be placed in. The data, put in by the visitor into the various form components, can then be passed onto the Confirmation Mails and is stored in GEM, accessible via the Bulk Editor.

There are two different Action Types that are available: Internal & External Mail and Next Step. These types define what action is taken upon submitting the form. All other available types are for SLSP use only.

Glossary:

Display & Usage

The Form component, that is created in a Modal Content Page is either loaded in a Modal Overlay or embedded in the Form Reference component in a Standard Content Page. The -component is used to define the form configuration and the style for the entire form. It has therefore no actual display (besides the Style) or user interaction.

Please find a form example loaded as a Modal Overlay by pressing the following link: 

And find below a form example, embedded to the page via the Form Reference component:

Example form in Form Reference

Additionally, the Form component serves as the container for all other Common Forms components. So a proper set-up would look as follows. All "sub-components" are placed within the Form component. These components are then fillable by a page visitor and its data can be sent via a Confirmation Mail and gets stored in GEM.

One step form with Thank You Page

Use case: A page visitor opens a form, fills in all the necessary data, clicks on Submit and the Thank You Page gets loaded.

This simple form only consists of a Modal Content Page with the Form component in it and a link to the Thank You Page. For this set-up, the Action Type of the form must be set to Internal & External Mail (see below) and as the Next Step page, the designated Thank You Page assigned.

Multiple steps form with Thank You Page

Use case: A page visitor opens a form, fills in all the necessary data, clicks on Continue, the next page gets loaded, fills in all the necessary date, clicks on Submit and the Thank You Page gets loaded.

This Multiple Stepls form must be created with multiple Modal Content Pages which contain a Form component. The Action Type of each step must be set to Next Step. On the last form step, the Action Type is set to Internal & External Mail (see below) and as the Next Step page, the designated Thank You Page assigned.

Please see the Multiple Steps Form help page for further information.

Action Types

Forms are always used to perform an action upon submit. So it is possible to either load the next step of a form (in a Multiple Steps form) or to display the Thank You Page and trigger the Confirmation Mails to be sent and store the put in data. In any case, the field Next Step Page must be configured (and set either as an additional form or as the Thank You Page). 

Available Action Types are Internal & External Mail and Next Step. Please note that all other configurable Action Types are for the sole use of SLSP and are not described here.

Internal & External Mail

This Action Type is used to configure the e-mails sent upon submitting a form. As the name states, there are two different mails that can be sent. An internal one to e.g. the servicedesk of your entity and an external one to the form submitter, stating that the form was received. Please see the E-mails set-up chapter for more details.

If this Action Type is chosen, the Action Configuration element gets activated and the internal and external mail settings can be configured. Please note that it is mandatory to fully configure the Internal Confirmation Mail. The External Confirmation Mail is optional. In the configuration, the e-mail sender and recipient information as well as the actual mail content is defined.

In the Message Template (mail conent), it is possible to inject the form data, that was filled in by the submitter (portal visitor). This data is also accessble in the GEM database via the link View Data that leads to the Bulk Editor.

In a Muliple Steps form, this Action Type must be set on the last step.

Please see the Action Configuration chapter for further information.

Also in a form with the Action Type = Internal & External Mail, the Next Step Page must be filled in, with the path to the previously created Thank You Page. So on submitting the form, the mails are sent, the data gets stored and the Thank You Page gets loaded.

Please see the Thank You Page help page for further information.

Next Step

This Action Type is used in Multiple Steps Mails only in order to define the next form step to be loaded after a click on Submit / Next Step button. There are no Action Configurations to be set up. Simply define the Next Step Page in the respective field.

Please see the Multiple Steps Form help page for further information.

E-mails set-up

If the Action Type is set to Internal & External Mail, the Confirmation Mails can be set up in the Action Configuration. In order to create the actual content of the mail, the field Message Template must be filled in.

The mail content can be written in HTML and is therefore fully customizable. If you are not familiar with HTML, it is of course possible to create simple mails by only adding line breaks with the HTML break tag <br>.

Component Name placeholders

The data put in by a form submitter (page visitor) can be reflected in the Message Template in order to submit the data in the Internal Confirmation Mail to the person responsible for handling such mails (e.g. servicecenter) and to show the data put in to the submitter himself in the External Confirmation Mail.

Almost every Common Forms component that is put inside the Form component is a potential data source. By defining the Name of a component, it receives a unique ID.

This ID can then be added as a placeholder in the Message Template to get the data put in by the form submitter into the Confirmation Mails. This means that once the mails get sent, the placeholder is replaced with the acutal put in data.

The placeholder is created by adding the Name with curly brackets to the message, e.g. {form_of_address}.

So in a form, with the following elements:

  • Text component with Name = comment
  • Selection component with Name = form_of_address
  • Text component with Name = first_name
  • Text component with Name = familiy_name
  • Text component with Name = email

the Message Template could be created as follows:

Dear {form_of_address} {family_name},<br><br>

thank you for your message!<br>
You have provided us with the following data:<br><br>

My comments/questions:{comments}<br>
Form of address:{form_of_address}<br>
First name:{first_name}<br>
Family name:{family_name}<br>
E-mail:{email}<br><br>

Best regards,<br>
Erste Group IT

Please try it out yourself by pressing the below link. Simply put in some personal data and your e-mail address, submit the form and check your inbox: 

Placeholder for e-mail address

When setting up the External Confirmation Mail, the e-mail address of the recipient must be set (To Email Address). In order to know the correct e-mail address, the submitter must state his address in the form. The Name of this component can then be taken as a placeholder to the To Email Address field.

On the form submission, the placehlder gets replaced with the real e-mail address stated.

General system provided placeholders

Besides the manually created placeholders by component Name, there are some pre-defined placeholders that can also be added to the Message Template.

Specific Branches related placeholders

Additionally, if forms are used in combination with institutes or branches (in Branch Search), the following placeholders can be used that are filled with API-data during the form submission:

Form data evaluation / Bulk Editor

The data that is filled in by a form submitter is not only sent by mail (with Action Type = Internal & External Mail), but it is also stored in the GEM database. This data is accessible via the link View Data in the Action Configuration of a form.

This link leads to the so called Bulk Editor where the data of this specific form is accessible and downloadable.

Please see the Bulk Editor help page for more information.

Component settings

The Form component serves as the container, in which the Common Forms components are added. In its confiuguration, the action taken on submitting a form (Action Type) and the general Styling options are set. Depending on the chosen Action Type, the e-mail set up of the Internal and External Confirmation Mails is performed.

A common form is set up as follows: A Form component is placed in a Modal Content Page. Inside the Form component, Common Forms or GEM Common components are added to define the form content. In the settings of the Form component, the Action Configuration (Internal & External Mail) and the Next Step Page (Thank You) are set.

tab: General

In the General tab, all important Form settings are configured, e.g. what action is performed on a submit or the content of the mails sent on a submit.

Action Configuration

Internal Confirmation Mail

The Internal Confirmation Mail is used to send the data put in by a visitor to a designated address within your company where enquires and such are being taken care of, e.g. a servicecenter. It is mandatory to define a correct Internal Confirmation Mail in order for a form to work properly.

The data put in the form by a visitor can be collected by manually adding the single component's name placeholders into the Message Template.

External Confirmation Mail

The External Confirmation Mail is used to sent a confirmation to the visitor who just submitted a form. Its content is freely configurable but meant to thank the visitor for the form submission and state that things are getting taken care of. The mail set-up is optional.

The data put in the form by a visitor can be collected by manually adding the single component's name placeholders into the Message Template. By doing so, also the To Email Address field can be defined, e.g. {email}.

Service Call Configuration

This service provides the set up of a URL pattern used to communicate with an API. It is currently only set up for SLSP. Please get in touch with the GEM Helpdesk if you want to use this feature.

Advanced

This service is an AEM standard feature and not used in GEM (yet). Please ignore.

tab: Styling

In the Styling tab, the width of the entire form and its background color are set.

Step by step

1

2

3

4

5

6

7

Related topics

Used recurring elements