Installing Metasys Server: Custom Method - 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

Brand
Metasys
Product name
Metasys Server
Document type
Installation Guide
Document number
LIT-12012162
Version
13.0
Revision date
2023-11-15
Product status
Active
Language
English

Follow the steps in this section if you want to use the custom method of installing Metasys Server software. Use the custom method for any of the following reasons:

  • you want to select a specific SQL Server instance other than MSSQLSERVER
  • you want to install the Metasys Server software in a location other than the default location (C:\Program Files (x86)\Johnson Controls)
  • you want to install the third-party applications that the Metasys Server uses (RabbitMQ and Erlang/OTP) in a location other than the default location (C:\Program Files (x86)\Johnson Controls)
  • you are installing Metasys Server software on a Windows Server operating system
  • you want to install the Metasys Advanced Reporting System on the Metasys Server
Note: If you select the Reporting component in the Metasys Server installation, do not begin the installation process until you have created the database in SCT that you intend to use with the Metasys Advanced Reporting System. You need to select this database during Metasys Server software installation. Also, verify that this database includes a Site object. Lastly, make sure that Reporting Services is properly configured and running. If you are unsure, refer to the Verifying SQL Server Reporting Services Configuration section of the SQL Server Installation and Upgrade Instructions (LIT-12012240).

When you begin the installation process, Metasys Server Setup detects whether the computer has a previous release of ADS/ADX software and meets the prerequisites defined in this document. If pre-Release 8.0 ADS/ADX software is found, a message appears requesting you to uninstall the ADS/ADX software first; see Uninstalling Metasys Server Software. If Release 8.0 or later ADS/ADX software is found, an upgrade option is available. Skip this section and go to Upgrading Metasys Server. Also, before you start the installation process, close Software Manager if currently open.

  1. Obtain the Metasys Server installation file (MetasysServer_13.0.exe) and Metasys Server data file (MetasysServer_13.0.data). Store both files in the same location.
  2. Using Windows Explorer, browse to the location of the Metasys Server installation and data files.
  3. Right-click MetasysServer_13.0.exe and select Run as Administrator. Enter the Administrator's user credentials if prompted. The setup window appears.
    Figure 1. Metasys Server Setup Window

  4. Click Custom. The Database screen appears.
    Figure 2. Metasys Server Database Window

  5. Under the Database section, select from these options:
    1. Install SQL Server Express Locally : Click this option if you want the Metasys Server Setup program to install a local instance of SQL Server 2019 Express with CU18. This option is disabled on computers with a Windows Server operating system. If the computer has an unsupported version of SQL Server Express software, the installation halts with a message that you must upgrade to a supported version.
      Note: This option is only available on Windows 10 and Windows 11 host computers when a SQL Server instance is not present.
    2. Use Existing Database Server : Click this option if an instance of SQL Server software is installed on the computer already, then select the server instance name.
    3. Server Name : Click the down arrow to select the server name of the SQL database engine installed on the computer. For a unified ADX, you select (localhost) in most cases. However, if multiple SQL Server instances are found on the local server, click the one to use for Metasys software. For a split ADX, input the database server name in this format: <servername> (default instance) or <servername>\<database instance> (named instance).
      Note: If your installation of SQL Server uses the default instance name, specify only the server name, but do not include the default instance name. Otherwise, an error message appears and you cannot proceed with the installation. You only need to specify a database instance if you have a named instance. Also, if the server name you specify does not resolve, use the server's IP address.
    4. Use Windows Credentials : Select if you want the installer to use the Windows OS credentials of the currently logged-in user to access the SQL Server software. The logged-in user must be a member of the system administrators (sysadmin) role in SQL Server. After installation, you can remove the SQL Server software system administrator rights from this user if so directed by IT personnel.
    5. Username and Password : Clear the Use Windows Credentials box to enter the SQL Server Administrator login and password credentials in these fields if you want the installer to use a SQL Server login with system administrator rights.
  6. Click the General tab. The General screen appears.
  7. In the Install Path and Third Party Install Path fields, you can either accept the default installation paths or select custom installation locations for the Metasys Server application and third-party applications that the server uses (RabbitMQ and Erlang/OTP). To select a custom location, click Browse to select a custom installation location (for example, drive E: instead of drive C:). A Browse For Folder dialog box appears. Select an installation location for each and click OK.
  8. From the Available Network Interface Cards list, select a network adaptor.
    Figure 3. Metasys Server General Window

  9. Click the Reporting tab. The Reporting screen appears.
    Figure 4. Metasys Server Reporting Window

  10. Under the Reporting section, select from these options:
    1. Install Metasys Advanced Reporting : Click to select to install the Metasys Advanced Reporting System. Metasys Advanced Reporting requires a computer with a server operating system that has the Reporting Services component of SQL Server properly configured.
    2. Server Name : Specify the computer where the SCT software is installed by either clicking the down arrow or typing the server name. Select the database that SCT uses. Input the server name in this format: <servername>\<database instance> (named instance).
      Note: When you enter the server name of the SCT computer and database instance, do not enter the default instance name. An error message appears and you cannot proceed with the installation. Only enter a database instance if you have a named instance.
    3. Use Windows Credentials : Select if you want the installer to use the Windows OS credentials of the currently logged-in user to access the SQL Server software. The logged-in user must be a member of the system administrators (sysadmin) role in SQL Server. After installation, you can remove the SQL Server software system administrator rights from this user if so directed by IT personnel. With SCT installed on a remote computer, the user logged in to the web/application server computer must have system administrator rights to SQL Server.
    4. Username and Password : Clear the Use Windows Credentials box to enter the SQL Server Administrator login and password credentials in these fields if you want the installer to use a SQL Server login with system administrator rights. (If you used the SQL Installer tool to set up SQL Server, you must use the SQL Server sa user and password).
    5. SCT Archive : Specify the name of the SCT archive that the Metasys Advanced Reporting System is to use. The installer verifies the existence of the archive you specify.
  11. To continue, click Install. The Initializing screen appears:

    Do not click Cancel, unless you need to halt installation and apply an update to SQL Server software. Seconds later, the installer continues and the progress of each step is shown.

    If the setup program requires a restart during installation, it prompts you, then resumes installation after the restart.
    Note: If .NET Framework 4.7.2 or 4.8 is missing from the computer, the Metasys Server installation is paused at this point and the .NET Framework 4.7.2 or 4.8 components are installed now, then the computer restarts. After the restart, the Metasys Server installer automatically resumes.
  12. After all installation steps have finished, the Metasys Server Setup Complete box appears.
    1. Click Restart Now: a restart is needed to make the changes on your computer. After the restart, continue with the next step.
    2. Click Finish: a restart is not needed. Proceed to the next step.
  13. If you disabled antivirus software before you began installing the Metasys Server software, after the computer restarts, log in and re-enable the software.
  14. (Optional) If the site is trending large amounts of data, resize the MSMQ limitation. For details, refer to Message Queue Size Considerations in the ADS/ADX Commissioning Guide (LIT-1201645) .
  15. License the Metasys Server with the Software Manager, which is installed with the server. For details, refer to Software Manager Help (LIT-12012389).