Repository files navigation

The AEM Forms Core Components project serves as accelerator to get started with projects using AEM Forms. The project contains re-useable Forms core components which are server-side rendered AEM components for dynamic experiences / data.

This project is intended to be used in conjunction with theAEM Sites Core Components. AEM Forms Core Components use the AEM Sites Core Components as a foundation where possible and extending them.

SeeAEM Sites Core Components for usage and configuration instructions of the AEM Forms Core Components.

https://opensource.adobe.com/aem-core-forms-components/

• Adaptive Form - Embed

• Link Component
• Drafts and Submissions Component
• Search and Lister Component

• Form Container
• Text Input
• Number Input
• Date Picker
• File Attachment
• Dropdown List
• Checkbox Group
• Radio Button Group
• Button
• Panel
• Accordion
• Wizard
• Horizontal Tabs
• Text
• Image
• Title
• Submit Button
• Reset Button
• Email Input
• Telephone Input
• Header
• Footer
• Switch
• ReCaptcha
• HCaptcha
• Terms and Conditions
• Checkbox
• Review
• Turnstile

• XFA Page

To create XFA-based core component forms, you need to use the XFA Page component. This component serves as the foundation for rendering XFA forms.

The latest version of the AEM Forms Core Components, require the below minimum system requirements:

For a list of requirements for previous versions, seeHistorical System Requirements.

This project relies on theAEM Sites Core Components. They are typically installed as part of AEM. If you install AEM without sample content option you have todeploy them manually before using the AEM Forms Core Components. See the System Requirements above for version requirements.

To compile your own version of the Core Components, you can build and install everything on your running AEM instance by issuing the following command in the top level folder of the project:

mvn clean install -PautoInstallPackage

You can also install individual packages/bundles by issuing the following command in the top-level folder of the project:

mvn clean install -PautoInstallPackage -pl<project_name(s)> -am

With AEM as a Cloud Service SDK, use the cloud profile as follows to deploy the components into/libs instead of/apps:

mvn clean install -PautoInstallPackage,cloud

Note that:

• -pl/-projects option specifies the list of projects that you want to install
• -am/-also-make options specifies that dependencies should also be built

For convenience, the following deployment profiles are provided when running the Maven install goal withmvn install:

• autoInstallAll: Install everything to the AEM author instance.
• autoInstallPackage: Install the ui.content and ui.apps content packages to the AEM author instance.
• autoInstallPackagePublish: Install the ui.content and ui.apps content packages to the AEM publish instance.

The hostname and port of the instance can be changed with the following user defined properties:

• aem.host andaem.port for the author instance.
• aem.publish.host andaem.publish.port for the publish instance.

We have a set of example proxy components to demonstrate how the existing components can be customized ornew components can be added. Theexamples module contains the code for all the components

To build and install that, from the examples directory (or from the root directory),run the following command

mvn clean install -PautoInstallExamples,include-wcm-components-examples

When compiling and deploying to AEM as a Cloud Service SDK, you can use thecloud profile(in conjunction with previously documented profiles) to generate cloud-ready artifacts(with components located in/libs instead of/apps).To allow recompilation of the HTL scripts, you should disableaem-precompiled-scripts bundle.

Due toFELIX-6365,please only useautoInstallPackage andautoInstallPackagePublish whenworking with the AEM as a Cloud Service SDK!

When working with the AEM as a Cloud Service local SDK, be aware that Forms Core Components are already included as part of the product in the/libs directory. Installing additional versions in/apps/core/fd may cause duplicate component installations and related issues.

If you encounter problems with components or clientlibs:

1. Check if you have duplicate installations of core components (both in/libs and/apps)
2. Remove any duplicated components in/apps/core/fd if they conflict with the built-in ones
3. Rebuild the client library cache by accessing:http://<host>:<port>/libs/granite/ui/content/dumplibs.rebuild.html

This ensures your environment uses the correct component versions and avoids conflicts that can occur with multiple installations.

We've identified that core component-based forms fail to render due to a version mismatch in the Forms Core Components package. This occurs when the version used in the customer's project (archetype project) is equal to or higher than the version bundled with the product (e.g., 3.0.104).To resolve this, either:

1. Use a lower version than the one included in the product, or
2. Remove the Forms Core Components dependency from the customer's code entirely, as it is already included as part of the product.

This project relies on the AEM 6.4.4cq-quickstart UberJar andAEM Forms SDK API. This is publicly available onhttps://repo.adobe.com

For more details about the UberJar please head over to theHow to Build AEM Projects using Apache Maven documentation page.

The released version of the AEM Forms Core Components are available on themaven central repository. To include theAEM Forms Core Components package into your own project maven build you can add the dependency

<dependency>    <groupId>com.adobe.aem</groupId>    <artifactId>core-forms-components-all</artifactId>    <type>zip</type>    <version>x.y.z</version></dependency>

and sub package section

 <subPackage>     <groupId>com.adobe.aem</groupId>     <artifactId>core-forms-components-all</artifactId>     <filter>true</filter> </subPackage>

to thecontent-package-maven-plugin.

In order to use components under pre-release:

1. Enable the pre-release channel. Instructions athttps://experienceleague.adobe.com/docs/experience-manager-cloud-service/content/release-notes/prerelease.html?lang=en
   1. Replacecore-forms-components-* version with the desired pre-release version (e.g1.0.4-PRERELEASE-20211223) in your Cloud Manager / AEM Archetype project. This can be done by updating<core.forms.components.version>x.y.z</core.forms.components.version> in the top level pom.xml of archetype project.

Contents in the pre-release are contained in thepre-release branch.

You can find the code formatting rules in theeclipse-formatter.xml file. The code formatting is automatically checked for each build. To automatically format your code, please run:

mvn clean install -Pformat-code

Releases of this project are triggered by manually runningmvn -Pcloud release:prepare release:clean on themaster branch on the root folder of this repository. Once you choose the release and the next snapshot versions, this commits the change along with a release git tag like for examplecore-forms-components-reactor-x.y.z. Note that the commits are not automatically pushed to the git repository, so you have some time to check your changes and then manually push them. The push then triggers a dedicatedCircleCI build that performs the deployment of the tagged artifact to Maven Central.

Important: this project does Maven reactor releases, donot trigger releases from sub modules!

Note: in case it is needed to update the version of a java bundle because of API changes and semantic versioning, one can easily update the parent POM version and all the POMs referencing the parent POM version by running the following command in the PARENT project folder:mvn versions:set -DnewVersion=x.y.z-SNAPSHOT. This will ensure all projects have the same version.

Contributions are welcomed! Read theContributing Guide for more information.

This project is licensed under the Apache V2 License. SeeLICENSE for more information.