Update On-Premises RabbitMQ (STP Common Services Setup)

Prerequisites

• ❗Before installing the new version of STP Common Services, please make a backup of the entire system. This backup can be used to restore the whole environment in case of any errors.

• ❗To ensure the installation runs properly, the home drive must point to a local drive (usually C:). Check this in a command prompt. If a network drive is shown, you can create a local administrator account and use it to perform the following update steps.

• The new STP.CommonServices.Main.Setup-1.6.530.0.exe is available.
• The update can be performed with an administrative user.
• The update should be done during downtime, as all STP client apps and STP services must be stopped.

Step-by-Step Update

Stop All Clients

All STP Client Applications Must Be Closed

Note that DMS LCAS may be running in the background and can start automatically. Make sure all LCAS instances are stopped as well.

All Cloud Connectors Must Be Stopped

Stopping all clients and connectors prevents messages from being sent to the local STP application services.

Make Sure 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 number of messages!

The console can be accessed via http://localhost:15672 (on the machine where RabbitMq is installed) or http://SERVERNAME:15672. The username is “stpuser”; you can find the password in the configuration file of STP.UserManagement (“C:\Program Files (x86)\STP AG\STP UserManagement Service\STP.Common.Services.exe.config”) or in your installation report.

On the overview page, the total number of messages should be 0. If there are still messages listed, go to the “Queues” page:

Here you can see the remaining queues. The ones marked with a “D” under “Features” are the persistent queues. Under “Total” you can see the current number of messages in these queues. For queues that still have messages, try restarting the corresponding service and check if the messages are processed (number = 0 or decreasing as messages are processed). Once the queues are empty, you can stop the STP application services as well. At this point, nothing should be connected to RabbitMq.

Stop STP Services

Depending on the products installed, there will be a corresponding list of services that all need to be stopped.
>Please note that this illustration is just an example and your system may have additional services such as beA Desk and winsolvenz. These should also be stopped.

Stop RabbitMq

In “Services,” find the RabbitMq service and stop it there.

Uninstall the Old RabbitMq Version

Note: We have found that the “epdm.exe” file from Erlang is sometimes blocked during uninstallation. If this happens, open the Task Manager (run as administrator), search for “epdm.exe,” and end the process.

If the uninstallation process still causes issues, go to the Erlang folder and rename the “epdm.exe” file:

Go to the Erlang installation folder C:\Program Files\Erlang OTP\erts-14.2.5.9\bin and rename the epdm.exe file (for example, to epdem.exe_old).

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

Note: Occasionally, Windows may not properly recognize the completion of an installation or uninstallation process. In this case, you cannot start a new installation/uninstallation and Windows will report that another process is still running. To fix this, a system restart is required.

First, Open “Apps and Features”

The uninstallation must be done in three steps.

1. Search for “RabbitMq Server 3.8.14”, select it for removal, and confirm the following uninstallation screens.
   
   
2. Search for “Erlang OTP 23” and select it to remove.
   
   Confirm the following uninstallation screens:
   
   
3. Search for “STP.Common.Services” and select remove. Confirm the following uninstallation screens:
   

Rename the Current RabbitMq Data Folder

Under C:\programdata\STP AG\ you’ll find the folder “LEXolution Service Bus.” Rename it (for example, to “LEXolution Service Bus_old”) to prevent it from being changed during the installation of the new RabbitMq version.

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

Delete Registry Entry

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

Disable STP Startup Scripts

As part of the update, before restarting the server, go to Task Scheduler (Administration/Task Scheduler) in the “STP” folder and disable the task “STP-Dienste_sicher-starten.” This will need to be re-enabled later.

Restart the Server

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

Install the New RabbitMq

❗To ensure the installation runs properly, the home drive must point to a local drive (usually C:). Check this in a command prompt:

Type “set” to display a list of all environment variables. The variable “HOMEDRIVE” should point to C: (HOMEDRIVE=C:).
If it points somewhere else (e.g., a network drive) and the network drive was created by a local administrator, the update must be performed with that user. If that doesn’t work, reconfigure it before proceeding with the installation. Please make sure to follow the previous instructions before using this method.

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

Please note that the setup requires administrative rights.

Welcome Page

Select Next…

STP LEXolution Bus Configuration

In most cases, the default configuration (username and password) can be used. If the password was different in the old configuration, you should reuse it (you can find it in the installation documentation).

❗Please check the path to the database (Common.db). If the update is installed by a different user than the initial installation, the path may be reset. Please also check this after installation in the configuration file “STP.Common.Services.exe.config” under the path, e.g., “C:Files (x86)AGUserManagement Service” with the value “add key=”DataSource” value=“YOUR-PATH”.

When you’re done, click “Next”…

Confirm the Installation of Erlang and Its Components

Select Next…

The default installation location should be used.

The default menu folder should be used.

After Erlang is installed, RabbitMq will be installed. Confirm all RabbitMq setup screens.

The default components should be used.

The default installation location should be used.

Finally, a console application will start to reconfigure RabbitMq according to your configuration.
>❗This console application configures RabbitMq and may take several minutes. The window will close automatically when the process is complete. Do not close it manually under any circumstances, as this could cause an inconsistent state and the system may not work afterwards.

The installation ends with the “Installation Complete” page, which you can confirm.

Select Next…

Verify RabbitMq Installation

Next, you should validate the RabbitMq installation. Open the RabbitMq management console in a browser and log in with the username and password you provided during configuration.

Note: Since the management console was previously opened in the browser with the old RabbitMq version, the browser may still have old artifacts cached. Use a private browser window or a different browser to open the management console.

The RabbitMq management console should display a page similar to the following:

Re-enable STP Startup Scripts

Now, in Task Scheduler (Administration/Task Scheduler) in the “STP” folder, re-enable the task “STP-Dienste_sicher-starten.”

Restart the Server Again

After completing the previous steps, we recommend restarting the server again.

If Something Went Wrong

Despite all precautions, errors can still occur. If the update does not complete successfully and RabbitMq is not running, you will need to repeat the process. Please restart the computer and follow the update instructions step by step again. If the second attempt also fails, we recommend restoring the system from the backup and trying again on the freshly restarted system.