Getting started - Metasys - LIT-12013222 - M4-OASHIST-0 - M4-OASMIN-0 - M4-OASMIN-6 - M4-OASMIN-SC3 - M4-OASMIN-SCS - M4-OASPPA-0 - M4-OASSCHRPT-0 - M4-OASSTD-0 - M4-OASSTD-6 - M4-OASSTD-SC3 - M4-OASSTD-SCS - Server - Open Application Server - 12.0

Open Application Server (OAS) Installation Guide
Product
Building Automation Systems > Application Servers > Open Application Server
Document type
Installation Guide
Document number
LIT-12013222
Version
12.0
Revision date
2022-05-20
Product status
Active

The Metasys Server setup is a comprehensive utility that installs the OAS software, third-party components required by OAS, and many of the Microsoft components required by the Metasys system. The following tables list the components installed by the Metasys Server installer, unless already present. For the software listed under the Components and products not installed column, use the respective installation programs to add those components and applications, if applicable.

Table 1. Components installed and not installed by the Metasys Server

Windows® components installed

Metasys products installed

Components and products not installed

  • Microsoft Internet Information Services (IIS)
  • Microsoft .NET Framework 4.7.2
  • Microsoft Visual C++ Runtime Libraries
  • Microsoft Message Queuing (MSMQ)
  • Microsoft SQL Server® 2017 Express CU17 64-bit (ADS only)
  • Microsoft .NET Framework 3.5.1
  • Server at Release 12.0
  • Metasys UI Release 6.0
  • Monitoring and Commanding API
  • Launcher 2.0
  • Metasys Advanced Reporting System (ADX only)
  • Software Manager Release 3.0
  • Metasys system databases
  • SQL Server software (full version)
  • SQL Server Management Studio Express
  • System Configuration Tool (SCT)
  • Metasys for Validated Environments (MVE) for ADX
  • Metasys Export Utility for ADS and ADX
  • Metasys Database Manager
  • Site Management Portal (SMP)
  • Johnson Controls System Configuration Tool (JCT)
Note: The Metasys Server setup attempts to install Microsoft .NET Framework 3.5.1 component. If the computer on which you are installing the Metasys Server software does not have access to Windows Updates, the installation of this component fails. In this case, install .NET Framework 3.5.1 manually.
The following table lists the third-party components installed with the Metasys Server Setup at Release 12.0.
Table 2. Third-party components installed with the Metasys Server setup
Third-party component Brief description
Erlang OTP 23.2 (11.1.4) A required component for RabbitMQ functionality.
RabbitMQ Server 3.8.16 RabbitMQ is a service bus used to send notification messages to other services and is used for inter-process communication (messages) on the server.
Set Rate Limits IIS module that applies rate limiting to Metasys API calls. This module and settings do not apply to SMP or Metasys UI.
GraphDB GraphDB stores a portion of the Metasys site's configuration data to improve data querying.
Before you run the installer, ensure you complete the following steps:
  1. Verify that the OAS computer has a supported Windows operating system. See OAS technical specifications.
  2. Verify and change if necessary the computer name to match the following Metasys naming requirements:
    • Begins with a letter, not a number.
    • Contains a maximum of 15 characters.
    • Contains only letters A-Z (upper or lower case), numbers 0-9, and hyphens.
    • Does not end in letters OAS.
    • Does not contain any diacritic or accent marks.
      Note: Do not use underscores for the Metasys system.
  3. Configure the Windows Firewall to ensure the ports that Metasys software requires are open. See Configuring the Windows firewall.
  4. If you install OAS on a non-English language computer, you need to set the computer's regional settings and the default language used by the SQL Server database to the same locale as the site default language. See Installing Metasys server for a non-English locale.
  5. If the computer has multiple network cards, configure the network card that the Metasys Server software is to use. See Configuring additional network cards.
  6. Ensure the OAS host computer has access to Windows Updates. If it does not, the automatic installation of Microsoft .NET Framework fails and you need to install it manually.
  7. If you want the OAS to use trusted certificates instead of self-signed certificates, configure the certificates on the Metasys Server before installing the software. Otherwise, go to the next step. See Appendix: Certificate management and security.