Enable Adaptive Forms Core Components on AEM 6.5 Forms

Applies to: ✅ Adaptive Form Core Components ❎ Adaptive Form Foundation Components.

Enabling Adaptive Forms Core Components lets you start creating, publishing, and delivering Core Components based Adaptive Forms and Headless Adaptive Forms from your AEM 6.5 Forms environment.

To enable Adaptive Forms Core Components on your AEM 6.5 Forms environment, setup and deploy an AEM Archetype 41 or later based project (with forms options enabled) on all of your Author and Publish instances.

This article provides detailed instructions to setup and deploy AEM Archetype 41 or later based project on your AEM 6.5 Forms environment to enable Adaptive Forms Core Components. You can refer to the list below for AEM 6.5 compatible versions for enabling Forms Core Components:

Prerequisites

Before enabling Adaptive Forms Core Components on an AEM 6.5 Forms environment:

• Upgrade to AEM 6.5 Forms Service Pack 16 (6.5.16.0) or later.

• Install the latest release of Apache Maven.

• Install a plain text editor. For example, Microsoft Visual Studio Code.

Create and deploy latest AEM Archetype based project

To create an AEM Archetype 41 or later based project and deploy it to all of your Author and Publish instances:

1. Log in to your computer, hosting and running your AEM 6.5 Forms instance, as an administrator.

2. Open the command prompt or terminal and run the following command to create AEM Archetype project (with forms options enabled):

   • Microsoft Windows

   
      mvn -B org.apache.maven.plugins:maven-archetype-plugin:3.2.1:generate ^
      -D archetypeGroupId=com.adobe.aem ^
      -D archetypeArtifactId=aem-project-archetype ^
      -D archetypeVersion=41 ^
      -D appTitle="My Form" ^
      -D appId="myform" ^
      -D groupId="com.myform" ^
      -D includeFormsenrollment="y" ^
      -D aemVersion="6.5.15"
   
   

   • Linux or Apple macOS

   
      mvn -B org.apache.maven.plugins:maven-archetype-plugin:3.2.1:generate \
      -D archetypeGroupId=com.adobe.aem \
      -D archetypeArtifactId=aem-project-archetype \
      -D archetypeVersion=41 \
      -D appTitle="My Form" \
      -D appId="myform" \
      -D groupId="com.myform" \
      -D includeFormsenrollment="y" \
      -D aemVersion="6.5.15"
   
   

   When you execute the above command, be sure to consider the following points:

   • Do not change the value of the aemVersion property from 6.5.15.0 to anything else.

   • Set the archetypeVersion property to 41 or later. For latest version, see system requirements section in AEM Project Archetype documentation.

   • Update the command to reflect the specific values for your environment, including the appTitle, appId, and groupId. Also, set the value of the includeFormsenrollment property to y. If you use Forms Portal, set the includeExamples=y option to include Forms Portal Core Components in your project.

3. (Only for Archetype version 41 based projects) After the AEM Archetype project is created, enable themes for Core Components based Adaptive Forms. To enable themes:

   1. Open the [AEM Archetype Project Folder]/ui.apps/src/main/content/jcr_root/apps/appId/components/adaptiveForm/page/customheaderlibs.html for editing:

   2. Add the following code at line 21:

      
      <sly data-sly-use.clientlib="core/wcm/components/commons/v1/templates/clientlib.html"
      data-sly-use.formstructparser="com.adobe.cq.forms.core.components.models.form.FormStructureParser"
      data-sly-test.themeClientLibRef="${formstructparser.themeClientLibRefFromFormContainer}">
      <sly data-sly-test="${themeClientLibRef}" data-sly-call="${clientlib.css @ categories=themeClientLibRef}"/>
      </sly>
      
      

      

   3. Save and close the file.

4. Update project to include latest version of Forms Core Components:

   1. Open the [AEM Archetype Project Folder]/pom.xml for editing.

   2. Set version of core.forms.components.version and core.forms.components.af.version to latest Forms Core Components version and ensure both have the same version as Forms Core Components mentioned in the table, and set version of core.wcm.components.version as given in the WCM Core Components.

      WARNING

      • When creating an Archetype project with version 45, the [AEM Archetype Project Folder]/pom.xml initially sets the forms core components version to 1.1.28. Prior to building or deploying the Archetype project, update the forms core components version to 1.1.26.
      NOTE

      • If you set up any other topology, ensure that you add the submit, prefill, and other URLs to the allowlist at the Dispatcher layer.

   3. Save and close the file.

5. After the AEM Archetype project is created successfully, build the deployment package for your environment. To build the package:

   1. Navigate to the root directory of your AEM Archetype project.

   2. Run the following command to build the AEM Archetype project for your environment:

      
      mvn clean install
      
      
      

      

   After the AEM Archetype project is successfully built, an AEM Package is generated. You can find the package at [AEM Archetype Project Folder]\all\target[appid].all-[version].zip

6. Use the Package Manager to deploy the [AEM Archetype Project Folder]\all\target[appid].all-[version].zip package on all the Author and Publish instances.

The Core Components are enabled for your environment. A blank Core Components based Adaptive Form template and Canvas 3.0 theme are deployed to your environment, enabling you to create Core Components based Adaptive Forms.

Frequently Asked Questions

What are core components?

The Core Components are a set of standardized Web Content Management (WCM) components for AEM to speed up development time and reduce maintenance cost of your websites.

What all is capabilities are added on enabling core components?

When the Adaptive Forms Core Components are enabled for your environment, a blank Core Components based Adaptive Form template and Canvas 3.0 theme are added to your environment. After enabling Adaptive Forms Core Components for your environment, you can:

• Create Core Components based Adaptive Forms.
• Create Core Components based Adaptive Form templates.
• Create custom themes for Core Components based Adaptive Form templates.
• Serve Core Component based Adaptive Form’s JSON representations to channels such as mobile, web, native apps, and services that require a form’s headless representation.

What’s Next

• Create a Core Components based Adaptive Form
• Create or Add an Adaptive Form to an AEM Sites Page or Experience Fragment
• Create themes for Core Components based Adaptive Forms
• Create a template for Core Components based Adaptive Forms