DocumentationAEM as a Cloud ServiceUser Guide

Enable Adaptive Forms Core Components enable-headless-adaptive-forms-on-aem-forms-cloud-service

Last update: Thu Jan 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Developer
  • User
Version
Article link
AEM 6.5
Click here
AEM as a Cloud Service
This article

Enabling Adaptive Forms Core Components on AEM Forms as a Cloud Service, lets you start creating, publishing, and delivering Core Components based Adaptive Forms and Headless Forms using your AEM Forms Cloud Service instances to multiple channels. You require Adaptive Forms Core Components enabled environment to use Headless Adaptive Forms.

Considerations

Enable Adaptive Forms Core Components and Headless Adaptive Forms enable-headless-forms

Perform the following steps, in the listed order, to enable Adaptive Forms Core Components and Headless Adaptive Forms for an AEM Forms as a Cloud Service environment

Enable core components and headless adaptive forms

1. Clone your AEM Forms as a Cloud Service Git Repository clone-git-repository

  1. Log in to Cloud Manager and select your organization and program.

  2. Navigate to the Pipelines card from your Program Overview page, click the Access Repo Info button to access and manage your Git Repository. The page includes the following information:

    • URL to the Cloud Manager Git Repository.
    • Credentials of the Git Repository (Username and Password) Git username.

    Click Generate Password to view or generate the password.

  3. Open terminal or command prompt on your local computer and run the following command:

    code language-shell 
    
git clone [Git Repository URL]

    When prompted, provide the credentials. The repository is cloned to your local computer.

2. Add Adaptive Forms Core Components dependencies to your Git Repository add-adaptive-forms-core-components-dependencies

  1. Open your Git Repository folder in a plain text code editor. For example, VS Code.

  2. Open the [AEM Repository Folder]\pom.xml file for editing.

  3. Replace versions of the core.forms.components.version, core.forms.components.af.version and core.wcm.components.version components with versions specified in core components documentation. If the component does not exist, add these components.

    code language-xml 
    
<!-- Replace the version with the latest released version at https://github.com/adobe/aem-core-forms-components/tags -->

<properties>
    <core.wcm.components.version>2.22.10</core.wcm.components.version>
    <core.forms.components.version>2.0.18</core.forms.components.version>
    <core.forms.components.af.version>2.0.18</core.forms.components.af.version>
</properties>

    Mention latest version of Forms Core Components

  4. In the dependencies section of the [AEM Repository Folder]\pom.xml file, add the following dependencies, and save the file.

    code language-xml 
    
    <!-- WCM Core Component Examples Dependencies -->
        <dependency>
            <groupId>com.adobe.cq</groupId>
            <artifactId>core.wcm.components.examples.ui.apps</artifactId>
            <type>zip</type>
            <version>${core.wcm.components.version}</version>
        </dependency>
        <dependency>
            <groupId>com.adobe.cq</groupId>
            <artifactId>core.wcm.components.examples.ui.content</artifactId>
            <type>zip</type>
            <version>${core.wcm.components.version}</version>
        </dependency>
        <dependency>
            <groupId>com.adobe.cq</groupId>
            <artifactId>core.wcm.components.examples.ui.config</artifactId>
            <version>${core.wcm.components.version}</version>
            <type>zip</type>
        </dependency>
        <!-- End of WCM Core Component Examples Dependencies -->
        <!-- Forms Core Component Dependencies -->
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-core</artifactId>
            <version>${core.forms.components.version}</version>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-apps</artifactId>
            <version>${core.forms.components.version}</version>
            <type>zip</type>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-af-core</artifactId>
            <version>${core.forms.components.version}</version>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-af-apps</artifactId>
            <version>${core.forms.components.version}</version>
            <type>zip</type>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-examples-apps</artifactId>
            <type>zip</type>
            <version>${core.forms.components.version}</version>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-examples-content</artifactId>
            <type>zip</type>
            <version>${core.forms.components.version}</version>
        </dependency>
<!-- End of AEM Forms Core Component Dependencies -->

  5. Open the [AEM Repository Folder]/all/pom.xml file for editing. Add the following dependencies in the <embeddeds> section and save the file.

    code language-xml 
    
<!-- WCM Core Component Examples Dependencies -->

<!-- inside plugin config of filevault-package-maven-plugin -->
<!-- embed wcm core components examples artifacts -->

<embedded>
    <groupId>com.adobe.cq</groupId>
    <artifactId>core.wcm.components.examples.ui.apps</artifactId>
    <type>zip</type>
    <target>/apps/${appId}-vendor-packages/content/install</target>
</embedded>
<embedded>
    <groupId>com.adobe.cq</groupId>
    <artifactId>core.wcm.components.examples.ui.content</artifactId>
    <type>zip</type>
    <target>/apps/${appId}-vendor-packages/content/install</target>
</embedded>
<embedded>
    <groupId>com.adobe.cq</groupId>
    <artifactId>core.wcm.components.examples.ui.config</artifactId>
    <type>zip</type>
    <target>/apps/${appId}-vendor-packages/content/install</target>
</embedded>
<!-- embed forms core components artifacts -->
<embedded>
    <groupId>com.adobe.aem</groupId>
    <artifactId>core-forms-components-af-apps</artifactId>
    <type>zip</type>
    <target>/apps/${appId}-vendor-packages/application/install</target>
</embedded>
<embedded>
    <groupId>com.adobe.aem</groupId>
    <artifactId>core-forms-components-af-core</artifactId>
    <target>/apps/${appId}-vendor-packages/application/install</target>
</embedded>
<embedded>
    <groupId>com.adobe.aem</groupId>
    <artifactId>core-forms-components-examples-apps</artifactId>
    <type>zip</type>
    <target>/apps/${appId}-vendor-packages/content/install</target>
</embedded>
<embedded>
    <groupId>com.adobe.aem</groupId>
    <artifactId>core-forms-components-examples-content</artifactId>
    <type>zip</type>
    <target>/apps/${appId}-vendor-packages/content/install</target>
</embedded>
    note note
    NOTE
    Replace ${appId} with your appId.
    To find your ${appId}, in the [AEM Repository Folder]/all/pom.xml file, search the -packages/application/install term. The text before the -packages/application/install term is your ${appId}. For example, the following code, myheadlessform is ${appId}.
    code language-none 
    



com.myheadlessform

myheadlessform.ui.apps

zip

/apps/myheadlessform-packages/application install

  6. In the <dependencies> section of the [AEM Repository Folder]/all/pom.xml file, add the following dependencies, and save the file:

    code language-xml 
    
        <!-- Other existing dependencies -->
        <!-- wcm core components examples dependencies -->
        <dependency>
            <groupId>com.adobe.cq</groupId>
            <artifactId>core.wcm.components.examples.ui.apps</artifactId>
            <type>zip</type>
        </dependency>
        <dependency>
            <groupId>com.adobe.cq</groupId>
            <artifactId>core.wcm.components.examples.ui.config</artifactId>
            <type>zip</type>
            </dependency>
        <dependency>
            <groupId>com.adobe.cq</groupId>
            <artifactId>core.wcm.components.examples.ui.content</artifactId>
            <type>zip</type>
        </dependency>
            <!-- forms core components dependencies -->
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-af-apps</artifactId>
            <type>zip</type>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-examples-apps</artifactId>
            <type>zip</type>
        </dependency>
            <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>core-forms-components-examples-content</artifactId>
            <type>zip</type>
        </dependency>

  7. Open the [AEM Repository Folder]/ui.apps/pom.xml for editing. Add the af-core bundle dependency, and save the file.

    code language-xml 
    
    <dependency>
    <groupId>com.adobe.aem</groupId>
    <artifactId>core-forms-components-af-core</artifactId>
    </dependency>
    note note
    NOTE
    Ensure that the following Adaptive Forms Core Components artifacts are not included in your project.
    <dependency>
    <groupId>com.adobe.aem</groupId>
    <artifactId>core-forms-components-apps</artifactId>
    </dependency>
    and
    <dependency>
    <groupId>com.adobe.aem</groupId>
    <artifactId>core-forms-components-core</artifactId>
    </dependency>

  8. Save and close the file.

3. Build and deploy the updated code

Deploy the updated code to your local development and Cloud Service environments to enable the Core Components on both the environments:

Build and deploy updated code on a local development environment core-components-on-aem-forms-local-sdk

  1. Open the command prompt or terminal.

  2. Navigate to the root directory of your Git Repository project.

  3. Run the following command to build the package for your environment:

    code language-shell 
    
    mvn clean install

    After the package is successfully built, you can find it at [Git Repository Folder]\all\target[appid].all-[version].zip

  4. Use the Package Manager to deploy the [AEM Archetype Project Folder]\all\target[appid].all-[version].zip package on local development environment.

Build and deploy updated code on an AEM Forms as a Cloud Service environment core-components-on-aem-forms-cs

  1. Open the terminal or command prompt.

  2. Navigate to your [AEM Repository Folder] and run the following commands in the listed order

    code language-shell 
    
 git add pom.xml
 git add all/pom.xml
 git add ui.apps/pom.xml
 git commit -m "Added dependencies for Adaptive Forms Core Components"
 git push origin

  3. After the files are committed to Git Repository, Run the pipeline.

    After pipeline run is successful, Adaptive Forms Core Components are enabled for the corresponding environment. Also, an Adaptive Forms (Core Components) template and Canvas 3.0 theme are added to your Forms as a Cloud Service environment, providing you with options to customize and create Core Components based Adaptive Forms.

Frequently Asked Questions faq

What are core components? 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 capabilities are added on enabling core components? core-components-capabilities

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:

Are Adaptive Forms Core Components enabled for my environment? enable-components

To check that Adaptive Forms Core Components are enabled for your environment:

  1. Clone your AEM Forms as a Cloud Service repository.

  2. Open the [AEM Repository Folder]/all/pom.xml file of your AEM Forms Cloud Service Git Repository.

  3. Search for the following dependencies:

    • core-forms-components-af-core
    • core-forms-components-core
    • core-forms-components-apps
    • core-forms-components-af-apps
    • core-forms-components-examples-apps
    • core-forms-components-examples-content

    locate the core-forms-components-af-core artifact in all/pom.xml

    If the dependencies exist, Adaptive Forms Core Components are enabled for your environment.

Related Articles
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab