Note:

This article is applicable if you are installing AEM forms on OSGi. For information, about Installing, Upgrading, and Clustering AEM forms on JEE stack, see AEM forms Help and Tutorials.

Installing AEM 6.1 forms add-on packages 

  1. (For AEM 6.1 forms feature pack 1 on IBM WebSphere with Oracle RDBMK only)  If you are installing AEM 6.1 forms feature pack 1 and you are using IBM WebSphere with Oracle RDBMK, then before starting AEM 6.1, use NPR-7700 to add a few JAR files to AEM 6.1 setup (JAR/WAR) files. Perform the following steps to add the JAR files to AEM 6.1 setup (JAR/WAR) file:

    1. Open AEM Package Share and search cq-6.1.0-hotfix-7700. In the search results, click cq-6.1.0-hotfix-7700. You can also use the direct link NPR-7700 to open the hot fix download page.
    2. Open the Assets tab and click Download to disk: cq-6.1.0-hotfix-7700-2.2. Accept the license agreement and save the archive to the local machine.
    3. Extract the downloaded archive and AEM 6.1 setup (JAR/WAR) file to separate folders. For example, extract hot fix to folder npr7700 and AEM 6.1 files to aem6.1setup.
    4. (If you are using a .war file to deploy AEM 6.1) Replace and add the following .jar files to extracted AEM 6.1 files:
      • Replace the [exracted-aem6.1-files]\cq-quickstart-6.1.0.war\WEB-INF\resources\install\0\jackrabbit-webdav-2.10.0.jar file with the [exracted-hotfix-files]\jcr_root\libs\system\install\jackrabbit-webdav-2.10.1.jar file.
      • Add or replace the file of folder [exracted-aem6.1-files]\cq-quickstart-6.1.0.war\WEB-INF\resources\install.crx3\15 with file of folder [exracted-hotfix-files]\jcr_root\libs\system\install.crx.
    5. (If you are using a .jar file to deploy AEM 6.1) Replace and add the following .jar files to extracted AEM 6.1 files:
      • Replace the [exracted-aem6.1-files]\cq-quickstart-6.1.0.jar\static\app\cq-quickstart-6.1.0-standalone-quickstart.jar\resources\install\0\jackrabbit-webdav-2.10.0.jar file with the [exracted-hotfix-files]\jcr_root\libs\system\install\jackrabbit-webdav-2.10.1.jar file.
      • Add or replace the file of folder [exracted-aem6.1-files]\cq-quickstart-6.1.0.jar\static\app\cq-quickstart-6.1.0-standalone-quickstart.jar\resources\install.crx3\15 with file of folder [exracted-hotfix-files]\jcr_root\libs\system\install.crx.
    6. Save/repackage the AEM 6.1 setup (JAR/WAR) file and start the AEM 6.1 instance.
    7. Repeat all of above steps for corresponding AEM 6.1 Publish instances also.

    Note:

    After installing NPR-7700, the following warning message may appear for multiple times in the log file of IBM WebSphere application server. You can safely ignore the warning:  

    Method setReadOnly(false) is ignored. No Oracle transaction will be started.

  2. Log in to AEM as an administrator and open the package share. Log in to the package share with an Adobe ID. A list of folders and packages appears.   

    Note:

    The default URL of package share is http:[server]/host/crx/packageshare/login.html.

    Note:

    Before installing the AEM forms add-on package, ensure that the installation path of the AEM Quickstart does not contain any spaces.

  3. In package share, search AEM forms add-on packages, click the package applicable to your operating system, and click Download. Read and accept the license agreement and click OK. Once downloaded, the word Downloaded appears next to the package.

    You can also use the direct download links listed in the AEM forms add-on package section to manually download a package.

    Note:

    AEM 6.1 forms service pack 2 is latest AEM form add-on package. It is a cumulative package. Along with enhancements and bug fixes for various components of AEM 6.1 forms, the package contains complete functionality of AEM 6.1 forms. For detailed list of enhancements and fixes, see AEM 6.1 service pack 2 release notes.

  4. Open the package manager, locate the downloaded package, and click Install. The default URL is http://[server]:[port]/crx/packmgr/index.jsp.

    Note:

    The downloaded package is at the same path as it appeared online. For example, if you download a package from Packages > Public > CRX2.1 hot fixes, your package appears at Packages > Public > CRX2.1 hot fixes on your local AEM installation. 

    Note:

    If a package is already installed on your environment, the word Share appears next to the package in the Package Manager.

    Note:

    If you have hot fix 6717 installed and you are installing AEM forms feature pack 1 add-on package, you can encounter an error "Could not Install Package" on the Package Manager window. It is safe to ignore the error message.   

  5. (Optional) Apart from the AEM 6.1 forms feature pack packages, the package share contains packages for Central Migration Bridge and Send to printer services and add-on packages for Geometrixx Finance and Geometrixx.gov reference sites. You can also install these packages as required.

    You can use AEM package share to download and install these packages. The AEM forms add-on package section also lists direct download links to manually download the packages.

  6. (Optional) If you have upgraded from an earlier version to AEM forms and also installed Correspondence Management, use the migration utility to migrate your existing Correspondence Management assets to AEM 6.1 forms.

  7. After the package is installed, do not immediately restart the server. Before restarting the AEM server, ensure that all the bundles, but the Signatures bundle, are in active state. The bundles are listed at http://[server]:[port]/system/console/. If all the bundles are not active, wait, and check the status of the bundles after for a few minutes.

    After all the bundles are in active state, restart the AEM server.  

AEM forms add-on packages

For the complete list of the packages available for AEM 6.1 Forms release, see AEM Forms releases article.

Additional libraries required for Red Hat Enterprise Linux, SUSE Enterprise Linux, and CentOS

AEM forms add-on package requires 32-bit libraries to run AEM forms Doc service, Output service, Mobile Forms, Adaptive forms, and forms manager components on Red Hat Enterprise Linux 6 or later, SUSE Enterprise Linux 11 or later, and CentOS 6 or later.

Install the following RPM packages listed below from the installation media of the respective operating system:

  • glibc-2.12-1.25.el6.i686.rpm
  • nss-softokn-freebl-3.12.9-3.el6.i686.rpm
  • libX11-1.3-2.el6.i686.rpm
  • libxcb-1.5-1.el6.i686.rpm
  • libXau-1.0.5-1.el6.i686.rpm
  • zlib-1.2.3-25.el6.i686.rpm
  • libXext-1.1-3.el6.i686.rpm
  • fontconfig-2.8.0-3.el6.i686.rpm
  • expat-2.0.1-9.1.el6.i686.rpm
  • freetype-2.3.11-6.el6_0.2.i686.rpm
  • libSM-1.1.0-7.1.el6.i686.rpm
  • libICE-1.0.6-1.el6.i686.rpm
  • libuuid-2.17.2-12.el6.i686.rpm
  • libXrandr-1.3.0-4.el6.i686.rpm
  • libXrender-0.9.5-1.el6.i686.rpm
  • libXinerama-1.1-1.el6.i686.rpm

After performing the above steps, AEM forms is accessible at http://[hostname]:[port]. Use the default user name admin and password admin to log in to AEM server.

Installing and configuring the Publish instance

Note:

The Installing and Configuring publish instance section is applicable only for fresh and clean installs. Do not perform these steps if you have installed AEM 6.1 forms add-on package (cumulative hot fix 6717) on top of an older AEM 6.1 forms add-on package.

Before you configure the AEM forms Publish instance, review AEM forms architecture and deployment topologies.

When you install AEM forms add-on package, by default, an Author instance is created. On this Author instance, you can create your Adaptive Forms. A Publish instance is required to publish the created forms. Perform the following steps to create and start a Publish instance.

Starting your Publish instance

Follow these steps to start your Publish instance:

  1. Rename the AEM QuickStart JAR file to cq-publish-p<port>.jar and place the jar file in the Publish directory. Specify the <port> of the Publish instance.  Run the jar file to start the jar. For more information, see Author and Publish Installs.

  2. Start the AEM QuickStart and install AEM forms add-on packages as described above in Installing AEM forms add-on packages.

To enable two-way communication between the Author and Publish instances, configure the Replication Agent and Reverse Replication Agent that replicates data across both the instances. 

Configuring replication agents to define the publish instance URL 

On the Author instance, o configure replication agents for each Publish instance. These agents replicate content from the Author instances to all the Publish instances. Follow these steps on the Author instance. 

    1. Access the CRX Package Share at http://[hostname]:[port]/crx/packageshare/login.html. Download the AEM forms add-on package to your operating system.

    2. Log in to AEM portal at http://[hostname]:[port]. The default user name is admin and the password is admin.

    3. Access CRX Package Manager at http://[hostname]:[port]/crx/packmgr/index.jsp. Upload and install the package downloaded in Step 1. To know more about package installation, see How to Work with Packages.

    Access the Tools interface on the Author instance at http://[hostname]:[port]/miscadmin.

  1. Select Replication, then Agents on Author in the left panel. On the right panel, you see various agents configured for the Author instance.

  2. On the right panel, Select New and click New Page. The Create Page dialog displays.

  3. Set the Title and Name and select Replication Agent.

  4. Click Create to create new agent.

  5. Double-click the new agent item to open the configuration panel.

  6. Click Edit. The Agent Settings dialog appears.

    1. In the Settings tab:
      1. Enter a description.
      2. Check Enabled.
      3. Select Serialization Type as Default.
      4. Set the Retry Delay to 60000. Leave Agent User Id as Blank
      5. Set the Log Level as Info.
    2. In the Transport tab:
      1. Enter the required URI for the Publish instance http://[hostname]:[port]/bin/receive?sling:authRequestLogin=1.
      2. Set User and Password. The default credentials are admin/admin.
    3. In the Extended tab:
      1. Enter the method POST in HTTP Method Section
    4. In the Triggers tab:
      1. Select On Receive and click Ok
  7. Click OK to save the settings.

  8. On the agent configuration panel, click Test Connection. A successful connection indicates that the configuration is done correctly.

Note:

In case, you have only one Publish instance you can use the default Replication Agent named as publish. You need to edit it for specifying Publish URI in the Transport tab as mentioned in the Step 7.b.i. In this case, you do not need to create a new replication agent.

Note:

In case, you have a publish farm, comprised of multiple non-clustered publish instances, you need to create a replication agent for each Publish instance as mentioned in Steps 1-9. For each such replication agent, Title and Name should be significant and unique, so the identification of the corresponding Publish instance can be simpler. Each such replication agent has a different URI in the Transport tab pointing to a particular Publish instance. For multiple publish instances, you can also create replication agents by copying the default agent publish and then editing Name and URI in transport tab of the created agent. If you are not using the default Replication Agent, disable it, so an unnecessary replication attempt can be avoided.

Note:

For Author clusters, these steps need to be performed on one Author instance (preferably a master instance).

Configuring the reverse replication agents

On the Author instance, you need to configure reverse replication agents for each Publish instance. These agents replicate content from the Publish instance to the Author instance. 

  1. Log in to Tools user interface at http://[hostname]:[port]/miscadmin

  2. Select Replication, then Agents on author in the left panel. On the right panel, you see various agents configured for the Author instance.

  3. On the right panel, Select New, and click New Page. The Create Page dialog appears.

  4. Set the Title and Name and then select Reverse Replication Agent.

  5. Click Create to create new agent.

  6. Double-click the new agent item to open the configuration panel.

  7. Click Edit. The Agent Settings dialog displays.

    1. In the Settings tab:
      1. Enter a description.
      2. Check Enabled.
      3. Select Serialization Type as Default.
      4. Set the Retry Delay to 60000. Leave Agent User Id as Blank
      5. Set the Log Level as Info.
    2. In the Transport tab:
      1. Enter the required URI for the Author instance http://[hostname]:[port]/bin/receive?sling:authRequestLogin=1.
      2. Set User and Password. The default credentials are admin/admin.
    3. In the Extended tab:
      1. Enter the method POST in HTTP Method Section
    4. In the Triggers tab:
      1. Select On Receive and click Ok
  8. The tabs Proxy and Extended are optional. Click OK to complete and save this configuration

  9. Wait for few seconds so that page is refreshed. Click "Test Connection" link on the page to check if the configuration is successful or not.

Note:

In case, you have only one Publish instance you can use the default Reverse Replication Agent named as publish_reverse. You need to edit it for specifying Publish URI in the Transport tab as mentioned in the Step 7.b.i. In this case, you do not need to create a new Reverse Replication Agent.

Note:

In case, you have a publish farm, comprised of multiple non-clustered publish instances, you need to create a reverse replication agent for each Publish instance as mentioned in Steps 1-9. For each such reverse replication agent, Title and Name should be significant and unique, so the identification of the corresponding Publish instance can be simpler. Each such replication agent has a different URI in the Transport tab pointing to a particular Publish instance. For multiple publish instances, you can also create replication agents by copying the default agent publish and then editing Name and URI in transport tab of the created agent. If you are not using the default Replication Agent, disable it, so an unnecessary replication attempt can be avoided.

Configuring Dispatcher for AEM forms

Dispatcher is Adobe Experience Manager's caching and/or load balancing tool. Using AEM's Dispatcher also helps to protect your AEM server from attack. Therefore, you can increase the security of your AEM instance by using the Dispatcher in conjunction with an enterprise-class web server.  

If you use Dispatcher, perform the following configurations:

  • Configure access for AEM forms
  • Configure the referrer filter service

Configure access for AEM forms

By default, the Dispatcher configuration is stored in the dispatcher.any text file. For AEM forms, add a filter to the configuration file. Perform the following steps to add the filter:

  1. Open the dispatcher.any file for editing and navigate to the filter section.

    Note:

    Search /filter to locate the filter section. To know more about filters, see Dispatcher documentation.

  2. Add the following filter to the filter section:
    /0025 { /type "allow" /glob "* /bin/xfaforms/submitaction*" } # to enable AEM forms submission

  3. Save and close the file.

Configure the referrer filter service

  1. Open the Apache Felix console (Configurations) at:
    http://[server]:[port_number]/system/console/configMgr

  2. Log in as an administrator and in the Configurations menu, select the Apache Sling Referrer Filter option.

  3. In the Allow Hosts field, enter host name of the dispatcher to allow it as a referrer and click Save. The format of the entry is http://[server]:[port].

Configuring the DocAssurance service  

Note:

The Configuring the DocAssurance service section is applicable only for fresh and clean installs. Do not perform these steps if you have installed AEM 6.1 forms add-on package (cumulative hot fix 6717) on top of an older AEM 6.1 forms add-on package.

The DocAssurance service is not available out of the box. It requires RSA and BouncyCastle libraries installed with AEM forms package. 

Note:

It is mandatory to bootdelegate RSA and BouncyCastle libraries for the Assembler service to run properly.  

 Perform the following steps to bootdelegate the libraries:  

  1. Stop the AEM server.

  2. Open the sling.properties at [AEM installation]\crx-quickstart\conf\ for editing.

    Note:

    If you use [AEM_root]\crx-quickstart\bin\start.bat to start AEM, then edit the sling.properties at [AEM_root]\crx-quickstart\

  3. Add the following properties to the sling.properties file.

    sling.bootdelegation.class.com.rsa.jsafe.provider.JsafeJCE=com.rsa.*
    sling.bootdelegation.class.org.bouncycastle.jce.provider.BouncyCastleProvider=org.bouncycastle.* 
  4. Save and close the file. Restart the AEM server.

Configure fonts manager service

Do the following to configure font directories in fonts manager service:

  1. Go to http://[hostname]:[port]/system/console/configMgr.

  2. Click the CQ-DAM-Handler-Gibson Font Manager Service to open in edit mode. 

  3. Specify paths to the directories for system fonts, Adobe server fonts, and customer fonts in the respective fields.

    Note:

    Your right to use fonts provided by parties other than Adobe is governed by the license agreements provided to you by such parties with those fonts, and is not covered under your license to use Adobe software. Adobe recommends that you review and ensure that you are in compliance with all applicable non-Adobe license agreements before using non-Adobe fonts with Adobe software, particularly with respect to use of fonts in a server environment.

  4. Click Save to save the settings.

Configuring the context path (optional)

Note:

The Configuring the context path  section is applicable only for fresh and clean installs. Do not perform these steps if you have installed AEM 6.1 forms add-on package (cumulative hot fix 6717) on top of an older AEM 6.1 forms add-on package.

AEM server, by default, is accessible at http://[host]:[port]/. It means that it runs on the context root path by default. However, you can configure AEM to run on a different context path. For example, if you want AEM to be accessible at http://[host]:[port]/myPage/, you need to configure myPage as the context path. To do so, perform the following steps:

  1. Open Apache Felix console (Configurations) at http://[host]:[port]/system/console/configMgr.
  2. Click Apache Felix Jetty Based HTTP Service to open the service in edit mode.
  3. In the Context Path field, specify /myPage in the Context Path field.
  4. Click Save.

Note:

The context path /aem is not supported for AEM forms.

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