Upgrading IMS

This section provides information about how to execute the upgrade commands. The upgrade will take some time to complete, so be sure to anticipate and plan for plenty of downtime.

Important! Before upgrading to a newer version of IMS, make sure that IMS services are not in the process of receiving new or active messages. This will help prevent errors during the upgrade process.

Consider the following guidelines prior to upgrading IMS:

  • If needed, update the config files in the Configuration folder.

  • Update the installation config files with the proper values.

  • Make sure that the new config values are consistent with the previous ones (such as TenantId, InstallationPath, customershortcode, Kafka settings, database settings, etc.). If no changes are expected, verify this by reviewing the config values from the earlier deployment.

  • Make sure that the latest fields are properly updated in the installation configuration files.

  • Execute the latest commands as documented for the target version.

  • Always upgrade core service first, and then adapter/transform services.

Installation commands will work for upgrades as well. There are no separate commands for upgrades.

Note: Before running a command during the upgrade process, it's not necessary to stop services, as the installation will take care of this. However, if you want to stop services to prevent any new message flows to IMS (which could result in lost messages or interruptions to the upgrade), stop client service before stopping IMS services.

During the upgrade process, the installation script identifies whether it will perform an upgrade or installation by looking for any existing services installed on the machine. Each MSI installer will uninstall the old version and install the new version service during the upgrade process.

Caution: Do not run MSI installers to upgrade IMS core and adapter services, as this will damage the service configuration. Do not run MSI installers at any point after installing or upgrading IMS services, as this may corrupt the cache.

Proceed to Upgrade commands and procedures.