Versions Compared

Old Version 15

changes.mady.by.user Wei Siong Siow

Saved on

compared with

New Version Current

changes.mady.by.user Yeok Hong Ng (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Note

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 in /wiki/spaces/MD82/pages/3779155. 

Note

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, please refer to Configuration Spaces in the Image Removed version MediationZone 8.3 documentation.

Before proceeding with the upgrade, make the following preparations:

  1. Verify that you are running version 8.3.x or 9.0.0 or laterx. 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 an 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:

Excerpt
nameupgrade_variables

Variable

Description

MZ_HOME

This environment variable specifies where the software is installed.

Note

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

Rw ui textbox macro
type
tip
Info

Example - Setting environment variables

Code Block
$ export MZ_HOME=/opt/mz 
$ export JAVA_HOME=/opt/Library/Javajdk/JavaVirtualMachines/jdk-17.0.2.jdk/Contents/Home
$ export PATH=$JAVA_HOME/bin:$MZ_HOME/bin:$PATH

Make a backup of all your configurations with System Export. This can be done either in Desktop, which is described in System Exporter or by using the mzsh systemexport command:

Code Block
$ mzsh mzadmin/<password> systemexport <backup directory>/<filename>

...

titleUse of System Export File

...

  1. Make an online backup of the database(s). For further information regarding how to perform an online backup, see Preventive Maintenance Backup and Disaster Recovery Procedures.
 Note
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
...
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.
 Code Block
$ cd $MZ_HOME/../
$ tar -zcvf mzhome_backup.tgz <MZ_HOME directory>
$ mv mzhome_backup.tgz <backup directory>
 Info
...
Use of MZ_HOME backup
The MZ_HOME backup 
...
is needed in 
...
If you are performing an upgrade of a system with large configurations, you may need to increase the maximum number of file descriptors.
...
titleExample - Changing the maximum number of file descriptors on Linux
...
languagetext
themeEclipse
...
case the upgrade fails.
 Info
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
...
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:
     Code Block
    $ 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.
 Info
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.
 Code Block
$ cp mz.license <release content directory>
  1. Enter the release content directory and prepare the install.xml file by running the following command:
 Code Block
$ 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 Platform PropertiesRefer Updating the Installation Properties for Platform  to know more about these properties and their default values.
 Insert excerpt
MD9:Upgrade Platform ContainerMD9:
Upgrade Platform Container
nopaneltrue
...
 Insert excerpt
Upgrade Platform Container
Upgrade Platform Container
namejvm-arguments-note
nopaneltrue
 Excerpt
nameimportant
 Warning
Important!
If your existing MZ_HOME platform database is configured to use other database type 
 rather 
 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 Properties for Oracle for details.
The following properties require manual update:
<property name="install.ora.jdbc.user" value="mzadmin"/>
<property name="install.ora.jdbc.password" value="mz"/>
<property name="install.ora.owner" value="mzowner"/>
<property name="install.ora.password" value="mz"/>
<property name="install.ora.host" value="localhost"/>
<property name="install.ora.size" value="small"/>
<property name="install.ora.port" value="1521"/>
PostgreSQL
See Properties for PostgreSQL for details.
The following properties require manual update:
<property name="install.
ora
pg.
home
owner" value="
/opt/oracle
mzowner"/>
<property name="install.
ora
pg.
sid
password" value="
MZ
mz"/>
See Properties for Oracle for details.
PostgreSQL
See Properties for PostgreSQL for details.
SAP HANA
See Properties for SAP HANA for details.
 Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#FFEBE6
Important
 Note
Important Note on Database 3pp Before Upgrading!
If you are upgrading from 9.0.0.0
 or 
, 9.0.1.0 or 9.1.0.0
 and using other database type rather than the default Derby
, 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 
 manual 
manually copy the database 3pp jar to the $MZ_HOME/3pp folder prior to the upgrade. 
However this 
This step is 
 not 
NOT required if your current running version is 9.0.2.0 or 9.1.2.0 onwards.
 Note
Note on Oracle ojdbc.jars!
If you are upgrading from 8.x and using Oracle as the system database, 
 it is recommended 
you need to use Oracle 19c (19.20.0.0) JDBC 
 driver which is the official supported version by 9.x.
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.