Upgrading Unified Metasys Server on Desktop OS - Metasys - LIT-12012162 - MS-ADS05U-0 MS-ADX10U-0 MS-ADX10SQL-0 MS-ADX25U-0 MS-ADX25SQL-0 MS-ADX50U-0 MS-ADX50SQL-0 MS-ADX50SQL2-0 MS-ADX100U-0 MS-ADX100SQL2-0 - Server - Metasys Server - 13.0

Metasys Server Installation and Upgrade Instructions
Product name
Metasys Server
Document type
Installation Guide
Document number
LIT-12012162
Version
13.0
Revision date
2024-03-26
Product status
Active
Table 1. Supported Platforms Unified Metasys Server on Desktop OS

Supported Operating System

Supported Database Options

Windows® 11 Pro and Windows® 11 Enterprise versions 22H2, 21H2 (64-bit) General Availability Channel (GAC)

Windows® 10 Pro and Windows 10 Enterprise Editions versions 21H2, 22H2 (64-bit).

SQL Server® 2022 Express (64-bit)

SQL Server® 2019 with CU18 (64-bit)

SQL Server® 2017 with CU31 (64-bit)

Use the steps in the following table to perform an out-of-place upgrade of Metasys Server software on a computer with a desktop operating system. These steps presume that the computer currently has no Metasys software installed.

Table 2. Upgrading Unified Metasys Server on Desktop OS (Out-of-Place)

Step

Action

Reference or Additional Steps

1.
Verify that the computer intended for Metasys Server software has the following supported Windows desktop operating system:
  • Windows® 11 Pro and Windows® 11 Enterprise versions 22H2, 21H2 (64-bit) General Availability Channel (GAC)
  • Windows® 10 Pro and Windows 10 Enterprise Editions versions 21H2, 22H2 (64-bit).
Also run Windows Update to verify the operating system is up to date.

Open a command prompt window and run the command Winver as Administrator. The Windows version is listed in the dialog box that appears. Start Windows Update from the Search box and apply all required and recommended updates before installing any Metasys software.

2.

Verify that the computer name is valid for Metasys Server software.

In Control Panel, click System and Security > System and verify the computer name that appears in the window meets the following criteria:
  • begins with a letter, not a number
  • contains a maximum of 15 characters
  • contains only letters A-Z (upper or lower case), numbers 0-9, and hyphens
    Note: Underscores are not valid for the Metasys system.
  • does not end in letters ADS
  • does not contain any diacritic or accent marks

3.

Configure the Windows Firewall to ensure the ports that Metasys software requires are open.

See Configuring the Windows Defender firewall.

4.

If you are installing the Metasys Server software on an English language computer, skip to the next step. If you are installing the Metasys Server software on a non-English language computer, you need to set the computer's regional settings and the default language used by the SQL Server database to the same locale as the site default language.

Consult the Microsoft documentation and see Installing Metasys server for a non-English locale.

5.

Install Microsoft .NET Framework 3.5 if the computer does not have this software installed.

In Control Panel, click Programs > Programs and Features > Turn Windows features on and off. The Server Manager window appears. Use the Add Roles and Features Wizard in Server Manager to add the .NET Framework 3.5 Features and HTTP Activation components. On some server-class OSs, HTTP Activation may be listed under WCF Services.

6.

Make sure all required software components are enabled.

See Required Windows operating system roles and features for more information.

7.

Install a version of SQL Server Express software on the computer that the Metasys system supports.

Refer to SQL Server Installation and Upgrade Instructions (LIT-12012240).

8.

Upload and back up all Metasys Server and network engine archive databases to the existing SCT. Make sure you select the Include Security option for the upload.

Refer to Database Uploading, Downloading, and Synchronization of SCT: System Configuration Tool Help (LIT-12011964) or the SCT Technical Bulletin (LIT-1201534) for the release you have currently installed (not the new release).

9.
Determine if you need to record existing user accounts and roles:
  • If the current Metasys system is at Release 5.2 and earlier, follow the steps on the right.
  • If the current Metasys system is at Release 6.0 or later, skip to the next step.

Log in to SCT and open the Security Administrator tool (Tools > Administrator). In Security Administrator, record all roles, local user accounts, and Active Directory user accounts that you want to recreate in the upgraded SCT. All customized roles and user accounts are lost when you uninstall SCT 5.2 (or earlier) and install a newer version of SCT. For easy recall later, you may find it helpful to use the computer's print screen function to capture the user access permissions and other information for each role. Refer to the Metasys Site Management Portal Help (LIT-1201793) for Release 5.2 or earlier.

10.

Forward all trend samples from each network engine to the ADS/ADX Site Director by using the Route Samples command at each engine. This step ensures that the Site Director has all possible samples before you begin the upgrade. Wait a few minutes to ensure that all samples have been forwarded.

Refer to Metasys Site Management Portal Help (LIT-1201793) for information about the Route Samples command.

11.

Stop the Metasys III Device Manager service on the ADS/ADX computer. This action prevents the collection of any new audits, alarms, trends, and annotations while you perform the upgrade. If you can accept the loss of data samples during an upgrade, you can skip to the next step.

Right-click the Windows task bar and start Task Manager. Click the Services tab. Locate a service called Metasys III Device Manager. Select this service and right-click and select Stop Service. The Metasys III Device Manager service stops.

12.

Perform a complete backup of all historical data in the ADS/ADX computer with the Metasys Database Manager. If the system to be upgraded is at Release 8.0 or 8.1, after the historical databases are backed up, use the SQL Server Management Studio to backup the SpacesAuthorization database. After the installation is complete, restore the SpacesAuthorization database.

Refer to Backing Up a Database in Metasys Database Manager Help (LIT-12011202) .

13.

Make a copy of each historical database backup file and archive backup file and store them on removable media (for example, a flash drive or DVD).

Use Windows Explorer to prepare and archive the file copies.

14.

As part of performing an out-of-place upgrade, follow the steps to the right.
If you do not complete all these steps in the following order, the upgrade will not be successful. You will need to uninstall and reinstall the server software.
  1. Disconnect the old ADS/ADX computer from the building network.
  2. Connect the new computer to the building network.
  3. On the new computer, assign the same computer name and IP address as the old ADS/ADX computer.
  4. Install and license SCT 16.0 on the new computer.
  5. Install Metasys Database Manager Release 13.0 on the new computer.
  6. Copy the Metasys database backup files (.bak) from the old computer to the Metasys Database Manager Backup folder of the new computer.
  7. Copy the SCT archive backup file (.backup) from the old computer to the new computer. Place the archive here: C:\ProgramData\Johnson Controls\MetasysIII\DatabaseFiles.
  8. Start SCT on the new computer. With SCT, restore the backup you copied in the previous step.
  9. If the new computer name is different from the old computer, open the restored SCT archive, upgrade the archive, then rename the Site Director in the upgraded archive to match the new computer name.
  10. Start the Metasys Database Manager in Expert mode and restore each database backup from the SQLData backup folder.
  11. If the new computer name is different from the old computer, use the Metasys Database Manager to update the Site Director and device names in the Metasys system databases.

15.

Install the Metasys Server 13.0 software.

See Metasys Server Software.

16.

License the Metasys Server software and SMP software with the Software Manager.

Refer to the Software Manager Help (LIT-12012389).

17.

(Optional) Start Launcher on the computer and launch the Site Management Portal (SMP) for the upgraded ADS/ADX.

Refer to Launcher Help (LIT-12011742) .

18.

To verify ADS/ADX operation, log in to the ADS/ADX using the MetasysSysAgent user and password.

See Launching the User Interfaces.

19.

Log in to SCT 16.0 and open the archive database. Allow SCT to upgrade the database to Release 16.0.

Refer to SCT: System Configuration Tool Help (LIT-12011964) .

20.

Log on to SCT 16.0 with a commissioning laptop, then use the Manage Archive wizard to upgrade the ADS/ADX device to Release 13.0. When asked to enter the ADS/ADX user credentials, specify the MetasysSysAgent user and password. If during the upgrade process an Upgrade Warning dialog box appears regarding password resets, set a default password for the affected users, then contact the users of their new default password. Each affected user is prompted to change this default password when logging on the Metasys ADS/ADX 13.0 for the first time.

Refer to SCT: System Configuration Tool Help (LIT-12011964) .

21.
If you upgraded the device in your SCT archive from a Metasys version up to Release 12.0, to Release 13.0, confirm the following:
  • All Third party BBMDs are compatible with the upgraded Metasys server (no checks needed if no Third party BBMDs are configured for the site).
  • All Email DDA destinations are compatible with the upgraded Metasys server (no checks needed if no Email DDA destinations are configured for the Metasys server).

To check the configuration of the Third party BBMDs, see Checking third party BBMDs compatibility for ADS/ADX upgrades.

To check the configuration of the Email DDA destinations, see Checking email DDA compatibility for ADS/ADX upgrades.
Note: The archive download to a Release 13.0 ADS/ADX fails if these attributes have an incompatible configuration. For more information, see General Troubleshooting.
22.
Download the Site Director archive database from SCT 16.0 to the ADS/ADX Site Director, making sure that you click Include Security. When asked to enter the ADS/ADX user credentials, specify the MetasysSysAgent user and password. If the login for the ADS/ADX fails, click the Clear Security Database tab and click Set to be cleared. The device is upgraded, but the security database is removed from the archive.
Note: Before you attempt a download/upload to the server from SCT, wait for it to become operational. If you perform a download/upload before then, the server does not operate correctly. To fix this, restart the Metasys server host, wait for it to become operational, and try the process again.

Refer to Database Uploading, Downloading, and Synchronization in SCT: System Configuration Tool Help (LIT-12011964) for information on downloading.

23.

(Optional) If you want to move the Metasys historical databases now, use SQL Management Studio to move the databases to your chosen location.

See Moving Metasys Historical Databases to a Custom Location.

24.
Update the network engines that you want to upgrade to Release 13.0. You can only upgrade SNx engines to Release 13.0.
Note: If you are upgrading from Release 5.2 or later, you do not need to update all devices to the newer release (except the Site Director). SCT 16.0 supports devices at multiple Metasys software releases, beginning with Release 5.2.

Refer to NAE Update Tool Help (LIT-12011524) and SCT: System Configuration Tool Help (LIT-12011964) .

25.

If you updated network engines to Release 13.0, use SCT 16.0 to download the archive database of each network engine. The download also restores the Security database. After the download completes, issue the Reset Device command to each downloaded N40-class device (NxE35, NIE39, NxE45, NIE49, NxE25, or NIE29s) to ensure that the security database is archived to non-volatile memory. This step is new beginning at Release 8.0, but is not required for any other network engine (for example, NxE55s, NxE59s, SNEs, and SNCs).

Refer to Database Uploading, Downloading, and Synchronization in SCT: System Configuration Tool Help (LIT-12011964) for information on downloading.

26.

(OPTIONAL) If you need the server to be FIPS compliant, enable FIPS mode and install the Metasys FIPS component.

See Enabling and installing FIPS component.

27.

Create a full disk image backup of the computer's hard drive to external media (optional but recommended).

Refer to the documentation that came with your operating system backup software.