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) |
Use the steps in the following table for upgrading the Metasys Server and SCT software on a computer with a server operating system.
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. |
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) . |
|
3. |
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). |
4. |
Determine if you need to
record existing user accounts and roles:
|
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. |
5. |
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. |
6. |
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. |
7. |
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) . |
8. |
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. |
9. |
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) . |
10. |
Uninstall the NxE Information and Configuration Tool (NCT) if present. |
In Control Panel, click Programs > Programs and Features. Select the program from the list and click Uninstall. |
11. |
Uninstall the Metasys Export Utility software if currently installed. |
In Control Panel, click Programs > Programs and Features. Select the program from the list and click Uninstall. |
12. |
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. |
13. |
Select the appropriate
action:
|
In Control Panel, click Programs > Programs and Features. Select the program from the list and click Uninstall. |
14. |
Select the appropriate action:
|
In Control Panel, click Programs > Programs and Features. Select the program from the list and click Uninstall. |
15. |
Uninstall the existing MVE software if present. |
|
16. |
Select the appropriate action:
|
|
17. |
Select the appropriate
action:
|
|
18. |
Select the appropriate
action:
|
In Control Panel, click Programs > Programs and Features. Select Johnson Controls - Launcher from the list of programs and click Uninstall. |
19. |
Select the
appropriate action:
|
|
20. |
Select the
appropriate action:
|
|
21. |
Start SCT from the Launcher or the Metasys SCT shortcut. Log in with the MetasysSysAgent user and password. The login process could take a little longer than usual. |
Refer to Launcher Help (LIT-12011742) . |
22. |
As part of the in-place upgrade, open the archive database with SCT by clicking Item > Open Archive. See the information on the right. |
Select the
appropriate action:
|
23. |
Select the appropriate action:
|
Open the Security Administrator tool (Tools > Administrator). In Security Administrator, recreate all roles, user accounts, and Active Directory user accounts that were present in the old version of SCT or, create a new limited set of SCT users. If you made screen captures of the SCT roles and users in an earlier step, use these screens as a guide for adding the roles and user accounts to SCT. Refer to the Security Administrator System Technical Bulletin (LIT-1201528) . |
24. |
Uninstall the Metasys Database Manager if currently installed. |
Refer to the Metasys Database Manager Installation Guide (LIT-12011553) . |
25. |
If you uninstalled ADS/ADX software in a previous step install the Metasys Server 13.0 software now. Otherwise, upgrade the Metasys Server 13.0 software now. |
To install, see Metasys Server Software. To upgrade, see Upgrading Metasys Server. |
26. |
License the Metasys Server software and SMP software with the Software Manager. |
Refer to the Software Manager Help (LIT-12012389). |
27. |
(Optional) Start Launcher on the computer and launch the Site Management Portal (SMP) for the upgraded ADS/ADX. |
Refer to Launcher Help (LIT-12011742) . |
28. |
To verify ADS/ADX operation, log in to the ADS/ADX using the MetasysSysAgent user and password. |
|
29. |
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) . |
30. |
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) . |
31. |
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:
|
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.
|
32. |
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. |
33. |
(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. |
34. |
As part of the in-place upgrade, install the Metasys Database Manager at Release 13.0. |
Refer to the Metasys Database Manager Installation Guide (LIT-12011553) . |
35. |
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) . |
36. |
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. |
37. |
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.
|
|
38. |
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. |