Transcription

SCT Installation and Upgrade InstructionsBuilding Technologies & 5-20Release 15.0

2SCT Installation and Upgrade Instructions

ContentsContentsDocument introduction. 5Summary of changes. 5Getting started.5Related documentation. 6SCT installation and upgrade overview. 6SCT installation and upgrade prerequisites. 7Operating system requirements.9SQL Server Software. 9Detailed procedures.13Uninstalling existing SCT software introduction.13Uninstalling SCT to install an earlier release of SCT. 14Uninstalling existing SCT release 13.0 or earlier software.14Uninstalling existing NAE/NIE Update Tool software.15Opening ports and configuring the Windows firewall.15Verifying your computer has a supported version of SQL Server software installed. 17Installing or upgrading SQL Server software using the SQL installer.18Upgrading from SCT Release 13.2 or later to Release 15.0 software. 18Installing the SCT software.18SCT software one-click installation. 18SCT custom installation. 19Uninstalling SCT Release 12.0 and later software.20Launching the SCT user interface.21Browsing to JCT or SCT Pro.22Authentication. 23Security certificate warnings. 23Troubleshooting. 24Product warranty.32Software terms. 32Patents.32Contact information.32SCT Installation and Upgrade Instructions3

4SCT Installation and Upgrade Instructions

Document introductionThis document describes how to install and upgrade the System Configuration Tool (SCT) softwareon a desktop or server-class computer.Summary of changesThe following information is new or revised for SCT Release 15.0: Updated SQL Server Software requirements. Updated Operating system requirements. Replaced references to Metasys UI Offline with Johnson Controls System Configuration Tool(JCT) throughout this document, because this tool is rebranded. Removed references to the Open Data Server (ODS) because the latest available version of theODS is Release 10.1. The ODS is not available for upgrade to Metasys Release 12.0. Updated Upgrading from SCT Release 13.2 or later to Release 15.0 software to include a notethat you must upgrade SCT and server products to the same version on a unified server. Removed problems related to Windows 7 and Windows 8 from Troubleshooting because theseWindows versions are no longer supported. Updated Troubleshooting to document an issue about the upgrade of an SCT archive. Updated Troubleshooting to document an issue where it is not possible to download legacyarchives with SCT. Updated Troubleshooting to include a workaround for an issue where appsetting keys are notpersisted after an uninstall. Updated the document throughout to be generic so that the document applies to bothMetasys and Facility Explorer (FX).Getting startedThe SCT setup is a comprehensive utility that includes and installs several Microsoft Windows components and products. The following table outlines the components and products that theSystem Configuration Tool Setup installs.Table 1: Components installed by the System Configuration Tool setupWindows Components InstalledProducts InstalledMicrosoft Internet Information Services (IIS)Microsoft .NET Framework 4.7.2 and 3.5.1Microsoft Visual C Runtime LibrariesMicrosoft Message Queuing (MSMQ)Microsoft SQL Server 2017 Express with CU17 Desktop Operating Systems only. Only installs ifno version of SQL Server is detected.System Configuration Tool 15.0SCT Pro 15.0Johnson Controls System Configuration Tool(JCT) 6.0Launcher 2.0Software Manager 3.0Engine ImporterPackage ImporterSCT Installation and Upgrade Instructions5

Related documentationThe following table provides a list of documents related to SCT software installation.Table 2: SCT installation and upgrade related documentationFor information aboutDocument referenceUnderstanding the Metasys systemMetasys System Configuration Guide(LIT-12011832)Installing and upgrading the Application andMetasys Server Installation and UpgradeData Server (ADS) and Extended Application and Instructions (LIT-12012162)Data Server (ADX) on the SCT ComputerInstalling and upgrading ADS-Lite on the SCTComputerMetasys Server Lite Installation and Upgrade Guide(LIT-12012258)Details for installing and upgrading SQL ServersoftwareSQL Server Installation and Upgrade Guide(LIT-12012240)How to install the Open Application Server (OAS) Open Application Server (OAS) Installation Guide(LIT-12013222)Using the LauncherLauncher Help (LIT-12011742)Knowing the features, benefits, andspecifications of SCTSystem Configuration Tool Catalog Page(LIT-1900198)Creating archive databases, integrating building SCT: System Configuration Tool Helpnetworks, and Auto Discovering Points(LIT-12011964)Understanding security risks on the networkNetwork and IT Guidance Technical Bulletin(LIT-12011279)Understanding JCTJohnson Controls System Configuration Tool (JCT)Help (LIT-12012116)Understanding SCT ProSCT Pro Help (LIT-12013035)Understanding the NAE Update Tool and theEngine Importer.NAE Update Tool Help (LIT-12011524)Licensing the SCT and field controller packages.Software Manager Help (LIT-12012389)Licensing SCT and field controller packages, thedaily use of the Facility Explorer system, anddatabase backup/restoreFacility Explorer Site Management Portal Help(LIT-12013520)Commissioning the SNCF4-SNC Commissioning Guide (LIT-12013549)SCT installation and upgrade overviewThe Windows operating system that you want to use for SCT software must have the correctcomponents installed. SCT software does not install or function properly if any of these componentsare missing. The SCT setup installs many of these prerequisites, but make sure you carefully reviewthe software requirements before installation. Follow the steps outlined in the Detailed proceduressection to ensure that the SCT successfully installs.If you have SCT Release 13.0 or earlier software, you must first uninstall it before you install SCTRelease 15.0. For details, refer to Uninstalling existing SCT release 13.0 or earlier software. Howeverif you have SCT Release 13.2 or later software, you can upgrade to SCT Release 15.0. For details,refer to Upgrading from SCT Release 13.2 or later to Release 15.0 software. If you install the SCTon a server and you do not have an earlier release of the SCT installed, first install, or verify that6SCT Installation and Upgrade Instructions

you have a supported version of Microsoft SQL Server software. If you install the SCT on a DesktopOperating Systems and you do not have a supported version of Microsoft SQL Server software,the SCT setup automatically installs Microsoft SQL Server Express. For details, see Verifying yourcomputer has a supported version of SQL Server software installed.You can install SCT Release 15.0 on a computer with a Metasys server that is at Metasys Release 9.0or later. Metasys servers include the ADS, ADX, and ADS-Lite. Do not install the SCT software on anOAS server. Some important installation rules to consider are: The SCT software and Trunk Utility features require license activation at Release 13.0 or later.Use the Software Manager to license the SCT and field controller packages. Install the softwaremanager through the SCT installation wizard. For more information on software licensing,refer to the Software Manager Help (LIT-12012389). You must uninstall any older stand-alone releases of the NAE/NIE Update Tool (NUT) beforeyou use the SCT setup to install SCT Release 15.0. You must uninstall SCT Release 13.0 or earlier software before installing SCT Release 15.0. Youmust apply any new OS or SQL service pack after you remove an older release of the SCT, butbefore you install a new release of the SCT. Do not install SCT and Metasys Server software on the same computer if more than 100network engines are to report to one ADX or ODS. If you have more than 100 engines on thesite, install the SCT on a separate computer. You can use SCT Release 15.0 to manage devices from Metasys Release 5.2 or later. The SCT nolonger requires the Site Director to be of an equivalent release version as the tool. Install SCT on a stand-alone computer when you use it with a split ADX system. Do not installSCT on the same computer as the web/application server or data server of a split ADX system.SCT installation and upgrade prerequisitesConsider the following before installing SCT: SCT software requires 8 GB minimum of available hard disk space. This requirement is toensure that enough room exists for future database storage used by SCT. The System Configuration Tool Setup installs Microsoft .NET Framework version 4.7.2 if it doesnot already exist on the computer. SCT Setup also installs .NET Framework version 3.5.1. To avoid any incompatibility issues, install SCT on a computer that does not have other nonMetasys applications that use IIS. You can use SCT to maintain a variety of release engines at Metasys Release 5.2 and later.The Site Director must be at an equivalent or greater release version than the highest versionengine. For example, if you have a Metasys Release 6.5 engine and a Metasys Release 5.2engine in your archive, your Site Director needs to be greater than or equal to Metasys Release6.5. For more information, refer to SCT: System Configuration Tool Help (LIT-12011964). The Ethernet network interface card (NIC) must have a valid connection status for theinstallation to complete successfully. Connect your Ethernet NIC to the powered-up Ethernethub, switch, or router or to a live Ethernet network. The initial logon user name for the SCT UI is MetasysSysAgent and is not case sensitive. Forthe MetasysSysAgent default password, contact your local Johnson Controls representative.For new SCT installations, change the logon account password to a valid, complex passwordwhen you log on for the first time. If the currently installed SCT is upgrade eligible, theMetasysSysAgent password is retained during the upgrade, so you are not promptedto change the password. For more information about passwords, refer to the SecurityAdministrator System Technical Bulletin (LIT-1201528).SCT Installation and Upgrade Instructions7

The NAE/NIE Update Tool is bundled with SCT. When you install SCT, the NAE/NIE Update Toolis also installed in the background. At SCT Release 13.0 or later, the tool is renamed to the NAEUpdate Tool. To launch the NAE Update Tool, navigate to Start Johnson Controls NAEUpdate Tool. The NAE Update Tool does not have a desktop icon and you cannot uninstall theNAE Update Tool without also uninstalling SCT. For SCT Release 14.0 or later, use SCT Pro in place of the NAE Update Tool because all of theNAE Update tool functions are available in SCT Pro. The SCT Pro includes some of the same functions as the NxE Information and ConfigurationTool (NCT). For NCT functions to work, open port 9910 (TCP) and port 9911 (UDP) on the SCTcomputer. For details about the NCT, refer to NxE Information and Configuration Tool TechnicalBulletin (LIT-1201990). For details about opening ports, see Opening ports and configuring theWindows firewall. The SCT and the NCT remain separately installed and maintained tools. To upload CAFs into the SCT archive, you no longer need to install CCT on the same computeras SCT. The CAF upload feature is only available for network engines at Release 6.0 or later. AtSCT Release 12.0 or later, you can use the Trunk utilities option to transfer CAFs to and fromthe SCT archive. If your computer has an older version of the NAE Update Tool, you cannot upgrade SCT untilyou uninstall the older version of the NAE Update Tool. The releases must match becausethe SCT and NAE Update Tool share the same code base for some upload and downloadoperations. The security database for the SCT application is not available after uninstalling and re-installingSCT. You must document the existing list of users and add them manually after you install thelatest release of the SCT. At SCT Release 14.1 and later, you require device package files, field controller package files,and Generic SA Bus packages to use all features in SCT. If you do not install device packages,you cannot add servers, supervisory devices, and field devices. Use the Software Manager,an application that is installed with SCT to license these package files after you download thepackage files from the license portal. You must import the package files before they can belicensed. Follow the steps in Licensing SCT and importing and licensing packages for SCT toimport and license all package files. For further information on software licensing, refer to theSoftware Manager Help (LIT-12012389). If you decide to move your IIS folder or files before you install SCT, please complete thefollowing steps:a. Choose a new location for C:\inetpub and copy the existing files from C:\inetpub tothe new location.b. Run the following command to change the Default Web Site physical site location to thenew inetpub location: %windir%\system32\inetsrv\appcmd set vdir "DefaultWeb Site/ -physicalPath:f:\inetpub\wwwroot replacing f:\inetpub\wwwrootwith the location you choose.c. Run the following command to update the IIS registry settings for the new location:reg add HKLM\Software\Microsoft\inetstp /v PathWWWRoot /t REG SZ /df:\inetpub\wwwroot replacing f:\inetpub\wwwroot with the location you choose.Note: Refer to Microsoft documentation for further information about moving your IISsite.8SCT Installation and Upgrade Instructions

Operating system requirementsThe following Windows operating systems support SCT software: Windows 10 Enterprise LTSC (21H2) (64-bit) Windows 10 Pro and Windows 10 Enterprise Editions versions 2004, 21H1, and 21H2 (64-bit).For all future Windows 10 updates after version 21H2, we will evaluate and certify that Metasyssoftware can support the updates before we provide guidance on support. Windows Server 2019 (version 1809 or later) (64-bit) Windows Server 2016 (version 1607 or later) (64-bit)Refer to the following guidelines to install SCT: If you install the SCT on a server and you do not have an earlier release of SCT installed, firstinstall or verify that you have a supported version of SQL Server software. If you install SCTon a desktop operating system without a version of SQL software installed, the SCT setupautomatically installs SQL Server Express. For details, see Verifying your computer has asupported version of SQL Server software installed.Note: If you have an unsupported version of SQL server software installed, the SCTinstallation does not install a supported version automatically. You must update orupgrade the version of SQL or install a supported version manually. Do not install the system software on a computer that was updated from an older version ofWindows, such as from Windows 7 to Windows 10. This process can leave behind files andregistry settings that can adversely affect the installation of system software. Prepare thecomputer by performing a clean installation using the Windows installation media. The System Configuration Tool Setup installs Microsoft .NET Framework version 4.7.2. ForWindows 10, Windows Server 2016, and Windows Server 2019, a valid connection to WindowsUpdate must be available for the SCT setup to be successful with the installation of .NETFramework 4.7.2. An error message appears if the prerequisite is not present.SQL Server SoftwareInstall SQL Server on the same computer as SCT. The following Microsoft SQL Server softwareversions are supported for use with SCT:Windows 10 Pro and Windows 10 Enterprise Editions versions 2004, 21H1, and 21H2 (64bit). For all future Windows 10 updates after version 21H2, we will evaluate and certify thatMetasys software can support the updates before we provide guidance on support. SQL Server 2019 Express with CU14 (64-bit): version 15.0.2005.5 or later SQL Server 2017 Express with CU27 (64-bit): version 14.0.3238.1 or later SQL Server 2016 Express with SP2 CU17 (64-bit): version 13.0.5492.2 or laterWindows Server 2019 (version 1809 or later) (64-bit) SQL Server 2019 with CU14 (64-bit): version 15.0.2005.5 or later SQL Server 2017 with CU27 (64-bit): version 14.0.3238.1 or later SQL Server 2016 with SP2 CU17 (64-bit): version 13.0.5492.2 or laterWindows Server 2016 (version 1607 or later) (64-bit) SQL Server 2019 with CU14 (64-bit): version 15.0.2005.5 or later SQL Server 2017 with CU27 (64-bit): version 14.0.3238.1 or later SQL Server 2016 with SP2 CU17 (64-bit): version 13.0.5492.2 or laterSCT Installation and Upgrade Instructions9

Before you install or upgrade your SQL Server software, consider the following information: Uninstall software such as SCT and CCT before you upgrade the version of an existing SQLinstance. Microsoft SQL Server 2014, 2012, SQL Server 2008, and SQL Server 2008 R2 are no longersupported. For information about how to upgrade SQL Server, refer to SQL Server SoftwareInstallation and Upgrade Guide (LIT-12012240). If your computer has SQL Server software installed, verify that the current version of SCTRelease 15.0 supports this software. Go to Verifying your computer has a supported version ofSQL Server software installed. A tool called the SQL Installer is provided on the License Portal with the Branch Toolsdownload to help you install or upgrade to any supported version of SQL Server software. Ifyou do not have this tool, refer to the SQL Server Software Installation and Upgrade Instructions(LIT-12012240) for details on how to install or upgrade SQL Server software. Also refer to SQLServer Software Installation and Upgrade Instructions (LIT-12012240) this document if you needto apply a new service pack (SP) to an existing installation of SQL Server software because theSQL Installer does not support service pack installations. To use the SQL Installer to install a full version of SQL Server software (for example, SQL Server2017 Standard edition), you can download the install files for full Microsoft SQL Server. To useSQL Installer to install an Express version of SQL Server software (for example, SQL Server2017 Express), download the SQL Server Express installation file from the Microsoft SQL ServerExpress website. The SQL Installer verifies that your computer has the prerequisites you need to install SQLServer. An error message appears if a prerequisite is not present. You need to install anymissing software prerequisites before continuing. The SQL Installer provides an advanced mode that lets you edit the SQL Server commandline options before you start the installation. You can also copy the options, paste them into acommand window, and run the installation at a command prompt. However, use this methodonly if you are an advanced user who fully understands SQL Server software options. If you are installing SQL Server software manually, do not enable the C2 audit tracing feature.With C2 audit tracing enabled, SQL Server creates a large number of operational log filesthat might eventually fill the hard disk and cause the server to stop responding. However, ifyou install MVE, the MVE installer enables the C2 audit tracing feature for you. If you want toconserve hard disk space, be sure to disable C2 audit tracing after installing MVE. The SA password that you specify in the SQL Installer window must follow the rules forMicrosoft complex passwords. For more information about complex passwords, refer to theSecurity Administrator System Technical Bulletin (LIT-1201528). SQL Server installation packages no longer include Management Tools after SQL Server 2016.If you use this server, or a later version, you must manually install the SQL Server ManagementStudio tool. For details on how to install SQL Server Management Studio after you installSQL Server software, refer to the SQL Server Software Installation and Upgrade Instructions(LIT-12012240). If you are installing server software on a server class machine, ensure SQL Server software isinstalled and running before you install SCT software. If after you upgrade to a newer version of SQL Server software, you need to open the archivedatabase in an older version of SQL Server software, use the Export Database option in SCT.Then import the archive that uses an older version of SQL Server software into SCT.Figure 1 shows the SQL Installer tool. Table 3 describes the fields and selections.10SCT Installation and Upgrade Instructions

Figure 1: SQL Installer WindowTable 3: Description of SQL Installer WindowCalloutAttributeAction1 File Name Location Click Find SQL Install Program to enter the location of the SQLServer software installation or upgrade file (setup.exe or SQLServer Install .exe) in this field.2 License Check Box Select the I accept the Microsoft software Terms andconditions check box.3Unified ADS/ADX, orSCTSelect this option for a stand-alone SCT computer. This selectionappears only for a new SQL Server installation.4SA PasswordSpecify a secure SA password for the SQL Server administratoraccount. This selection appears only for a new SQL Serverinstallation.5Software KeyEnter the software license key required to activate SQL Serversoftware, usually found on the media label. This selectionappears only for a new SQL Server installation.6Show AdvancedOptionsSelect this check box to enable the advanced options editingwindow.7Instance NameSpecify a database instance name for SQL Server.SCT Installation and Upgrade Instructions11

Table 3: Description of SQL Installer WindowCalloutAttributeAction8Windows AccountSelect the appropriate checkbox to grant administrator rightsGranted SA Accessto either the local Administrators group or the local Windows Local Administrators Administrator.Group Local WindowsAdministrator9Application Installation Leave this field blank.Path10Default DatabaseStorage PathLeave this field blank.11Command LineOptionsContains the full command-line options that reflect the dialogbox selections you made. Only edit the contents of this box ifyou fully understand SQL Server software options.12Find SQL InstallProgramClick to open a browser window from which you can select thelocation of the SQL Server installation or upgrade file. Select theappropriate SQL Server setup (setup.exe) or executable file.13DownloadManagement StudioInstall ProgramClick to access the Microsoft download page to download thelatest version of SQL Server Management Studio (SSMS). SSMSis backward-compatible with all earlier versions of SQL Server.14Split ADX App ServerSplit ADX Data ServerMake no selection; these selections only apply to a split ADX.15Install New Instanceor Upgrade ExistingInstanceClick Install New Instance to start the SQL Server softwareinstallation or Upgrade Existing Instance to start the SQLServer software upgrade.If your computer has SQL Server software installed, go to Verifying your computer has a supportedversion of SQL Server software installed to verify that you have a version the software supports.The following table lists the default SQL Server installation options that can be used by the Installer.Table 4: SQL Server configuration selectionsSQL Server configurationscreenSQL Server Express editionselectionsSQL Server Standard orEnterprise edition selectionsSetup roleN/ASQL Server featureinstallationFeature selectionDatabase engine servicesManagement tools - Basic (ifavailable)Unified ADX or SCT:Database Engine ServicesReporting ServicesManagement Tools - BasicManagement Tools - CompleteWeb/application server onsplit ADX:Reporting ServicesManagement Tools - BasicManagement Tools - Complete12SCT Installation and Upgrade Instructions

Table 4: SQL Server configuration selectionsSQL Server configurationscreenSQL Server Express editionselectionsSQL Server Standard orEnterprise edition selectionsInstance configurationDefault Instance(Named instance is valid aswell)Default Instance(Named instance is valid aswell)Server configurationSQL Server Database Engine:NT Service\SQLSERVERAGENTor NT AUTHORITY\SYSTEMSQL Server Browser:NT AUTHORITY\LOCAL SERVICESQL Server Agent:NT Service\SQLSERVERAGENTor NT AUTHORITY\SYSTEMSQL Server Database Engine:NT Service\SQLSERVERAGENTor NT AUTHORITY\SYSTEMSQL Server ReportingServices:NT Service\SQLSERVERAGENTor NT AUTHORITY\SYSTEMSQL Server Browser:NT AUTHORITY\LOCAL SERVICEDatabase engineconfigurationMixed ModeSpecify SQL strators)Mixed ModeSpecify SQL strators)Reporting servicesconfigurationN/AUnified ADX or SCT:Reporting Services NativeMode: Install and configureSQL Server configurationmanagerProtocols for instancename Named Pipes: EnabledTCP/IP: EnabledNamed Pipes: EnabledTCP/IP: EnabledDetailed proceduresUninstalling existing SCT software introductionNote: If you are uninstalling the SCT to install an earlier release, see Uninstalling SCT to installan earlier release of SCT for more information.Important: You need to uninstall SCT Release 11.0 or earlier software before you can use theSystem Configuration Tool Setup to install the latest release of SCT.Important: If you receive error messages when you uninstall SCT software, you may haveproblems reinstalling it. Diagnose these problems before you attempt to reinstall the software.Important: The security database for the SCT application is not available after uninstalling andreinstalling the software when you select the Remove Databases option. Before uninstallingthe SCT software, document the existing list of SCT users and after reinstalling the softwaremanually add the users to the database again.SCT Installation and Upgrade Instructions13

Uninstalling SCT to install an earlier release of SCTYou do not need to install an earlier release of the SCT to work with devices that are at an earlierRelease. You can use SCT Release 14.1 or later to manage devices that are at Metasys Release 5.2 orlater.Important: To open an archive in the SCT, the archive must be at the same release as the SCT.If the archive is at an older release, SCT prompts you to upgrade it. However, if you upgradean archive in the SCT, you can no longer open that archive in an earlier release of the SCT. Forexample, if you upgrade an archive to SCT Release 15.0, uninstall SCT Release 15.0, and theninstall an older release, such as SCT Release 14.2, you cannot open the archive in SCT Release14.2.If you uninstall the SCT and attempt to install an earlier release, the install may fail because ofconflicting entries in the SQL database. If you need to install an earlier release of the SCT, or youneed to open an archive database in an earlier release of the SCT, contact your local JohnsonControls representative for assistance.Uninstalling existing SCT release 13.0 or earlier softwareFollow these steps to uninstall existing SCT 13.0 or earlier software.1.Optional: Use the Metasys Datab

SCT Release 12.0 or later, you can use the Trunk utilities option to transfer CAFs to and from the SCT archive. If your computer has an older version of the NAE Update Tool, you cannot upgrade SCT