Udpate on-premise RabbitMq (STP Common Services Setup)

Prerequisites

  • ❗Before installing the new version of STP Common Services, please back up your entire system. This will allow you to restore the entire environment in case of an error.

  • ❗In order for the installation to run properly, the Homedrive must point to a local drive (usually C:). Check this in a command prompt. If a network drive is displayed, you can create a local administrator and then use this to perform the subsequent update steps.

  • New STP.CommonServices.Main.Setup-1.6.530.0.exe is available.
  • Update can be done with an administrative account.
  • Update can be done inside a Downtime as all STP-Client-Apps and STP-Services must be stopped.

Step by step update

Stop all clients

All STP client application must be stopped

Keep in mind that the DMS LCAS can run in the background and be started automatically. It must be ensured that also all LCAS instances are stopped.

All Cloud connectors must be stopped

By stopping all clients and connectors, one prevents messages to be send to the on-premise STP application services.

Ensure that all persistent queues in RabbitMq are empty

Persistent queues are marked as durable in the RabbitMq Management Console.

Open the RabbitMq Management Console and check the message count!
>The console can be opened either via http://localhost:15672 (on the machine where RabbitMq is installed) or via http://SERVERNAME:15672 >The user is “stpuser”, the password can be found e.g. in the configuration file of the STP.UserManagement (“C:\Program Files (x86)\STP AG\STP UserManagement Service\STP.Common.Services.exe.config”) or in your installation report.

RMq overview

On the overview page the total message count must be 0. If there are still messages listed go to the “Queues” page:

RMq queues
Here one can see the remaining queues. The ones flagged with a “D” under Features are the persistent queues. Under “Total” one can see the current message count of that queues. For queues that still contain messages try to restart the related service and check if the messages are processed (count = 0 or is decreasing because the messages are processed). After the queues do no longer contain any messages, the STP application services can also be stopped. Now there shouldn’t be anything connected to RabbitMq anymore.

Stop STP Services

Depending on the installed products there is a comparable list of services that must all be stopped.
RMq windows services > Please note that this illustration is only an example and that other services such as beA Desk and winsolvenz may also be available on your system. These should also be terminated.

Stop RabbitMq

RMq rabbitmq service

Under services one can find the RabbitMq service and stop it.

Uninstall old RabbitMq version

Attention: We recognized that sometimes the epdm.exe from Erlang is blocked during uninstall. In that case go to the Task Manager (run as administrator) look for epdm.exe and stop it.
Task manager epmd
In case the uninstall process still complains go to the Erlang folder and rename the epdm.exe file:
RMq epmd
Go to the Erlang installation folder C:\Program Files\Erlang OTP\erts-14.2.5.9\bin and rename epdm.exe file (e.g. epdem.exe_old).

Depending on the installation, the Erlang installation folder may be located at C:\Program Files\erl-23.3\erts-11.2\bin.

Attention: Occasionally, Windows may fail to correctly detect the completion of an installation or uninstallation process. When this happens, you won’t be able to start a new install/uninstall, and Windows will report that another process is still running. To resolve this issue, a system restart is required.

Open “Apps and Features” first.
RMq apps and features

The uninstall must be made in three steps.

  1. Look for “RabbitMq Server 3.8.14”, select to remove it and confirm the following uninstall pages.
    RMq uninstall
  2. Look for “Erlang OTP 23” and select to remove it.
    Erlang uninstall
    Confirm the following uninstall pages:
    Erlang uninstall in setup
  3. Look for “STP.Common.Services” and select to remove it. Confirm the following uninstall pages:
    STP Common services uninstall

Rename current RabbitMq data folder

RMq data folder

Under C:\programdata\STP AG\ the folder “LEXolution Service Bus” is located. Rename it (e.g. “LEXolution Service Bus_old”), to prevent it from being modified during setup of the new RabbitMq version.

The folders for Erlang (often called “Erlangen”) and RabbitMq can be deleted. Otherwise, this may cause problems during reinstallation.

Delete registry entry

In rare cases, it may be necessary to manually delete the registry key “Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\Erlang”.

Deactivating STP start scripts

During the update, you should deactivate the task “STP-Dienste_sicher-starten” in the task planning area (Administration/Task Planning) in the “STP” folder before restarting the server system. This must be reactivated at a later point in time.

Restarting the server system

Before continuing with the installation of the new version, we recommend restarting the server system.

Install new RabbitMq

❗For the installation to run properly it is necessary that the Homedrive points to a local drive (usually C:). Check it on a command prompt:

RMq install
Enter “set” to get a list of all Environment variables. The variable “HOMEDRIVE” shoud point to C: (HOMEDRIVE=C:) If it points to another location (e.g., a network drive) and the network drive was created by a local administrator, the update must be performed with this user. If no success, reconfigure it before continuing with the installation. Please be sure to follow the previous instruction first before using this method.

Run the file STP.CommonServices.Main.Setup-1.6.530.0.exe and go through the setup pages:

Please note that the setup requires administrative rights.

Welcome page

RMq welcome install
Press continue…

STP LEXolution Bus configuration

RMq install config
In most cases, the default configuration (user name and password) can be used. If the password was different in the old configuration, you should reuse it (it can be found in the installation documentation).

When configured press continue…

Confirm to install Erlang and its components

Erlang install
Press continue…

Erlang install folder
The default installation location should be used.

Erlang install menu
The default menu folder should be used.

After Erlang is installed RabbitMq will be installed. Confirm all pages from the RabbitMq Setup.

RMq install components
The default components should be used.

RMq install folder
The default installation location should be used.

Finally a console application starts and reconfigures RabbitMq to match the enterd configuration. >❗This console application is used to configure RabbitMQ and may take several minutes. The window will close automatically once the process is complete. Please do not close it manually under any circumstances, as this will create an inconsistent state and render the system inoperable.

Console Config app

The installation ends with the “Installation done” page which can be confirmed.
RMq install folder
Press confirm

Validate RabbitMq installation

After that the RabbitMq installation should be validated. Open the RabbitMq Management Console in an browser. and login with the username and password that were provided for the configuration.

Attention: As the management console was opened in the browser before with the old RabbitMq version installed, the browser will most likely still cachen old artifacts. A private browser page or another browser should be used to open the management console.

The RabbitMq Management Console should display a page similar to this:

RMq Management Console

Reactivating STP start scripts

Now, in the task planning area (Administration/Task Planning), the task “STP Services_Start Securely” should be reactivated in the “STP” folder.

Restarting the server system

Once the previous steps have been completed, we recommend restarting the server system.

If something went wrong

Despite all due care, it cannot be ruled out that an error may occur. If the update cannot be completed without errors and RabbitMq is not executable, the process must be repeated. Please restart the computer and perform the update again step by step according to the instructions. If the second attempt also fails, we recommend resetting the system from the system backup and trying again on the freshly started system.

Related to