Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: formatting and typo fixes

 
Table of Contents

Introduction

This guide is intended to help you through the migration process from SONARPLEX Version 4.1.x and 4.2.x to SONARPLEX release 5.1. SONARPLEX Generation 5 is a major release, and contains essential changes of the software especially for the plugins. This requires from the user additional steps in the upgrade procedure. 

...

Plugin Migration


Info

Note that most of the plugins will show up Installation problems(s) (see screenshot above) in Admin GUI > My Plugins, this is normal as you now must now upgrade the plugins for compatibility.

Image RemovedImage Added

Follow one of the below described ways, automatic or manual, to update all plugins.

Automatic Plugin Update (recommended)

As most of the plugins are not compatible between SONARPLEX 4.x.x and 5.x.x, these must be updated. We highly recommend to use the upgrade patch (TODO: name here) as it will upgrade the plugins automatically. 

Info

You can find the plugin update, named plugin-updates-001_v4.2.0b_to_v5.1.1a.tar in the azeti Portal > Downloads > SONARPLEX Generation 5 > Updates

After the download you must install the plugin updates package:

  1. Choose Admin GUI > System > Patch
  2. Choose Browse to select the proper patch file and elect the apply icon  to start the installation, the SONARPLEX will reboot which can take up to 10 minutes

...

Info

In case you are using old MODBUS daemons, right click on you appliance and choose "Manage Plugins" and deinstall modbus_fastd-COM1.azse and modbus_fastd-COM2.azse. To do this, uncheck all other plugins, mark the "Remove" tick of the mod_bus_fastd-COM1 and COM2, and modbus_setup,  and press apply. See the screenshot above.


Now install the MODBUS daemon version (tick it an press Apply).

All further plugins for update must now be selected and installed. Check all the new plugins and press Apply.

The old plugins "Modbus Fast Write Plug-In for fast MODBUS daemon", modbus_fastd-COM1 and -COM2, the new modbus_fastd and the modbus_active_to_passive_converter must be left unchecked.


Install the configuration migration plugin modbus_active_to_passive_converter which will run immediately after installation and update all necessary monitoring configuration items.

Info

Now please close the Plugin Management and reopen to load the latest installation state. 

As the converter package is only required once you can now remove it, choose Remove, and Apply.


You now have updated all MODBUS plugins and you can close the Plugin Management.

Updating Plugins

via

with the Administrative Interface

Remove the old MODBUS-Daemons

If you are using Modbus deinstall modbus_fastd-COM1.azse, modbus_fastd-COM2.azse and modbus_setup:

  1. click on the triangle to expand the Plugin page
  2. click on the bin "Delete plugin" icon and confirm to deinstall it
Install the new MODBUS-
  1. Open Configuration > My Plugins 
  2. Click the arrow Image Added to expand the plugin information for both daemons
  3. Delete the addon by selecting the trash can icon Image Added, repeat this for both the COM1 and COM2 daemon

Install the new MODBUS-Daemons

Install the new Modbus daemon, modbus_fastd.azse:

  1. Click browse Open Configuration > My Plugins 
  2. Choose Browse to select modbus_fastd.azse
  3. Click on uploadWait for "install -ok" Image Added upload
The installation was successful when the appearing installation notes shows an OK at the end. 
Image Added

Update incompatible Plugins

Incompatible/obsolete plugins are marked in red color and require a new version. Do following steps for all red marked plugins:

  1. Click browse to Open Configuration > My Plugins 
  2. Choose Browse to select the new plugin
  3. Click on upload
  4. Wait for "install -ok"
  5. on Image Added upload and check if the installation notes show OK 

Migrate the MODBUS Plugins

If you are using Modbus install MODBUS migration Plugin:

  1. Click browse to select the plugin Open Configuration > My Plugins 
  2. Choose Browse to select modbus_active_to_passive_converter.azse
  3. Click on upload
  4. wait some seconds and press F5 to refresh your Web browser (this is because of a software bug)
For cleaning up your appliance delete check_
  1. on Image Added upload and check if the installation notes show OK

For cleaning up your appliance delete check_modbus_fast_write3.azsp and modbus_active_to_passive_converter.azse:

  1. click on the triangle to expand the Plugin page
  2. click on the bin "Delete plugin" icon and confirm to deinstall it

Done!

At the end the MyPlugins page should look like this:

Image Removed, repeat the following steps for both

  1. Open Configuration > My Plugins 
  2. Click the arrow Image Added to expand the plugin information
  3. Delete the addon by selecting the trash can icon Image Added
Info

You can verify if the installation was successful when service check plugins which are used by any service are marked green.

Image Added

Configuration changes after upgrade

The new release introduced a whole new logging framework which allows a detailed logging configuration for single system components.

Info
  • By default logging verbose level is OFF. We recommend turning it to INFO for all hardware types except the SONARPLEX NG as it runs on SD flash.
  • To warrant a consistent status among the old and new plugins, delete the retention file by going to the administrative interface; go to the Status::Monitor menu and press the icon for "Delete state retention file".
  • The modbus upgrade uses a plugin called "modbus_active_to_passive_converter". This is an script that adjusts for you the configuration of the modbus plugins that were installed in the system. If still in the system after the upgrade (when using the  patch upgrade, it should automatically removed from the system), search in Configuration::MyPlugins for the pluging "Modbus_active_to_passive_converter". This plugin can be safely removed from the system.

Downgrade to SONARPLEX 4.x.x

Following instruction guides you to perform a downgrade from SONARPLEX generation 5 to the previous version 4.x.x. Similar as for the upgrade you need to follow the upgrade path in the reverse direction. This means if you want to go to release 4.1.3 you need to install 4.2.0 first as an intermediate step.

Info

The next steps are an example how to downgrade from SONARPLEX version 5.1.0 to version 4.1.3 with installed patch level 53

Preparations

  • you need the two upgrade images SONARPLEX version 4.2.0 and 4.1.3
  • you need the last patch for SONARPLEX version 4.1.3 update-4.1.3a-enhance-53-ir.tar
  • you need a backup created in SONARPLEX version 4.1.3
  • you need the downgrade patch update-4.1.3a-down-1.tar

...