Upgrade a Production Installation

On this page

A production upgrade brings your Alloy Navigator database to the latest version in place and goes live at once. The Database Management wizard calls this scenario Production Upgrade: "Upgrade your database to the latest version and go live immediately."

The in-place upgrade accepts an Alloy Navigator database of version 8.0.0 or later. A database of version 7 or earlier reaches the latest version only through the pilot upgrade and migration steps.

The production upgrade runs in this order:

  1. Force the users to log off, and stop the Automation Server and the Inventory Server.
  2. Upgrade the server components.
  3. Upgrade the database.
  4. Upgrade the Web App, the Self Service Portal, and the API, in any order.
  5. Start the servers again.

Alloy Navigator does not enforce this order. Each component checks the database version when it connects and refuses a database whose version is not its own, and none of them checks another component. The Database Management wizard does not force anyone to log off before a production upgrade.

A production upgrade does not pause the notification queue, so it leaves no test notifications to delete and no queue to resume.

When the upgrade includes the Self Service Portal, the portal no longer needs a separately installed Node.js; see Remove the standalone Node.js.

Before you begin

  • The database is at version 8.0.0 or later.
  • Your SQL Server login is a member of the sysadmin fixed server role on the SQL Server instance that hosts the database. Otherwise the wizard stops at the Backup Location page with "You must be a member of the sysadmin role on the specified SQL Server instance. Please contact your system administrator."
  • The database does not take part in SQL Server replication. The wizard refuses to upgrade a replicated database in place; remove it from its replication topology first.

Prepare the production system

Force the users to log off, then stop the Automation Server and the Inventory Server of the previous version. Both servers run as Windows services: the Windows Services console lists the Automation Server as Alloy Automation Server. An Automation Server left running keeps trying to reconnect once the database version has changed.

In the Settings App

Force the users to log off with the User Sessions manager: terminate their sessions. Each client sees the termination, shows "Your Alloy Navigator session has been terminated by the administrator." and closes.

In the Automation Server Manager

Open the Automation Server Manager from the Alloy Control Panel, or by double-clicking the Automation Server icon on the Settings App's status bar, and click Stop.

In the Inventory Server Manager

On every Inventory Server computer, open the Inventory Server Manager from the Alloy Control Panel and click Stop. Stop acts on the Inventory Server service of the computer the manager runs on and saves nothing; a progress window waits up to 125 seconds for the service to stop. If your account cannot manage the service, the manager warns "You do not have enough permissions to manage the Alloy Inventory Server."

Upgrade the server components

In the Installer

Upgrade the server components with the Alloy Navigator setup program. When an earlier version of the same product line is installed, the setup program upgrades it.

Upgrade the database

In the Database Management wizard

  1. Start the Database Management wizard. The Alloy Control Panel lists it among the tools installed on the computer.
  2. On the Task page, choose Upgrade your existing database, the button above the Manage Existing Database label. It is selected by default.
  3. On the Source Database page, specify the database to upgrade.
  4. On the Upgrade Scenario page, keep Production Upgrade selected.
  5. On the Backup Location page, keep Enable backup selected to have the wizard back up the database before it upgrades it. Clear it to skip the backup.
  6. Go through the pages the wizard shows for your database:
    • Backward-Incompatible Changes lists the changes since your version that are not backward compatible. The page is not shown for a database of version 2022 or later.
    • Database Account and Database Access Key are shown when the database is earlier than version 8.2.0.
    • Automatic Upgrade lets you store the client setup program in the database; see Upgrade Clients Automatically. The page is skipped when its default path already holds a valid setup program.
  7. On the Ready to Proceed page, start the upgrade. The wizard then shows the Progress Status page and, after the run, the Summary page.
  8. On the Summary page, click Finish.

When the upgraded database is not activated, Finish starts the Settings App on that database, logging in automatically when the saved startup login uses Windows authentication or names a user. For an activated database, it starts nothing.

On Azure SQL, the wizard takes no backup, and the Upgrade Scenario page does not offer Pilot Upgrade.

Unless the wizard is started with one of its command-line switches that force a repair re-run, a database that is already at the wizard's version is refused with "Your database is already compatible with this version of Alloy Navigator, no update is required."

Upgrade the web applications

In the Installer

Run the setup program of each web application you use, the Web App, the Self Service Portal, and the API, in any order. When a web package upgrades an earlier version:

  • It shows the Files Backup page, which states that the upgrade replaces all files. The backup check box is selected, and the backup folder defaults to a dated subfolder of Backups\ under the installation directory. Customized instance files survive only in that backup.
  • Before it removes the earlier version, it saves the configuration of the instances published from that package to a file in a dated backup folder. After the installation, it recreates the instances from that saved configuration.
  • It does not offer to run the Web Configuration tool to create a new instance. The existing instances keep their settings.

IMPORTANT: Across an upgrade, hand-made edits to an instance's Web.config, such as added <customHeaders>, are replaced with the new files. Only the part between the two comments BEGIN_CUSTOM_EF677073_10AC_44FE_AF1F_2AED27E06048 and END_CUSTOM_EF677073_10AC_44FE_AF1F_2AED27E06048, placed directly under the root element, survives; it is added back at the end of the root element of the new file. The file backup on the Files Backup page is the only other copy.

In the Web Configuration tool

The Web Configuration tool lists the recreated instances. Select an instance in the tree to see its information page. The instance's context menu holds Restart, Delete, and Configure, whose commands include Full, Database, and Web. The Error Logs category of the information page shows "No errors were logged." or "There are some errors logged.", with Clear and View Details, which are disabled when nothing is logged.

Start the servers

Bring each server up with the same three commands of its manager: Import Key..., Test Connection, and Start. The Automation Server connects to the upgraded Alloy Navigator database. The Inventory Server connects to the Alloy Discovery database, so its key must reach that database.

In the Automation Server Manager

On each Automation Server computer:

  1. Click Import Key... and import the Database Access Key. The Database: list offers the databases of that server at the current version.
  2. Click Test Connection. For a key that uses SQL Server authentication, the manager reports "Test connection succeeded." or "Test connection failed." with the error. For a key that uses Windows authentication, the service must be stopped; otherwise the manager warns "You'll need to stop the Automation Server before you can test the connection." With the service stopped, the manager saves the server and database, starts the service so that it tests the connection under its startup account, stops it again, and reports the result.
  3. Click Start. The manager reports success, or lists the problems under "The Automation Server has started with the following error:".

When no key is stored at start-up, or a legacy connection does not open, the manager shows "Unable to find a valid Database Access Key. Please import your Database Access Key before configuring the Automation Server." and opens the key import. Without an imported key, Start stops with "No information about database connection provided. You need to obtain and import the database access key." The Automation Server connects only to a database whose version matches its own.

At start, the service writes its outcome, a failed connection or a successful start, to the Windows event log. It retries a failed connection five times at 60-second intervals, five times at 10-minute intervals, and then hourly. Its schedules resume from their stored run history rather than restart: a job, trigger, or recurrent ticket whose next run fell due while the service was stopped runs once as soon as the service is active.

In the Inventory Server Manager

On every Inventory Server computer:

  1. Click Import Key... and import the Database Access Key. The Database: list offers only the Alloy Discovery databases on the server whose version is the manager's own.
  2. Click Test Connection. It saves the connection before it tests it, so a failed test still changes the saved connection. For a key that uses SQL Server authentication, the manager reports "Test connection succeeded.", "Test connection failed.", or "Database 'server.database' is corrupted, or there is no access to it." For a key that uses Windows authentication, the service must be stopped; otherwise the manager warns "You'll need to stop the Inventory Server before you can test the connection." The manager then starts the service in test mode and reports "Windows Account test succeeded.", or "Inventory Server is not started." with an offer to open the Windows event log.
  3. Click Start. Start first saves the connection settings shown in the form and stops if that fails.

When the manager finds neither a key nor a legacy connection at start-up, or only a legacy connection that does not open, it shows "Unable to find a valid Database Access Key. Please import your Database Access Key before configuring the Inventory Server." and opens the key import. Without an imported key, Test Connection is disabled, and Start stops with "No information about database connection provided. You need to obtain and import the database access key."

In the Settings App

The Settings App shows whether the Automation Server runs, from its registration in the database:

  • The Automation Server manager's Job List page shows Host:, Status:, and Version:. Status: reads "Running", "Offline", or "<not registered>"; Host: and Version: read "N/A" when no instance is registered.
  • The status bar icon's hint reads "The Automation Server is running on host." or "The Automation Server is not running." Double-click the icon to start the Automation Server Manager.
  • At start-up, when no running Automation Server is found and the license is valid, the Settings App shows "Some Alloy Navigator features will be unavailable because an Automation Server instance was not found." A stopped service, a service that cannot reach the database, and an instance that was never registered all raise this warning.

Remove the standalone Node.js

In the Installer

Node.js is not among the installer's prerequisites: the Self Service Portal package carries its own Node.js runtime. The installer's summary page shows "Upgrade completed successfully." when every upgraded product succeeded. When, in addition, the Self Service Portal is among the products the run installed and a separately installed Node.js is on the computer, the summary page also shows "Node.js is no longer required by the Self Service Portal. You may remove it manually if it is not needed by other tools on this server. The installer will not remove it automatically." A first-time installation and an upgrade in which a product failed do not show this line.

If no other tool on the server needs that Node.js, remove it manually.

Convert archive databases

In the Settings App

Archive databases are not upgraded by the Database Management wizard. The Settings App converts an archive database of a version earlier than 8.0.0 when you select it in the archived databases manager: it asks "To view this archive database, you must update it to the latest format. The update process may take considerable time." and converts it only when you click Yes.

Version checks after the upgrade

Each of these components checks the database version when it connects:

Component When the versions differ
Settings App, Automation Server Manager An error message names both versions, and the connection is not opened.
Import Wizard An error message; a command-line run stops without one.
Automation Server service It logs a fatal entry, closes the connection, and retries on its connect interval.
Command-line tools They stop with an error before doing any work.
Web App, Self Service Portal, API The session connection fails with an error.

In the Settings App, the Automation Server Manager, the Import Wizard, and the web applications, the beginning of the version check's message tells you the cause:

  • "Your database needs to be updated to be compatible with this version of Alloy Navigator." The database is older than the component.
  • "Your Alloy Navigator installation needs to be updated for compatibility with this database." The component is older than the database.
  • "The database you are connecting to is under upgrade." The database is marked as being upgraded, and no upgrade error was recorded.
  • "The database 'name' has been corrupted due to an upgrade failure." The database is marked as being upgraded, and the wizard recorded an upgrade error.