Upgrade to AEM 6.5 Forms LTS on OSGi upgrade-to-aem-forms-osgi

Install AEM Forms add-on package. The steps are listed below:

1. Open Software Distribution. You require an Adobe ID to log in to the Software Distribution.

2. Select Adobe Experience Manager available in the header menu.

3. In the Filters section:

   1. Select Forms from the Solution drop-down list.
   2. Select the version and type for the package. You can also use the Search Downloads option to filter the results.

4. Select the package name applicable to your operating system, select Accept EULA Terms, and select Download.

5. Open Package Manager and click Upload Package to upload the package.

6. Select the package and click Install.

   You can also download the package using the direct link listed in AEM Forms releases article.

   After the package is installed, you are prompted to restart the AEM instance. Do not immediately stop the server. Before stopping the AEM Forms server, wait until the ServiceEvent REGISTERED and ServiceEvent UNREGISTERED messages stop appearing in the <crx-repository>/error.log file and the log is stable. Also note, a few packages can remain in the installed state. You can safely ignore the state of these packages.

   Restart the AEM instance with the following additional JVM command-line parameters:
   --add-opens java.base/java.util=ALL-UNNAMED --add-exports=java.xml/com.sun.org.apache.xml.internal.serialize=ALL-UNNAMED

   If the server is started via a script or service, update it accordingly to include the above so that these are effective after subsequent restarts as well.

   note note
   NOTE
   It is recommended to use the ‘Ctrl + C’ command to restart the SDK. Restarting the AEM SDK using alternative methods, for example, stopping Java processes, may lead to inconsistencies in the AEM development environment.

Perform post-installation activities.

• Run Migration Utility

  The migration utility makes the adaptive forms and correspondence management assets of earlier versions compatible with AEM 6.5 forms. You can download the utility from AEM Software Distribution. For step-by-step information to configure and use the migration utility, see migration utility.

  If you are using Sample for integrating drafts & submissions component with the database and upgrading from a previous version, then run the following SQL queries after performing the upgrade:

  code language-sql
  UPDATE metadata m, additionalmetadatatable am SET m.dataType = am.value WHERE m.id = am.id AND am.key = 'dataType'

  code language-sql
  DELETE from additionalmetadatatable WHERE `key` = 'dataType'

• (If upgrading from AEM 6.2 Forms or previous versions only) Reconfigure Adobe Sign

  If you had Adobe Sign configured in the previous version of AEM Forms, then reconfigure Adobe Sign from AEM Cloud services. For more details, see Integrate Adobe Sign with AEM Forms.

• Support for jQuery

  In AEM 6.5 Forms, version of jQuery is updated to 3.2.1 and jQuery UI version is updated to 1.12.1. AEM Form uses JQuery in noConflict mode. So, if you are using any other jQuery version, no issues are displayed while performing an upgrade. However, when you upgrade to AEM 6.5 Forms:

  • Ensure that your custom components, if any, are compatible with supported jQuery versions.
  • Remove unsupported APIs from the custom components. See upgrade guide for the list of removed APIs. For example, support for the load(), .unload(), and .error() APIs is removed. Use the .on() method in place of aforementioned APIs. For example, change $(“img”).load(fn) to $(“img”).on(“load”, fn).

• (If upgrading from AEM 6.2 Forms or previous versions only) Reconfigure analytics and reports

  In AEM 6.4 Forms, traffic variable for source and success event for impression are not available. So, when you upgrade from AEM 6.2 Forms or previous versions, AEM Forms stops sending data to Adobe Analytics server and analytics reports for adaptive forms are not available. Moreover, AEM 6.4 Forms introduces traffic variable for the version of form analytics and success event for the amount of time spent on a field. So, reconfigure analytics and reports for your AEM Forms environment. For detailed steps, see Configuring analytics and reports.

Verify that the server is upgraded successfully, all the data is also migrated successfully, and it can operate normally.

• Verify the status of the bundles: Ensure that all the bundles are in active state.

• Verify replication and reverse replication: Publish, fill, and submit a few migrated forms. Verify the submitted data also.

• Verify access to admin and developer user interfaces: Log in to AEM instance from an admin account and verify that you have access to the following URLs:

  • https://'[server]:[port]'/crx/packmgr
  • https://'[server]:[port]'/crx/de
  • https://'[server]:[port]'/aem/forms.html/content/dam/formsanddocuments

Navigate to the Red Hat Developer portal:
https://developers.redhat.com/products/eap/download

Download the JBoss EAP 8 ZIP distribution for Windows.

Extract the downloaded ZIP file to your preferred installation directory.

Note this directory path as <JBOSS_HOME> for use throughout this guide.

Example:
C:\jboss-eap-8.0

Create a temporary working directory:

C:\aem\war-config

Copy cq-quickstart.war into this directory.

Open Command Prompt and navigate to your working directory:

cd C:\aem\war-config

Extract the WAR file:

jar -xvf cq-quickstart.war

This creates a directory structure with WEB-INF and other application files.

Navigate to the WEB-INF directory within your extracted WAR:

cd WEB-INF

Create a new file named jboss-deployment-structure.xml.

Add the following XML content:

<?xml version="1.0" encoding="UTF-8"?>
<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
    <deployment>
        <dependencies>
            <module name="jdk.unsupported" />
        </dependencies>
    </deployment>
</jboss-deployment-structure>

Save and close the file.

Open WEB-INF\web.xml in a text editor.

Locate the <servlet> section containing the run mode configuration:

<!-- Set the runmode per default to author -->
<init-param>
    <param-name>sling.run.modes</param-name>
    <param-value>author</param-value>
</init-param>
<load-on-startup>100</load-on-startup>
</servlet>

Replace the closing </servlet> tag and preceding line with:

<init-param>
    <param-name>sling.run.modes</param-name>
    <param-value>author</param-value>
</init-param>
<multipart-config>
    <max-file-size>1048576000</max-file-size>
    <max-request-size>1048576000</max-request-size>
    <file-size-threshold>0</file-size-threshold>
</multipart-config>
<load-on-startup>100</load-on-startup>
</servlet>

Save and close web.xml.

Navigate back to the working directory containing the extracted contents:

cd C:\aem\war-config

Create the new WAR file:

jar -cvf cq-quickstart.war *

Copy the repackaged cq-quickstart.war to the JBoss deployments directory:

<JBOSS_HOME>\standalone\deployments

Example:
C:\jboss-eap-8.0\standalone\deployments

Open <JBOSS_HOME>\bin\standalone.conf.bat in a text editor.

Modify or add the following line to set heap memory:

set "JAVA_OPTS=-Xms4096m -Xmx4096m -XX:MaxMetaspaceSize=512m"

Open Command Prompt as Administrator.

Navigate to the JBoss bin directory:

cd <JBOSS_HOME>\bin

Example:
cmd cd C:\jboss-eap-8.0\bin

Start the JBoss server:

standalone.bat -b 0.0.0.0 -bmanagement 0.0.0.0

Parameters:

• -b 0.0.0.0 — Binds the server to all network interfaces
• -bmanagement 0.0.0.0 — Binds the management interface to all network interfaces