(9.1+) Upgrade prerequisites

On-Premise Callback version 9.x supports an upgrade for the following versions:

  • 9.0 to 9.1
  • 9.0 to 9.2
  • 9.1 to 9.2
  • 9.2 to 9.3

If you are upgrading from an earlier version of On-Premise Callback application, you will need to uninstall your current version of Callback software, and reinstall the latest version.

The Callback upgrade runs using the Installer like a new installation. The Installer detects if a version of Callback is already installed and then performs an upgrade. The existing configuration is used and all configuration files are saved and preserved, or modified as required for new features or fixes that have been implemented. All applications are reinstalled for the new version and all callbacks are preserved.

Pre-Upgrade checklist

Prior to upgrading Callback, prepare your servers for the software by verifying they meet the necessary requirements.

Preparing servers

Callback system requirements

Before upgrading On-Premise Callback components, it is important to ensure that all hardware and software requirements have been met. Review the Callback System Requirements documents to help install and maintain a proper environment. This document contains information on server requirements, hardware requirements, software requirements, third party information, and other additional system considerations.

.NET compatibility

Before upgrading, check for the presence of any .NET version less than 4.7.0. If found, uninstall it and install a supported version:

  • 4.7.0
  • 4.7.1
  • 4.7.2

Removing Ruby

To remove the previous version of Ruby from the server being upgraded:

  • Stop Callback services.
  • Use Task Manager to stop any Ruby services that may be running.
  • Navigate to Programs > Features to uninstall Ruby1.9.3.
  • In C drive: delete C:\Ruby193 folder, delete C:\DevKit folder

Backing up databases

Back up the VHT_Config and VHT_RPT databases before upgrading.

Warning: Changes were made in On-Premise Callback Version 8.6 that are incompatible with earlier versions of Callback and cannot be rolled back.

If Version 8.6 is uninstalled and an earlier version reinstalled, you must restore the databases from the backups.

Configurations to note

Services

Make a note of which account is currently running these services:

  • Core Monitor
  • Authorization
  • Management API
  • Configuration Management

Set these services to this account after the upgrade.

Erlang ports

Before upgrading, make a note of any ports which have been allocated to the Erlang processes within On-Premise Callback software in order to recreate them after upgrading.

Normally, Erlang ports are dynamically assigned. However, a range of ports may have been specified if a server is behind a firewall, or for other security reasons.

Within the registry of each Core and Management server:

  • Check these paths: (The first is for 64-bit Erlang and the second is 32-bit. Either or both may be in use.)
  • HKLM\SOFTWARE\Wow6432Node\Ericsson\Erlang\ErlSrv\1.1\See_Below_Service_Names
  • HKLM\SOFTWARE\Ericsson\Erlang\ErlSrv\1.1\Our_Service_Name
  • Look for these services:
  • VHT Configuration Management
  • VHT Core Monitor
  • VHT Datastore
  • VHT Management API
  • VHT Notification Server
  • VHT Peripheral Monitor
  • Inside each service, locate and edit this key: Args
  • Note any range of posts which has manually been configured for this service. For example, if you see:

-kernel inet_dist_listen_min 55000 -kernel inet_dist_listen_max 55999

  • The reserved ports for this service are 55000 through 55999.

Files preserved during upgrade

site.config file

The following site.config files are preserved during an upgrade in each of the following folders:

  • Core Monitor
  • Peripheral Monitor
  • Datastore

No backup files are created; the files are only preserved.

Note: The Peripheral monitor site.config file may contain minor formatting differences when upgrading to 8.12 (ie spacing). The file is still accurately read and interpreted.

The following site.config files are renamed to backup_site.config during an upgrade. The old files are then overwritten by the new 8.12.x site.config files. Users must manually restore any custom settings from the backup file to the new file. The backup_site.config file is saved in the same location as the new site.config file (by default either C:\Program Files (x86)\Virtual Hold Technology\Management API or C:\Program Files (x86)\Virtual Hold Technology\Notification Server).

  • Management API
  • Notification Server

During the upgrade process, verify the site.config file is not open in the background.

Configuration files

The following On-Premise Callback configuration files are preserved and saved during an upgrade:

  • Web Configuration - VirtualHoldPubs directory and web.config files
  • VHT_OperationModeServer_Console.exe.config - inside the Virtual Hold Technology directory
  • Site.config (refer to Site.config files for more information)
  • Registry - HKLM > SOFTWARE > Virtual Hold
  • Scripts - If GlobalCall from the Virtual Hold Technology/IVR directory, if VXML 5.0 or later the location defined in the Virtual Hold/toolkit.properties file
  • VHT_Message_Bus_Console.exe.config files from Virtual Hold Technology/PlatformToolKit directory
  • vht_auth_api-config.yml - Virtual Hold Technology/Dashboard
  • vht_stats_api-config.yml - Virtual Hold Technology/Dashboard
  • Datastore Files - folder from the Virtual Hold Technology directory

No backup files are created. The files are only preserved.

Restarting servers

Restart all servers in the Callback system to complete all pre-upgrade activities.