1. Introduction  

After Software AG has announced a possible end of life of webMethods Broker and recommended a migration to Universal Messaging, they come out with a new version of webMethods Broker 10.5. 

The new version of webMethods is similar to Broker 9.6 with resolved issues and including the following fixes: 

  • BR_9.6_Core_Fix22 
  • BR_9.6_Core_Fix21 
  • BR_9.5_SP1_Core_Fix19 

Therefore, we have performed an upgrade of our Broker servers from 9.6 to 10.5. To do so we have prepared a strategy considering the targets below: 

  • Low cost: we have made the decision to upgrade the software on the same machines. 
  • Fast transition from the previous version to the new one to avoid queuing messages since during the migration many applications using broker remain running.  
  • To avoid a lot of post installation configuration steps, it was decided to use the same ports as the previous one (more details below). 
  • In case of an unexpected issue we should be able to switch to the previous version immediately. 

This strategy is based on a Broker Server in different machine, a second Broker Server from the same cluster installed in a second machine, to take over in case of an issue and which made the transition very smooth. The different Integration Servers and the MWS server each Installed in different machines.  

2. Preparation of the environments  

Before Installing the new product it is very important to prepare the target environment, and verify the hardware and system requirements. 

2.1 System And Hardware Requirements For WebMethods Broker 10.5 

According to the documentation, the minimum Hard Drive Space needed is 2GB however more space will be needed during the migration for files backup, Software AG recommends 10GB. And recommends 2 GB of RAM (minimum 512MB). 

Supported OS: a)     Windows Server (Datacenter and Standard Edition) 2012, 2016, 2019 
b)     Windows 8.x Pro and Enterprise 
c)      Windows 10 Pro and Enterprise 
Supported JDK Zulu Java 8.40 (1.8.0_222) 
Supported Browsers a)     Microsoft IE 11.x /Edge 
b)     Mozilla Firefox – ESR 60 
c)      Google Chrome 
Supported Application Servers  a)     IBM WebSphere 8.5 
b)     JBoss/WildFly  EAP (7.1 and 6.4) 
c)      Oracle BEA Weblogic 12.2 

2.2 Products And Installation Image 

Before preparing the installation Image with Software AG Installer, it is recommended to make a list of the products needed and already installed in the current installation. If applicable Command Central is very useful to list the products elsewise Software AG Installer or Software AG Update Manager.  

2.3 Pre Installation 

  1. Before starting the installation, backup all the following files and folders from the current installation: 
    1. <SAG>\Broker\bin 
    2. The data directory from which the migration is performed, by default in <SAG>\Broker\data 
  1. It is highly recommended to make a snapshot of the target server(s). 
  1. Create the new folder where installing the new version.  
  1. Prepare the license key of  the product and place it in the target server. 
  1. Create the installation image by using Software AG Installer. 

3. Installation Of The New Products  

We are installing webMethods Broker 10.5 in the same server and drive than the 9.6, and using the same ports of that one. This means that during the installation the existing servers should be shut down as the new one can be installed using the same ports.  

By using the same ports, we are avoiding additional configuration in all linked Integration Servers and MWS server levels to update the new ports. which takes more time by troubleshooting many issues due to this change. 

The estimated time of the installation and the migration is between 20 and 30 minutes. It is recommended in case of an unexpected issue which might increase this duration more than 30 minutes to reconnect to the old Broker Server for few minutes, to avoid queuing messages and alarms.  

In the target sever using Software AG Installer and the created image, and selecting the target folder, follow the steps, if not using Command Central skip the configuration step of Platform Manager. 

Very important: When in SAG Broker Monitor and SAG Broker Server configuration step, let the new Broker Monitor box checked and configured on the same port as the existing installation. But do not configure the new Broker server. Since we are Performing an upgrade of an existing installation and migrating the same Data Directory, “Create a Broker Server Configuration” don’t have to be selected, this will create a Broker server which is not needed. This is the exact moment just before clicking on next, to stop and disable the existing Broker Monitor and Broker Server in Windows Services. When the products are installed, it is recommended to have a look on the installation Log, then to reboot the machine. 

4. Migration  

After the reboot of the machine the old Broker Monitor and Broker Server have to be kept disabled. And the new Broker Monitor 10.5 should be running. 

  1. Place the old data directory from the old installation to its expected place in the new one. 
  1. If we are using the same SSL certificate and truststore place them in the same location of the new installation “<New_SAG>\Broker\certs”   
  1. Make sure the SAG Broker Monitor 10.5 (The new one) is Running. 
  1. From the old installation folder in <Old_SAG>\broker\bin copy the jndi.properties file to the same location in the new installation and edit it to update the certificates paths to point to the new installation. 
  1. Relocate the data directory in the new installation, in Command Prompt browse to <New_SAG >\broker\bin and run:  server_configrelocate path_to_data_directory_in_New_SAG  
  1. Create broker server 10.5 using old data directory (server_config add), browse to < New_SAG>\Broker\bin: server_config add path_to_data_directory -k path_to_data_license_key.xml -p PORT_of_Broker_server 

The new Broker server is created running and using the same data and port as the old one. 

5. Post Installation Configuration And Verification 

In My webMethods Administration > Messaging > Broker Servers the Broker Server should be already configured and connected to the same port. So it is possible to check the log and the Process Instances. 

First thing to do to verify that the new installation is running properly, has to be done at the Integration Server level in Settings > Messaging> JNDI Settings test the JNDI Provider Alias Definition, the result should be successful. Then verify if the JMS Connection Alias Definition(s) in “JMS Settings” and all JMS Triggers in “JMS Trigger Management” are all enabled. 

In MWS Monitoring > Business > Process Instances follow if the process Instances are completed without errors.  

Additionally, it is important to watch the logs on MWS and Windows Event Viewer if everything is running properly.  

To be able to perform this upgrade, these are the documents needed: 

  • 10.5_Installing_and_Upgrading_Broker 
  • Broker_readme_10-5 
  • 10-5_System_Requirements_for_Software_AG_Products 
  • 10.5_Administrating_Broker  
  • 10.5_Upgrading_Software_AG_Products (Broker section) 

Author: Riyadh Bourezzane