Preparatory work

Ensure that an appropriate change request has been made and that a change freeze for Halcyon (such as new alerts, scheduled jobs,and so on) is implemented throughout the upgrade duration.

These instructions show a generic download and upgrade.

You should tailor these instructions to your environment and software level.

We recommend that you perform your upgrade during office hours so that technical support is available locally or from Help Systems in the event of a failed install.

Failed installs are NOT common – if you perform an install out-of-hours, then you should be familiar with the roll-back process in case you need to roll-back the upgrade.

Useful hyperlinks

Release notes for Halcyon products:

All Halcyon software has been IBMi V7R3 Compatible since April 2016 (PTF Version 2016.029.7)

Upgrading Halcyon MQ Manager


The following steps describe the procedure required to upgrade an existing installation of Halcyon MQ Manager

Before you begin

You must download the latest PC executable file for your product suite from the Helpsystems Community Portal:

Run the downloaded PC executable for each of your systems and once the executable wizard has completed, follow the steps below.

Upgrade Instructions

  1. If you are using third party software to replicate Halcyon as part of your High Availability (HA) solution, end the replication for Halcyon before running the upgrade procedure.
  2. End Halcyon using command HALPROD/ENDMON.
  3. If Halcyon journaling is active, take option 41=Utilities from the main menu, followed by option 5=Work with Journal. Use F23 to end journaling. There should be no error messages when the journaling is ended.
  4. Check for any Halcyon libraries named R_* and delete if any exist. These are the previous release rollback libraries. If you have these saved to tape, you can safely remove them.
  5. Exit Halcyon and sign off your current session.
  6. Sign on as QSECOFR or equivalent.
  7. If you have DBU10 library in your system library list, then use the command below to temporarily remove the library. Halcyon shares object names and failure to perform this step causes the upgrade to fail. QSYS/CHGSYSLIBL LIB(DBU10) OPTION(*REMOVE).
  8. Run the command HALINST/INSTALL.
  9. Check the correct name of the environment that you want to upgrade is shown (the default environment name is PROD).
  10. Using option 1, select the level of suite installed (commonly LVL2) and press <Enter>. Select any other independently installed Halcyon products that must also be upgraded.
  11. Press <Enter> when prompted to progress the upgrade.
  12. At the end of the upgrade, press <Enter> to progress the completion. If you were previously using Halcyon journaling, use option F20 on the Work with Journal screen to restart journaling.
  13. Sign off the QSECOFR session and sign back on as normal.
  14. If the upgrade has been successful, you can now use the command HALPROD/STRMON to restart the monitors.
  15. If using third party HA software, restart the replication for Halcyon objects.

Example upgrade

Download and run the Halcyonsolution.exe transfer program

Click “Next” to continue”, then accept the licence agreement.

Check the box of the software you wish to transfer, in this case MQ Manager.

Supply the hostname and an appropriate userid with SECOFR authority.

Click “Next” to continue.

Click “Install” to begin the software transfer to the IBMi.

A progress screen is displayed.

When complete, click “Finish” to close the software transfer program.

Once transferred to the IBMi, you can finish with the windows installer and login to the IBMi.

End the environment monitors by using the ENDMON command in the environment you are upgrading;


Check the Halcyon subsystem has ended cleanly.

Make sure you and no-one else are using Halcyon or any of the menus, the best option is to sign out and sign-in again.

To begin the upgrade, use the following command:


Enter the environment name if required and check 1 against The HAL “Halcyon Common Library” and HMQ “MQ Manager” <Enter>.

This will perform an installed version check and highlight it on the screen.

The “Installed” column shows you what products and versions are currently installed in this environment.

The “Available” column shows you what products and version are available in the installation library.

Differences are highlighted in reverse-video so you can clearly see what will be upgraded.

Press <Enter> to go to the confirmation screen.

The confirmation screen is displayed.

Press <Enter> to confirm you wish to upgrade, do not submit to batch as you will lose visibility of the upgrade process.

During the installation process, the status is automatically updated.

Upon completion, press <Enter> to continue

Press <Enter> to continue past the journal

The final message will indicate that the product has been upgraded.

Still have questions? We can help. Submit a case to Technical Support.

Last Modified On: January 27, 2021