Upgrade Platform Container

Owned by Jenni Wallin
Last updated: Nov 01, 2024 by Huey Yun NgVersion comment
2 min read

Follow the steps in this section to upgrade the Platform Container.

Log out Desktops

Before starting the upgrade, please ensure that all Desktop clients have been logged out.

If you want to see which Desktops that are connected, you can use the following command:

$ mzsh mzadmin/<password> pico -view

Important!

When upgrading to 9.x, install.admin.password must be set according to your current admin password before proceeding with the ./setup.sh upgrade step.

Important!

If the existing installation has additional JVM arguments configured which are obsolete in Java 17, remove them and update to use supported options.

Please refer to Java 17 docs for details on 'Obsolete' and 'Removed' Java options since Java 8.

Refers to Managing Picos with Topo for JVM Arguments configuration.

Note!

When upgrading to 9.x, the install.security property (in install.xml) is automatically set to true. If you prefer to disable this setting, it must be manually changed to false. 

If install.security was set to false before the upgrade and is set to true after or during the upgrade, you need to change the url in the desktop launcher from http to https.


  1. Enter the release content directory that was created when you extracted the delivered *.tgz file during the Preparations, and execute the upgrade.

    $ ./setup.sh upgrade

  2. When using the setup.sh upgrade command, setup log file will be generated in the $MZ_HOME/log directory.

    Hint!

    It may be a good idea to open a new command line window in order to keep track of the log files.

  3. Start the pico for the User Interface.

    $ mzsh topo set -l pico:ui template:mz.standard-ui
$ mzsh startup ui

  4. MZ 9 upgrade does not install the legacy Web Desktop by default. If this feature is still required, see Installing Web Desktop Server


In case the upgrade was unsuccessful, check the latest setup log for further details in order to analyze the result and see what may have caused the problem. If it is needed, a system restore can be performed. For information about how to perform a system restore, see Simplified Downgrade Procedure.

Note!

If you are upgrading from 8.x and the upgrade fails, you may want to perform a system restore using the old MZ_HOME backup.

Note!

If you are using SAP HANA as the Platform database, you will need to enable TLS/SSL on the SAP HANA database after you upgrade your Platform. 

Note!

If you have HTTP configured in the 8.x platform container prior to the upgrade, the configuration will apply to MediationZone 9 upon upgrade. For more information on configuring the HTTP, see HTTP Configuration Properties.

Hint!

If any configurations have become invalid due to the upgrade, these will be listed in the log file. Search for the string "Regenerating configs" in the log file to find information about any invalid configurations.

Example - Output in the upgrade_<timestamp>.log file with invalid configurations.

Mon Nov 19 10:52:10 CET 2013 Regenerating configs 
The following configurations changed status 
and may require manual attention: 
Workflow Test.WF1 became invalid, 
Workflow Test.WF2 became invalid, 
APL Code Test.apl_profile became invalid,