Upgrade from an Existing Installation on a Different Computer

This topic applies only to VoiceConsole On Prem deployment customers.

If you plan on upgrading your database, you must upgrade it before performing a remote upgrade to VoiceConsole.

Before beginning the installation, stop the VoiceConsole service on the computer from which you are installing. Failure to do so may result in corrupt data in your new installation.

Locations specified throughout this procedure must be shared by the computers containing the existing installation and the location of the new installation.

For an HTTPS installation:

  • If you are performing a remote upgrade where HTTPS is enabled in the original installation, you must disable HTTPS, perform the remote upgrade, then enable HTTPS. See Create and Install a Certificate for HTTPS.

If the existing location is using an embedded database on a version of VoiceConsole earlier than 6.2, use the VoiceConsole Database Migrator to transfer the data to one of the supported Express databases prior to completing the instructions below.

  1. Shut down the existing installation of VoiceConsole.
  2. Run the installer.
    The Introduction window appears.
  3. Click Next.
    The License Agreement window appears.
  4. Accept the terms of the license agreement, and click Next.
    The Select Installation Path window appears.
  5. Click Next to install to the default path or, if necessary, browse to the desired installation path and click Next.
    The Software to Install window appears.
  6. Click Next.
    The Copying Software window displays the installer progress during the copy of the individual selected software and the entire copying process.
  7. When the copying process is finished, click Next.
    The Remote Upgrade window appears.
  8. Select Yes.
  9. Enter the directory information, and click Next.
    The remote storage directory must contain the Device Logs and Files folders. If the default folders were used in the existing installation (4.2 and later), the remote installation directory and the remote storage directory are the same.
    The Configuration and Installation window displays tabs to configure your installation.
  10. Click the Tomcat Server Configuration tab.

  11. Enter the appropriate information for your Tomcat server configuration.

    1. Tomcat Login Information
      Choose an account, and enter the account username and password, if necessary.
      In Windows, if you select Use Existing Account, ensure that the account entered has the necessary permission described below:

      If you want to use NT authentication for SQL Server databases for a Windows installation, you must use an existing account.

      When using an existing account, set the permissions for starting the Tomcat service. Access \Domain\Users\ to enable the logon for the particular user group and to set permissions.

      • Read permission to the directory from which the installation program is being run

      • Log On As a Service rights and permissions (refer to Tomcat documentation for setup information).

      • Write permissions to all paths provided during installation for the install folder, log files directory, application files location

      • Write permissions to the shared drive for a clustered install (if applicable)

    2. Tomcat Path Configuration
      Confirm the default path to the location where the log files are to be stored, or - if necessary - browse to the desired path. Log files track user activities in the VoiceConsole On Prem deployment application.
    3. Tomcat Port Configuration
      Confirm the default ports that the application server uses, or - if necessary - enter different ports.
  12. Click the Database Configuration tab.

  13. Enter the appropriate information for your database.

    For Express database installs, the Advanced fields below are not used.

    1. SQL Server
      For more information on using a SQL Server Express database with VoiceConsole, see Microsoft SQL Server 2019 or 2022 Express.
      For installations using SQL Server, you must enter the information listed in the following table:

      SQL Server does not enable TCP/IP by default. You must manually enable TCP/IP before the installation can complete successfully.

      • For Basic
        FieldDescriptionValid Entry Format
        Database HostnameDNS name or IP address of the machine hosting the database. 
        Database PortThe port that the database uses.Must be an integer between 1 and 65535.
        Default is 1433.
        Database NameThe name of the database. 
      • For Advanced
        FieldDescriptionValid Entry Format
        JDBC URLThe JDBC URL for the database.

        jdbc:sqlserver://<host>:<port>; DatabaseName=<database name>

      • For Both Basic and Advanced
        FieldDescriptionValid Entry Format
        Authentication Type (Windows installs only where existing user specified for Tomcat Server configuration)The authentication type used to connect to the database.If installing on Windows and an existing user was specified for the Tomcat Service configuration, you can select to use NT Authentication. Otherwise, select SQL Server Authentication.
        Database UsernameThe username that the application should use to log into the database. This is disabled if using NT Authentication. 
        Database PasswordThe password of the user that the application should use to log into the database. This is disabled if using NT Authentication. 
        Database SchemaThe database schema that you are using. 
    2. Oracle
      For more information on using an Oracle Express database with VoiceConsole, see Oracle Database 21c Express Edition.
      For installations using Oracle, you must enter the following information:
      • For Basic
        FieldDescriptionValid Entry Format
        Database HostnameDNS name or IP address of the machine hosting the database. 
        Database PortThe port that the database uses.Must be an integer between 1 and 65535.
        Default is 1521.
        SID or Service NameThe SID or Service Name of the Oracle database. 
      • For Advanced
        FieldDescriptionValid Entry Format
        JDBC URLThe JDBC URL for the database.jdbc:oracle:thin:@<host>:<port>:<database name>
      • For Both Basic and Advanced
        FieldDescriptionValid Entry Format
        Database UsernameThe username of a user with administrative privileges. 
        Database PasswordThe password of a user with administrative privileges. 
  14. Click the VoiceConsole Configuration tab.

  15. Enter the appropriate information for your VoiceConsole On Prem deployment configuration.

    • VoiceConsole Hostname
      Specify the hostname of the machine onto which you are installing VoiceConsole On Prem deployment.

    • Display Dialog Port
      Confirm the default port that the application server uses for the Display Dialog feature.

    • Enable HTTPS Support
      Select to enable secure HTTPS on all pages of VoiceConsole On Prem deployment. Certain pages are still secure if this check box is not selected.

    • Storage Directory
      Specify where you would like to have application files stored.
      The storage directory must have enough room to store device logs, which could grow very large in a short amount of time. Additionally, VoiceConsole On Prem deployment performance may be negatively affected if the storage directory is on a shared network drive with low throughput. If not required for clustering, Honeywell recommends having this location on a local drive.

    • Enable SAML SSO
      Check to enable Federation SAML (Security Assertion Markup Language) Single Sign On. Additional configuration is necessary to use this feature after the installation is completed.

      SAML SSO cannot be enabled during an upgrade installation. It can only be enabled during a new installation.

  16. Click the License Server Configuration tab.

  17. Enter the appropriate information for the VoiceConsole On Prem deployment to enable the local licensing server:

    1. Port
      The port to be used by the license server. The default is 1443.

    2. Password
      The password to be used for the local license server.

  18. Click Install Now.
    The installation begins. When the first part of the VoiceConsole On Prem deployment installation is successfully completed, click OK.
    If installing on Windows, the Setup Shortcuts window appears. If installing on Linux, go to step 21.
  19. If desired, select the program group in the Start menu to place the shortcut within or edit the path of the shortcut. If you do not want a VoiceConsole shortcut on the Start menu, clear the Create shortcut in the Start menu checkbox. A shortcut to VoiceConsole is placed on the desktop automatically after the upgrade process completes.
  20. Click Next.
    The upgrade continues. When the upgrade is complete, the Installation Finished window appears.
  21. If desired, click Generate an automatic installation script to generate an .xml file with your installation choice data to use for silent or automatic installations.
  22. Click Done.
    The VoiceConsole Installer closes, and the VoiceConsole On Prem deployment application opens.

Migrate the Devices to the New Computer

After installing VoiceConsole On Prem deployment, you need to configure the devices to point to the new server. Follow these steps:

  1. Change the hostname of the original instance of VoiceConsole to the hostname specified in Step 9 in Upgrade from an Existing Installation on a Different Computer. If the original instance is a 3.0 or newer VoiceConsole installation, change the hostname in Device Management > Device Profiles > Edit hostname for all profiles.
  2. In the original instance of VoiceConsole, reload device profiles to selected devices that are to use VoiceConsole On Prem deployment 6.2.1. See the VoiceConsole Online Help for that version of VoiceConsole for more information.

These devices can now be used with the new installation.