Pre-Work checklist for new installations and upgrades - Metasys - LIT-12012162 - MS-ADS05U-0 - MS-ADX100SQL2-0 - MS-ADX100U-0 - MS-ADX10SQL-0 - MS-ADX10U-0 - MS-ADX25SQL-0 - MS-ADX25U-0 - MS-ADX50SQL-0 - MS-ADX50SQL2-0 - MS-ADX50U-0 - Server - Metasys Server - 11.0

Metasys Server Installation and Upgrade Instructions

Product name
Metasys Server
Document type
Installation Guide
Document number
Revision date
Product status

Before you begin the process of installing or upgrading the Metasys Server at a customer site, follow the steps in the checklist below.

Table 1. Pre-work Checklist




Review related documentation

Download and review all the Flash Sheets, FYIs, and Quick Patches from the portal that relate to Metasys software installation and upgrades. Links to all these resources are available on the Field Support Center Find Answers page.

Download and review all the relevant product literature from the Knowledge Exchange website. Knowledge Exchange has the most up-to-date versions of product literature.

Verify that all available Windows updates have been applied to the Windows operating system on the target computer. Also make sure the versions of the OS and SQL Server software (if previously installed) are supported.

See Prerequisite Software Checklist for Installation and Upgrade. During the Metasys Server installation or upgrade process, a message may appear that prompts you to check that the version of SQL Server software is up to date.

Understand steps for installing Metasys software on a virtual machine (VM)

If you are installing a virtual ADS/ADX server, ensure the virtual server is running in static memory mode, not dynamic. Otherwise, operational issues with SQL Server may occur. Also, if upgrading from hardware server to virtual, configure the ADS/ADX VM with the same amount of memory as the hardware ADS/ADX server, or with 8 GB of memory as a minimum.

Verify Metasys Server computer has a minimum of 8 GB RAM

The Metasys installer requires at least 8 GB of memory or the install fails. The same holds true for installing on a virtual machine.

Uninstall or upgrade existing release of SCT

If your computer has SCT 11.1 or earlier, plan to uninstall SCT before installing SCT Release 14.0.

If your computer has SCT Release 12.0 or 13.x, you can upgrade to SCT Release 14.0 without removing the older version of SCT. During this upgrade, the newest version of the NAE Update Tool is also installed.

Upgrade existing release of CCT

If your computer has CCT 13.1 or earlier, and you plan to use the NxE Passthru option in CCT with Metasys Release 11.0, you must upgrade to CCT Release 14.0.

Uninstall or upgrade existing NAE Update Tool

If your computer has SCT 11.0 or earlier, plan to uninstall any older version of the NAE Update Tool if still present on the computer. If your computer has SCT 12.0 or later, you do not need to uninstall the NAE Update Tool, because upgrading SCT also upgrades the latest version of the NAE Update Tool. The stand-alone setup for the NAE Update Tool has been discontinued.

If the job site does not allow your laptop on their network, install the SCT and the NAE Update Tool on the ADS/ADX server. When you are creating a full target list of network engines in the NAE Update Tool, save the Target file to your laptop with a descriptive name. If you need help with the NAE Update Tool, review the Overview section for the NAE Update Tool Help (LIT-12011524).

Bring along all necessary software updates and service packs

If your customer site does not have access to the Internet, download any Microsoft or other software patches and service packs onto a DVD or flash drive before you go to the site. Any newly installed Microsoft software must be registered, through the Internet or email/fax, which takes time.

Check Network Engine Versions

Check the versions and memory usage of the NAE/NIEs installed at the site. The NxE55xx-0 and NAE45xx-0 models cannot be upgraded to Release 8.0 or later because they have insufficient memory and performance. Also, NIE55 models cannot be upgraded to Release 10.0 or later because they are no longer supported. To help you locate older NxEs, use the Metasys Supervisory Scan tool. You have two choices for these engines: replace the NxE or keep the engine at its current release. The NxE55xx-0, NAE45xx-0, and NIE55 models may coexist with servers running the latest Metasys version.

In addition, the NCE25, NAE35, and NAE45 models cannot be upgraded beyond Release 9.0.8, and the LON models of these engines cannot be upgraded beyond Release 9.0.

Lastly, all modem and pager functions on network engines are no longer functional with the Release 9.0.7 or later upgrade.

Check for NxE55xx-1 Engines

If the site has NxE55xx-1 models, review Flash Sheet 2013F21. This Flash Sheet has you check for bad memory by using the Field Bus Fault Detection and Diagnostic (FDD) Tool.

Create a network engine report

Use the Metasys Supervisory Tool or Tailored Summaries to print out a summary of the network engines operating at the site. The network engine information that is most helpful includes:

  • the current online condition and IP address
  • the current software release
  • the current memory usage. If a network engine is currently running at >95% of Flash memory usage, you may have issues with the upgrades, since features requiring more memory may be added.

Decide which network engines to update

It is not necessary to update all the network engines on the site immediately. You can keep some network engines at their existing release. You only need to upgrade the Site Director to the new release. You can delay the upgrade of critical engines to off-hours or extend the upgrade schedule across a number of site visits.

Important: After you install or upgrade the Metasys Server to Release 11.0, the Site object attribute called Advanced Security Enabled is set to True, so that any network engine not at Release 10.0 or later no longer communicates to the server. You have two options: (1) update all network engines to Release 10.0 or later or (2) do not update the network engines to Release 10.0 or later and change the Advanced Security Enabled on the Site object to False.

Arrange for updating network engines over individual subnets

When you update a network engine from Release 9.0 or earlier to Release 9.0.7 or later, you must use SCT Pro 14.0 or the NAE Update Tool with the PXE only option. You cannot use SCT 13.2 to update the network engine. Also, the update can only occur on the same subnetwork, so special arrangements might be required to access remote engines.

Plan for and be aware of new field controller limitations for new SNE and SNC network engines

The SNE and SNC network engines have fixed limits for the number of field controller that they support, which are listed in the SNE/SNC Product Bulletin (LIT-12013296). If you plan to replace an NAE with an SNE, or an NCE with an SNC, be aware of these newly enforced limitations. If you have any NAE/NCE that has a higher device count than the limits, plan to redistribute field controllers to different SNE/SNC engines.

Verify that the network card on the computer or VM you selected for the Metasys Server has a valid IP address and an active network connection

Before you begin the installation or upgrade, make sure that the network card on the computer or VM for the Metasys Server is enabled and connected to the building network with a valid IP address. For a successful installation or upgrade, the Metasys Installer must be able to read the MAC address of the network card.

Verify Port 443 is open and handles traffic in the same manner as Port 80

Check with IT and verify how the networking equipment handles Port 80 traffic. The same type of treatment is needed for Port 443. Refer to the Network and IT Guidance Technical Bulletin (LIT-12011279).

Review Graphics

Review and print to a PDF file the existing conditions of the graphics for all major equipment, such as chilled water system, cooling towers, air handlers, exhaust fans, boilers, and any others.

Generate reports

Review and print to a PDF file the Override, Offline, Disabled, and Alarm Reports for the entire network. These reports are available from the Query menu in the Site Management Portal (SMP) UI. Also, review and print NAE Diagnostics, NAE Unbound References, and Field Bus diagnostics for the network. This data is helpful when you return the system back to a pre-upgrade state.