Upgrade Preparations

Owned by Kevin Wu
Last updated: Dec 04, 2024 by Jenni Wallin
4 min read

During the upgrade process, you must use the default application user, mzadmin, and correct password whenever you are prompted to enter it.

The preparation steps will not affect the running system and can be done in advance.

Note!

For users who have custom agents created in Development Toolkit and upgrading from MediationZone 8.3:

If you have custom agents created using Development Toolkit, these agents cannot be included in the upgrade. For information on how to remove them before proceeding with the upgrade procedure, see Upgrade and Downgrade in Installation and Setup.

Note!

For systems using Configuration Spaces:

Configuration Spaces is replaced with the new Workflow Packages functionality. Prior to upgrading make sure to export the configuration from inactive configuration spaces that you want to keep, as only the active space is carried across during the upgrade process.

For further information regarding Configuration Spaces, and how to use them, refer to Configuration Spaces in the MediationZone 8.3 documentation.

Before proceeding with the upgrade, make the following preparations:

  1. Verify that you are on a version from which upgrade is supported. You can check the current version by opening the About window in the Desktop, where the current version is listed in the Pico Version section. If the system is running an earlier version, you need to upgrade it to 8.3.x or 9.0.x version first. See the documentation space for the version you are currently running for more information.
      

  2. Install either Oracle JDK 17 or OpenJDK 17 on the server(s) where the Platform Container and Execution Containers are running.

  3. Verify that the System Requirements are met. If the operating system, or database need to be upgraded, this should be done prior to the upgrade. This has to be done for all machines that are hosting the system.

  4. Ensure that the environment variables are set correctly:

Variable

Description

MZ_HOME

This environment variable specifies where the software is installed.

Note!

You should use an absolute path instead of a symlink for the MZ_HOME directory to avoid any issue during installation or upgrade.

JAVA_HOME

This environment variable specifies where the JDK is installed.

PATH

This environment variable specifies the search path and must contain the following directories:

$JAVA_HOME/bin:$MZ_HOME/bin

 

  1. Make an online backup of the database(s). For further information regarding how to perform an online backup, see Backup and Disaster Recovery Procedures.

 

  1. It is important to make a backup of MZ_HOME for rollback purposes.

    To make a backup of your MZ_HOME, you can use the following command:

$ cd $MZ_HOME/../ $ tar -zcvf mzhome_backup.tgz <MZ_HOME directory> $ mv mzhome_backup.tgz <backup directory>

  1. Create a directory to use when unpacking this release and future releases. For the purpose of these instructions, this designated directory is referred to as the staging directory.

 

  1. Place the *.tgz file from your release delivery into the staging directory.

  2. Use a command line tool, go to the staging directory, and unpack the *.tgz file by running the following command:

    $ tar xvzf <filename>.tgz

    A directory is then created in the staging directory, containing the software to be installed. For the purpose of these instructions, this directory is referred to as the release content directory.

  3. Now copy the MZ license file into the release content directory.

$ cp mz.license <release content directory>

  1. Enter the release content directory and prepare the install.xml file by running the following command:

The *.mzp packages have now been extracted, and the install.xml has been extracted into the release content directory. The install.xml file will automatically be populated with information from your existing installation.

Â