From 7.3.2 to 7.3.4.1

Published January 17, 2022
Webapp Webapp + Tomcat 7.3.4.1 Release notes

Upgrading to 7.3.4 consists of one unique, easy step; please read it carefully before proceeding.

Please:

  • Stop the user requests / traffic to the server (either on the front-end Apache HTTPD server or firewall/router)
  • Stop Digital Experience Manager before backing up and running the fix applier
  • Backup your Digital Experience Manager installation before running the fix applier
  • Run a pre-production test first.

Release notes

  • The changelogs of Digital Experience Manager 7.3.4.1 and its updated modules are available in the 7.3.4.1 Release notes

Spring bean modifications

  • If you have customized your application context in the file digital-factory-config/jahia/applicationcontext-custom.xml , please consult the list of changes we made in our Spring beans as you might need to update your configuration.

Synchronisation of OSGi configurations is enabled

  • In DX 7.3.1.1 we have fixed and activated the cluster synchronisation of OSGi configurations (usually found under /digital-factory-data/karaf/etc ). From now on, any modification done in a OSGi configuration file will be automatically applied to the other cluster nodes. It is still possible to deactivate such synchronisation by following this procedure.
  • Configuration files that were present in the digital-factory-data/modules folder will be moved to digital-factory-data/karaf/etc

Before upgrading, ensure that you:

  • Stop user requests and traffic to the server, either on the front-end Apache HTTPD server or firewall/router
  • Stop Jahia before backing up and running the fix applier
  • Backup your Jahia installation before running the fix applier. For more details about how to backup Jahia, see the Configuration and Fine tuning guide.
  • Run a pre-production test first

Note that the following steps are mainly for projects running under Tomcat or JBoss. If you use WebSphere as application server, refer to the section 7 of the WebSphere 8.5.5 installation guide.

Tomcat

Upgrading a standalone installation

When you perform a standalone install upgrade, you:

  • Migrate Digital Experience Manager core and modules
  • Stop Jahia and back up your installation
  • Upgrade your application
  • Clean Tomcat and resources folders
  • Start Digital Experience Manager

Migrating Digital Experience Manager core and modules

Copy the fix applier you would like to use on your production server.

A list of all the files you have customized in your installation will help you to go through the upgrade and decide more easily if you want to merge, keep or overwrite the files. For all the files impacted, the fix applier creates a backup in the following folder:

$USER_HOME/.fixapplier/backup/

And a detailed log is also available under:

<JAHIA_INSTALLATION>/tomcat/webapps/ROOT/META-INF/updates/history/fixes/<FiXAPPLIER_NAME>.log

If you didn't use the default ROOT context, the log is located under:

<JAHIA_INSTALLATION>/tomcat/webapps/<your context>/META-INF/updates/history/fixes/<FiXAPPLIER_NAME>.log

If the fix creator detects that a file has been modified it will try to automatically merge it. If the merge fails you will be able to overwrite the files or skip it installing the modification.
If the merge fails or you decide to skip it, a diff file <FILE_NAME>.patch is available in the destination folder. Make sure that you don't forget to manually apply the changes.

Stopping Jahia and backing up your installation

Important note: All the bundle's cache will be removed during the FixApplier so make sure you backup your installation first before applying the fix and validate the proper migration before deleting the backup.
You must take care regarding patches to DX core and core modules that you manually deployed to your DX instance before the migration (that is, not by a DX fix applier). The patches will be reverted during migration and you may need to apply them again after the migration. However in many cases, the new DX version already includes these fixes and it is not necessary to re-apply them.

Upgrading your application

Open a terminal in the JAHIA_INSTALLATION/tomcat/webapps/ROOT or JAHIA_INSTALLATION/tomcat/webapps/<your context> directory if you didn't use the default ROOT context, and type the following command:

java -jar <PATH-TO-FIX-APPLIER>/<FIXAPPLIER_NAME>.jar

The fix applier manages the upgrade of your platform by deleting, updating and merging all necessary files. The fix applier also handles the migration of Jahia Core and all the additional Jahia modules installed on your platform.

If you have externalized your configuration (jar file or folder), you will need to apply the modification relative to jahia.properties or jahia.node.properties manually at the appropriate place.

If you store your DX sources (digital-factory-data, digital-factory-config) on a location other than default, you might need to execute the Fix Applier package and pass the required parameters (replace the <DF_INSTALL_DIR> with the corresponding absolute path and the name of the fix applier file with the appropriate one:

java -jar <PATH-TO-FIX-APPLIER>/<FIXAPPLIER_NAME>.jar --target <DF_INSTALL_DIR>/digital-factory/digitalfactory.ear --data <DF_INSTALL_DIR>/digital-factory/data --config <DF_INSTALL_DIR>/digitalfactory/config
If the fix applier cannot find the digital-factory-config and digital-factory-data folders at the specified locations or cannot auto-detect their location, it stops executing the update and produces an error. Review your log before starting the next step to ensure you haven't missed a file that needs to be manually merged.

Cleaning Tomcat and resources folders

The fix applier handles the cleaning of the Tomcat and resources folders automatically, but depending on your OS and permissions you may need to clean them manually. Ensure that you remove the content of the following Tomcat and resources folders:

  • <JAHIA_INSTALLATION>/tomcat/temp
  • <JAHIA_INSTALLATION>/tomcat/work
  • <JAHIA_INSTALLATION>/digital-factory-data/generated-resources

Starting your Digital Experience Manager

Start your DX.

If you used additional bundles before migration (bundles that are not Jahia Modules, bundles installed using the Karaf Features), re-install them with the same procedure as used for the initial installation of the additional bundles.

Your Digital Experience Manager upgrade is now completed.

Clustered installation upgrade

Migrate all your nodes starting with the processing node.

To upgrade a clustered installation:

  1. Shut all nodes down.
  2. Apply the steps described for a standalone installation.
  3. Repeat the previous step for each of your cluster nodes.
Your Digital Experience Manager upgrade is now completed.
Important note: All the bundles’ cache will be removed when running the fix applier, so make sure you backup your installation first before applying the fix and validate the proper migration before deleting the backup.

To upgrade your application:

  1. Stop your JBoss server and backup your application.

  2. Upgrade your application. Open a terminal in the JAHIA_INSTALLATION/ and type the following command: (with the right fix applier name).  
    java -jar <PATH-TO-FIX-APPLIER>/<FIXAPPLIER_NAME>.jar --target
 /standalone/deployments/digitalfactory.ear --config /standalone/deployments/digital-factory-config.jar
 --data /digital-factory-data
  3. Purge the webapp cache by removing <JBOSS_HOME>/standalone/tmp/work/jboss.web/default-host
  4. Restart your JBoss server.

Start JBoss server and monitor the log file to check for a proper startup of migrated DX instance.