Embed an Adaptive Form to an AEM sites page

Overview

AEM Forms allows form developers to seamlessly embed adaptive forms in an AEM Sites page or a web page hosted outside AEM. The embedded Adaptive Form is fully functional and users can fill and submit the form without leaving the page. It helps user remain in context of other elements on the web page and simultaneously interact with the form.

In AEM Sites page, you can add an Adaptive Form using:

  • AEM Forms Container component
    AEM Forms provides a component that you can add to your site pages. The AEM Forms Container component lets you embed an Adaptive Form.

  • Asset browser
    All the forms are available under Assets. You can drag-drop the form as an asset on your page.

Prerequisites

To embed an Adaptive Form in an AEM Sites page that uses an editable template, ensure that the AEM Form component is configured as an allowed component in the associated template.

In case AEM Forms Container component is not visble in the Component browser panel of AEM sites page, perform the following steps as illustrated in the video.

In case Sites page is using a static template, you need to configure it in the paragraph system of the site page.

Embedding an Adaptive Form

To embed an Adaptive Form using AEM Forms Container component:

  1. Open the AEM sites page, in edit mode, in which you want to embed an Adaptive Form.

  2. From the Component browser panel, drag-drop the AEM Forms Container component on the page. Alternatively, you can search for an Adaptive Form in the Assets browser and drag-drop it onto the Sites page. It embeds the form in an AEM Forms Container. You can create and add a new Adaptive Form or Embed an existing Adaptive Form.

    NOTE

    Multiple AEM Forms Container components on a page are not supported.

  3. To create and embed a new form, on the component toolbar, tap the Create Form icon. A window to create the new form opens.

  4. Tap the embedded AEM Forms Container component in the sites page, and then tap settings_icon on the action bar. The Edit AEM Forms Container dialog opens.

  5. In the Edit AEM Forms Container dialog, specify the following.

    Asset Type: Select the type of asset to embed.

    • Asset Path: Browse and select the Adaptive Form to embed. It is auto-populated if you dropped it from the Assets browser.
    • Post Submission : Select the action to trigger on form submission. You can choose to show a thank you message or a thank you page.
      • Show

      • Thank You Message: Write a message using the rich text editor to show on form submission. This option is available only when you choose to show a thank you message.

      • Thank You Page: Browse and select the page to display on form submission. This option is available only when you choose to show a thank you page.

        • Redirect to thank you page: Enable the option to replace the page containing the embedded Adaptive Form with thank you page. Otherwise, the thank you page replaces the Adaptive Form in the AEM Forms container, without refreshing underlying sites the page. This option is available only when you choose to show a thank you page.
    • Use Page Language: Use local of the AEM Sites page instead locale of Adaptive Form.
    • Set Focus on Form: Select to set the focus on the first field of the Adaptive Form.
    • Theme: Select a theme that defines styling for components of your Adaptive Form. Styling includes appearance properties such as font style, background color, dimensions, and alignment.
    • Form covers entire width of the frame: If checked, iframe is not used used to render the form.
    • Height: Specify the height of the container. Leave it blank to automatically resize the container.
    • CSS Client library: Specify path to a CSS client library.
  6. Save the settings. The Adaptive Form is now embedded in the page.

AEM site also allows you to create an Adaptive Form on the fly using the AEM forms container component. Follow the steps to create an Adaptive Form using AEM Forms container component on AEM sites page:

  1. Open the AEM sites page, in edit mode, in which you want to embed an Adaptive Form.

  2. From the Component browser panel, drag-drop the AEM Forms Container component on the page.

  3. Click on the Plus icon and you will be redirected to the form creation wizard.

    AEM Form Container Component

  4. When an Adaptive Form is created, you are redirected to the AEM sites page and the created form renders at the AEM sites page.

Publishing embedded Adaptive Form

Let’s consider the following scenarios for publishing an embedded Adaptive Form in AEM sites page:

  • If you are publishing the AEM sites page for the first time and it includes an embedded Adaptive Form, publish the sites page and the embedded asset.
  • If you modified only the embedded Adaptive Form in a published site page, publish the original asset and the changes reflect in the published site page. The published site page includes a reference to the asset and does not require republishing the page.
  • If you modified the sites page and the embedded Adaptive Form , republish the sites page and the embedded asset.

Modifying embedded Adaptive Form

AEM sites page maintains a reference to the Adaptive Form in the AEM Forms Container. Therefore, all configurations and properties, such as the theme, styles, and submit action, configured in the original Adaptive Form are retained in the embedded Adaptive Form .

To modify any configuration or property of the embedded Adaptive Form, do one of the following.

  • Open the original form in adaptive forms in respective editors and modify them.
  • Tap the Adaptive Form from within the site page in edit mode and then tap Edit in a new window. The original form opens in edit mode that you can modify.
NOTE

The changes made in the original Adaptive Form automatically reflect in the embedded form. However, republish the Adaptive Form, or the site page to reflect the changes in the published page.

Considerations and best practices

Do keep the following points in mind when embedding adaptive forms in AEM sites pages:

  • Header and footer in the original form are not included in the embedded form.
  • User drafts and submissions of embedded forms are supported and visible in Drafts and Submitted Forms tabs on the forms portal.
  • The submit action configured on the original form is retained in the embedded form.
  • Experience targeting and A/B tests configured on the original form do not work in the embedded form. However, you can use experience targeting on the sites page to present different forms based on user profiles.
  • If you have Adobe Analytics configured for the original form, the analytics data of the embedded form is captured in Adobe Analytics. However, it is not available in the forms analytics report.

On this page