Web/Application Server - 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
Building Automation Systems > Application Servers > 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 Split Metasys Server for Web/Application Server

Supported Operating System

Supported Database Options

Windows® Server® 2022 (64-bit)

Windows® Server® 2019 (version 1809 or later) (64-bit)

SQL Server® 2022 (64-bit)

SQL Server® 2019 with CU18 (64-bit)

SQL Server® 2017 with CU31 (64-bit)

Follow these steps to upgrade the web/application component of the ADX on a split Metasys system.

Table 2. Upgrading Web/Application Server on Split Metasys Server (Out-of-Place)

Step

Action

Reference or Additional Steps

1.
Verify that the computer intended for Metasys Server software is running one of the following supported Windows Server operating systems:
  • Windows® Server® 2022 (64-bit)
  • Windows® Server® 2019 (version 1809 or later) (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.

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.

5.

Make sure all required software components are enabled.

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

6.

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.

7.
If you plan to install Metasys Advanced Reporting System, install a supported version of SQL Server Reporting Services on the web application computer. If you are using SQL Server 2016, select the Reporting Services and Management Tools components, but not the Database Engine Services component. If you are using SQL Server 2017, use the standalone Reporting Services installer on the web application computer. Note: Metasys Advanced Reporting System does not support installation with SQL Server 2019.
Note: Metasys Advanced Reporting System does not support installation with SQL Server 2019.

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

8.

If you plan to install Metasys Advanced Reporting System, verify that Reporting Services on the computer is configured properly.

Refer to the Verifying SQL Server Reporting Services Configuration section of SQL Server Installation and Upgrade Instructions (LIT-12012240).

9.

If you plan to use the Metasys Advanced Reporting system on an ADX that will include any non-English languages, install the corresponding language support files for SQL Server's reporting services.

Refer to the Appendix: Reporting Services Language Support for Metasys Advanced Reporting System of SQL Server Installation and Upgrade Instructions (LIT-12012240).

10.
If you uninstalled ADS/ADX software in a previous step because the site was at Release 7.x or earlier, install the Metasys Server 13.0 software. Otherwise, upgrade the Metasys Server 13.0 software.
Note: When you install or upgrade, specify the SCT archive database in the SCT Archive Db field on the Reporting tab screen of the Metasys Server 13.0 installer. Make sure you install the new Metasys Server 13.0 software on the Site Director first. If you have other ADSs/ADXs, upgrade them after the Site Director.

See Upgrading Metasys Server or Metasys Server Software.

11.

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

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

12.

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) .

13.

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) .

14.
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.

15.
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.

16.

If the site has other ADS/ADX servers, upgrade and download each ADS/ADX archive database from SCT 16.0 to the other ADS/ADX servers. The download also restores user accounts.

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

17.
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) .

18.

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 engines (NxE55s, NxE59s, SNEs, and SNCs).

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

19.

(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.

20.

(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.

21.

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.