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 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 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 Express (64-bit)

SQL Server® 2019 with CU18 (64-bit)

SQL Server® 2017 with CU31 (64-bit)

Note: Reporting Services is only supported on SQL 2017. If you are not installing Reporting Services, you do not require SQL Server on the Web/Application computer.

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 (In-Place)

Step

Action

Reference or Additional Steps

1.

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

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

2.

Backup the Fault Manager Global Attributes.

Refer to the Potential Problem Areas widget section in the Metasys UI Help (LIT-12011953).

3.

Check if the computer has a SHA256 self-signed certificate bound to Default Web Site in IIS. If the ADS/ADX computer has a purchased certificate from a certificate authority (CA), determine if this is a SHA256 (Secure Hash Algorithm) certificate. If so, follow the steps on the right. If not, skip to the next step. Also, for more details, refer to the Network and IT Guidance Technical Bulletin (LIT-12011279) .

  1. In Control Panel, click System and Security > Administrative Tools.
  2. Start IIS Manager. Expand the server, then expand Sites.
  3. Click Default Web Site. Click Bindings in the right pane. The Site Bindings window appears.
  4. Look for a Site Binding called Type: https, Port: 443. If this site binding is not present, skip these substeps.
  5. If this site binding is present, select it and click Edit.
  6. In the Edit Site Binding window, click View.
  7. Read the values in the Issued to: and Issued by: fields. If these values are the same, the computer has a self-signed certificate. If these values are different, the computer has a purchased certificate from a CA.
  8. On the Certificate window, click Details.
  9. Read the value for the signature hash algorithm. If the value is not at least sha256, you need to update your certificate. The upgrade will not overwrite bound site certificates with at least a 256-bit RSA.
    1. If you have a self-signed certificate, or have a purchased one from a CA that does not need to be updated, make no changes.
    2. If you need to update a purchased certificate, make no changes, and contact your public CA for how to update your signed certificate to at least SHA256. If you continue with server installation now, a self-signed certificate is installed, which you can replace with a purchased certificate after the upgrade.
  10. Close IIS Manager.

4.

Uninstall the Ready Access Portal software if currently installed.

Refer to the Uninstalling Ready Access Portal Software section in the Ready Access Portal Software Installation Instructions (LIT-12011523) .

5.

Uninstall the Metasys Export Utility software if currently installed.

Note: Energy Essentials is not supported from Metasys Release 12.0.

In Control Panel, click Programs > Programs and Features. Select the program from the list and click Uninstall.

6.

Uninstall Energy Essentials if present. This uninstall step is required before you uninstall the ADS/ADX software in a later step.

In Control Panel, click Programs > Programs and Features. Select the program from the list and click Uninstall.

7.

Select the appropriate action:
  • If Metasys UI Online Release 1.5.1 or earlier software is installed, uninstall Metasys UI Online.
  • If Metasys UI Online Release 2.0 or higher is installed, skip to the next step.

In Control Panel, click Programs > Programs and Features. Select the program from the list and click Uninstall.

8.

Select the appropriate action:
  • If the site is at Release 7.0 or earlier, uninstall the current version of Metasys Launcher from the ADS/ADX computer and remove from all clients that log in to the ADS/ADX.
  • If the site is at Release 8.0 or later, skip to the next step.

In Control Panel, click Programs > Programs and Features. Select Johnson Controls - Launcher from the list of programs and click Uninstall.

9.

Select the appropriate action:
  • If the site is at Release 7.0 or earlier, uninstall the NAE Update Tool if present. This uninstall step is required before you can install or upgrade to the new version of SCT.
  • If the site is at Release 8.0 or later, skip to the next step.

In Control Panel, click Programs > Programs and Features. Select the program from the list and click Uninstall.

10.

Uninstall the existing MVE software if present.

See Uninstalling MVE Software.

11.

Select the appropriate action:
  • If you uninstalled MVE in the previous step, uninstall the ADX software.

  • If the computer has ADS/ADX software at Release 8.x or later, and did not have MVE installed, skip to the next step.

See Uninstalling the Metasys Server Software Introduction.

12.

If you followed any steps 4-11, restart the computer.

Refer to the information for restarting the computer that came with your operating system.

13.

Verify that the currently installed version of SQL Server software is supported for the new release of Metasys software. If necessary, apply the supported service pack or cumulative update.

See Verifying your computer has a supported version of SQL Server software installed.

14.

Verify that SQL Server Reporting Services is configured properly.

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

15.

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.

16.

License the Metasys Server software and any other software you require for the Web/Application server with the Software Manager.

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

17.

Start Metasys UI to verify proper operation.

Refer to the Metasys UI Help (LIT-12011953) for more information.

18.

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

Refer to Launcher Help (LIT-12011742) .

19.

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

See Launching the User Interfaces.

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.

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.

24.

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

25.

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

26.

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.

27.

If you need to bind a purchased SHA256 certificate from a public certificate authority, follow the steps on the right.
Note: The purchased certificate must be SHA256 to work with Metasys UI.
  1. In Control Panel, click System and Security > Administrative Tools.
  2. Start Internet Information Services (IIS) Manager.
  3. Expand the server, then expand Sites.
  4. Click Default Web Site.
  5. Click Bindings in the right pane. The Site Bindings window appears.
  6. Select the Site Binding called Type: https, Port: 443.
  7. Click Edit. The Edit Site Binding window appears with the SSL certificate drop-down list currently showing MUI Application Server. Click Select and select your signed certificate on the Select Certificate window.
  8. Click OK to confirm your selection, then click OK on the Edit Site Binding window.
  9. Close all windows.

28.

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

29.

Restore the Fault Manager Global Attributes.

Refer to the Potential Problem Areas widget section in the Metasys UI Help (LIT-12011953).

30.

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.