Article summary

Summary

Discusses how to develop an AEM HTML Template Language (HTL - formerly known as Sightly) component that uses the WCMUsePojo class, a Maven 10 Archetype project, and a Multifield control. Also discusses how to use the Experience Manager Urber 6.2 JAR.  

A special thank you to Lokesh BS, community member of the year for 2015, for contributing code towards this community article. Also, a special thank you to community members Ranta Kumar Kotla for testing this Community Article to ensure it works.

HTL is the AEM template language that can be used to replace use of JSP when developing an AEM component. HTL helps you to separate your design from your application logic. For more information, see Introduction to the HTML Template Language.

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (beginner - intermediate)
Required Skills
JCR nodes, JavaScript, HTML
Version Adobe Experience Manager 6.2
Video https://youtu.be/iKVGlo3iM-o

Note:

You can download an AEM package that contains the code used in this article. Download the package and deploy using package manager. The purpose of this code is to show the community these concepts in action. That is, it's to illustrate how to write a HTL component that uses the WCMUsePojo API. This community code is for teaching purposes only and not meant to go into production as is.

You can view the sample community application by using the following URL: http://localhost:4502/editor.html/content/mfHTL/en.html (assuming you deploy on author).

Download

Note:

This is an AEM 6.2 article. If you are working with AEM 6.1, see Creating an AEM HTML Template Language component that uses a Multifield (6.1).

Additional AEM HTL Articles

Ask the AEM Community Experts Sessions on HTL (used to be known as Sightly)

Introduction

You can create an Adobe Experience Manager (AEM) 6 Touch UI component that can be used within the AEM Touch UI view. Furthermore, you can use the AEM HTML Template Langauge (HTL - formally known as Sightly) to develop the AEM component. For example, consider an author whom enters information into a multi-field control in the component's dialog, as shown in this illustration.

MultiField
A HTL Component Dialog that uses a Multi-field

In the previous illustration, notice that the Page Name and Path controls are used within a multi-field control. When an author clicks the Add Field button, a new area that contains a Page Name control and Path control appears. This lets an author dynamically enter as many values as required into the dialog.

The component created in this article is a HTL component that uses Java to retrieve the values entered into the multi-field control. For example:

iBean.setPage(jObj.getString("page"));

The Java class that you use as part of the HTL component extends com.adobe.cq.sightly.WCMUsePojo.

The HTL component dialog has three tabs:

  • India
  • USA
  • UK

Each tab has a Dashboard field and a multi-field control (granite/ui/components/foundation/form/multifield).

Each muti-field control contains these controls:

  • granite/ui/components/foundation/form/textfield
  • granite/ui/components/foundation/form/pathbrowser

The HTL component displays the values entered into the dialog, as shown in this illustration.

Output
HTL Component displays the values entered into the multi-field control

This development article steps you through how to build an AEM 6.2 HTL component by using an AEM Maven Archetype 10 project. This HTL component uses a Java class that extends com.adobe.cq.sightly.WCMUsePojo.

Note:

The Java class com.adobe.cq.sightly.WCMUse is deprecated.

Setup Maven in your development environment

You can use Maven to build an OSGi bundle that contains a Sling Servlet. Maven manages required JAR files that a Java project needs in its class path. Instead of searching the Internet trying to find and download third-party JAR files to include in your project’s class path, Maven manages these dependencies for you.

You can download Maven 3 from the following URL:

http://maven.apache.org/download.html

After you download and extract Maven, create an environment variable named M3_HOME. Assign the Maven install location to this environment variable. For example:

C:\Programs\Apache\apache-maven-3.0.4

Set up a system environment variable to reference Maven. To test whether you properly setup Maven, enter the following Maven command into a command prompt:

%M3_HOME%\bin\mvn -version

This command provides Maven and Java install details and resembles the following message:

Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Note:

It is recommended that you use Maven 3.0.3 or greater. For more information about setting up Maven and the Home variable, see: Maven in 5 Minutes.

Next, copy the Maven configuration file named settings.xml from [install location]\apache-maven-3.0.4\conf\ to your user profile. For example, C:\Users\scottm\.m2\.

You have to configure your settings.xml file to use Adobe’s public repository. For information, see Adobe Public Maven Repository at http://repo.adobe.com/.

The following XML code represents a settings.xml file that you can use.

<?xml version="1.0" encoding="UTF-8"?>
 
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->
 
<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user, 
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in 
 |                 ${maven.home}/conf/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ~/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
 
  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->
 
  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->
 
  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>
 
  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>
 
  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the 'id' attribute below).
     | 
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are 
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->
     
    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
  </servers>
 
  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   | 
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred 
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
     -->
  </mirrors>
   
  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is 
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a 
   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id's for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>
 
      <activation>
        <jdk>1.4</jdk>
      </activation>
 
      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->
 
    <!--
     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |   
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>
 
      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>
 
      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
   
 
<profile>
 
                <id>adobe-public</id>
 
                <activation>
 
                    <activeByDefault>true</activeByDefault>
 
                </activation>
 
                <repositories>
 
                  <repository>
 
                    <id>adobe</id>
 
                    <name>Nexus Proxy Repository</name>
 
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
 
                    <layout>default</layout>
 
                  </repository>
 
                </repositories>
 
                <pluginRepositories>
 
                  <pluginRepository>
 
                    <id>adobe</id>
 
                    <name>Nexus Proxy Repository</name>
 
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
 
                    <layout>default</layout>
 
                  </pluginRepository>
 
                </pluginRepositories>
 
            </profile>
 
</profiles>
 
  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>

Note:

The Adobe repository URL is now made secured. Change http://repo.adobe.com/nexus/content/groups/public/ to https://repo.adobe.com/nexus/content/groups/public/.

Create an AEM Maven 10 archetype project

You can create an Experience Manager archetype project by using the Maven archetype plugin. In this example, assume that the working directory is C:\AdobeCQ.

files
Maven Archetype 10 generated files

The following list describes the Archetype 10 project arguments:

  • groupId - Base Maven groupId
  • artifactId - Base Maven ArtifactId
  • version - the version of your project
  • package - Java Source Package
  • appsFolderName - /apps folder name
  • artifactName - Maven Project Name
  • componentGroupName - AEM component group name
  • contentFolderName - /content folder name
  • cssId - prefix used in generated css
  • packageGroup - Content Package Group name
  • siteName - AEM site name

To create an Experience Manager archetype project, perform these steps:

1. Open the command prompt and go to your working directory (for example, C:\AdobeCQ).

2. Run the following Maven command:

mvn archetype:generate -DarchetypeGroupId=com.adobe.granite.archetypes -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=10 -DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/

3. When prompted, specify the following information:

  • groupId - mfHTL
  • artifactId - mfHTL
  • version - 1.0-SNAPSHOT
  • package - com.community.htl.mf
  • appsFolderName - mfHTL
  • artifactName - mfHTL
  • componentGroupName - mfHTL
  • contentFolderName - mfHTL
  • cssId - mfHTL
  • packageGroup - mfHTL
  • siteName - mfHTL

4. WHen prompted, specify Y.

5. Once done, you will see a message like:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:42 min
[INFO] Finished at: 2016-04-25T14:34:19-04:00
[INFO] Final Memory: 16M/463M
[INFO] ------------------------------------------------------------------------

6. Change the working directory to mfHTL and then enter the following command.

mvn eclipse:eclipse

After you run this command, you can import the project into Eclipse as discussed in the next section.

Add Java files to the Maven project using Eclipse

To make it easier to work with the Maven generated project, import it into the Eclipse development environment, as shown in the following illustration.

Project
Eclipse Import Project Dialog

The Eclipse project that you work in to build the OSGi bundle that uses HTL API is mfHTL.core. You do not have to work in the other projects under mfHTL. 

Note:

Do not worry about the errors reported in Eclipse. It does not read the POM file where the APIs are resolved. You build the bundle with Maven. Eclipse is used to edit the Java files and the POM file. Also, delete all files in the project except for the  com.community.htl.mf.core package. Ensure that only the Java files discussed in this article are located in this package. Delete all other Java files.

The next step is to add Java files to the com.community.htl.mf.core package:

  • TouchMultiComponent - this class is the Java side of the HTL component and extends com.adobe.cq.sightly.WCMUsePojo, which is an abstract class that implements the Use interface. For information, see WCMUsePojo.
  • TouchMultiBean - stores values used in the multifield 
  • ItemsBean - contains a data member for each field in the multifield

 

ItemsBean class

The ItemsBean class is simply a getter and setter class that stores values that an author enters into the multi-field control. There is a class member for each field in the multi-field control. That is, there is a String path and a String page data member.

The following Java code represents the ItemsBean class.

package com.community.htl.mf.core;

public class ItemsBean {    
    
    private String page;    
  
    private String path;
  
    public String getPage() {
  
        return page;
  
    }
  
    public void setPage(String page) {
  
        this.page = page;
  
    }
  
    public String getPath() {
  
        return path;
  
    }
  
    public void setPath(String path) {
  
        this.path = path;
  
    }    
  
}

TouchMultiBean class

The TouchMultiBean class is used to store values in each multi-field. It stores a value for the Dashboard field and a List object where each element is an ItemsBean instance. The following Java code represents the TouchMultiBean class.

package com.community.htl.mf.core;

import java.util.List;  

public class TouchMultiBean {    
      
    private String dashboard;
  
    private List<ItemsBean> items;
  
    public List<ItemsBean> getItems() {
  
        return items;
  
    }
  
    public void setItems(List<ItemsBean> items) {
  
        this.items = items;
  
    }
  
    public String getDashboard() {
  
        return dashboard;
  
    }
  
    public void setDashboard(String dashboard) {
  
        this.dashboard = dashboard;
  
    }    
  
}

TouchMultiComponent class

The TouchMultiComponent class is the Java server-side part of the AEM HTL component. This class extends the WCMUsePojo class. You override the activate method in this class. 

In this Java example, notice that a For Loop is executed for each tab in the dialog:

  • India
  • USA
  • UK

For each iteration of the loop, the Dashboard field (defined in the dialog) is read:

if(currentNode.hasProperty(tabs[i]+"Dashboard")){ mBean.setDashboard(currentNode.getProperty(tabs[i]+"Dashboard").getString());

}

The values that are entered into the multi-field control are retrieved in the setItems method. This is an important method to understand as it shows you how to retrieve values that an author enters into a multi-field control.

The purpose of the setItems method is to set an object named mBean of type TouchMultiBean. This object stores all of the multi-field values entered into the dialog, as shown here:

iBean = new ItemsBean();

iBean.setPage(jObj.getString("page"));

iBean.setPath(jObj.getString("path"));

lBean.add(iBean);

Both page and path are names of fields located in the multi-field control. The values are stored in a List object name lBean. After the code loops through all multi-field controls (defined by another for loop using the value of currentProperty.getValues() as an index), the list is stored in the mBean object.

mBean.setItems(lBean);

The following method represents the TouchMultiComponent class.

package com.community.htl.mf.core;

import com.adobe.cq.sightly.WCMUsePojo;
import java.util.List;  
import javax.jcr.Node;
import javax.jcr.PathNotFoundException;
import javax.jcr.RepositoryException;
import javax.jcr.ValueFormatException;
import org.json.JSONException;
import org.apache.sling.commons.json.JSONObject;
import java.util.ArrayList;
import javax.jcr.Value;  
import javax.jcr.Property;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
 
public class TouchMultiComponent
	extends WCMUsePojo{
     
    /** Default log. */
    protected final Logger log = LoggerFactory.getLogger(this.getClass());
      
    private TouchMultiBean mBean = null;
  
    private ItemsBean iBean = null;
  
    private List<ItemsBean> lBean = null;
  
    private List<TouchMultiBean> multiList = null;    
  
    @Override
  
    public void activate() throws Exception {
         
         
          log.info("##### INVOKED ACTIVATE");
  
        multiList = new ArrayList<TouchMultiBean>();
  
        Node currentNode = getResource().adaptTo(Node.class);
         
         String[] tabs = {"i","u","uk"};        
  
        for (int i = 0; i < tabs.length; i++) {
  
            String currentItem = tabs[i]+"Items";
             
           if(currentNode.hasProperty(currentItem)){
  
                 
                 log.info("##### ITEMS ARE BEING SET" + currentItem ); 
                setItems(currentNode, currentItem);
  
                if(currentNode.hasProperty(tabs[i]+"Dashboard")){
  
                    mBean.setDashboard(currentNode.getProperty(tabs[i]+"Dashboard").getString());
  
                }
  
                multiList.add(mBean);  
                 
  
            }
  
        }        
  
    }
  
    private void setItems(Node currentNode, String tab)
  
            throws PathNotFoundException, RepositoryException, ValueFormatException, org.json.JSONException {
  
        
        try
        {
        Value[] value;
  
        JSONObject jObj;
  
        Property currentProperty;
  
        mBean = new TouchMultiBean();
  
        lBean = new ArrayList<ItemsBean>();
  
        currentProperty = currentNode.getProperty(tab);
  
        if(currentProperty.isMultiple()){                
  
            value = currentProperty.getValues();            
  
        }else{
  
            value = new Value[1];
  
            value[0] = currentProperty.getValue();            
  
        }
  
        for (int i = 0; i < value.length; i++) {
  
            jObj = new JSONObject(value[i].getString());
  
            iBean = new ItemsBean();
  
            iBean.setPage(jObj.getString("page"));
  
            iBean.setPath(jObj.getString("path"));
  
            lBean.add(iBean);                    
  
        }        
  
        mBean.setItems(lBean);
  
     
         
        }
        catch(Exception e)
        {
            e.printStackTrace();
        }
         
        }
  
    public List<TouchMultiBean> getMBean(){
  
        return this.multiList;
  
    }
  
}

Modify the Maven POM file

Add the following POM dependency to the POM file located at C:\AdobeCQ\mfHTL.

<dependency>
               <groupId>com.adobe.aem</groupId>
               <artifactId>uber-jar</artifactId>
               <version>6.2.0</version>
               <!-- for AEM6.1 use this version     : <version>6.1.0</version> -->
               <!-- for AEM6.1 SP1 use this version : <version>6.1.0-SP1-B0001</version> -->
               <!-- for AEM6.1 SP2 use this version : <version>6.1.0-SP2</version> -->
               <!-- for AEM6.2 use this version     : <version>6.2.0</version> -->
               <classifier>obfuscated-apis</classifier>
               <scope>provided</scope>
           </dependency>
            
           <dependency>
               <groupId>org.apache.geronimo.specs</groupId>
               <artifactId>geronimo-atinject_1.0_spec</artifactId>
               <version>1.0</version>
               <scope>provided</scope>
           </dependency>

You need to modify two POM files. The first one is the parent POM file shown in this illustration.

ParentPOM
Parent POM

Add the dependency shown above to the Parent POM file. Next, modify the POM file located at C:\AdobeCQ\mfHTL\core. The following code represents this POM file. 

<?xml version="1.0" encoding="UTF-8"?>
<!--
 |  Copyright 2015 Adobe Systems Incorporated
 |
 |  Licensed under the Apache License, Version 2.0 (the "License");
 |  you may not use this file except in compliance with the License.
 |  You may obtain a copy of the License at
 |
 |      http://www.apache.org/licenses/LICENSE-2.0
 |
 |  Unless required by applicable law or agreed to in writing, software
 |  distributed under the License is distributed on an "AS IS" BASIS,
 |  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 |  See the License for the specific language governing permissions and
 |  limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>mfHTL</groupId>
        <artifactId>mfHTL</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>mfHTL.core</artifactId>
    <packaging>bundle</packaging>
    <name>mfHTL - Core</name>
    <description>Core bundle for mfHTL</description>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-scr-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <!--
                        <Embed-Dependency>
                            artifactId1,
                            artifactId2;inline=true
                        </Embed-Dependency>
                        -->
                        <Sling-Model-Packages>
                            com.community.htl.mf.core
                        </Sling-Model-Packages>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <profiles>
        <!-- Development profile: install only the bundle -->
        <profile>
            <id>autoInstallBundle</id>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.sling</groupId>
                        <artifactId>maven-sling-plugin</artifactId>
                        <configuration>
                            <!-- Note that this requires /apps/mfHTL/install to exist!!          -->
                            <!--    This is typically the case when ui.apps is deployed first                -->
                            <!--    Otherwise, create /apps/mfHTL/install manually (CRXDE|Lite)  -->
                            <slingUrlSuffix>/apps/mfHTL/install/</slingUrlSuffix>
                            <failOnError>true</failOnError>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>
   <dependencies>
       <!-- OSGi Dependencies -->
            
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>uber-jar</artifactId>
            <classifier>obfuscated-apis</classifier>
        </dependency>
 
        <dependency>
            <groupId>org.apache.geronimo.specs</groupId>
            <artifactId>geronimo-atinject_1.0_spec</artifactId>
        </dependency>
<dependency>
    <groupId>com.adobe.granite.bundles</groupId>
    <artifactId>json</artifactId>
    <version>20090211_1</version>
    <scope>provided</scope>
</dependency>
 
         <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
        </dependency>
        <dependency>
            <groupId>biz.aQute</groupId>
            <artifactId>bndlib</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.compendium</artifactId>
        </dependency>
        <!-- Other Dependencies -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.jcr</groupId>
            <artifactId>jcr</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>aem-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.models.api</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mockito</groupId>
            <artifactId>mockito-all</artifactId>
        </dependency>
        <dependency>
            <groupId>junit-addons</groupId>
            <artifactId>junit-addons</artifactId>
        </dependency>
    </dependencies>
</project>

Build the OSGi bundle using Maven

To build the OSGi bundle by using Maven, perform these steps:

  1. Open the command prompt and go to the C:\AdobeCQ\mfHTL.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\mfHTL\core\target. The file name of the OSGi component is mfHTL.core-1.0-SNAPSHOT.jar.

The command -PautoInstallPackage automatically deploys the OSGi bundle to AEM.

Create an AEM HTL component

Perform these tasks using CRXDE Lite:

1. Right click on /apps/mfHTL/components/content and then select New, Component.

2. Enter the following information into the Create Component dialog box:

  • Label: The name of the component to create. Enter touchmulti.
  • Title: The title that is assigned to the component. Enter touchmulti.
  • Description: The description that is assigned to the template. Enter touchmulti.
  • Super Resource Type: Enter foundation/components/parbase.
  • Group: The group in the side rail or side kick where the component appears. Enter General. (The component is located under the General heading in the Touch UI side rail.)
  • Allowed parents: Enter */*parsys.

3. Add the following properties to this node:

  • cq:isContainer (Boolean) - false
  • cq:noDecoration (Boolean) - false

4. Click Ok.

Once done, you will see the component as shown in the following illustration. 

component
The touchmulti component

Note:

Rename touchmulti.jsp to touchmulti.html. 

Note:

For information about the default files created by the Maven 10 Archetype project, see this community article: Creating your first AEM 6.2 Project using Adobe Maven Archetype 10.

Add a dialog to the HTL component

A dialog lets an author click on the component in the Touch UI (or Classic UI) view during design time and enter values that are used by the component. The component created in this development article lets the AEM author enter information in a multi-field control. 

MultiField
Dialog for the HTL component

The following illustration shows the JCR nodes for this component.

DialogJCR
JCR Nodes that create the dialog

Build the dialog by performing these tasks:

1. Select /apps/mfHTL/components/content/touchmulti.

2. Right click and select Create, Create Node.

3. Enter the following values:

  • Name: cq:dialog
  • Type: nt:unstructured

4. Add the following properties to the cq:dialog node.

  • sling:resourceType (String) - cq/gui/components/authoring/dialog

5. Select /apps/mfHTL/components/content/touchmulti/cq:dialog.

6. Right click and select Create, Create Node. Enter the following values:

  • Name: content
  • Type: nt:unstructured

7. Add the following properties to the content node.

  • sling:resourceType (String) - granite/ui/components/foundation/container

8. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content.
9. Right click and select Create, Create Node. Enter the following values:

  • Name: layout
  • Type: nt:unstructured

10. Add the following properties to the layout node.

  • sling:resourceType (String) - granite/ui/components/foundation/layouts/tabs
  • type (String) - nav

11. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content.
12. Right click and select Create, Create Node. Enter the following values:

  • Name: items
  • Type: nt:unstructured

13. Click on the following node:/apps/mfHTL/components/content/touchmulti/cq:dialog/content/items.

14. Right click and select Create, Create Node.

15. Enter the following values:

  • Name: india
  • Type: nt:unstructured

16. Add the following property to the india node.

  • sling:resourceType (String) - granite/ui/components/foundation/section
  • jcr:title (String) - India

17. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items.

18. Right click and select Create, Create Node.

19. Enter the following values:

  • Name: usa
  • Type: nt:unstructured

20. Add the following property to the usa node.

  • sling:resourceType (String) - granite/ui/components/foundation/section
    jcr:title (String) - usa 

21. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items.

22. Right click and select Create, Create Node.

23. Enter the following values:

  • Name: uk
  • Type: nt:unstructured

24. Add the following property to the uk node.

  • sling:resourceType (String) - granite/ui/components/foundation/section
  • jcr:title (String) - uk

25. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india.

26. Right click and select Create, Create Node.

27. Enter the following values:

  • Name: layout
  • Type: nt:unstructured

28. Add the following property to the layout node.

  • sling:resourceType (String) - granite/ui/components/foundation/layouts/fixedcolumns

29. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india.

30. Right click and select Create, Create Node.

31. Enter the following values:

  • Name: items
  • Type: nt:unstructured

32. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india/items.

33. Right click and select Create, Create Node.

34. Enter the following values:

  • Name: column
  • Type: nt:unstructured

35. Add the following property to the column node.

  • sling:resourceType (String) - granite/ui/components/foundation/container

36. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india/items/column.

37. Right click and select Create, Create Node.

38. Enter the following values:

  • Name: items
  • Type: nt:unstructured

39. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india/items/column/items.

40. Right click and select Create, Create Node.

41. Enter the following values:

  • Name: fieldset
  • Type: nt:unstructured

42. Add the following property to the fieldset node.

  • sling:resourceType (String) - granite/ui/components/foundation/form/fieldset
  • jcr:title (String) - India Dashboard

43. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india/items/column/items/fieldset.

44. Right click and select Create, Create Node.

45. Enter the following values:

  • Name: layout
  • Type: nt:unstructured

46. Add the following property to the layout node.

  • sling:resourceType (String) - granite/ui/components/foundation/layouts/fixedcolumns

47. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset.

48. Right click and select Create, Create Node.

49. Enter the following values:

  • Name: items
  • Type: nt:unstructured

50. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset/items.

51. Right click and select Create, Create Node.

52. Enter the following values:

  • Name: column
  • Type: nt:unstructured

53. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset/items/columns.

54. Right click and select Create, Create Node.

55. Enter the following values:

  • Name: items
  • Type: nt:unstructured

56. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset/items/columns/items.

57. Right click and select Create, Create Node.

58. Enter the following values:

  • Name: dashboard
  • Type: nt:unstructured

59. Add the following properties to the dashboard node.

  • sling:resourceType (String) - granite/ui/components/foundation/form/textfield
  • name (String) - ./iDashboard
  • fieldLabel (String) - Dashboard
  • fieldDescription (String) - Enter Dashboard name

60. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset/items/columns/items.

61. Right click and select Create, Create Node.

62. Enter the following values:

  • Name: pages
  • Type: nt:unstructured

63. Add the following properties to the pages node.

  • sling:resourceType (String) - granite/ui/components/foundation/form/multifield
  • class (String) - full-width
  • fieldLabel (String) -URLs
  • fieldDescription (String) - Click '+' to add a new page

64. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset/items/columns/items/pages.

65. Right click and select Create, Create Node.

66. Enter the following values:

  • Name: field
  • Type: nt:unstructured

67. Add the following properties to the field node.

  • sling:resourceType (String) -granite/ui/components/foundation/form/fieldset
  • name (String) - ./iItems

68. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset/items/columns/items/pages/field.

69. Right click and select Create, Create Node.

70. Enter the following values:

  • Name: layout
  • Type: nt:unstructured

71. Add the following properties to the field node.

  • sling:resourceType (String) - granite/ui/components/foundation/layouts/fixedcolumns
  • method (String) - absolute

72. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset/items/columns/items/pages/field.

73. Right click and select Create, Create Node.

74. Enter the following values:

  • Name: items
  • Type: nt:unstructured

75. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india
/items/column/items/fieldset/items/columns/items/pages/field/items.

76. Right click and select Create, Create Node.

77. Enter the following values:

  • Name: column
  • Type: nt:unstructured

78. Add the following property to the column node.

  • sling:resourceType (String) - granite/ui/components/foundation/container

79. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india/items
/column/items/fieldset/items/columns/items/pages/field/items/column.

80. Right click and select Create, Create Node.

81. Enter the following values:

  • Name: items
  • Type: nt:unstructured

82. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items
/india/items/column/items/fieldset/items/columns/items/pages/field/items/column/items.

83. Right click and select Create, Create Node.

84. Enter the following values:

  • Name: page
  • Type: nt:unstructured

85. Add the following properties to the page node: 

  • sling:resourceType (String) - granite/ui/components/foundation/form/textfield
  • name (String) - ./page
  • fieldLabel (String) - Page Name
  • fieldDescription (String) - Enter Page name

86. Click on the following node: /apps/mfHTL/components/content/touchmulti/cq:dialog/content/items/india/items
/column/items/fieldset/items/columns/items/pages/field/items/column/items.

87. Right click and select Create, Create Node.

88. Enter the following values:

  • Name: path
  • Type: nt:unstructured

89. Add the following properties to the path node:

  • sling:resourceType (String) - granite/ui/components/foundation/form/textfield
  • name (String) - ./path
  • fieldLabel (String) - Path Name
    fieldDescription (String) - Enter Path name

 

 

Dashboard
Enter Dashboard name
URLs
./iItems
./iItems

Note:

If you install the package at the start of this article, then you do not need to build the JCR nodes that represent the dialog. 

Create a ClientLibs folder

Create the clientlibs folder at the following JCR location:

/apps/mfHTL/components/content/touchmulti

Assign the value cq.authoring.dialog to the clientlibs category property.

The purpose of this clientlibs folder is to store a JS script file, named nested-multifield.js, that creates and fills the nested multifield controls with data. This is an example of how you can programmatically work with Granite data types. For information, see Granite UI’s documentation.

The following JS logic is located in the nested-multifield.js file.

(function () {
    var DATA_EAEM_NESTED = "data-eaem-nested";
    var CFFW = ".coral-Form-fieldwrapper";

    //reads multifield data from server, creates the nested composite multifields and fills them
    function addDataInFields() {
        $(document).on("dialog-ready", function() {
            var $fieldSets = $("[" + DATA_EAEM_NESTED + "][class='coral-Form-fieldset']");

            if(_.isEmpty($fieldSets)){
                return;
            }

            var mNames = [];

            $fieldSets.each(function (i, fieldSet) {
                mNames.push($(fieldSet).data("name"));
            });

            mNames = _.uniq(mNames);

            var actionUrl = $fieldSets.closest("form.foundation-form").attr("action") + ".json";

            $.ajax(actionUrl).done(postProcess);

            function postProcess(data){
                _.each(mNames, function(mName){
                    buildMultiField(data, mName);
                });
            }

            //creates & fills the nested multifield with data
            function fillNestedFields($multifield, valueArr){
                _.each(valueArr, function(record, index){
                    $multifield.find(".js-coral-Multifield-add").click();

                    //a setTimeout may be needed
                    _.each(record, function(value, key){
                        var $field = $($multifield.find("[name='./" + key + "']")[index]);
                        $field.val(value);
                    })
                })
            }

            function buildMultiField(data, mName){
                if(_.isEmpty(mName)){
                    return;
                }

                $fieldSets = $("[data-name='" + mName + "']");

                //strip ./
                mName = mName.substring(2);

                var mValues = data[mName], $field, name;

                if(_.isString(mValues)){
                    mValues = [ JSON.parse(mValues) ];
                }

                _.each(mValues, function (record, i) {
                    if (!record) {
                        return;
                    }

                    if(_.isString(record)){
                        record = JSON.parse(record);
                    }

                    _.each(record, function(rValue, rKey){
                        $field = $($fieldSets[i]).find("[name='./" + rKey + "']");

                        if(_.isArray(rValue) && !_.isEmpty(rValue)){
                            fillNestedFields( $($fieldSets[i]).find("[data-init='multifield']"), rValue);
                        }else{
                            $field.val(rValue);
                        }
                    });
                });
            }
        });
    }

    function fillValue($field, record){
        var name = $field.attr("name");

        if (!name) {
            return;
        }

        //strip ./
        if (name.indexOf("./") == 0) {
            name = name.substring(2);
        }

        record[name] = $field.val();

        //remove the field, so that individual values are not POSTed
        $field.remove();
    }

    //for getting the nested multifield data as js objects
    function getRecordFromMultiField($multifield){
        var $fieldSets = $multifield.find("[class='coral-Form-fieldset']");

        var records = [], record, $fields, name;

        $fieldSets.each(function (i, fieldSet) {
            $fields = $(fieldSet).find("[name]");

            record = {};

            $fields.each(function (j, field) {
                fillValue($(field), record);
            });

            if(!$.isEmptyObject(record)){
                records.push(record)
            }
        });

        return records;
    }

    //collect data from widgets in multifield and POST them to CRX as JSON
    function collectDataFromFields(){
        $(document).on("click", ".cq-dialog-submit", function () {
            var $form = $(this).closest("form.foundation-form");
            var $fieldSets = $("[" + DATA_EAEM_NESTED + "][class='coral-Form-fieldset']");
            var record, $fields, $field, name, $nestedMultiField;

            $fieldSets.each(function (i, fieldSet) {
                $fields = $(fieldSet).children().children(CFFW);

                record = {};

                $fields.each(function (j, field) {
                    $field = $(field);

                    //may be a nested multifield
                    $nestedMultiField = $field.find("[data-init='multifield']");

                    if($nestedMultiField.length == 0){
                        fillValue($field.find("[name]"), record);
                    }else{
                        name = $nestedMultiField.find("[class='coral-Form-fieldset']").data("name");

                        if(!name){
                            return;
                        }

                        //strip ./
                        name = name.substring(2);

                        record[name] = getRecordFromMultiField($nestedMultiField);
                    }
                });

                if ($.isEmptyObject(record)) {
                    return;
                }

                //add the record JSON in a hidden field as string
                $('<input />').attr('type', 'hidden')
                    .attr('name', $(fieldSet).data("name"))
                    .attr('value', JSON.stringify(record))
                    .appendTo($form);
            });
        });
    }

    $(document).ready(function () {
        addDataInFields();
        collectDataFromFields();
    });

    //extend otb multifield for adjusting event propagation when there are nested multifields
    //for working around the nested multifield add and reorder
    CUI.Multifield = new Class({
        toString: "Multifield",
        extend: CUI.Multifield,

        construct: function (options) {
            this.script = this.$element.find(".js-coral-Multifield-input-template:last");
        },

        _addListeners: function () {
            this.superClass._addListeners.call(this);

            //otb coral event handler is added on selector .js-coral-Multifield-add
            //any nested multifield add click events are propagated to the parent multifield
            //to prevent adding a new composite field in both nested multifield and parent multifield
            //when user clicks on add of nested multifield, stop the event propagation to parent multifield
            this.$element.on("click", ".js-coral-Multifield-add", function (e) {
                e.stopPropagation();
            });

            this.$element.on("drop", function (e) {
                e.stopPropagation();
            });
        }
    });

    CUI.Widget.registry.register("multifield", CUI.Multifield);
})();

Add HTL code

Add code to the HTML file named heromultifield.html located in the following JCR location:

/apps/mfHTL/components/content/touchmulti/touchmulti.html

In the HTL file, notice this line of code:

<div data-sly-use.mbeanObj="com.community.htl.mf.core.TouchMultiComponent">

This is how you create an instance of the TouchMultiComponent object.

Add the following HTML to this file.

<h2>This is an AEM 6.2 Multi Field HTL Component</h2></br>
<div data-sly-use.mbeanObj="com.community.htl.mf.core.TouchMultiComponent">
    <p>

		<div data-sly-test="${!mbeanObj.mBean}">Add values in Dialog</div>
    	<div data-sly-test="${mbeanObj.mBean}" data-sly-list.items="${mbeanObj.mBean}">
    		<h3>${items.dashboard}</h3>
    		<div data-sly-list.itemsList="${items.items}">
    			<p><b>page:</b> ${itemsList.page}</p>
        		<p><b>path:</b> ${itemsList.path}</p>
            </div>
      	</div>

	</p>
</div>

Next notice these lines of HTL code:

<div data-sly-test="${!mbeanObj.mBean}">Add values in Dialog</div>
<div data-sly-test="${mbeanObj.mBean}" data-sly-list.items="${mbeanObj.mBean}">
<h3>${items.dashboard}</h3>
<div data-sly-list.itemsList="${items.items}">
<p><b>page:</b> ${itemsList.page}</p>
<p><b>path:</b> ${itemsList.path}</p>
</div>
</div>

Here, mbeanObj is an instance of TouchMultiComponent class developed earlier in this article. The code

<p><b>page:</b> ${itemsList.page}</p>
<p><b>path:</b> ${itemsList.path}</p>
</div>

is how you handle a collection. In this example,

data-sly-list.items="${mbeanObj.mBean}"

maps to the TouchMultiBean data member named mBean defined in the TouchMultiComponent class.

${itemsList.page} maps to the page data member in the ItemsBean class. Likewise, path maps to the data member in the ItemsBean class.

Create the Classic Dialog

View the output of the HTL component

To access the component, enter the following URL: 

http://localhost:4502/editor.html/content/mfHTL/en.html

The following illustration shows the HTL component.

 

Client
The HTL component created in this article

Note:

You need to drag and drop the touchmulti component into the page. Or you can install the package at the start of this article. 

See also

Congratulations, you have just created an AEM sample application that uses a HTL component that uses the WCMUsePojo API. Please refer to the AEM community page for other articles that discuss how to build AEM services/applications.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy