/
Upgrade Preparations

Upgrade Preparations

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. See Upgrade and Downgrade in https://infozone.atlassian.net/wiki/spaces/MD91/pages/23374347 for information on how to remove them before proceeding with the upgrade procedure.

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.

See https://infozone.atlassian.net/wiki/spaces/MD83/pages/5967404 in the MediationZone 8.3 documentation for further information regarding Configuration Spaces, and how to use them.

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 https://infozone.atlassian.net/wiki/spaces/MD91/pages/23363786 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.

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

Example - Setting environment variables

export MZ_HOME=/opt/mz export JAVA_HOME=/opt/jdk/jdk-17.0.2 export PATH=$JAVA_HOME/bin:$MZ_HOME/bin:$PATH

  1. Make an online backup of the database(s). For further information regarding how to perform an online backup, see https://infozone.atlassian.net/wiki/spaces/MD91/pages/23376913.

Note!

If you are upgrading from 9.x, you can find the database backup instructions in the documentation for 8.3 as the procedure may differ from that of 9.x.

  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:

Note!

Ensure that all processes in your installation are shutdown prior to the backup.

You can check which processes are running by using the mzsh status command.

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

Use of MZ_HOME backup

The MZ_HOME backup is needed in case the upgrade fails.

Use of Filebase persistence

When you have the platform property mz.userserver.filebased set to true, to ensure a seamless upgrade process, it is imperative to export all the config before the upgrade and re-import it afterward. Failure to do so may result in the missing configuration data in the upgrade.

  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.

Note!

The staging directory should not be the same directory as the one you created and set up as the MZ_HOME 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.

Note!

If you are upgrading from 8.3.x, you need a new license file. https://www.digitalroute.com/contact/contact-support/ on getting the MZ license file.

cp mz.license <release content directory>

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

cd <release content directory> ./setup.sh prepare

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.

Note!

Refer https://infozone.atlassian.net/wiki/spaces/MD91/pages/38961153 to know more about these properties and their default values.

Important!

If your existing MZ_HOME platform database is configured to use other database type than the default Derby, you need to check and update the respective database related properties from the install.xml file to match your current setup.

Oracle

See https://infozone.atlassian.net/wiki/spaces/MD91/pages/38961217 for details.

The following properties require manual update:

<property name="install.ora.owner" value="mzowner"/>
<property name="install.ora.password" value="mz"/>

PostgreSQL

See https://infozone.atlassian.net/wiki/spaces/MD91/pages/38961238 for details.

The following properties require manual update:

<property name="install.pg.owner" value="mzowner"/>
<property name="install.pg.password" value="mz"/>

SAP HANA

See https://infozone.atlassian.net/wiki/spaces/MD91/pages/891584513 for details.

Important Note on Database 3pp Before Upgrading!

If you are upgrading from 9.0.0.0, 9.0.1.0 or 9.1.0.0, check to see if the database 3pp jar is in the $MZ_HOME/3pp folder.

If it does not exist in the $MZ_HOME/3pp folder, then you need to manually copy the database 3pp jar to the $MZ_HOME/3pp folder prior to the upgrade.

This step is NOT required if your current running version is 9.0.2.0 or 9.1.2.0 onwards.

Note on Oracle ojdbc.jars!

If you are upgrading from 8.x and using Oracle as the system database, you need to use Oracle 19c (19.20.0.0) JDBC drivers (ojdbc8.jar/ojdbc10.jar).

Replace the jar files in $MZ_HOME/3pp and $MZ_HOME/lib folders

The jar file can be downloaded from https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html.