13.07.2015 Views

Network and IT Guidance for the BAS Professional Technical Bulletin

Network and IT Guidance for the BAS Professional Technical Bulletin

Network and IT Guidance for the BAS Professional Technical Bulletin

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong><strong>Bulletin</strong>Code No. L<strong>IT</strong>-12011279Software Release 6.1Issued June 17, 2013Supersedes May 15 2013Refer to <strong>the</strong> QuickL<strong>IT</strong> website <strong>for</strong> <strong>the</strong> most up-to-date version of this document.Document Introduction.............................................................................................................4Concepts.....................................................................................................................................4Key Terms............................................................................................................................................4Active Directory Service........................................................................................................................4Active Directory Service Domain/Domain Controller............................................................................4Active Directory Service Schema..........................................................................................................4Demilitarized Zone (DMZ).....................................................................................................................4Domain Name System (DNS)...............................................................................................................4Dynamic Host Configuration Protocol (DHCP).....................................................................................4Firewall..................................................................................................................................................5Forest....................................................................................................................................................5Integrated Windows Au<strong>the</strong>ntication......................................................................................................5Kerberos................................................................................................................................................5Lightweight Directory Access Protocol (LDAP).....................................................................................5Microsoft Message Queuing (MSMQ)...................................................................................................5<strong>Network</strong> Address Translation (NAT)......................................................................................................5NT LAN Manager (NTLM) ....................................................................................................................5Organizational Units (OU).....................................................................................................................5Point-to-Point Protocol (PPP)...............................................................................................................6Service Account in Active Directory Service.........................................................................................6Security Identification (SID)..................................................................................................................6Simple Mail Transfer Protocol (SMTP)..................................................................................................6Simple <strong>Network</strong> Management Protocol (SNMP)...................................................................................6Simple <strong>Network</strong> Time Protocol (SNTP).................................................................................................6Transmission Control Protocol (TCP)...................................................................................................6User Account in Active Directory Service.............................................................................................6User Datagram Protocol (UDP)............................................................................................................6Virtual Private <strong>Network</strong> (VPN)...............................................................................................................7Related Documentation.............................................................................................................7<strong>Network</strong> <strong>and</strong> <strong>IT</strong> Considerations................................................................................................7Computer Hardware Configuration Requirements..........................................................................7Metasys Device IP Address Assignment (DHCP or Manual)..........................................................8Metasys Device Hostname Resolution (DNS or Hosts File).........................................................10DNS Implementation Considerations..............................................................................................10DHCP Implementation Considerations...........................................................................................10Microsoft Active Directory® Service Overview..............................................................................11Support <strong>for</strong> Active Directory Service (Including Single Sign-On Capability).......................................12Implementation Considerations..........................................................................................................12ADS/ADX/SCT Considerations...........................................................................................................13Child Device Considerations...............................................................................................................13In<strong>for</strong>mation Obtained from Active Directory Services.........................................................................14Service Account..................................................................................................................................14MSEA-SSO User Group.....................................................................................................................15<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>1


Disabling User Account Control..........................................................................................................55Metasys Dial-up <strong>Network</strong>ing............................................................................................................55Data Sharing with Published Web Services...................................................................................56<strong>Network</strong> Interface Cards (NICs).......................................................................................................56Appendix: Microsoft® Windows® Operating System <strong>and</strong> SQL Server Software LicenseRequirements...........................................................................................................................57Windows Operating System License Requirements............................................................57Operating System CALs...................................................................................................................57Purchasing <strong>and</strong> Designating CALs.................................................................................................58Licensing Modes <strong>and</strong> CAL Examples.............................................................................................59SQL Server 2008 Licensing Requirements............................................................................59SQL Server 2012 Licensing Requirements............................................................................60ADS Requirements..................................................................................................................61Appendix: SNMP Agent Protocol Implementation................................................................62Overview............................................................................................................................................62Limitations.........................................................................................................................................62Metasys SNMP MIB Files..................................................................................................................62Enterprise ID Number.......................................................................................................................62SNMP Traps.......................................................................................................................................62Trap Format........................................................................................................................................62Configuring Trap Filtering....................................................................................................................63Agent Restart Trap..............................................................................................................................63Alarm Raised Trap..............................................................................................................................63Alarm Clear Trap.................................................................................................................................63Alarm Synchronization........................................................................................................................63Trap Cases..........................................................................................................................................63SNMP Get Requests...........................................................................................................................64Appendix: Active Directory Service.......................................................................................79Overview............................................................................................................................................79Infrastructure Questions..................................................................................................................79Primary Requirements......................................................................................................................80ADS/ADX Computer...........................................................................................................................80SCT Computer....................................................................................................................................80Client Computer..................................................................................................................................80Additional Requirements.................................................................................................................81Appendix: Windows Server OS Considerations...................................................................82Administrator Rights........................................................................................................................82Services.............................................................................................................................................82Internet Explorer Enhanced Security Configuration.....................................................................82Software Supported on Windows Server Plat<strong>for</strong>ms......................................................................83Configuring <strong>the</strong> Computer as an Application Server <strong>for</strong> Use as an ADX....................................83Appendix: Windows Desktop OS Considerations................................................................84Folder Structure................................................................................................................................84Administrator Rights........................................................................................................................84Services.............................................................................................................................................85Internet Explorer Web Browser Settings........................................................................................85Software Supported..........................................................................................................................85Windows Features Not Supported by Metasys Software..............................................................85Windows Scheduled Features.........................................................................................................86<strong>Technical</strong> <strong>Bulletin</strong>3


Document IntroductionThis document contains important in<strong>for</strong>mation about connecting a Metasys® system to your network. From an <strong>IT</strong>perspective, a Metasys system device is simply a node on <strong>the</strong> network. But, <strong>the</strong> Metasys system uses communicationprotocols, security methods, <strong>and</strong> o<strong>the</strong>r technologies that you should consider.This document is intended <strong>for</strong> <strong>the</strong> Building Automation System (<strong>BAS</strong>) professional <strong>and</strong> contains everything in <strong>the</strong><strong>Network</strong> <strong>and</strong> <strong>IT</strong> Considerations <strong>for</strong> <strong>the</strong> <strong>IT</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201578) as well as supplementaldefinitions <strong>and</strong> concepts to help you interact with a network technologist.Important: Engage appropriate network security professionals to ensure <strong>the</strong> computer hosting <strong>the</strong> Site Director isa secure host <strong>for</strong> Internet access. <strong>Network</strong> security is an important issue. Typically, <strong>the</strong> <strong>IT</strong> organizationmust approve configurations that expose networks to <strong>the</strong> Internet. Be sure to fully read <strong>and</strong> underst<strong>and</strong><strong>IT</strong> Compliance documentation <strong>for</strong> your site. Use care when per<strong>for</strong>ming steps on Metasys systemcomponents as restarts may be required that conflict with compliance requirements. For example,upgrading an ADS/ADX requires <strong>the</strong> computer be offline <strong>for</strong> a period of time. Similarly, installing newsoftware on <strong>the</strong> ADS/ADX may require a computer restart.Note: In this document, engine refers to all models of <strong>Network</strong> Automation Engine (NAE) 35, NAE45, NAE55,<strong>Network</strong> Integration Engine (NIE) 55, <strong>Network</strong> Control Engine (NCE) 25, NxE85, <strong>and</strong> LONWORKS® ControlServer (LCS) 85, unless noted o<strong>the</strong>rwise.Note: Application <strong>and</strong> Data Server (ADS) refers to all ADS products unless noted o<strong>the</strong>rwise.Note: Some products in this document are available only to specific markets.ConceptsKey Terms<strong>Network</strong>-related key terms are defined as follows.Active Directory ServiceA network operating technology that enables <strong>IT</strong> administrators to manage enterprise-wide in<strong>for</strong>mation from a centralrepository. This in<strong>for</strong>mation includes data center policy compliance <strong>and</strong> identity management (user logon accounts),which are used <strong>for</strong> both Microsoft® Windows® au<strong>the</strong>ntication (logon to <strong>the</strong> Windows operating system) as well asnetwork resource au<strong>the</strong>ntication (logon to enterprise-wide secured applications, such as e-mail).Active Directory Service Domain/Domain ControllerA collection of Domain Controllers that can be thought of as a security boundary <strong>for</strong> network resources. A DomainController provides <strong>the</strong> Active Directory service to network users <strong>and</strong> computers; stores directory data; <strong>and</strong> managesuser <strong>and</strong> domain interactions including <strong>the</strong> logon process, au<strong>the</strong>ntication, <strong>and</strong> directory searches.Active Directory Service SchemaThe <strong>for</strong>mal definition of all object <strong>and</strong> attribute data that can be stored in <strong>the</strong> directory; <strong>for</strong> example, user is an objecttype with attribute data of name, first name, last name, e-mail, <strong>and</strong> so on. The schema is made up of object classes<strong>and</strong> attributes. The base (or default) schema contains a rich set of object classes <strong>and</strong> attributes to meet <strong>the</strong> needsof most organizations, <strong>and</strong> is modeled after <strong>the</strong> ISO X.500 st<strong>and</strong>ard <strong>for</strong> services.Demilitarized Zone (DMZ)A portion of <strong>the</strong> network located between <strong>the</strong> Internet <strong>and</strong> <strong>the</strong> intranet. It is a buffered area that is usually protectedby two or more firewalls.Domain Name System (DNS)The method by which host domain names are translated into IP addresses. A domain name is a meaningful <strong>and</strong>easy-to-remember h<strong>and</strong>le <strong>for</strong> an Internet address. domain name system (DNS) is <strong>the</strong> Internet st<strong>and</strong>ard <strong>for</strong> naminghost devices <strong>and</strong> mapping host names to IP addresses.Dynamic Host Configuration Protocol (DHCP)A communications protocol that lets network administrators centrally manage <strong>and</strong> automate <strong>the</strong> assignment of IPaddresses in an organization’s network.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>4


Dynamic Host Configuration Protocol (DHCP) lets a network administrator supervise <strong>and</strong> distribute IP addressesfrom a central point <strong>and</strong> automatically sends a new IP address when a device is plugged into a different location on<strong>the</strong> network. DHCP can also assign dial-up users an IP address automatically when <strong>the</strong>y connect to <strong>the</strong> network.Some DHCP servers can support fixed addresses <strong>for</strong> devices that need a static IP address.The engine, ADS, Extended Application <strong>and</strong> Data Server (ADX), TEC20 Coordinator, <strong>and</strong> Many-to-One WirelessRoom Temperature Sensing Receiver (WRS-RTN) can obtain <strong>the</strong>ir IP addresses <strong>and</strong> o<strong>the</strong>r network in<strong>for</strong>mationusing DHCP. Each Metasys device that can connect to <strong>the</strong> E<strong>the</strong>rnet network needs a unique IP address. WithoutDHCP, <strong>the</strong> IP address must be entered manually <strong>for</strong> each device; <strong>and</strong>, if <strong>the</strong> devices are moved to ano<strong>the</strong>r subneton <strong>the</strong> network, you must enter a new IP address. The Metasys system supports both dynamic <strong>and</strong> static IP addressassignments.FirewallA firewall combines hardware <strong>and</strong> software to provide a security system that prevents unauthorized access from<strong>the</strong> Internet to <strong>the</strong> intranet. When engines have access to <strong>the</strong> Internet, firewalls typically are installed to preventoutsiders from accessing private data resources <strong>and</strong> to control which outside resources its own users can access.ForestOne or more domains that share a common schema <strong>and</strong> global catalog. Forests are normally organized hierarchically.The hierarchy is determined by <strong>the</strong> <strong>IT</strong> organization.Integrated Windows Au<strong>the</strong>nticationAn au<strong>the</strong>ntication method <strong>for</strong> directory security on a web server. Integrated Windows au<strong>the</strong>ntication uses acryptographic exchange with <strong>the</strong> user’s Internet Explorer® web browser to confirm <strong>the</strong> identity of <strong>the</strong> user <strong>and</strong> thusau<strong>the</strong>nticate <strong>the</strong> user to access <strong>the</strong> web server resource (such as a web service or a file).KerberosA network au<strong>the</strong>ntication protocol designed to provide strong au<strong>the</strong>ntication <strong>for</strong> client/server applications by usingsecret-key cryptography. Kerberos is <strong>the</strong> primary security protocol <strong>for</strong> au<strong>the</strong>ntication within an Active Directoryservice domain.Lightweight Directory Access Protocol (LDAP)A st<strong>and</strong>ard communication protocol <strong>for</strong> directories located on networks. Lightweight Directory Access Protocol(LDAP) defines how a directory client can access a directory server <strong>and</strong> how <strong>the</strong> client can per<strong>for</strong>m directory operations<strong>and</strong> share directory data.Microsoft Message Queuing (MSMQ)A technology that supports reliable, persistent storage of messages that require processing when <strong>the</strong> recipient deviceis temporarily offline or busy. Refer to http://www.microsoft.com <strong>for</strong> in<strong>for</strong>mation on Microsoft Message Queuing(MSMQ).<strong>Network</strong> Address Translation (NAT)A protocol that enables a local area network to use one set of IP addresses <strong>for</strong> internal traffic <strong>and</strong> registered IPaddresses <strong>for</strong> external traffic.NT LAN Manager (NTLM)A network au<strong>the</strong>ntication protocol developed by Microsoft Corporation. NT LAN Manager (NTLM) is <strong>the</strong> secondaryprotocol <strong>for</strong> au<strong>the</strong>ntication within an Active Directory service domain. If a domain client or domain server cannot useKerberos au<strong>the</strong>ntication, <strong>the</strong>n NTLM au<strong>the</strong>ntication is used.Organizational Units (OU)A container within Active Directory service that should be used to reflect <strong>the</strong> details of <strong>the</strong> organization’s businessstructure or to delegate administrative control over smaller groups of users, groups, <strong>and</strong> resources. An organizationalunit (OU) inherits security policies from <strong>the</strong> parent domain <strong>and</strong> parent OU unless it is specifically disabled.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>5


Point-to-Point Protocol (PPP)A protocol <strong>for</strong> communication between two computers using a serial interface, typically a computer connected byphone line to a server. For example, your Internet service provider may provide you with a Point-to-Point Protocol(PPP) connection so that <strong>the</strong> provider’s server can respond to your requests, pass <strong>the</strong>m on to <strong>the</strong> Internet, <strong>and</strong><strong>for</strong>ward your requested Internet responses back to you. PPP uses IP (<strong>and</strong> is designed to h<strong>and</strong>le o<strong>the</strong>rs). It issometimes considered a member of <strong>the</strong> TCP/IP suite of protocols. Relative to <strong>the</strong> Open Systems Interconnection(OSI) reference model, PPP provides layer 2 (data-link layer) service. Essentially, it packages your computer TCP/IPpackets <strong>and</strong> <strong>for</strong>wards <strong>the</strong>m to <strong>the</strong> server where <strong>the</strong>y can be placed on <strong>the</strong> Internet.Service Account in Active Directory ServiceA login account assigned to an application to enable <strong>the</strong> application to per<strong>for</strong>m privileged actions within ActiveDirectory service; <strong>the</strong> Metasys system requires one or more Service Accounts to be assigned to allow <strong>the</strong> systemto per<strong>for</strong>m directory queries <strong>and</strong> request Active Directory service au<strong>the</strong>ntication. Only one Service Account is allowedper domain.Security Identification (SID)An alphanumeric character string that uniquely identifies Active Directory service users <strong>and</strong> groups within ActiveDirectory service. Unlike a user name or group name, which may be renamed, <strong>the</strong> Security Identification (SID)remains constant throughout <strong>the</strong> life of <strong>the</strong> user account or group.Simple Mail Transfer Protocol (SMTP)A protocol <strong>for</strong> sending e-mail messages between servers. Most e-mail systems that send mail over <strong>the</strong> Internet useSimple Mail Transfer Protocol (SMTP) to send messages from one server to ano<strong>the</strong>r. The messages can <strong>the</strong>n beretrieved with an e-mail client using ei<strong>the</strong>r Post Office Protocol (POP) or Internet Message Access Protocol (IMAP).Simple <strong>Network</strong> Management Protocol (SNMP)The primary protocol governing IP network management <strong>and</strong> <strong>the</strong> monitoring of IP network devices <strong>and</strong> <strong>the</strong>ir functions.It is not necessarily limited to TCP/IP networks.Simple <strong>Network</strong> Time Protocol (SNTP)A simplified version of <strong>Network</strong> Time Protocol (NTP). These protocols allow one computer to ask ano<strong>the</strong>r computerwhat time it is across a TCP/IP network, <strong>the</strong>n set its own clock accordingly. A number of public Simple <strong>Network</strong> TimeProtocol (SNTP) time servers keep track of time with a very high degree of accuracy that can be used to ensure <strong>the</strong>Site Director is synched to real time. You can find lists of public SNTP time servers by per<strong>for</strong>ming a search on <strong>the</strong>Internet.Transmission Control Protocol (TCP)A set of rules (protocol) used along with IP to send data in <strong>the</strong> <strong>for</strong>m of message units between computers over <strong>the</strong>Internet <strong>and</strong> on o<strong>the</strong>r networks commonly referred to as intranets or extranets. Whereas IP takes care of h<strong>and</strong>ling<strong>the</strong> actual delivery of <strong>the</strong> data, Transmission Control Protocol (TCP) keeps track of <strong>the</strong> individual units of data (calledpackets) into which a message is divided <strong>for</strong> efficient routing through <strong>the</strong> Internet.User Account in Active Directory ServiceA login account assigned to a user that is created, stored, <strong>and</strong> maintained only within Active Directory service; thisUser Account provides access to Active Directory service <strong>Network</strong> Resources. It may also provide access to <strong>the</strong>Metasys system when added <strong>and</strong> privileged using <strong>the</strong> Metasys Security Administrator System.User Datagram Protocol (UDP)A communications protocol that offers a limited amount of service when messages are exchanged between computersin a network that uses IP. User Datagram Protocol (UDP) is an alternative to TCP. Like TCP, UDP uses <strong>the</strong> InternetProtocol to actually get a data unit (called a datagram) from one computer to ano<strong>the</strong>r. Unlike TCP, UDP does notdivide a message into packets (datagrams) <strong>and</strong> reassemble it at <strong>the</strong> o<strong>the</strong>r end. Specifically, UDP does not providesequencing of <strong>the</strong> packets that <strong>the</strong> data arrives in; <strong>the</strong>re<strong>for</strong>e, <strong>the</strong> application program that uses UDP must ensurethat <strong>the</strong> entire message has arrived <strong>and</strong> is in <strong>the</strong> right order.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>6


Virtual Private <strong>Network</strong> (VPN)A private data network that uses <strong>the</strong> public telecommunication infrastructure <strong>and</strong> <strong>the</strong> Internet, maintaining privacythrough <strong>the</strong> use of tunneling protocol <strong>and</strong> security procedures (encrypting data be<strong>for</strong>e sending it through <strong>the</strong> publicnetwork <strong>and</strong> decrypting it at <strong>the</strong> receiving end).Related DocumentationTable 1: Related In<strong>for</strong>mationFor In<strong>for</strong>mation OnSee DocumentL<strong>IT</strong> NumberThe Metasys SystemMetasys System Extended ArchitectureOverview <strong>Technical</strong> <strong>Bulletin</strong>L<strong>IT</strong>-1201527Access Settings <strong>and</strong> Users/Roles in <strong>the</strong>SystemSecurity Administrator System <strong>Technical</strong><strong>Bulletin</strong>L<strong>IT</strong>-1201528Security Database Backup/RestoreTime, Date, Time Zone, <strong>and</strong> TimeSynchronizationMetasys system HelpNAE Commissioning GuideADS/ADX Commissioning GuideLCS85 Commissioning GuideL<strong>IT</strong>-1201793 1L<strong>IT</strong>-1201519L<strong>IT</strong>-1201645L<strong>IT</strong>-12011568Interaction between an N1 <strong>Network</strong> <strong>and</strong><strong>the</strong> NIEN1 Migration with <strong>the</strong> NIE <strong>Technical</strong><strong>Bulletin</strong>L<strong>IT</strong>-1201535BACnet® <strong>Network</strong> <strong>and</strong> a Metasys<strong>Network</strong> InteractionSNMP <strong>for</strong> <strong>Network</strong> MonitoringBACnet Controller Integration withNAE/NCE <strong>Technical</strong> <strong>Bulletin</strong>Metasys system HelpL<strong>IT</strong>-1201531L<strong>IT</strong>-1201793 11 This L<strong>IT</strong> number represents a print-friendly version of <strong>the</strong> Help.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> ConsiderationsComputer Hardware Configuration RequirementsComputer minimum hardware configurations are based upon experience <strong>and</strong> testing <strong>for</strong> both client <strong>and</strong> serverplat<strong>for</strong>ms <strong>and</strong> are published in <strong>the</strong> literature <strong>for</strong> each component of <strong>the</strong> Metasys system. Follow <strong>the</strong>se requirements.Computers running Metasys software must per<strong>for</strong>m simultaneous tasks that require both hardware <strong>and</strong> networkresources, <strong>and</strong> optional or advanced features require a large amount of memory <strong>for</strong> proper per<strong>for</strong>mance. Examplesof <strong>the</strong> optional features of <strong>the</strong> Metasys system include advanced navigation <strong>and</strong> support <strong>for</strong> complex graphics,operation with <strong>the</strong> maximum number of concurrent users, complex <strong>and</strong> extended queries with <strong>the</strong> Metasys ExportUtility, support <strong>for</strong> large network integrations, extensive use of trending, <strong>and</strong> large numbers of concurrent openwindows.It is important to note that operating systems <strong>and</strong> computing capabilities change rapidly. A computer that is adequate<strong>for</strong> today’s applications may be inadequate in a year if additional system features <strong>and</strong> functions are required.Configuration requirements may be upgraded on a regular basis to reflect <strong>the</strong>se changes.Refer to <strong>the</strong> Metasys System Configuration Guide (L<strong>IT</strong>-12011832) <strong>for</strong> specific computer requirements.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>7


Metasys Device IP Address Assignment (DHCP or Manual)See Table 2 <strong>for</strong> IP address assignment rules in <strong>the</strong> Metasys system.Table 2: IP Address AssignmentsDevice Dynamic AddressingStatic AddressingCommentsNAE/NCESupportedRecommended when <strong>the</strong>NAE/NCE is <strong>the</strong> Site Director 1• The NAE/NCE is a supervisorycontroller/engine.• NAE85s are installed on server-classcomputers, but all o<strong>the</strong>r models arest<strong>and</strong>-alone devices on <strong>the</strong> IP network.• The NAE45-Lite cannot be <strong>the</strong> SiteDirector. It must reside under anADS-Lite Site Director.NIENot SupportedRequired• A DHCP server can be configured toassign a particular IP address to aparticular MAC address; <strong>the</strong>re<strong>for</strong>e, DHCPcan be used to assign a static IP addressto a device.• The NIE is a supervisorycontroller/engine.• NIE85s are installed on server-classcomputers, but <strong>the</strong> NIE55s <strong>and</strong> NIE59sare st<strong>and</strong>-alone devices on <strong>the</strong> IPnetwork.LCSSupportedRecommended when <strong>the</strong> LCS85is <strong>the</strong> Site Director 1• The NAE/NCE is a supervisorycontroller/engine.• LCS85s are installed on server-classcomputers.• DHCP is supported as long as <strong>the</strong> sameaddress is assigned to <strong>the</strong> LCS85 aftera restart or shut down <strong>for</strong> an extendedperiod of time. If a new address isassigned, you must reconfigure <strong>the</strong>LONWORKS software driver <strong>and</strong> updatesettings <strong>for</strong> <strong>the</strong> LCS85 designated as <strong>the</strong>configuration server.ADS/ADXSupportedRecommended when <strong>the</strong>ADS/ADX is <strong>the</strong> Site Director 1The ADS is loaded on a desktop-classcomputer <strong>and</strong> <strong>the</strong> ADX is installed on aserver-class computer.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>8


Table 2: IP Address AssignmentsDevice Dynamic AddressingStatic AddressingCommentsTEC20-3C-2Supported <strong>for</strong> primary portonlyRecommended <strong>for</strong> primary port;required <strong>for</strong> secondary port• Enable DHCP only if your network hasone or more DHCP servers. O<strong>the</strong>rwise,<strong>the</strong> TEC20-3C-2 Coordinator maybecome unreachable over <strong>the</strong> network.• Only <strong>the</strong> primary E<strong>the</strong>rnet connection PRI(NET1, LAN1) can be enabled to useDHCP. The secondary E<strong>the</strong>rnetconnection SEC (NET2, LAN2) can onlyuse static IP addressing.• A new TEC20-3C-2 Coordinator isfactory-configured with an IP address of192.168.1.12n <strong>and</strong> a submask of255.255.255.0, where n equals <strong>the</strong> lastnumber in <strong>the</strong> TEC20-3C-2 Coordinatorserial number. When commissioning <strong>the</strong>device with <strong>the</strong> TEC WirelessConfiguration Tool, do not assign yourcomputer with <strong>the</strong> same IP address as<strong>the</strong> TEC20-3C-2 Coordinator’sfactory-assigned IP address.WRS-RTNSupportedRecommended if communicationissues arise• If your network uses network addresstranslation (NAT) to communicate across<strong>the</strong> Internet, <strong>the</strong> NATs must provide staticinternal <strong>and</strong> external IP addresses. If youare using DHCP to assign addresses todevices that communicate acrossnetworks that use NATs, your DHCPserver should be configured to alwaysallocate <strong>the</strong> exact same IP address as<strong>the</strong> Metasys system devices' MACaddresses. This configuration makes<strong>the</strong>se devices behave as if <strong>the</strong>y havestatic IP addresses, although <strong>the</strong>y haveDHCP addresses. This behaviorsometimes is called DynamicallyAssigned, Statically Allocated addressingfrom a DHCP server.• The data transmission over E<strong>the</strong>rnetbetween a WRS-RTN <strong>and</strong> an engineconsumes very little b<strong>and</strong>width (less than1.5% of <strong>the</strong> usable b<strong>and</strong>width on a 10Mbps E<strong>the</strong>rnet network, based onmaximum device loading). Refer to <strong>the</strong>WRS Series Many-to-One WirelessRoom Temperature Sensing System<strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-12011095) <strong>for</strong>details.1 The Site Director is <strong>the</strong> device designated to maintain <strong>the</strong> site in<strong>for</strong>mation by holding <strong>the</strong> Site object, which contains in<strong>for</strong>mationabout <strong>the</strong> logical organization of data about your facility, user password administrative in<strong>for</strong>mation, <strong>and</strong> overall master time<strong>and</strong> date. This function resides in an engine, or an ADS/ADX on large installations. Although an engine can be a Site Director,if <strong>the</strong> site has an ADS/ADX, <strong>the</strong>n an ADS/ADX must be <strong>the</strong> Site Director. The Site Director provides a uni<strong>for</strong>m point of entry<strong>and</strong> supports functions such as user logon, user administration, time synchronization, <strong>and</strong> traffic management.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>9


Metasys Device Hostname Resolution (DNS or Hosts File)If DHCP servers are available on <strong>the</strong> network <strong>and</strong> DHCP is enabled on <strong>the</strong> Metasys system devices, a DHCP servercan automatically assign <strong>the</strong> addresses of <strong>the</strong> DNS servers to some devices. Alternatively, <strong>the</strong> DNS server addressesmay be manually assigned. See Table 2 <strong>for</strong> specifics <strong>for</strong> each device.If <strong>the</strong> network does not support DNS, <strong>the</strong>n <strong>the</strong> hosts file or registry entries of <strong>the</strong> Site Director must be updated with<strong>the</strong> host name/IP address pairs <strong>for</strong> all engines/servers on <strong>the</strong> Metasys site, <strong>and</strong> each child device (non-Site Directorengine/server) must be updated with <strong>the</strong> host name/IP address pair of <strong>the</strong> Site Director (<strong>and</strong> any o<strong>the</strong>r E<strong>the</strong>rnet-baseddevice with which it communicates).Ei<strong>the</strong>r DNS or local host file updates are necessary <strong>for</strong> successful communication between a Site Director <strong>and</strong> alldevices on <strong>the</strong> Metasys site.We recommend using DNS scavenging to ensure old host records are cleaned up properly. The recommendedscavenging interval is <strong>the</strong> same interval as <strong>the</strong> DHCP lease time.For in<strong>for</strong>mation on configuring DHCP <strong>and</strong> DNS on an engine, refer to <strong>the</strong> NAE Commissioning Guide (L<strong>IT</strong>-1201519)or LCS85 Commissioning Guide (L<strong>IT</strong>-12011568). For in<strong>for</strong>mation on configuring DHCP <strong>and</strong> DNS <strong>for</strong> an ADS/ADX,refer to Microsoft® Windows operating system literature. Also refer to <strong>the</strong> TEC Series Wireless Thermostat ControllerSystem <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-12011414) <strong>and</strong> WRS Series Many-to-One Wireless Room Temperature SensingSystem <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-12011095) <strong>for</strong> DHCP <strong>and</strong> DNS in<strong>for</strong>mation on those respective devices.DNS Implementation ConsiderationsThe DNS infrastructure must be configured to do <strong>the</strong> following:• The Metasys server <strong>and</strong>/or Metasys engine <strong>and</strong> Metasys DHCP supported devices (TEC20-3C-2 Coordinators,WRS-RTN Many-to-One Receivers) must be defined in <strong>the</strong> same DNS domain.• The Metasys server <strong>and</strong>/or Metasys engine <strong>and</strong> Metasys DHCP supported devices (TEC20-3C-2 Coordinators,WRS-RTN Many-to-One Receivers) require DNS servers defined to resolve hosts in <strong>the</strong> domain <strong>the</strong>y are in.• If <strong>the</strong> DNS server <strong>and</strong> <strong>the</strong> Metasys server <strong>and</strong>/or Metasys engine are in different networks (VLANs), routing mustbe available between networks.DHCP Implementation ConsiderationsFor Metasys devices to function properly in a DHCP implementation, <strong>the</strong> DHCP servers must support dynamic DNS.The DHCP infrastructure must be configured to do <strong>the</strong> following:• The DHCP server must create an A record in <strong>the</strong> defined DNS domain upon h<strong>and</strong>ing a lease to a Metasys device.Optionally, you can configure <strong>the</strong> DHCP server to update <strong>the</strong> PTR (pointer) record of <strong>the</strong> Metasys DHCP supporteddevice in <strong>the</strong> reverse zone DNS domain.• The domain <strong>for</strong> DNS updates must be included in <strong>the</strong> DHCP server configuration. The Metasys DHCP supporteddevice does not specify <strong>the</strong> domain.• The Metasys server <strong>and</strong>/or Metasys engine <strong>and</strong> <strong>the</strong> Metasys DHCP supported devices (TEC20-3C-2 Coordinators<strong>and</strong> WRS-RTN Many-to-One Receivers) all must be in <strong>the</strong> same DNS domain.• We recommend that <strong>the</strong> Metasys server <strong>and</strong>/or Metasys engine <strong>and</strong> <strong>the</strong> Metasys DHCP supported devices(TEC20-3C-2 Coordinators <strong>and</strong> WRS-RTN Many-to-One Receivers) be in a separate VLAN from all o<strong>the</strong>r devicesat <strong>the</strong> Metasys site.• If <strong>the</strong> DNS server, Metasys server, Metasys engine, <strong>and</strong>/or Metasys DHCP supported devices (TEC20-3C-2Coordinators <strong>and</strong> WRS-RTN Many-to-One Receivers) are in different networks (VLANs), ensure that routing isavailable between networks <strong>and</strong> that a proper router is passed in <strong>the</strong> DHCP lease.• If <strong>the</strong> DHCP server is not in <strong>the</strong> same VLAN as <strong>the</strong> Metasys devices, enable DHCP <strong>for</strong>warding to <strong>the</strong> properDHCP server on <strong>the</strong> VLANs on which <strong>the</strong> Metasys devices are located.Metasys devices require that you configure <strong>the</strong> DHCP options in Table 3 in <strong>the</strong> DHCP server in addition to <strong>the</strong> IPaddress <strong>and</strong> subnet mask.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>10


Support <strong>for</strong> Active Directory Service (Including Single Sign-On Capability)Table 4 is a summary of which Metasys system application UIs support Active Directory logons <strong>and</strong> <strong>the</strong> SSO capability.If <strong>the</strong> application supports Active Directory logons, <strong>the</strong>n <strong>the</strong> Metasys system can be configured to use your existing<strong>IT</strong> Active Directory Service infrastructure <strong>for</strong> au<strong>the</strong>ntication purposes. If <strong>the</strong> application supports SSO, <strong>the</strong>n you canlog on to multiple, secured applications without reentering <strong>the</strong> same user name <strong>and</strong> password.Table 4: Products That Support Active Directory Logons <strong>and</strong> SSOApplicationActive Directory Logons SupportedSSO SupportedADS Site Management Portal UIADX Site Management Portal UISCTMetasys Advanced Reporting SystemReady Access PortalEngine 4YesYesYes 1NoYes (Computer) No (H<strong>and</strong>held)NoYesYesYesNo 2No 3No1 If you are using <strong>the</strong> SCT Manager to switch between SCT versions, do not use <strong>the</strong> Active Directory service. SCT versionsmanaged this way do not support <strong>the</strong> integration of <strong>the</strong> Metasys system with <strong>the</strong> Active Directory service.2 If you are using Metasys Advanced Reporting System UI on an ADX, you still can use <strong>the</strong> SSO capability to log on to <strong>the</strong> ADXSite Management Portal UI. For example, if you have an ADX with <strong>the</strong> Metasys Advanced Reporting System, you can useSSO to log on to <strong>the</strong> ADX Site Management Portal UI but you must enter your Metasys system user name <strong>and</strong> password pairto log on to <strong>the</strong> reporting system.3 If you are using Ready Access Portal UI on an ADS/ADX, you still can use <strong>the</strong> SSO capability to log on to <strong>the</strong> ADS/ADX SiteManagement Portal UI. For example, if you have an ADX with <strong>the</strong> Ready Access Portal software installed on it, you can useSSO to log on to <strong>the</strong> ADX Site Management Portal UI but you must enter your Metasys system user name <strong>and</strong> password pairto log on to <strong>the</strong> Ready Access Portal UI.4 The engine Site Management Portal UI does not support au<strong>the</strong>ntication with Active Directory service. If you have an ADS/ADXSite Director, however, you can log on to <strong>the</strong> ADS/ADX Site Management Portal UI using SSO <strong>and</strong> access system in<strong>for</strong>mation<strong>for</strong> <strong>the</strong> entire site, including details on <strong>the</strong> engine.For more details on Active Directory <strong>and</strong> SSO interaction with Metasys system security, refer to <strong>the</strong> SecurityAdministrator System <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201528).Implementation ConsiderationsThe Active Directory service feature as implemented on <strong>the</strong> Metasys system uses <strong>the</strong> existing Active Directoryservice infrastructure at <strong>the</strong> customer site. The following are important considerations:• Active Directory service users in Windows Server® 2012, Windows Server 2008 R2 with SP1, or Windows Server2008 SP2 domains <strong>and</strong> read-only domains are supported.• Use of a Windows Server 2012, Windows Server 2008 R2 SP1, or Windows Server 2008 SP2 read-only domaincontroller is determined by <strong>the</strong> <strong>IT</strong> department that is responsible <strong>for</strong> setting up accounts <strong>for</strong> au<strong>the</strong>ntication against<strong>the</strong> domain controller. SSO <strong>and</strong> Active Directory service logins function with <strong>the</strong> Windows Server 2012, WindowsServer 2008 R2 SP1, or Windows Server 2008 SP2 read-only domain controller whe<strong>the</strong>r <strong>the</strong> primary read-onlydomain controller is online, offline, or not accessible (as long as <strong>the</strong> Active Directory service user credentials arecached in <strong>the</strong> read-only controller). If a trust relationship exists between <strong>the</strong> read-only domain controller <strong>and</strong>ano<strong>the</strong>r domain, <strong>the</strong> Active Directory service login functions properly as long as <strong>the</strong> trusted domain is accessible.In this case, Kerberos manages <strong>the</strong> <strong>for</strong>warding to <strong>the</strong> correct domain. SSO does not work <strong>for</strong> an Active Directoryservice user in a trusted domain of a read-only domain controller because SSO uses NTLM <strong>and</strong> <strong>the</strong> messageis not <strong>for</strong>warded.• The default Active Directory services schema is supported. For details, see In<strong>for</strong>mation Obtained from ActiveDirectory Services.• NTLMv2 is required to accomplish strict SSO login-free access to <strong>the</strong> Metasys system using IIS WindowsIntegrated Au<strong>the</strong>ntication. All o<strong>the</strong>r au<strong>the</strong>ntication is per<strong>for</strong>med using Kerberos, which includes <strong>the</strong> Active Directoryservice user name, password, <strong>and</strong> domain selection at <strong>the</strong> Metasys system login screen <strong>and</strong> au<strong>the</strong>ntication toActive Directory services <strong>for</strong> LDAP queries.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>12


• The Metasys system does not store or manage <strong>the</strong> passwords of Active Directory service users. Active Directoryservice users who are given access to <strong>the</strong> Metasys system (identified by SID) are not created or managed by<strong>the</strong> Metasys system. The system maintains authorization permissions to <strong>the</strong> Metasys system only.• Active Directory service credentials provided at <strong>the</strong> Metasys system login screen are strongly encrypted be<strong>for</strong>ebeing sent over <strong>the</strong> network from <strong>the</strong> Site Management Portal UI to <strong>the</strong> ADS/ADX <strong>and</strong> SCT. Preceding <strong>the</strong> login,a Rivest, Shamir, <strong>and</strong> Adelman (RSA) exchange of an RC2 key occurs. For details, see <strong>Network</strong> MessageSecurity.• To ensure that Metasys system SSO works properly, <strong>the</strong> security policy <strong>Network</strong> Security: LAN Managerau<strong>the</strong>ntication level must be configured to compatible settings on <strong>the</strong> ADS/ADX <strong>and</strong> SCT computer, any SiteManagement Portal UI client machines, <strong>and</strong> <strong>the</strong> Active Directory service domain controller.• The Active Directory service structure may comprise one or more <strong>for</strong>ests consisting of one or more domains.The Metasys system does not require any particular Active Directory service structure. Users from any domainmay be given access privileges to <strong>the</strong> Metasys system, as long as appropriate trust relationships <strong>and</strong> privilegesexist within Active Directory services.• The ADS/ADX <strong>and</strong> SCT computer should be placed in an Active Directory service that is not affected by GroupPolicies (such as those typically applied to a desktop), which download software to <strong>the</strong> machine that may adverselyaffect Metasys system device operation.• A service account in Active Directory service consisting of an Active Directory user name, password, <strong>and</strong> domainis required. For details, see Service Account.• Trust relationships <strong>and</strong> privileges are dictated by <strong>the</strong> customer <strong>IT</strong> department <strong>and</strong> are a fundamental part of asecurity policy. Active Directory service implementation on <strong>the</strong> Metasys system does not dictate <strong>the</strong> trusts thatare established. While Active Directory services provide multiple domain support, <strong>the</strong> customer infrastructuredetermines whe<strong>the</strong>r this function is used.ADS/ADX/SCT ConsiderationsThe ADS/ADX or SCT computer that is h<strong>and</strong>ling user au<strong>the</strong>ntication <strong>and</strong> authorization must adhere to <strong>the</strong> followingrequirements to use <strong>the</strong> Active Directory services feature as implemented on <strong>the</strong> Metasys system:• ADS/ADX <strong>and</strong> SCT software must be at Release 4.1 or later.• ADS/ADX <strong>and</strong> SCT computer must be joined to an Active Directory service domain. This is necessary <strong>for</strong> SSOlogin-free access to <strong>the</strong> Metasys system using Windows Integrated Au<strong>the</strong>ntication. If <strong>the</strong> ADS/ADX <strong>and</strong> SCTare not joined to an Active Directory service domain, <strong>the</strong> Active Directory service user cannot use <strong>the</strong> login-freeaccess to <strong>the</strong> Metasys Site Management Portal UI, but <strong>the</strong> Active Directory service user may still specify <strong>the</strong>irActive Directory service user name, password, <strong>and</strong> domain at <strong>the</strong> login screen.• ADS/ADX <strong>and</strong> SCT computer must be configured to use Windows Integrated Au<strong>the</strong>ntication through IIS. WindowsIntegrated Au<strong>the</strong>ntication is configured by <strong>the</strong> Metasys installation program <strong>and</strong> is necessary <strong>for</strong> SSO login-freeaccess to <strong>the</strong> Metasys system.• ADS/ADX <strong>and</strong> SCT computer must be configured to allow Metasys system privileged Active Directory serviceusers access to <strong>the</strong> device from <strong>the</strong> network <strong>and</strong> read/execute access to <strong>the</strong> Metasys Single Sign-On web service.This is accomplished through <strong>the</strong> MSEA-SSO Windows user group that was created when <strong>the</strong> ADS/ADX or SCTsoftware was installed. For details, see MSEA-SSO User Group.• The hard disk on <strong>the</strong> ADS/ADX or SCT computer must be <strong>for</strong>matted <strong>for</strong> <strong>the</strong> NTFS, not <strong>the</strong> File Allocation Table(FAT) system.• ADS/ADX <strong>and</strong> SCT computer must not be running o<strong>the</strong>r third-party applications that compete with <strong>the</strong> Metasyssystem <strong>for</strong> computer resources.Child Device ConsiderationsChild devices such as engines do not use <strong>the</strong> Active Directory service; however, if <strong>the</strong> user logs on to a Site Directorwith Active Directory service credentials, <strong>the</strong>y may navigate to child devices, including engines. The child devices:• can be any combination of plat<strong>for</strong>ms illustrated in Figure 6• do not need to be at <strong>the</strong> same release as <strong>the</strong> Site Director• do not need to join an Active Directory service domain<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>13


In<strong>for</strong>mation Obtained from Active Directory ServicesThe Active Directory service used by <strong>the</strong> Metasys system reads a set of in<strong>for</strong>mation from <strong>the</strong> Active Directory servicedatabase <strong>and</strong> populates/updates <strong>the</strong> user’s Properties based on those values. The following in<strong>for</strong>mation is read,with <strong>the</strong> actual Active Directory service attribute names in paren<strong>the</strong>ses:• User name (samAccountName, userPrincipalName, CanonicalName)• Description (Description)• Full Name (displayName)• Email (mail)• Phone Number (telephoneNumber)• Account Disabled (UserAccountControl)In addition, <strong>the</strong> Security Identifier (ObjectSID) is obtained from <strong>the</strong> Active Directory service database <strong>and</strong> usedinternally to uniquely identify <strong>the</strong> Metasys user.Service AccountThe Active Directory services, as implemented on <strong>the</strong> Metasys system, require a service account in Active Directoryservice consisting of a user name, password, <strong>and</strong> domain. The feature uses this service account when executingLDAP queries of Active Directory service. The Active Directory service feature allows <strong>the</strong> use of one Service Accountto access all domains, or one Service Account per domain.The service account in Active Directory service must have directory read privileges. These privileges may be opento <strong>the</strong> entire directory or limited to only those organizational units <strong>and</strong> domains that contain Metasys privileged ActiveDirectory service users <strong>and</strong> groups. For some Active Directory service configurations, <strong>the</strong> <strong>IT</strong> department may dictatethat one service account is created per domain.The service account user name, password, <strong>and</strong> domain are defined by <strong>the</strong> customer <strong>IT</strong> department. This user shouldbe created with a non-expiring password. If <strong>the</strong> <strong>IT</strong> department requires <strong>the</strong> modification of <strong>the</strong> Service Accountpassword on a periodic basis, a Metasys system work process must be defined to update <strong>the</strong> password in <strong>the</strong>Security Administrator System at <strong>the</strong> time it is changed in Active Directory service. If <strong>the</strong> Service Account passwordin <strong>the</strong> Metasys system does not match <strong>the</strong> Service Account password in Active Directory service, Metasys systemaccess by Active Directory service users is denied.Service Account RulesWhen specifying a service account with <strong>the</strong> Metasys Security Administrator System, keep <strong>the</strong>se important rules inmind:• For each service account, use <strong>the</strong> user principal name (UPN) <strong>for</strong>mat <strong>for</strong> <strong>the</strong> user name. Provide <strong>the</strong> fully qualifieddomain name where <strong>the</strong> domain specifier is at <strong>the</strong> domain level. For example, usemetasys.service@my.corp.com instead of metasys.service@corp.com, even though <strong>the</strong> latter is a valid <strong>for</strong>mof <strong>the</strong> user name.• A blank password <strong>for</strong> a service account is prohibited.• The ability to specify more than one service account is available. You only need to specify more than one serviceaccount if an Active Directory service trust does not exist between <strong>the</strong> domain in which <strong>the</strong> service account iscreated <strong>and</strong> all o<strong>the</strong>r domains where Metasys users reside. In this case, specify one service account per domainwhere <strong>the</strong> Metasys users reside.• The service account user does not need to be part of <strong>the</strong> MSEA-SSO user group.• The Service Account should be configured with a non-expiring password; however, if <strong>the</strong> password is set toexpire, you need to reset it in <strong>the</strong> Metasys Security Administrator System each time you reset it on <strong>the</strong> ActiveDirectory service domain.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>14


Service Account PermissionsThe Metasys system requires that <strong>the</strong> service account in Active Directory service allow a minimal set of permissions.This section lists <strong>the</strong>se permissions, but does not dictate how <strong>the</strong>y should be applied; <strong>the</strong> customer <strong>IT</strong> departmentdetermines this at <strong>the</strong> time of creation. The required permissions include <strong>the</strong> following:• Read access to <strong>the</strong> domain object of each domain that contains Active Directory service users who are Metasyssystem users.• Read access to each organizational unit that contains Active Directory service users who are also Metasyssystem users.• Read access to <strong>the</strong> attributes of each User Object in Active Directory service that relates to Metasys systemusers or read access to only <strong>the</strong> following individual attributes on those user objects (if full read access is notallowed):- ObjectSID- samAccountName- displayName- Description- mail- userPrincipalName- telephoneNumber- UserAccountControl- CanonicalNameIn addition, a non-expiring Service Account password is required. See Service Account Rules. Also, <strong>the</strong> ServiceAccount must be able to access all domains with Metasys system users to per<strong>for</strong>m LDAP queries. For example,accounts cannot be denied access to <strong>the</strong> domain controller in <strong>the</strong> domain security policy.MSEA-SSO User GroupWhen <strong>the</strong> ADS/ADX or SCT is installed, a new user group called MSEA-SSO is created under <strong>the</strong> set of user groupson <strong>the</strong> computer. To allow <strong>the</strong> Active Directory service user SSO login-free access to <strong>the</strong> Metasys ADS/ADX or SCTsoftware, each Active Directory service user must be added to this user group. Alternatively, <strong>the</strong> <strong>IT</strong> professional cancreate an Active Directory service group intended solely <strong>for</strong> Metasys system users <strong>and</strong> place each Active Directoryservice user, who has permission to use <strong>the</strong> Metasys system, under that group. In this case, adding this ActiveDirectory service group to <strong>the</strong> MSEA-SSO user group provides access to all Metasys users defined under that ActiveDirectory service group.Note: The Active Directory service user you add to <strong>the</strong> MSEA-SSO group on <strong>the</strong> ADS/ADX or SCT computer mustbe defined on <strong>the</strong> same Active Directory service domain as <strong>the</strong> ADS/ADX or SCT computer, or on a trusteddomain.When <strong>the</strong> ADS/ADX <strong>and</strong> SCT software is present on <strong>the</strong> same computer, both applications share <strong>the</strong> same MSEA-SSOuser group. If <strong>the</strong> ADS/ADX <strong>and</strong> SCT software is installed on separate computers, <strong>the</strong> set of Active Directory serviceusers must be added separately to <strong>the</strong> MSEA-SSO group of both computers.Note: If <strong>the</strong> ADS/ADX or SCT computer is not in an Active Directory service domain, SSO login-free access is notavailable. Do not add any users to <strong>the</strong> MSEA-SSO group.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>15


The MSEA-SSO group has <strong>the</strong> following permissions on <strong>the</strong> ADS/ADX <strong>and</strong> SCT computer:• User Rights Assignment: Access this computer from <strong>the</strong> network:- In Windows 8, Windows 7, Windows Server 2012, or Windows Server 2008 R2 with SP1, select ControlPanel > System <strong>and</strong> Security > Administrative Tools > Local Security Policy > Local Policies- In Windows XP®, select Control Panel > Administrative Tools > Local Security Policy > Local Policies- In Windows Server 2008 SP2, select Control Panel > System <strong>and</strong> Maintenance > Administrative Tools >Local Security Policy > Local Policies• Read <strong>and</strong> execute access on <strong>the</strong> following web service file <strong>and</strong> directory:{IIS Drive <strong>and</strong> Directory}\wwwroot\MetasysIII\WS\Security\ActiveDirectory\ SingleSignOnService\ValidateSingleSignOnADUser.asmxUser Account RulesThe following rules apply to Active Directory service users who are added with <strong>the</strong> Metasys Security AdministratorSystem:• The UPN <strong>for</strong>mat is used <strong>for</strong> <strong>the</strong> user name, in which <strong>the</strong> fully qualified domain name is provided. For example,myUser@my.corp.com is specified instead of myUser@corp.com, even though <strong>the</strong> latter is a valid <strong>for</strong>m of<strong>the</strong> user name. The fully qualified user name appears on <strong>the</strong> main Metasys Site Management Portal UI screento identify <strong>the</strong> currently logged in user. It also appears as <strong>the</strong> user name on Metasys reports <strong>and</strong> logs.• Each specified user must exist <strong>and</strong> be enabled in Active Directory service. Properties of <strong>the</strong> user (<strong>for</strong> example,phone number <strong>and</strong> e-mail address) are read when <strong>the</strong> user is added to <strong>the</strong> Metasys system. These items aredisplayed by <strong>the</strong> Metasys Site Management Portal UI under User Properties. For details, see In<strong>for</strong>mation Obtainedfrom Active Directory Services.• If <strong>the</strong> user name <strong>for</strong> an Active Directory service user changes, you do not need to change <strong>the</strong> user’s name in<strong>the</strong> MSEA-SSO group or specify <strong>the</strong> new name with <strong>the</strong> Metasys System Administrative tool. The update of <strong>the</strong>new user name occurs within <strong>the</strong> Security Administrator System when you left-click <strong>the</strong> Active Directory serviceuser account.• If an Active Directory service user is deleted from <strong>the</strong> Active Directory service database, delete that user from<strong>the</strong> Metasys system as well. If, <strong>for</strong> any reason, an Active Directory service user with <strong>the</strong> same user name is lateradded to <strong>the</strong> Active Directory service database but you did not delete this user from <strong>the</strong> Metasys system, <strong>the</strong>new user cannot be added to Metasys until <strong>the</strong> original user is deleted.• If an Active Directory service user is disabled in <strong>the</strong> Active Directory service database, <strong>the</strong> Metasys AccessSuspended property check box under <strong>the</strong> user’s Properties window is selected. Once <strong>the</strong> service user <strong>for</strong> ActiveDirectory directory is re-enabled, a Metasys Administrator must manually click to clear <strong>the</strong> Metasys AccessSuspended property check box be<strong>for</strong>e <strong>the</strong> user can log on again.• The Metasys system follows <strong>the</strong> text case <strong>for</strong>mat dictated by Active Directory services. In o<strong>the</strong>r words, if youadd a user called MYUSER@my.corp.com, <strong>and</strong> <strong>the</strong> Active Directory service <strong>for</strong>mat uses all lowercase characters,<strong>the</strong> user name adjusts to myuser@my.corp.com when added.• At least one defined Service Account must have <strong>the</strong> privilege to read <strong>the</strong> user’s Active Directory service attributes.User Creation <strong>and</strong> PermissioningIn many organizations, different people need to be involved in <strong>the</strong> process of defining <strong>and</strong> maintaining Active Directoryservice users <strong>for</strong> <strong>the</strong> Metasys system.<strong>IT</strong> <strong>and</strong> Active Directory service Administrators create, delete, <strong>and</strong> update accounts in Active Directory service,including <strong>the</strong> provision of a Service Account <strong>for</strong> use by <strong>the</strong> Metasys system. They manage Active Directory serviceuser account passwords, password policies, <strong>and</strong> account policies.Metasys Administrators add existing Active Directory service users to <strong>the</strong> Metasys system, <strong>and</strong> assign Metasyssystem privileges using <strong>the</strong> Security Administrator System. They may also manage <strong>the</strong> users assigned to <strong>the</strong>MSEA-SSO user group on <strong>the</strong> ADS/ADX or SCT computer.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>16


Once you add an Active Directory service user to Metasys, <strong>the</strong> user is assigned privileges in <strong>the</strong> same manner asa local Metasys user. In fact, a user’s local Metasys account can be disabled or deleted once <strong>the</strong>ir Active Directoryservice user account is established, unless <strong>the</strong>re is an important reason <strong>for</strong> a user to have two accounts. An auditrecord is created whenever an Active Directory service user is added to or removed from <strong>the</strong> Metasys system.Web Site CachingIf you cache web pages to reduce b<strong>and</strong>width, you may experience problems with Metasys system graphics <strong>and</strong>schedules. These features still function normally, but <strong>the</strong> UI may appear distorted or dimmed. We recommend youdo not use web page caching.Microsoft Message Queuing (MSMQ) TechnologyIntroductionAs implemented in <strong>the</strong> Metasys system, MSMQ supports trending <strong>and</strong> Site Management Portal UI navigation treefeatures. The Site Director queue receives trend data <strong>and</strong> navigation tree changes from o<strong>the</strong>r system devices. When<strong>the</strong> Site Director is busy, <strong>the</strong> messages remain in <strong>the</strong> queue until <strong>the</strong> Site Director is available to process <strong>the</strong>m.Using MSMQ allows <strong>the</strong> system to avoid bottlenecks by separating <strong>the</strong> actions of receiving <strong>and</strong> processing data.MSMQ must be installed on all computers where ADS, ADX, <strong>and</strong> Ready Access Portal software is installed. Onceinstalled, do not stop or disable MSMQ. If MSMQ is stopped or disabled, <strong>the</strong> Site Director does not receive/processmessages. Lost trending data may be irrecoverable. The queue fills at a rate determined by your site configuration<strong>and</strong> system use; <strong>for</strong> example, trend frequency or number of additions, changes, or deletions made to <strong>the</strong> navigationtree.Note: Each Site Director <strong>and</strong> Ready Access Portal computer contain all <strong>the</strong> navigation in<strong>for</strong>mation <strong>for</strong> an entire sitein a cache known as <strong>the</strong> Navigation Tree Cache. This cache allows <strong>the</strong> Site Management Portal UI to displayquickly without repeated requests to system devices. Updates received through <strong>the</strong> MSMQ queue keep <strong>the</strong>Navigation Tree Cache in<strong>for</strong>mation current.An alarm is generated in <strong>the</strong> Metasys system when any trend or alarm sample remains in <strong>the</strong> MSMQ <strong>for</strong> more than10 minutes. This alarm usually indicates a problem with <strong>the</strong> Microsoft SQL Server or that a remote <strong>for</strong>wardingdestination is offline. See Figure 1 <strong>for</strong> an example of <strong>the</strong> Metasys alarm.Figure 1: MSMQ AlarmRecoveryWe recommend that you set MSMQ to restart after first, second, <strong>and</strong> subsequent failures.To set recovery action:1. In Control Panel, select Administrative Tools.2. Double-click Services.3. Right-click Message Queuing <strong>and</strong> select Properties. The Message Queuing Properties dialog box appears.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>17


4. On <strong>the</strong> Recovery Tab (in <strong>the</strong> First failure, Second failure, <strong>and</strong> Subsequent failures drop-down lists boxes) selectRestart <strong>the</strong> Service.5. Click OK.Queue TroubleshootingUnder normal operation, Metasys message queues are empty or near zero. If <strong>the</strong>re is a problem with trend <strong>for</strong>warding,<strong>the</strong> messages remain in <strong>the</strong> backlog queue <strong>and</strong> queue size increases. If this occurs, <strong>and</strong> <strong>the</strong> queues become full,permanent data loss can result.Note: This procedure requires that you have Windows Administrator access on your computer. Per<strong>for</strong>m thisprocedure on all ADSs/ADXs on your site. If you have a split ADX, per<strong>for</strong>m this procedure on <strong>the</strong> DatabaseServer computer.To see <strong>the</strong> size of your MSMQ queue:1. Using Windows Explorer, right-click My Computer <strong>and</strong> select Manage. Depending on your operating system, <strong>the</strong>Computer Management tor Server Management screen appears.2. Do <strong>the</strong> following depending on your operating system:• On Windows 8, Windows 7, or Windows Server 2008 R2 SP1, in <strong>the</strong> tree in <strong>the</strong> left pane, browse to Services<strong>and</strong> Applications > Message Queueing > Private Queues.• On Windows XP, in <strong>the</strong> tree in <strong>the</strong> left pane, browse to Services <strong>and</strong> Applications > Message Queuing >Private Queues.• On Windows Server 2008 SP2, browse to Features > Message Queuing > Private Queues.3. If <strong>the</strong> Number of Messages column <strong>for</strong> <strong>the</strong> Metasys queues (particularly metasys_trendbacklog) contains anumber that is growing or not zero, you may have an issue with trend <strong>for</strong>warding that requires fur<strong>the</strong>r investigation.You may need to resize <strong>the</strong> window if this column is not visible.Metasys System <strong>and</strong> Virtual EnvironmentsJohnson Controls recognizes <strong>the</strong> benefits <strong>and</strong> popularity of running software applications in virtual environmentsusing software such as VMWare® <strong>and</strong> Microsoft Hyper-V Server 2008 R2. Virtual environments allow multiple,independent instances of an operating system to function on a single computer hardware plat<strong>for</strong>m. Many <strong>IT</strong>organizations have embraced <strong>the</strong> economic benefits of deploying applications in virtual environments. AlthoughJohnson Controls does not <strong>for</strong>mally support virtual environments, <strong>the</strong> Metasys system functions under certain virtualenvironments <strong>and</strong> requires that you consider <strong>the</strong> following important factors:• Supported Operating Systems: Run only supported operating systems in your virtual environment. For a listof supported operating systems, refer to <strong>the</strong> technical literature <strong>for</strong> <strong>the</strong> product you are installing.• Operating System Installation: You must install <strong>the</strong> operating system software <strong>and</strong> apply <strong>the</strong> appropriateservice packs following <strong>the</strong> procedures in <strong>the</strong> ADS, ADX, <strong>and</strong> SCT Installation <strong>and</strong> Upgrade Wizard(L<strong>IT</strong>-12011521).Note: Ensure <strong>the</strong> correct manufacturer drivers are installed <strong>and</strong> do not use generic Windows drivers, especially<strong>for</strong> Bluetooth®, wireless, USB 2.0, USB 3.0, network cards, <strong>and</strong> disk drives. To obtain <strong>the</strong> correct drivers,please visit your computer manufacturer's web site.• SQL Server Software Installation: You must install <strong>the</strong> SQL Server software <strong>and</strong> apply <strong>the</strong> appropriate servicepacks following <strong>the</strong> procedures in <strong>the</strong> ADS, ADX, <strong>and</strong> SCT Installation <strong>and</strong> Upgrade Wizard (L<strong>IT</strong>-12011521).• O<strong>the</strong>r Metasys Applications: You must follow <strong>the</strong> procedures in Johnson Controls® technical literature <strong>for</strong> anyo<strong>the</strong>r Metasys software application that is installed on a computer with a virtual environment.• SQL Server Software Per<strong>for</strong>mance: Underst<strong>and</strong> that <strong>the</strong> per<strong>for</strong>mance of SQL Server software may degradewhen deployed in a virtual environment. Also, o<strong>the</strong>r applications that compete with <strong>the</strong> Metasys system <strong>for</strong> SQLServer resources may affect per<strong>for</strong>mance.• Help from <strong>IT</strong>: Engage <strong>the</strong> expertise of your <strong>IT</strong> department <strong>and</strong> network technologists when setting up <strong>the</strong> virtualenvironment.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>18


• Reliability: Realize that Metasys system reliability in a virtual environment with o<strong>the</strong>r applications is difficult toassess when <strong>the</strong> applications share <strong>the</strong> same hardware. Be aware of o<strong>the</strong>r applications that run in <strong>the</strong> samevirtual environment as <strong>the</strong> Metasys system.• Dedicated <strong>Network</strong> Card: To ensure reliable communication between <strong>the</strong> Site Director <strong>and</strong> supervisory controllers,use a dedicated network interface card (NIC) whose MAC address does not change. Do not use managed orload sharing NICs.• Available Memory <strong>and</strong> Hard Disk Space: Make sure that <strong>the</strong> virtual environment has allocated enough memory<strong>and</strong> hard disk space. Do not attempt to run a system with <strong>the</strong> bare minimums. Both <strong>the</strong> virtual environment <strong>and</strong><strong>the</strong> Metasys software need a certain amount of memory <strong>and</strong> disk space; typically, 4 GB <strong>for</strong> <strong>the</strong> host operatingsystem <strong>and</strong> 4 GB <strong>for</strong> <strong>the</strong> operating system that Metasys is using. For general hardware requirements, refer to<strong>the</strong> Application <strong>and</strong> Data Server (ADS/ADX) Product <strong>Bulletin</strong> (L<strong>IT</strong>-1201525).Note: Dynamic memory mode <strong>for</strong> virtual servers is not supported. ADX must be installed in a static-memoryenvironment or SQL Server may not function correctly.• Hard Disk Configuration: Make sure that <strong>the</strong> hard disk space is fully allocated, <strong>and</strong> do not configure <strong>the</strong> virtualenvironment to allow <strong>for</strong> disk drive expansion.• O<strong>the</strong>r Applications: Make sure that no o<strong>the</strong>r applications are adversely affecting <strong>the</strong> computer that is running<strong>the</strong> virtual environment. Metasys system per<strong>for</strong>mance degrades very quickly if o<strong>the</strong>r applications are contending<strong>for</strong> host operating system resources.• Dedicated Processor: Dedicate <strong>the</strong> virtual environment to a single processor. Do not share <strong>the</strong> processor witho<strong>the</strong>r virtual environments.• Reduced Cost Benefit: Do not allow reduced hardware <strong>and</strong> software costs be <strong>the</strong> sole reason <strong>for</strong> deploying avirtual environment.If you deploy Metasys applications in a virtual environment, Johnson Controls supports any Metasys product issue,but issues that are identified with <strong>the</strong> virtual environment are not supported. For Metasys product support, contactyour local authorized Johnson Controls provider.Monitoring <strong>and</strong> Managing (SNMP)SNMP provides IP st<strong>and</strong>ard SNMP functionality in <strong>the</strong> Metasys system, enabling network administrators to manageMetasys network per<strong>for</strong>mance, find <strong>and</strong> resolve issues related to <strong>the</strong> Metasys network, <strong>and</strong> plan <strong>for</strong> future growthof <strong>the</strong> Metasys system. SNMP uses st<strong>and</strong>ard SNMP Versions 1, 2C, <strong>and</strong> 3 (which excludes SNMP encryption <strong>and</strong>au<strong>the</strong>ntication support). The Metasys system allows delivery of unsecured SNMP traps <strong>for</strong> Metasys alarm eventsvia a <strong>Network</strong> Management System (NMS).A custom Metasys system specific management in<strong>for</strong>mation base (MIB) is available <strong>and</strong> allows <strong>the</strong> NMS to monitorMetasys point objects, display attributes, <strong>and</strong> control sequence objects. The MIB also defines explicit traps <strong>and</strong>associated attributes that align with Metasys alarm messages, making data correlation (parsing/sorting) at <strong>the</strong> NMSstraight<strong>for</strong>ward. Traps from <strong>the</strong> Metasys system are not encrypted.The NMS operator can per<strong>for</strong>m Gets <strong>and</strong> Get Nexts (SNMP Walks) against engines via an NMS. Gets allow you toview object data but do not allow you to write to objects. To use Gets, you must query <strong>the</strong> specific engine (NAE55,<strong>for</strong> example) on which <strong>the</strong> object appears. Site Directors do not <strong>for</strong>ward Get requests to o<strong>the</strong>r devices on <strong>the</strong> site<strong>and</strong> you cannot per<strong>for</strong>m Gets on ADSs/ADXs. Metasys system objects are specified as a string index in a table, so<strong>the</strong> NMS must have <strong>the</strong> capability to specify an index as a string or <strong>the</strong> NMS operator must encode <strong>the</strong> Object IDusing <strong>the</strong> decimal equivalents.The Johnson Controls® MIB is included on <strong>the</strong> product media. SNMP is offered on all supervisory devices (engine<strong>and</strong> ADS/ADX).For in<strong>for</strong>mation on configuring SNMP traps, turning off SNMP or Gets capability, <strong>and</strong> o<strong>the</strong>r alarm in<strong>for</strong>mation, referto <strong>the</strong> Alarm <strong>and</strong> Event Management section of <strong>the</strong> Metasys system Help (L<strong>IT</strong>-1201793). For in<strong>for</strong>mation aboutSNMP implementation in <strong>the</strong> Metasys system, see Appendix: SNMP Agent Protocol Implementation.Time Management (Simple <strong>Network</strong> Time Protocol [SNTP])There are three methods <strong>for</strong> network time synchronization available in <strong>the</strong> Metasys system, including MicrosoftWindows SNTP time synchronization, Multicast, <strong>and</strong> BACnet time synchronization.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>19


You can use <strong>the</strong> Multicast <strong>and</strong> Microsoft Windows methods when an SNTP master time server is available. If <strong>the</strong>Site Director has no access to SNTP time servers, you can use <strong>the</strong> BACnet synchronization method.Note: The Multicast time synchronization is preferred over <strong>the</strong> Windows time synchronization.Typically in <strong>the</strong> Metasys system, only <strong>the</strong> Site Director synchronizes its time with an SNTP time server. The o<strong>the</strong>rdevices on <strong>the</strong> Metasys network synchronize with <strong>the</strong> Site Director. As a secondary method of time synchronization,configure <strong>the</strong> Metasys system to have all devices synchronize time with <strong>the</strong> Site Director as an SNTP Time Server.If critical changes occur to time zones or time change protocols, Johnson Controls issues patches to update <strong>the</strong>Metasys system. For more details on time management, refer to <strong>the</strong> Time Zone, Date, <strong>and</strong> Time ManagementAppendix found in <strong>the</strong> NAE Commissioning Guide (L<strong>IT</strong>-1201519), LCS85 Commissioning Guide (L<strong>IT</strong>-12011568),<strong>and</strong> <strong>the</strong> ADS/ADX Commissioning Guide (L<strong>IT</strong>-1201645).E-mail (SMTP)All e-mail capable devices in <strong>the</strong> Metasys system use only to communicate with <strong>the</strong> mail server. The Metasys systemcan be configured to use SMTP <strong>for</strong> notification of system events <strong>and</strong> alarms.For in<strong>for</strong>mation about using e-mail as a notification method <strong>for</strong> alarms, refer to <strong>the</strong> NAE Commissioning Guide(L<strong>IT</strong>-1201519) or LCS85 Commissioning Guide (L<strong>IT</strong>-12011568).Note: If Symantec® Enterprise Protection Version 12 is installed on an ADS/ADX client machine with <strong>the</strong> POP3/SMTPScanner option selected, <strong>the</strong> SMTP functions <strong>and</strong> e-mail alerts <strong>for</strong> <strong>the</strong> ADS/ADX software are disabled withoutnotification. Do not select <strong>the</strong> POP3/SMTP Scanner option during Symantec Enterprise Protection installationin order to use <strong>the</strong> SMTP <strong>and</strong> e-mail alert features in <strong>the</strong> ADX application.Encrypted EmailMetasys software features an email encryption capability that encrypts your user name <strong>and</strong> password as <strong>the</strong>y areentered into <strong>the</strong> SMP UI. This feature allows embedded <strong>and</strong> server machines to send email to email servers overa secure channel (secure socket layer [SSL]). The entire email payload is encrypted, <strong>and</strong> allows Metasys softwareto communicate to email servers that require SSL connections.Email encryption can be configured with no au<strong>the</strong>ntication required, SMTP au<strong>the</strong>ntication, <strong>and</strong> POP-Be<strong>for</strong>e-SMTPau<strong>the</strong>ntication.Communication to Pager, E-mail, Printer, or SNMP DestinationThe Metasys system guarantees delivery of events from engines to an ADS/ADX, but this delivery guarantee doesnot extend to <strong>the</strong> Destination Delivery Agent (DDA) destinations: pagers, e-mail accounts, printers, or SNMPdestinations.See <strong>the</strong> following:• Pagers: (Telocator Alphanumeric Protocol) - Delivery guaranteed to <strong>the</strong> service provider. The service providerdelivers to <strong>the</strong> final pager account as time permits.• E-mail: (Simple Mail Transfer Protocol) - Delivery to <strong>the</strong> service provider is guaranteed. The service providerdelivers to <strong>the</strong> final e-mail account as time permits. The delivery may not be made <strong>for</strong> a number of reasons,including recipient mail server spam rules, or <strong>the</strong> service provider’s inability to communicate to <strong>the</strong> recipient mailserver.• Printers: In<strong>for</strong>mation sent to a printer may not be delivered in a timely manner <strong>for</strong> a number of reasons, includingprinter offline or out-of-paper conditions.• SNMP: This delivery system uses User Datagram Protocol (UDP), which does not guarantee delivery.Given <strong>the</strong> non-deterministic status of delivery, we recommended that physical fail-over measures be implementedas <strong>the</strong> primary safety control <strong>for</strong> critical activities.Location of a Site Director in a Demilitarized Zone (DMZ) or on <strong>the</strong> InternetImportant: Do not place <strong>the</strong> Site Director <strong>and</strong> any Metasys components in <strong>the</strong> DMZ or on <strong>the</strong> Internet. If offsiteaccess is necessary, use a VPN. Access to any component of Metasys should be strictly controlled.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>20


The Site Director provides access to all <strong>the</strong> devices on <strong>the</strong> site using only one public IP address (<strong>the</strong> address of <strong>the</strong>Site Director). Only <strong>the</strong> Site Director requires access through <strong>the</strong> firewall to <strong>the</strong> Internet. All o<strong>the</strong>r devices on <strong>the</strong> siteare exposed through <strong>the</strong> Site Director. See Figure 2 <strong>for</strong> an example of a DMZ.Communication between a Metasys client computer on <strong>the</strong> Internet (web browser in Figure 2) <strong>and</strong> <strong>the</strong> Site Directorwithin a DMZ uses HTTP only. Metasys software requires that only TCP Port 80 be opened at <strong>the</strong> firewall.If you are using NAT to communicate between a browser <strong>and</strong> <strong>the</strong> Metasys site over <strong>the</strong> Internet, all Metasys systemdevices exposed to <strong>the</strong> Internet (normally only <strong>the</strong> Site Director) must have static internal <strong>and</strong> external IP addresses.Dynamic NAT is not a supported Metasys system configuration. If you are using DHCP to assign addresses todevices that communicate across networks that use NAT, your DHCP server should be configured to always allocate<strong>the</strong> same IP address to each Metasys system device. This is done in <strong>the</strong> DHCP server by assigning IP addressesto <strong>the</strong> MAC addresses of <strong>the</strong> Metasys system devices. This configuration makes <strong>the</strong>se devices behave as if <strong>the</strong>yhave static IP addresses, although <strong>the</strong>y have DHCP addresses. This behavior sometimes is called DynamicallyAssigned, Statically allocated addresses from a DHCP server.Note: Supervisory devices in a Metasys system site (<strong>the</strong> Site Director <strong>and</strong> its child devices) cannot be separatedby NATs. All devices on a site must be addressable via local IP addresses; however, if a site is <strong>for</strong>wardinghistorical data (such as alarms, events, <strong>and</strong> trends) to an ADS/ADX repository that is not part of <strong>the</strong> site,NATs can be used if <strong>the</strong> ADS/ADX repository is assigned static internal <strong>and</strong> external IP addresses.If <strong>the</strong> Active Directory service is implemented <strong>for</strong> Metasys system use, all involved devices (ADS/ADX, SCT computer,<strong>and</strong> Site Management Portal UI clients) must be directly addressable on <strong>the</strong> LAN. The client cannot make a directconnection to <strong>the</strong> Site Director over <strong>the</strong> Internet. For example, if <strong>the</strong> user is connected remotely to <strong>the</strong> Site Director,a VPN or extranet connection must be used. This is a restriction of <strong>the</strong> Active Directory service <strong>and</strong> is not unique to<strong>the</strong> Metasys system implementation of <strong>the</strong> service. The existing customer infrastructure determines VPN <strong>and</strong> extranetconnectivity; <strong>the</strong> Metasys system implementation of <strong>the</strong> Active Directory service does not require a particularconnectivity method.At Release 6.0 or later, Remote Desktop <strong>for</strong> engines is only available through <strong>the</strong> NxE In<strong>for</strong>mation <strong>and</strong> ConfigurationTool (NCT). If you intend to apply upgrades or patches over <strong>the</strong> Internet instead of locally at <strong>the</strong> site, you must openadditional ports to <strong>the</strong> Internet.Figure 2: Site Director in a DMZ Example<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>21


Because <strong>the</strong> Remote Desktop port (TCP port 3389) is susceptible to network attacks, <strong>IT</strong> does not readily open <strong>the</strong>port. Opening this port is not recommended because it goes against <strong>IT</strong> security best practice. Be prepared to explainto <strong>the</strong> <strong>IT</strong> department why contacting <strong>the</strong> devices via this open port is <strong>the</strong> best option.Remote Access to <strong>the</strong> Metasys System Using a VPNThe simplest method of remotely accessing <strong>the</strong> Metasys system is to use an existing VPN infrastructure. If an existingVPN infrastructure is present on <strong>the</strong> site already, <strong>the</strong> risks <strong>and</strong> security concerns have been established <strong>and</strong>addressed. Using a VPN, <strong>the</strong> Metasys system features are <strong>the</strong> same as if remote users are on <strong>the</strong> company intranet.Note: Johnson Controls does not supply VPN infrastructure.Note: The Metasys system does not support Secure Socket Layer (SSL) VPN.Figure 3: Metasys System Internet Communication via VPNMetasys System ArchitectureFigure 4 shows one example of <strong>the</strong> many ways you can design <strong>the</strong> Metasys system architecture.Note: Restrictions apply to <strong>the</strong> engines supported with an ADS-Lite Site Director. Refer to <strong>the</strong> Metasys SystemExtended Architecture Overview <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201527).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>22


Figure 4: Metasys System ArchitectureProtocols, Ports, <strong>and</strong> Connectivity <strong>for</strong> <strong>the</strong> Metasys SystemProtocols <strong>and</strong> Ports TablesNote: Bluetooth technology is used by <strong>the</strong> Metasys system only as an option to commission a select number ofdevices. Bluetooth technology is not used <strong>for</strong> system communication in any way after initial commissioning.Table 5 <strong>and</strong> Table 6 describe <strong>the</strong> various IP protocols <strong>and</strong> how <strong>the</strong>y relate to <strong>the</strong> Metasys system. See Connectivity<strong>and</strong> Protocol Diagrams <strong>for</strong> in<strong>for</strong>mation on how protocols are used in various network layouts.Table 5: E<strong>the</strong>rnet Protocols <strong>and</strong> PortsProtocolUses Port 1 NumberMetasys DeviceDescriptionDHCPUDP6768EngineADS/ADXComputer (WebBrowser)Active Directory ClientAssigns <strong>and</strong> keeps track of dynamicIP addresses <strong>and</strong> o<strong>the</strong>r networkconfiguration parameters.Alternate Method: Use static IPaddresses.Trivial File TransferProtocol (TFTP)UDP69EngineDownloads new images to NAEs.DNSUDP53EngineADS/ADXTranslates domain names into IPaddresses.Computer (WebBrowser)Active Directory Client<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>23


Table 5: E<strong>the</strong>rnet Protocols <strong>and</strong> PortsProtocolUses Port 1 NumberMetasys DeviceDescriptionHTTPTCP80EngineADS/ADXComputer (WebBrowser)Provides communication betweenpeer controllers, computers, <strong>and</strong> o<strong>the</strong>rInternet systems using Simple ObjectAccess Protocol (SOAP) over HTTP.The ADS/ADX requires that only Port80 be open to receive communicationfrom client devices.Note:TCP Port Forwarding issupported on Port 80 only.Post Office Protocol 3(POP3)UDP <strong>and</strong> TCP110995Computer (WebBrowser)Usually, POP receives <strong>and</strong> holdse-mail <strong>for</strong> downloading from yourInternet server. POP3 is allowed in <strong>the</strong>Metasys system only <strong>for</strong>au<strong>the</strong>ntication from a Simple <strong>Network</strong>Management Protocol (SNMP) server.Note:Firewall rules are notnecessary to allow access inmost cases because thisserver should be behind <strong>the</strong>firewall.SMTPUDP25EngineE-mails alarms.ADS/ADXN30SNMPUDP161465EngineADS/ADXProvides network monitoring <strong>and</strong>maintenance.M-Series WorkstationE<strong>the</strong>rnet IPSNMP TrapUDP162EngineADS/ADXM-Series Workstation(M-Alarm messages)Typically notifies <strong>IT</strong> departmentpersonnel of alarms that are of interestto <strong>the</strong>m such as data centerenvironmental conditions. The sitemust use a network managementsystem capable of receiving SNMPTraps.Alternate Method: Use pager ore-mail destinations <strong>for</strong> remote alarmnotification instead of SNMP.Simple <strong>Network</strong> TimeProtocol (SNTP)UDPTCP12380EngineADS/ADXComputer (WebBrowser)Used to synchronize computer clocksover a network between a server <strong>and</strong>its clients. SNTP is not required <strong>for</strong> allsystems.Metasys System Client(Client not on anyDomain)<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>24


Table 5: E<strong>the</strong>rnet Protocols <strong>and</strong> PortsProtocolUses Port 1 NumberMetasys DeviceDescriptionN1 ProtocolUDP11001 2NIENCMProvides N1 message transmission(proprietary packet encoded in UDP).If you are connecting to multiple N1networks, <strong>the</strong> port is unique <strong>for</strong> eachN1 network. <strong>Network</strong> Control Module(NCM) automatically configure<strong>the</strong>mselves to use Port 11001. Startnumbering o<strong>the</strong>r networks in <strong>the</strong>Multinetwork configuration with 11003<strong>and</strong> continue sequentially. Do not usea UDP Port Address (UDPPA) of11002. The value 11002 is used by<strong>the</strong> Metasys E<strong>the</strong>rnet Router <strong>and</strong>should be avoided even if MetasysE<strong>the</strong>rnet Routers are not in <strong>the</strong>system. The recommendedaddressing <strong>for</strong> five N1s is 11001,11003, 11004, 11005, 11006.BACnet/IP ProtocolUDP47808NAE/NCEN30TEC20-3c-2Refer to <strong>the</strong> BACnet ControllerIntegration with NAE/NCE <strong>Technical</strong><strong>Bulletin</strong> (L<strong>IT</strong>-1201531). If you areconnecting to multiple BACnetnetworks, <strong>the</strong> port is unique <strong>for</strong> eachBACnet network. The default portnumber is 47808. Choose additionalUDP ports that do not conflict with aport that is in use.Microsoft SQL ServerDatabaseTCP1433ADXMetasys ADX SplitDatabase Server(Member of Domain X)Used between <strong>the</strong> web/applicationserver <strong>and</strong> Database servercomputers when <strong>the</strong> ADX is splitacross two devices.Remote DesktopProtocol (RDP)TCP3389NAE55/NIEUsed to log on to <strong>the</strong> operating systemof a device from a remote computer.KerberosTCPUDP88Metasys System Client(Member of anyDomain)Metasys SCT (Memberof Domain X)Metasys ADS/ADX(Member of Domain X)Metasys ADX SplitWeb/Application Server(Member of Domain X)Kerberos is au<strong>the</strong>ntication protocolused by <strong>the</strong> Metasys system <strong>for</strong> ActiveDirectory service au<strong>the</strong>ntication at <strong>the</strong>Metasys system logon screen, <strong>and</strong>Service Account au<strong>the</strong>ntication priorto LDAP queries.Kerberos is a st<strong>and</strong>ard networkau<strong>the</strong>ntication protocol designed toprovide strong au<strong>the</strong>ntication <strong>for</strong>client/server applications by usingsecret-key cryptography. Kerberos is<strong>the</strong> primary security protocol <strong>for</strong>au<strong>the</strong>ntication within an ActiveDirectory service Domain. Kerberosau<strong>the</strong>ntication relies on clientfunctionality built into <strong>the</strong> Windowsoperating systems supported byMetasys software.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>25


Table 5: E<strong>the</strong>rnet Protocols <strong>and</strong> PortsProtocolUses Port 1 NumberMetasys DeviceDescriptionNT LAN ManagerVersion 2 (NTLMv2)TCP445Metasys System Client(Member of anyDomain)NTLMv2 is <strong>the</strong> protocol used duringMetasys system SSO (login free)au<strong>the</strong>ntication.Metasys SCT (Memberof Domain X)Metasys ADS/ADX(Member of Domain X)Metasys ADX SplitWeb/Application Server(Member of Domain X)NTLMv2 is a network au<strong>the</strong>nticationprotocol developed by Microsoft <strong>and</strong><strong>the</strong> secondary security protocol <strong>for</strong>au<strong>the</strong>ntication within an ActiveDirectory service domain. If a domainclient or domain server cannot useKerberos au<strong>the</strong>ntication, <strong>the</strong>n NTLMau<strong>the</strong>ntication is used.Secure Sockets Layer(SSL)TCP443Metasys AdvancedReporting ADXReady Access PortalRequired if you use SSL with yourreporting ADX. See Implementing SSLSecurity <strong>for</strong> <strong>the</strong> Metasys AdvancedReporting System.LDAPTCP389Metasys System Client(Member of anyDomain) 3LDAP is used by <strong>the</strong> Metasys systemto access user objects <strong>and</strong> attributeswithin Active Directory service.Metasys SCT (Memberof Domain X)Metasys ADS/ADX(Member of Domain X)Metasys ADX SplitWeb/Application Server(Member of Domain X)LDAP is a st<strong>and</strong>ard communicationprotocol <strong>for</strong> directories located onTCP/IP networks. LDAP defines howa directory client can access adirectory server <strong>and</strong> how <strong>the</strong> client canper<strong>for</strong>m directory operations <strong>and</strong>share directory data.NTPTCP123Metasys System Client(Member of anyDomain)Metasys SCT (Memberof Domain X)Metasys ADS/ADX(Member of Domain X)Time synchronization across anetwork between Windows 8,Windows 7, or Windows XP clientcomputers <strong>and</strong> Windows Server 2012,Windows Server 2008 R2 SP1, orWindows Server 2008 SP2 servercomputers.Metasys ADX SplitWeb/Application Server(Member of Domain X)Remote Procedure Call(RPC)TCP1351025Metasys System Client(Member of anyDomain)Metasys SCT (Memberof Domain X)Metasys ADS/ADX(Member of Domain X)Metasys ADX SplitWeb/Application Server(Member of Domain X)Used by IIS on <strong>the</strong> ADS/ADX/SCTduring <strong>the</strong> process of au<strong>the</strong>nticationduring SSO (Windows IntegratedAu<strong>the</strong>ntication). If SSO is disabled in<strong>the</strong> Metasys system, this port <strong>and</strong>protocol are not used by Metasys;however, if <strong>the</strong> ADS/ADX/SCT <strong>and</strong>/orMetasys client is a member of anActive Directory service domain, thisport <strong>and</strong> protocol are used <strong>for</strong> ActiveDirectory service functionality.1 Generally recorded by <strong>the</strong> Internet Assigned Numbers Authority (IANA).2 This port number is registered to Johnson Controls, Inc.3 LDAP is used by <strong>the</strong> Metasys system client only if an Windows Active Directory service search tool is used (<strong>for</strong> example,Start -> Search -> For People).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>26


Table 6: Wireless Ports <strong>and</strong> ProtocolsProtocolUsesWirelessProtocolPort 1NumberMetasys DeviceDescriptionWirelessMany-to-OneSensing 2UDP802.15.44050 3WRS-RTNRecommended UDP port numberused <strong>for</strong> wireless supervisorintegration.Wireless ZigBeeUDP802.15.447808TEC20-3CCoordinatorRecommended UDP port numberused <strong>for</strong> wireless supervisorintegration.HTTPTCP802.11b/802.11g80Computer (WebBrowser)TCP Port Forwarding is supportedon Port 80 only.1 Generally recorded by <strong>the</strong> IANA.2 Proprietary protocol.3 If this port is in use, it can be reconfigured to ano<strong>the</strong>r port.Connectivity <strong>and</strong> Protocol DiagramsFigure 5 through Figure 11 are example diagrams of <strong>the</strong> various types of connectivity <strong>and</strong> protocols <strong>for</strong> <strong>the</strong> Metasyssystem. Not all protocols are used in all Metasys system configurations.The configuration <strong>and</strong> network topology of <strong>the</strong> specific Metasys system installation must be considered when openingfirewall ports <strong>for</strong> communication. For example, considering Figure 5 <strong>and</strong> Table 5, if <strong>the</strong> ADS is not acting as a timeserver, <strong>the</strong>n <strong>the</strong> SNTP protocol between 3 <strong>and</strong> 2 is not used. Similarly, if Metasys system alarms <strong>and</strong> events arenot being monitored by <strong>IT</strong> tools, <strong>the</strong>n <strong>the</strong> SNMP Trap protocol between 2 <strong>and</strong> 4, <strong>and</strong> 3 <strong>and</strong> 4 is not used.Note: Restrictions apply to <strong>the</strong> engines supported with an ADS-Lite Site Director. Refer to <strong>the</strong> Metasys SystemExtended Architecture Overview <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201527) to discover which engines are supported<strong>for</strong> systems using <strong>the</strong> ADS-Lite as Site Director.Figure 5 is an example of <strong>the</strong> connectivity <strong>and</strong> protocols <strong>for</strong> a Metasys system using multiple engines <strong>and</strong> an ADS.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>27


Figure 5: Metasys System with Multiple Engines <strong>and</strong> an ADSNote: Figure 5 does not show <strong>the</strong> interaction between <strong>the</strong> NCM <strong>and</strong> NIE using <strong>the</strong> N1 protocol. See Figure 8.Figure 6 is an example of <strong>the</strong> connectivity <strong>and</strong> additional protocols used in a Metasys system that uses ActiveDirectory service. Table 7 describes <strong>the</strong> protocols used in Figure 6, <strong>and</strong> Figure 5 <strong>and</strong> Table 5 describe <strong>the</strong> baseprotocols used by <strong>the</strong> Metasys system.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>28


Figure 6: Metasys System with Active Directory ServiceNote: Figure 6 does not show <strong>the</strong> interaction between <strong>the</strong> NCM <strong>and</strong> NIE using <strong>the</strong> N1 protocol. See Figure 8.Table 7: Metasys System with Active Directory ServiceInteraction between Callouts Protocol113, 4, 5, 6, 78, 9, 10No new protocols. See Figure 5 <strong>and</strong> Table 5. 1NTLMv2 3 existing protocols already defined <strong>for</strong>Metasys system; no new protocols. See Figure5 <strong>and</strong> Table 5. 1Communication DirectionUnidirectional 2Unidirectional 21 4,5 12, 13, 14, 15 Kerberos or NTLMv2 3 , DNS, LDAP, NTP, RPC Unidirectional 223, 4, 5, 6, 7 No new protocols. See Figure 5 <strong>and</strong> Table 5. 1 Unidirectional 2<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>29


Table 7: Metasys System with Active Directory ServiceInteraction between Callouts ProtocolCommunication Direction28, 9, 10No new protocols. See Figure 5 <strong>and</strong> Table 5. 1Unidirectional 28, 9, 10 4,6,7,812, 13, 14, 15Kerberos or NTLMv2 3 , LDAP, NTP, RPCUnidirectional 21 Metasys system client in Figure 6 is equivalent to web browser in Figure 5.2 In Unidirectional communication, only <strong>the</strong> originating device initiates requests (assuming synchronous response is allowed to<strong>the</strong> request).3 NLTMv2 is <strong>the</strong> default <strong>and</strong> preferred version of <strong>the</strong> NTLM protocol.4 DNS, NTP, Kerberos, NTLM, LDAP, <strong>and</strong> RPC are protocols required as a result of <strong>the</strong> device becoming a member of an ActiveDirectory service domain. These are st<strong>and</strong>ard Active Directory service protocols.5 The LDAP protocol may be used between <strong>the</strong> Metasys system client <strong>and</strong> domain controller when <strong>the</strong> client is using ActiveDirectory service tools provided by <strong>the</strong> operating system <strong>and</strong> <strong>the</strong> particular domain controller is responding to <strong>the</strong> LDAP query.6 The Kerberos protocol is used between a Metasys Site Director <strong>and</strong>/or SCT <strong>and</strong> <strong>the</strong> Active Directory service domain controllerwhen <strong>the</strong> Site Director is au<strong>the</strong>nticating against <strong>the</strong> Active Directory service domain. For domain au<strong>the</strong>ntication, any domaincontroller within <strong>the</strong> domain may respond.7 The LDAP protocol is used between a Metasys Site Director <strong>and</strong>/or SCT <strong>and</strong> Active Directory service domain controller when<strong>the</strong> Site Director is querying <strong>the</strong> directory <strong>for</strong> object in<strong>for</strong>mation.8 RPC is used by IIS on <strong>the</strong> ADS/ADX/SCT during <strong>the</strong> process of au<strong>the</strong>ntication during SSO (Windows Integrated Au<strong>the</strong>ntication).If SSO is disabled in <strong>the</strong> Metasys system, this port <strong>and</strong> protocol are not used by Metasys; however, if <strong>the</strong> ADS/ADX/SCT <strong>and</strong>/orMetasys system client is a member of an Active Directory service domain, this port <strong>and</strong> protocol are used <strong>for</strong> Active Directoryservice functionality.Figure 7 is an example of <strong>the</strong> connectivity <strong>and</strong> protocols <strong>for</strong> a Metasys system using <strong>the</strong> M3 Workstation <strong>and</strong> N30controllers. See Figure 5 with Table 5, <strong>and</strong> Figure 6 with Table 7, <strong>for</strong> <strong>the</strong> full set of protocols used by <strong>the</strong> engine,ADS/ADX, <strong>and</strong> Site Management Portal UI.Figure 7: Metasys System with N30 Controllers Using BACnet ProtocolSee Table 8 <strong>for</strong> details on <strong>the</strong> callout numbers in Figure 7.Table 8: Metasys System with N30 Controllers Using BACnet ProtocolInteraction between CalloutsProtocolCommunication Direction12BACnet 1Bidirectional 213BACnet 1Bidirectional 2<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>30


Table 8: Metasys System with N30 Controllers Using BACnet ProtocolInteraction between CalloutsProtocolCommunication Direction14BACnet 1Bidirectional 215POP3, SMTP, SNMP, SNMP TrapUnidirectional 123BACnet 1Bidirectional 234BACnet 1Bidirectional 222BACnetBidirectional25DHCPUnidirectional1 When using BACnet protocol with N30s, you must specify UDP Port 47808 as being used. For multiple BACnet networks, usea different port number <strong>for</strong> each network.2 In Bidirectional communications, both devices initiate requests.3 In Unidirectional communication, only <strong>the</strong> originating device initiates requests (assuming synchronous response is allowed to<strong>the</strong> request).Figure 8 is an example of <strong>the</strong> connectivity <strong>and</strong> protocols used in a Metasys system using <strong>the</strong> operator workstation(OWS) or M5 Workstation <strong>and</strong> NCMs. See Figure 5 with Table 5, <strong>and</strong> Figure 6 with Table 7, <strong>for</strong> <strong>the</strong> full set of protocolsused by <strong>the</strong> engine, ADS/ADX, <strong>and</strong> Site Management Portal UI.Figure 8: Metasys System with NCMsSee Table 9 <strong>for</strong> in<strong>for</strong>mation on <strong>the</strong> number callouts in Figure 8.Table 9: Metasys System with NCMsInteraction between CalloutsProtocolCommunication Direction12N1 1Bidirectional 213SNMP, SNMP TrapUnidirectional 1<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>31


Table 9: Metasys System with NCMsInteraction between CalloutsProtocolCommunication Direction22N1Bidirectional24 4N1Bidirectional1 When using UDP protocol with NCMs, you must specify Port 11001 as being used. For multiple N1 networks, you must use adifferent port number <strong>for</strong> each network.2 In Bidirectional communications, both devices initiate requests.3 In Unidirectional communication, only <strong>the</strong> originating device initiates requests (assuming synchronous response is allowed to<strong>the</strong> request).4 You can configure multiple N1 networks on <strong>the</strong> NIE. Refer to <strong>the</strong> N1 Migration with NIE <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201535) <strong>for</strong>details.Figure 9 is an example of <strong>the</strong> connectivity <strong>and</strong> protocols used in a Metasys network using <strong>the</strong> Many-to-One WirelessRoom Temperature Sensing Application.Figure 9: Metasys System with Many-to-One Wireless Room Temperature Sensing ApplicationSee Table 10 <strong>for</strong> in<strong>for</strong>mation on <strong>the</strong> number callouts in Figure 9.Table 10: Metasys System with Many-to-One Wireless Room Temperature Sensing ApplicationInteraction between CalloutsProtocolCommunication Direction12Tunneling over E<strong>the</strong>rnetBidirectional23Wireless Many-to-One Sensing (802.15.4) 1Bidirectional (2.4 GHzChannelized, 2.4 GHz DSSSWireless Protocol)42HTTPUnidirectional 11 Port 4050 is recommended <strong>for</strong> <strong>the</strong> WRS-RTN Receiver.2 In Unidirectional communication, only <strong>the</strong> originating device initiates requests (assuming synchronous response is allowed to<strong>the</strong> request).The WRS Series sensors <strong>and</strong> WRS receivers operate on <strong>the</strong> 2.4 GHz Industrial, Science, Medical (ISM) b<strong>and</strong> <strong>and</strong>use multi-frequency direct sequence spread spectrum (DSSS) technology. The receiver meets <strong>the</strong> Institute ofElectrical <strong>and</strong> Electronic Engineers, Inc. (IEEE) 802.15.4 st<strong>and</strong>ard <strong>for</strong> low power, low duty-cycle wireless transmittingsystems.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>32


The 802.15.4 st<strong>and</strong>ard radio is used <strong>for</strong> employing control networks within a building. This technology uses 16different channels, allowing 802.15.4 devices, such as <strong>the</strong> WRS Series systems, to coexist with 802.11 devices.The Many-to-One system uses multi-frequency, redundant data transmissions. The sensor transmits a rapid sequenceof high-speed (2 millisecond) redundant data bursts to an associated receiver approximately every 60 seconds. Thesensor transmits up to five redundant data bursts in rapid sequence, <strong>and</strong> each burst is transmitted on a differentZigBee frequency. When a single data burst is successfully received <strong>and</strong> acknowledged (or if all five redundant databursts fail), <strong>the</strong> sensor goes dormant <strong>for</strong> approximately 60 seconds <strong>and</strong> <strong>the</strong>n repeats <strong>the</strong> rapid transmission burstsequence.Multi-frequency, redundant data-transmission sequences greatly enhance <strong>the</strong> success of <strong>the</strong> wireless sensing systemdata transmissions. Transmitting short, high-speed data bursts at 60-second intervals also reduces wireless datatransmission collisions <strong>and</strong> interference with o<strong>the</strong>r WiFi transmissions. The DSSS technology virtually eliminatesaccidental <strong>and</strong> unauthorized wireless interference.Figure 10 is an example of a Metasys network using <strong>the</strong> TEC Series Wireless Thermostat Controller system.Figure 10: Metasys <strong>Network</strong> with TEC Series Wireless Thermostat Controller System (BACnet IP <strong>and</strong> BACnetMS/TP Versions Shown)Note: A system can use ei<strong>the</strong>r a TEC20-3C-2 Coordinator (BACnet IP) or a TEC20-6C-2 coordinator (BACnetMaster-Slave/Token-Passing [MS/TP]), but cannot use both BACnet IP <strong>and</strong> BACnet MS/TP versions.Table 11: Metasys <strong>Network</strong> with TEC Series Wireless Thermostat Controller SystemInteraction between CalloutsProtocolCommunication Direction12BACnet IP 1Bidirectional14HTTPUnidirectional 123ZigBee Wireless <strong>Network</strong> (802.15.4)Bidirectional (2.4 GHzChannelized, 2.4 GHz DSSSWireless Protocol)42HTTPUnidirectional<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>33


Table 11: Metasys <strong>Network</strong> with TEC Series Wireless Thermostat Controller SystemInteraction between CalloutsProtocolCommunication Direction15BACnet MS/TPBidirectional53ZigBee Wireless <strong>Network</strong> (802.15.4)Bidirectional (2.4 GHzChannelized, 2.4 GHz DSSSWireless Protocol)1 When using BACnet protocol with TEC20-3C-2s, you must specify UDP Port 47808 as being used. For multiple BACnetnetworks, use a different port number <strong>for</strong> each network.2 In Unidirectional communication, only <strong>the</strong> originating device initiates requests (assuming synchronous response is allowed to<strong>the</strong> request).The TEC Wireless Thermostat Controller System provides a wireless interface between anNAE25/NAE35/NAE45/NAE55/NCE <strong>and</strong> <strong>the</strong> TEC Wireless Thermostat Controllers, allowing <strong>the</strong> exchange of BACnetIP (TEC20-3C) or BACnet MS/TP (TEC20-6C) messages <strong>for</strong> <strong>the</strong> purpose of wireless monitoring <strong>and</strong> temperaturecontrol of building HVAC equipment.The system consists of at least one TEC20-3C-2 Coordinator <strong>and</strong> multiple TEC Wireless Thermostat Controllers.The system uses DSSS wireless technology <strong>and</strong> operates on <strong>the</strong> 2.4 GHz ISM b<strong>and</strong>. The system meets <strong>the</strong> IEEE802.15.4 st<strong>and</strong>ard <strong>for</strong> low power, low duty-cycle wireless transmitting systems <strong>and</strong> are compatible with wirelessmesh networks compliant with <strong>the</strong> ZigBee st<strong>and</strong>ard. The TEC Thermostat Controllers use a transmission power of10 dBm.For general in<strong>for</strong>mation on <strong>the</strong> TEC Series Wireless system, refer to <strong>the</strong> TEC Series Wireless Thermostat ControllerSystem <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-12011414).Figure 11 is an example of a Metasys network using <strong>the</strong> ZFR1800 Series Wireless Field Bus system.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>34


Figure 11: Metasys <strong>Network</strong> with ZFR1800 Series Wireless Field Bus SystemSee Table 12 <strong>for</strong> details on <strong>the</strong> number callouts in Figure 11.Table 12: Metasys <strong>Network</strong> with ZFR1800 Series Wireless SystemInteraction between CalloutsProtocolCommunication Direction14HTTPUnidirectional 112BACnet MS/TPBidirectional<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>35


Table 12: Metasys <strong>Network</strong> with ZFR1800 Series Wireless SystemInteraction between CalloutsProtocolCommunication Direction23ZigBee Wireless <strong>Network</strong> (802.15.4)Bidirectional (2.4 GHzChannelized, 2.4 GHz DSSSWireless Protocol)35ZigBee Wireless <strong>Network</strong> (802.15.4)Bidirectional (2.4 GHzChannelized, 2.4 GHz DSSSWireless Protocol)1 In Unidirectional communication, only <strong>the</strong> originating device initiates requests (assuming synchronous response is allowed to<strong>the</strong> request).The ZFR1800 Series Wireless Field Bus System provides a wireless plat<strong>for</strong>m <strong>for</strong> Metasys field controllers usingJohnson Controls Metasys BACnet protocol. The system consists of at least one ZFR1810 Wireless Field BusCoordinator, connected to an NAE25/NAE35/NAE45/NAE55 or NCE. It also has one or more ZFR1811 WirelessField Bus Routers, each connected to any Metasys BACnet Field Equipment Controller (FEC) 16, FEC26, or VMA16Series Controller. And lastly, multiple WRZ Series Wireless Room Temperature Sensors (WRZ-TTx) in <strong>the</strong> systemcommunicate with <strong>the</strong> routers.As with <strong>the</strong> TEC Wireless system, <strong>the</strong> ZFR1800 Wireless Field Bus system uses DSSS wireless technology <strong>and</strong>operates on <strong>the</strong> 2.4 GHz ISM b<strong>and</strong>. The system also meets <strong>the</strong> IEEE 802.15.4 st<strong>and</strong>ard <strong>for</strong> low power, low duty-cyclewireless transmitting systems <strong>and</strong> are compatible with wireless mesh networks compliant with <strong>the</strong> ZigBee st<strong>and</strong>ard.For more details on <strong>the</strong> ZFR1800 Series Wireless system, refer to <strong>the</strong> ZFR1800 Series Wireless Field Bus System<strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-12011295).ZigBee ChannelsA ZigBee network has 16 channels available <strong>for</strong> use. The TEC Series Wireless Thermostat Controller system <strong>and</strong>ZFR1800 Series Wireless Field Bus system use only channels 15, 20, <strong>and</strong> 25. These channels were selectedbecause <strong>the</strong>y do not overlap with channels used on a WiFi network. Figure 12 is a diagram from <strong>the</strong> ZFR1800 SeriesWireless Field Bus System <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-12011295) illustrating that <strong>the</strong> ZigBee channels do not interferewith <strong>the</strong> Wi-Fi network.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>36


Figure 12: Comparing Channel Spacing of <strong>the</strong> Systems Using ZigBee Technology Versus WiFi <strong>Network</strong>sSpanning TreesImproperly configured spanning trees cause excessive Spanning Tree Protocol (STP), Rapid Spanning Tree Protocol(RSTP), or Bridge Protocol Data Unit (BPDU) traffic, which causes Metasys engines to reset. Be sure all spanningtrees are properly configured.Field Bus ConsiderationsMetasys system devices that connect to E<strong>the</strong>rnet networks use various field buses to interface with <strong>the</strong> buildingcontrol system. Field buses provide direct connections between field devices <strong>and</strong> <strong>the</strong> supervisory device that controls<strong>the</strong>m. Field devices/buses do not interact directly with <strong>the</strong> E<strong>the</strong>rnet network, but <strong>the</strong> supervisory devices do interactwith <strong>the</strong> E<strong>the</strong>rnet network. Possible field buses include <strong>the</strong> LONWORKS network, Master-Slave/Token-Passing (MS/TP)bus, <strong>and</strong> N2 Bus. For in<strong>for</strong>mation on <strong>the</strong> buses supported by specific Metasys system devices, refer to <strong>the</strong> productliterature <strong>for</strong> each device.Pre-boot Execution Environment (PXE)Engines (excluding <strong>the</strong> NxE85 <strong>and</strong> LCS85) implement a PXE client. If your network uses a Pre-boot ExecutionEnvironment (PXE) server, exclude <strong>the</strong> MAC address <strong>for</strong> <strong>the</strong>se devices from <strong>the</strong> PXE server. If you do not exclude<strong>the</strong> MAC addresses, <strong>the</strong>se devices may not start up properly.<strong>Network</strong> Reliability RequirementCommunication between <strong>the</strong> ADS/ADX <strong>and</strong> engines requires a robust <strong>and</strong> reliable network. If communicationthroughput is not sufficient or is unreliable, false online <strong>and</strong> offline alarms from supervisory controllers may occur.In most cases, <strong>the</strong> controllers report online almost immediately, which is an indication that <strong>the</strong>re is no problem with<strong>the</strong> controllers. If <strong>the</strong>y do not report online within a few seconds, or this behavior persists, contact <strong>the</strong> JohnsonControls technical support <strong>for</strong> assistance.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>37


Metasys System Security ConsiderationsGeneral Security RecommendationsFor general recommendations based on <strong>the</strong> Best Practices <strong>for</strong> Enterprise Security document on Microsoft TechNet,follow this link:http://www.microsoft.com/technet/archive/security/bestprac/bpent/bpentsec.mspxMetasys Access SecurityDepartment of Defense BannerIf <strong>the</strong> custom United States Department of Defense (DoD) banner was enabled when <strong>the</strong> ADS/ADX was installed,a warning statement appears each time you access <strong>the</strong> Metasys Site Management Portal UI. The statement containsin<strong>for</strong>mation important to any Metasys user accessing <strong>the</strong> building automation system at a Department of Defensefacility. You must click OK to indicate you consent to <strong>the</strong> stated conditions be<strong>for</strong>e reaching <strong>the</strong> login screen. Afteryou click OK, <strong>the</strong> st<strong>and</strong>ard Metasys system login screen appears. If your network uses Active Directory service withSingle Sign-On capability, <strong>the</strong> DoD banner still appears, but <strong>the</strong> Metasys login screen is bypassed, <strong>the</strong>n <strong>the</strong> SiteManagement Portal appears.Figure 13: United States DOD Warning StatementThe DOD banner remains on <strong>the</strong> screen until ei<strong>the</strong>r you click OK or you manually close <strong>the</strong> banner window. Thebanner does not close on its own.When <strong>the</strong> Metasys system login screen appears, you have up to 30 seconds to log in. If 30 seconds passes with nouser activity, <strong>the</strong> login screen closes <strong>and</strong> <strong>the</strong> DOD banner screen returns. The banner also reappears after you logoff from <strong>the</strong> Metasys system or <strong>the</strong> system logs you off because of user inactivity.Note: The DOD banner does not appear be<strong>for</strong>e logging in to <strong>the</strong> Metasys Advanced Reporting System, ReadyAccess Portal user interface, supervisory engine, SCT UI, or LONWORKS® Control Server (LCS85).Note: If you wish to remove <strong>the</strong> DoD banner requirement, uninstall <strong>the</strong> Metasys ADS/ADX, <strong>the</strong>n reinstall MetasysADS/ADX with <strong>the</strong> DoD banner option box unchecked.UsersThe Metasys system has two types of users: local users <strong>and</strong> Active Directory service users. A local user is definedin <strong>the</strong> Security Administrator system <strong>and</strong> is au<strong>the</strong>nticated <strong>and</strong> authorized against <strong>the</strong> Metasys Security database.An Active Directory service user is created <strong>and</strong> stored in an Active Directory service domain <strong>and</strong> is added as aMetasys system user with <strong>the</strong> Security Administrator System. This user is au<strong>the</strong>nticated against an Active Directoryservice domain <strong>and</strong> authorized against <strong>the</strong> Metasys system.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>38


Once logged in, <strong>the</strong> user is limited to actions that are permitted by <strong>the</strong> user’s assigned privileges. Refer to <strong>the</strong> SecurityAdministrator System <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201528) <strong>for</strong> specific details on Metasys system access security.Metasys System Local User Accounts <strong>and</strong> PasswordsThe user name <strong>and</strong> password are part of a Metasys local user account that controls which actions a user can per<strong>for</strong>m<strong>and</strong> which parts of <strong>the</strong> system a user can see, among o<strong>the</strong>r access controls. The data store <strong>for</strong> user accounts <strong>and</strong>user privileges is a SQL Server database on computer/server plat<strong>for</strong>ms (ADS/ADX, NxE85, <strong>and</strong> LCS85) <strong>and</strong> anXML-based file on <strong>the</strong> supervisory controller plat<strong>for</strong>ms (NAE35/NAE45/NAE55/NIE55/NIE59/NCE25). Metasyssystem user account passwords are hashed (Secure Hash Algorithm [SHA] 1) be<strong>for</strong>e storing.St<strong>and</strong>ard policy settings apply to a Metasys system local user account: password expiration/reset, session timeout,lockout after failed attempts, <strong>and</strong> password uniqueness. You also can set <strong>the</strong> times of day a user may access <strong>the</strong>system.Active Directory Service – User AccountsActions of an Active Directory service user within <strong>the</strong> Metasys system are controlled in <strong>the</strong> same manner as aMetasys local user, through assigned privileges. The data store <strong>for</strong> user privileges is a SQL Server database oncomputer/server plat<strong>for</strong>ms (ADS/ADX <strong>and</strong> SCT). For Active Directory service users, account policy settings – includingmaximum password age, account lockout, password uniqueness, password complexity – are controlled outside of<strong>the</strong> Metasys system by <strong>the</strong> Active Directory service domain server. These settings are shaded when displayed in<strong>the</strong> Security Administrator System window. The Session Timeout attribute is one exception.Default Administrator AccountsThe MetasysSysAgent <strong>and</strong> BasicSysAgent accounts (both Metasys local accounts) are <strong>the</strong> default Administratoraccounts. These accounts cannot be renamed or deleted from <strong>the</strong> system. The MetasysSysAgent account retainsfull administrative rights, <strong>and</strong> <strong>the</strong>se rights cannot be changed. The BasicSysAgent account retains a subset ofadministrative rights, in that Basic Access administrators can administer only user accounts that have been assigned<strong>the</strong> Basic Access access type.Important: The first time you log in with <strong>the</strong> MetasysSysAgent account using <strong>the</strong> new default password, or <strong>the</strong>BasicSysAgent account with <strong>the</strong> original default password, <strong>the</strong> system prompts you to change <strong>the</strong>password immediately. This new behavior enhances <strong>the</strong> overall security of <strong>the</strong> Metasys system. Fordetails about <strong>the</strong> new default password, contact your local Johnson Controls representative.Metasys system local user name <strong>and</strong> password pairs are stored only in <strong>the</strong> system proprietary user store, with oneexception. For engines (excluding <strong>the</strong> NxE85 <strong>and</strong> LCS85), <strong>the</strong> MetasysSysAgent account is also mirrored in <strong>the</strong>operating system as a Windows account with full administrative privileges. The password of <strong>the</strong> MetasysSysAgentoperating system account is controlled by <strong>the</strong> resetting of <strong>the</strong> MetasysSysAgent account through <strong>the</strong> Site ManagementPortal UI. Changing <strong>the</strong> account password in <strong>the</strong> Metasys system also changes <strong>the</strong> Windows operating systemaccount password in <strong>the</strong> supervisory controller.For <strong>the</strong> server-based NxE85 at Release 4.0 or later <strong>and</strong> <strong>the</strong> LCS85, <strong>the</strong> MetasysSysAgent account on <strong>the</strong> Windowsoperating system is not linked to <strong>the</strong> MetasysSysAgent account on <strong>the</strong> Site Management Portal UI. Changing <strong>the</strong>account password in <strong>the</strong> Metasys system does not change <strong>the</strong> Windows operating system account password. Thepasswords are independent.Note: The Windows operating system accounts <strong>and</strong> Metasys system local accounts never have been linked on <strong>the</strong>ADS/ADX.For in<strong>for</strong>mation on NAE35/NAE45/NAE55/NIE55/NIE59/NCE25 operating system security, see Security on Non-ServerBased Engines.Complex PasswordsComplex password requirements <strong>for</strong> Metasys local accounts are enabled by default when you install an ADX withMetasys <strong>for</strong> Validated Environments (MVE) Extended Architecture. For o<strong>the</strong>r ADSs/ADXs <strong>and</strong> supervisory engines,<strong>the</strong> complex password requirement is not enabled. For details on complex passwords, refer to <strong>the</strong> SecurityAdministrator System <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201528).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>39


To define a complex password <strong>for</strong> an ADX with MVE, or any ADS/ADX or supervisory engine, you need to:• create a password with at least six characters• use at least three of <strong>the</strong> following character types:- uppercase letter (A-Z)- lowercase letter (a-z)- number (0-9)- symbol (<strong>for</strong> example: # %)- non-alphanumeric or non-symbol character (example: 0244)• avoid using three consecutive characters from <strong>the</strong> user name. Using three consecutive characters from <strong>the</strong> username is not allowed. For example, if <strong>the</strong> user name is Fred, <strong>the</strong> password cannot contain Fre or red.You can enable or disable <strong>the</strong> complex password requirements using <strong>the</strong> procedure in this section.To enable or disable complex passwords:1. Log out of <strong>the</strong> Metasys system Site Management Portal UI.2. Using Windows Explorer, browse to C:\Inetpub\wwwroot\MetasysIII\UI\com\jci\framework.3. Using a text editor, open frameworkproperties.properties.4. Go to <strong>the</strong> bottom of <strong>the</strong> file <strong>and</strong> enter <strong>the</strong> following new requireComplexPasswords setting on its own line:requireComplexPasswords=trueSpecify true to enable complex passwords or false to disable complex passwords.5. Save <strong>the</strong> file.6. Restart <strong>the</strong> ADS/ADX computer to allow <strong>the</strong> Site Management Portal to initialize <strong>the</strong> complex passwordrequirement.7. Log on to <strong>the</strong> Metasys system using your existing password.8. Change <strong>the</strong> passwords so <strong>the</strong>y meet <strong>the</strong> complexity requirements, referring to <strong>the</strong> Security Administrator System<strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201528) <strong>for</strong> assistance.AuditingThe Metasys system offers user action auditing within <strong>the</strong> system. In o<strong>the</strong>r words, <strong>the</strong> software can trace each actionback to <strong>the</strong> logged-on user who per<strong>for</strong>med <strong>the</strong> action, <strong>and</strong> list that in<strong>for</strong>mation in <strong>the</strong> Audit Viewer. For Active Directoryservice users, <strong>the</strong> name recorded is <strong>the</strong> fully qualified user name (<strong>for</strong> example, myuser@division.company.com).Audits are written to a proprietary data store of <strong>the</strong> Metasys system, which is a SQL Server database oncomputer/server plat<strong>for</strong>ms (ADS/ADX, NxE85, <strong>and</strong> LCS85) <strong>and</strong> an XML-based file on <strong>the</strong> o<strong>the</strong>r engine plat<strong>for</strong>ms(NAE35/NAE45/NAE55/NIE55/NIE59/NCE25). Audits may be viewed using <strong>the</strong> Audit Trail feature of <strong>the</strong> SiteManagement Portal UI.DeviceIntra-computer Metasys system local accounts are used to per<strong>for</strong>m au<strong>the</strong>ntication <strong>and</strong> authorization among deviceswithin <strong>the</strong> Metasys system. An intra-computer account is a Metasys system site account, which means <strong>the</strong> accountresides in <strong>the</strong> same proprietary user store as <strong>the</strong> o<strong>the</strong>r Metasys users. But, <strong>the</strong> intra-computer account cannot beadministered <strong>and</strong> cannot be used to log on to <strong>the</strong> system through <strong>the</strong> Site Management Portal UI. The intra-computeraccount uses a generated password that is programmatically changed once a day. Active Directory service accountsare not used <strong>for</strong> intra-computer accounts.Secure Sockets Layer (SSL)The Metasys Advanced Reporting System <strong>and</strong> <strong>the</strong> Ready Access Portal UI are <strong>the</strong> two Metasys system offeringsthat support SSL. We recommend that you implement SSL security <strong>for</strong> improved protection of user passwords whenusing <strong>the</strong> Metasys Advanced Reporting System (including when you use <strong>the</strong> reporting system on ADXs with MVE).SSL security is required <strong>for</strong> <strong>the</strong> Ready Access Portal UI.The steps in <strong>the</strong>se sections should be done be<strong>for</strong>e you install <strong>the</strong> Metasys Advanced Reporting System or ReadyAccess Portal software on your site.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>40


Implementing SSL Security <strong>for</strong> <strong>the</strong> Metasys Advanced Reporting SystemTo implement SSL security <strong>for</strong> <strong>the</strong> Metasys Advanced Reporting System:1. Generate a certificate request <strong>and</strong> install <strong>the</strong> certificate.For more in<strong>for</strong>mation on <strong>the</strong>se steps, see <strong>the</strong> following address:http://technet.microsoft.com/en-us/library/cc771438(WS.10).aspx2. Configure <strong>the</strong> Metasys software to use HTTPS (SSL) <strong>and</strong> HTTP protocols on <strong>the</strong> computer where you plan toinstall <strong>the</strong> reporting system.a. In Control Panel:• In Windows Server 2012 or Windows Server 2008 R2 with SP1, select System <strong>and</strong> Security, <strong>the</strong>nAdministrative Tools. On Administrative Tools, double-click Internet In<strong>for</strong>mation Services (IIS) Manager.• In Windows Server 2008 SP2, select System <strong>and</strong> Maintenance, <strong>the</strong>n Administrative Tools. OnAdministrative Tools, double-click Internet In<strong>for</strong>mation Services (IIS) Manager.b. In <strong>the</strong> tree in <strong>the</strong> left pane, browse to <strong>and</strong> exp<strong>and</strong> Sites or Web Sites.c. In <strong>the</strong> right pane, right-click Default Web Site <strong>and</strong> select Edit Bindings. The Site Bindings box appears.Figure 14: Site Bindingsd. Click Edit. Verify that <strong>the</strong> SSL port field contains 443 (Figure 15).Note: Port 80 must be open on <strong>the</strong> ADX <strong>for</strong> communication from o<strong>the</strong>r system devices. Verify that <strong>the</strong> TCPport entry is 80.Figure 15: SSL Port Field: 443e. Click OK.f. Close <strong>the</strong> Internet In<strong>for</strong>mation Services (IIS) Manager window.g. Install <strong>the</strong> ADX software with Metasys Reporting. For details, refer to <strong>the</strong> ADS/ADX Installation section of<strong>the</strong> ADS, ADX, <strong>and</strong> SCT Installation <strong>and</strong> Upgrade Instructions (12011521).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>41


h. Using Windows Explorer, browse to:C:\Inetpub\wwwroot\MetasysIII\UI\com\jci\frameworki. Using a text editor, open frameworkproperties.properties.j. Update <strong>the</strong> advancedReportingURL setting line to use https: instead of http: so it appears like <strong>the</strong> following:advancedReportingURL=https://SERVERNAME/MetasysReportsk. Save <strong>the</strong> file.l. Using Windows Explorer, browse to:C:\Inetpub\wwwroot\MetasysReportsm. Using a text editor, open services.config.n. Delete <strong>the</strong> comment tags from <strong>the</strong> file. Comment markers appear as (Figure 16).Note: Do not delete <strong>the</strong> text between <strong>the</strong> comment tags. Delete only <strong>the</strong> text circled in Figure 13. Deleteall three sets of comment tags that appear in <strong>the</strong> file.Figure 16: Comment Tagso. Save <strong>the</strong> file.p. Close all Windows Explorer windows.q. Do <strong>the</strong> following depending on your operating system:• In Windows Server 2012 or Windows Server 2008 R2 with SP1, on <strong>the</strong> Start menu, in <strong>the</strong> Run text box,type regedit.• In Windows Server 2008 SP2, on <strong>the</strong> Start menu, select All Programs > Accessories > Run. The Rundialog box appears. Type regedit.r. Click OK. The Registry Editor window appears.s. In <strong>the</strong> tree on <strong>the</strong> left, browse to HKEY_LOCAL_MACHINE > Software > Johnson Controls > Metasys >ADS.t. On <strong>the</strong> right side of <strong>the</strong> screen, double-click SSRSWebURL. The Edit String box appears.u. In <strong>the</strong> Value data field, add an s after http. The value should be: https://(ADx Server Name)/ReportServer(Figure 17).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>42


Figure 17: Edit String Boxv. Click OK.w. Close <strong>the</strong> Registry Editor.3. Restart <strong>the</strong> computer.4. Log on to <strong>the</strong> Metasys Advanced Reporting System UI.The UI should open correctly <strong>and</strong> <strong>the</strong> URL in <strong>the</strong> browser window should have <strong>the</strong> https: prefix.Implementing SSL <strong>for</strong> Ready Access Portal U<strong>IT</strong>o implement SSL security <strong>for</strong> <strong>the</strong> Ready Access Portal UI, follow <strong>the</strong> steps during installation of <strong>the</strong> software. Youcan add SSL <strong>for</strong> <strong>the</strong> logon only or <strong>for</strong> <strong>the</strong> entire Ready Access Portal UI. The options <strong>for</strong> SSL certificates include <strong>the</strong>following:• Third-Party – Coordinate with <strong>the</strong> customer <strong>IT</strong> department be<strong>for</strong>e installing <strong>the</strong> Ready Access Portal software toconfigure IIS correctly.• Self-Signed – Follow <strong>the</strong> installation process that allows you to generate a self-signed certificate.Note: We do not recommend a self-signed certificate <strong>for</strong> networks exposed directly to <strong>the</strong> Internet (no firewall orVPN).You also must have Port 80 (TCP) <strong>and</strong> Port 443 (SSL) open on <strong>the</strong> computer where <strong>the</strong> Ready Access Portalsoftware is installed. To open Port 443 on <strong>the</strong> computer where you are going to install <strong>the</strong> Ready Access Portal:1. In Control Panel:• In Windows 7 in <strong>the</strong> search box, type administrative tools, <strong>and</strong> <strong>the</strong>n click Administrative Tools.• In Windows XP, select Administrative Tools > IIS Manager.• In Windows 8, Windows Server 2012, or Windows Server 2008 R2 with SP1, select System <strong>and</strong> Security,<strong>the</strong>n Administrative Tools. On Administrative Tools, double-click Internet In<strong>for</strong>mation Services (IIS) Manager.The IIS Manager window appears.• In Windows Server 2008 SP2, select System <strong>and</strong> Maintenance, <strong>the</strong>n Administrative Tools. In AdministrativeTools, double-click Internet In<strong>for</strong>mation Services (IIS) Manager. The IIS Manager window appears.2. In <strong>the</strong> tree in <strong>the</strong> left side of <strong>the</strong> screen, browse to <strong>and</strong> exp<strong>and</strong> Sites or Web Sites.3. On <strong>the</strong> right side of <strong>the</strong> screen, right-click Default Web Site <strong>and</strong> select Properties. The Default Web Site Propertiesbox appears.4. On <strong>the</strong> Web Site tab, verify that <strong>the</strong> SSL port field contains 443 (Figure 15).Note: Port 80 must be open on <strong>the</strong> ADX <strong>for</strong> communication from o<strong>the</strong>r system devices. Verify that <strong>the</strong> TCP portentry is 80.5. Click OK.6. Close <strong>the</strong> IIS Manager window.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>43


Metasys <strong>for</strong> Validated Environments (MVE)MVE is an enhanced feature of <strong>the</strong> Metasys system that audits user management <strong>for</strong> critical environments to facilitateU.S. Food <strong>and</strong> Drug Administration (FDA) electronic records <strong>and</strong> signature requirements (Title 21 Code of FederalRegulation [CFR] Part 11). MVE is also compliant with o<strong>the</strong>r similar agencies around <strong>the</strong> world that deal with electronicrecords <strong>and</strong> electronic signature requirements, such as Annex 11 of <strong>the</strong> European Union Good ManufacturingPractice (EU GMP) regulations (European Medicines Agency [EMEA] 1998).MVE provides secure data management <strong>and</strong> reporting capabilities, traceable electronic records <strong>and</strong> signatures, <strong>and</strong>time-stamped audit trails <strong>for</strong> facilities subject to Part 11 compliance. Any action or change initiated by <strong>the</strong> user on avalidated device, such as alarm acknowledgment or setpoint adjustment, requires user reau<strong>the</strong>ntication <strong>and</strong> electronicsignature with required annotation.Additionally, complex passwords that are enabled by default <strong>and</strong> message encryption secure <strong>the</strong> system fromunauthorized access <strong>and</strong> data tampering. The system uses Internet protocols <strong>and</strong> <strong>IT</strong> st<strong>and</strong>ards, <strong>and</strong> is compatiblewith enterprise level communication networks.MVE can be used only on an ADX running Windows Server 2012, Windows Server 2008 R2 with SP1, or WindowsServer 2008 SP2 with supported versions of SQL Server 2012, SQL Server 2008 R2, or SQL Server 2008 software.Also, MVE supports access by Active Directory service users of <strong>the</strong> Metasys system from <strong>the</strong> st<strong>and</strong>ard login screen.SSO login-free access is not supported because SSO is disabled <strong>for</strong> MVE installed on an ADX.For more in<strong>for</strong>mation, refer to <strong>the</strong> Metasys <strong>for</strong> Validated Environments, Extended Architecture <strong>Technical</strong> <strong>Bulletin</strong>(L<strong>IT</strong>-12011327).<strong>Network</strong> Message SecurityMetasys software offers secured au<strong>the</strong>ntication challenges at logon. These include:• RSA exchange (using 1025-bit key) of RC2 Session Key (64-bit key)• RC2 encrypted credentials (user name <strong>and</strong> password)After logon, <strong>the</strong> Metasys software au<strong>the</strong>nticates each SOAP message at <strong>the</strong> receiving engine. Au<strong>the</strong>ntication isbased on RC2 encrypted credentials, which may be a session token or user name <strong>and</strong> password pair. Within eachencrypted SOAP message header, <strong>the</strong>re is protection against message spoofing, message replay, <strong>and</strong> messagetampering.SQL Database SecuritySQL Server databases are secured using SQL Server au<strong>the</strong>ntication.SQL Server software accounts used by Metasys software can be end-user defined on <strong>the</strong> ADS/ADX plat<strong>for</strong>m. Addedsecurity is possible if you separate <strong>the</strong> Database Server function of <strong>the</strong> ADX from <strong>the</strong> web/application Server functionof <strong>the</strong> ADX. In this scenario, <strong>the</strong> Database Server portion of <strong>the</strong> ADX can reside in a different DMZ from <strong>the</strong>web/spplication Server portion of <strong>the</strong> ADX.Security on Non-Server Based EnginesThe operating system of <strong>the</strong> NAE35/NAE45/NAE55/NIE55/NIE59/NCE25 is secured using an account in <strong>the</strong> controller'sembedded operating system. This account is <strong>the</strong> MetasysSysAgent account <strong>and</strong> is <strong>the</strong> only Windows account locatedon <strong>the</strong>se devices. The account has administrative privileges <strong>and</strong> <strong>the</strong> password can be changed by logging in to <strong>the</strong>device directly with <strong>the</strong> Site Management Portal UI <strong>and</strong> resetting <strong>the</strong> password of <strong>the</strong> Metasys system userMetasysSysAgent. The MetasysSysAgent user is <strong>the</strong> only account that exists both in <strong>the</strong> proprietary user store ofMetasys user accounts <strong>and</strong> in <strong>the</strong> operating system.Many of <strong>the</strong> operating system features not required by Metasys software have been removed from <strong>the</strong> engines,rendering <strong>the</strong>m less vulnerable to operating system attack.Security Updates ManagementA Johnson Controls engineering team regularly evaluates newly released Microsoft security updates ranked Criticalor Important <strong>for</strong> <strong>the</strong>ir effect on <strong>the</strong> Metasys system. The results of <strong>the</strong> update analysis can be obtained from JohnsonControls technical support.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>44


For Metasys system engines, we send out applicable security updates through our support channels with instructions<strong>for</strong> applying <strong>the</strong>m. For <strong>the</strong> computer-based components of <strong>the</strong> Metasys system (ADS/ADX, NxE85, <strong>and</strong> LCS85),you can apply Microsoft security updates as soon as <strong>the</strong>y are released by <strong>the</strong> Microsoft Corporation.To ensure higher security <strong>for</strong> <strong>the</strong> Site Management Portal, a private JRE is required at Release 6.0 or later thatprovides isolation between Metasys software <strong>and</strong> <strong>the</strong> Internet. The public Java® Runtime Environment (JRE) thatwas required at earlier Metasys software releases is no longer necessary <strong>for</strong> Release 6.0 or later, but it still arequirement <strong>for</strong> any older release of Metasys software. A new application called <strong>the</strong> Launcher puts down <strong>the</strong> privateJRE required by Release 6.0 or later. You install it when you first browse to <strong>the</strong> Site Management Portal UI from aclient computer or when you newly install Metasys system software. Thereafter, you use <strong>the</strong> Launcher to access<strong>the</strong> Site Management Portal UI. Refer to <strong>the</strong> Launcher Installation Instructions (L<strong>IT</strong>-12011783) <strong>for</strong> instructions abouthow to install <strong>the</strong> Launcher application.Note: If you use any applications from a release prior to Release 6.0 or later, you must continue to use <strong>the</strong> publicJRE required <strong>for</strong> that particular software release.Software BombsMetasys software does not have a software time bomb to disable <strong>the</strong> system. However, <strong>the</strong> software does remindyou periodically if you do not license <strong>the</strong> product. Reminders appear as pop-up messages when you are using <strong>the</strong>Site Management Portal UI <strong>and</strong> as a special tab within <strong>the</strong> UI that appears until you license <strong>the</strong> product.Antivirus Software Considerations (ADS/ADX, NxE85, <strong>and</strong> LCS85 Only)Frequent virus scans of <strong>the</strong> ADS/ADX, NxE85, <strong>and</strong> LCS85 are necessary to maintain <strong>the</strong> integrity of your system.We support virus scans on computer-based <strong>and</strong> server plat<strong>for</strong>m-based Metasys system components only (ADS/ADX,NxE85, <strong>and</strong> LCS85). The NAE35/NAE45/NAE55/NIE55/NIE59/NCE25 <strong>and</strong> o<strong>the</strong>r Metasys system components notrunning on a computer do not support virus scans; however, many of <strong>the</strong> operating system features not required byMetasys software have been removed from <strong>the</strong> engines, rendering <strong>the</strong>m less vulnerable to operating system attacks.We have tested <strong>the</strong> ADS/ADX, NxE85, <strong>and</strong> LCS85 successfully with <strong>the</strong> following antivirus software programs:• Symantec AntiVirus Corporate Edition 9.0 software or later (recommended <strong>for</strong> <strong>the</strong> NxE85 <strong>and</strong> LCS85)• McAfee® VirusScan® 2004 Version 8.0 software or laterNote: Turnkey versions of <strong>the</strong> NxE85 <strong>and</strong> LCS85 ship with Symantec AntiVirus Corporate Edition Version 11.ADS/ADX ConsiderationsADX-Specific FeaturesSee <strong>the</strong> Metasys <strong>for</strong> Validated Environments (MVE) <strong>and</strong> Metasys Advanced Reporting System UI sections <strong>for</strong>in<strong>for</strong>mation on <strong>the</strong>se two features that are available only on ADXs with specific components installed.ADX Split ConfigurationThe ADX software <strong>and</strong> its associated database software are often installed on one computer (unified ADX). However,<strong>the</strong> ADX also can be installed in a split configuration, which involves installing ADX-related software on two separatecomputers. The computer running SQL Server software is known as <strong>the</strong> Database server computer, <strong>and</strong> it storeshistorical Metasys system data. The ADX software itself <strong>and</strong> all required ADX prerequisites reside on a secondcomputer, known as <strong>the</strong> web/application server computer. Additionally, in a split configuration, <strong>the</strong> SCT must resideon a third computer. Users browse to <strong>the</strong> web/application server computer to see system data. The Database servercomputer cannot be used as a historical data repository by more than one web/application server computer.Figure 18: Split ADX in a <strong>Network</strong><strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>45


ADSADX Log FolderThe ADSADX Log folder in <strong>the</strong> Windows Event Viewer on <strong>the</strong> ADS/ADX contains in<strong>for</strong>mation related to specificADS/ADX software failures or important events. The messages appear in English only.Note: In a split ADX, this folder is on <strong>the</strong> web/application server computer.The following events appear in <strong>the</strong> ADSADX Log folder:• The ADS/ADX software has a failure initializing any subsystem during startup.• The ADS/ADX software has a failure during runtime when it tries to write to <strong>the</strong> Microsoft SQL Server database.• The ADS/ADX or SCT software has a failure during runtime <strong>for</strong> interactions with Active Directory services. Forexample, an Active Directory service user was denied access to <strong>the</strong> ADS/ADX or SCT software, or an ActiveDirectory service user could not be added as an ADS/ADX or SCT user.• The ADSADX Log reports a message queue timeout has occurred. The message contains <strong>the</strong> textSystem.Messaging.Message.QueueException: Timeout <strong>for</strong> <strong>the</strong> requested operating has expired. Thisevent indicates that MSMQ encountered an exception while reading an empty message queue. The sporadicappearance of this error in <strong>the</strong> ADSADX Log is normal. Because <strong>the</strong> error only occurs when <strong>the</strong> message queueis empty, all Metasys system messages have been processed successfully. However, if this error occurs constantlyor continually over brief periods of time, <strong>the</strong>re may be a problem with message queuing. Report this behavior toyour Johnson Controls support representative.The ADSADX Log folder defaults to Overwrite as Necessary. If you would like to save all events or have a certainEvent Log folder size, right-click <strong>the</strong> folder in <strong>the</strong> Windows Event Log <strong>and</strong> change this property.Note: A display problem exists when viewing <strong>the</strong> properties of <strong>the</strong> ADSADX Log in <strong>the</strong> Windows Event Viewer.Even though <strong>the</strong> folder defaults to Overwrite as Necessary when <strong>the</strong> folder is created during <strong>the</strong> first startupof <strong>the</strong> ADS/ADX, it appears in <strong>the</strong> Windows Event Viewer as Overwrite Events Older Than. The file isOverwrite as Necessary.Additional errors write to <strong>the</strong> Windows Event Viewer Application folder. Any event in this folder is a result of in<strong>for</strong>mationgenerated by or an error in <strong>the</strong> Metasys III Device Manager service (MIIIDM source).The Windows Event Viewer is located in <strong>the</strong> Control Panel > Administrative Tools > Event Viewer.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>46


The Windows Internet Explorer Web BrowserAdvanced Security ConfigurationWhen an ADX is installed, Windows Internet Explorer Advanced Security Configuration is enabled by default. Youmust add any website you want to navigate to from <strong>the</strong> ADS/ADX Internet Explorer web browser to <strong>the</strong> list of trustedwebsites. This applies to all external websites.We strongly advise that you do not browse to <strong>the</strong> Metasys Site Management Portal UI from a computer running aserver class operating system. By default, Windows Internet Explorer Enhanced Security Configuration is enabledon server class operating systems <strong>and</strong> may block <strong>the</strong> Launcher download page from which you install <strong>the</strong> Launcherapplication <strong>for</strong> access to <strong>the</strong> Site Management Portal. Open <strong>the</strong> Site Management Portal UI from a computer thatis not running a server class operating system.SmartScreen FilterIf you are using a private network, we recommend you turn off <strong>the</strong> Internet Explorer SmartScreen Filter feature.Failure to do so does not prevent Metasys software from running, but may launch multiple UI windows unnecessarily.Anti-Spyware ConsiderationsAnti-spyware packages alert users when changes are made to <strong>the</strong>ir operating systems by unidentified applications,programs, or services <strong>and</strong> may also allow <strong>the</strong> users to control <strong>the</strong>se changes to <strong>the</strong>ir operating systems. For example,changes may occur in Internet Explorer web browser settings, processes running, or dial-up connections.The anti-spyware software may also allow <strong>the</strong> user to designate which services can run on an ADS/ADX. TheMetasys Device Manager, Metasys Action Queue, <strong>and</strong> Metasys Report Cache Refresh may appear on <strong>the</strong> list ofservices as unknown/unreliable. In both of <strong>the</strong>se cases, in <strong>the</strong> anti-spyware tool, <strong>the</strong> Publisher attribute of <strong>the</strong> processdoes not identify <strong>the</strong> process as a Johnson Controls process, nor does <strong>the</strong> term Metasys appear in <strong>the</strong> name. Bothof <strong>the</strong>se services must be allowed to run on <strong>the</strong> ADS/ADX.Additionally, anti-spyware software may not allow <strong>the</strong> ADS/ADX software to write to <strong>the</strong> hosts file. Some anti-spywaresoftware warns <strong>the</strong> user changes are to be made <strong>and</strong> <strong>the</strong> user must accept or reject <strong>the</strong> changes. O<strong>the</strong>r anti-spywarepackages do not allow <strong>the</strong> change to occur at all until <strong>the</strong> software is configured.For more in<strong>for</strong>mation, refer to <strong>the</strong> ADS/ADX Commissioning Guide (L<strong>IT</strong>-1201645).Backup Considerations <strong>for</strong> <strong>the</strong> ADS/ADXIf a backup program changes attributes in certain ADS/ADX files, <strong>the</strong> ADS/ADX may shut down <strong>and</strong> <strong>the</strong>n restart. Toavoid this scenario, we recommend that you always avoid backing up <strong>the</strong> following files <strong>and</strong> folders, <strong>and</strong> exclude<strong>the</strong>m from any o<strong>the</strong>r programs that access <strong>the</strong>se directories in <strong>the</strong> ADS/ADX:• C:\Inetpub\wwwroot\MetasysIII\GLOBAL.ASAX• C:\Inetpub\wwwroot\MetasysIII\WEB.CONFIG• C:\Inetpub\wwwroot\MetasysIII\BIN• C:\\Microsoft.NET\Framework\v1.1.4332\CONFIG• C:\\Microsoft.NET\Framework\v2.0.50727\CONFIG• C:\Windows\Microsoft.NET\Framework\v4.0.30319\Config• C:\Windows\Microsoft.NET\Framework64\v2.0.50727\CONFIG• C:\Windows\Microsoft.NET\Framework64\v4.0.30319\Config• C:\Inetpub\wwwroot\MetasysReports\bin (Metasys Advanced Reporting System only)• C:\Inetpub\wwwroot\MetasysReports\web.config (Metasys Advanced Reporting System only)Supported Operating System <strong>and</strong> SQL Server Software VersionsRefer to <strong>the</strong> literature <strong>for</strong> <strong>the</strong> Metasys products you are installing <strong>for</strong> a list of supported operating system <strong>and</strong> SQLServer software versions. For an overview of software supported by <strong>the</strong> Metasys system, refer to <strong>the</strong> PrerequisitesOverview <strong>for</strong> Supported Releases section of ADS, ADX, <strong>and</strong> SCT Installation <strong>and</strong> Upgrade Instructions WizardContent (L<strong>IT</strong>-12011331).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>47


As new software <strong>and</strong> service packs become available, Johnson Controls tests <strong>the</strong>m <strong>for</strong> use with Metasys software.We do not recommend installing software or a service pack on a computer running Metasys software unless it hasbeen tested <strong>and</strong> qualified.Internet In<strong>for</strong>mation Server (IIS) Anonymous Access Considerations (ADS/ADX<strong>and</strong> SCT)General In<strong>for</strong>mationThe Default Web Site of IIS must allow anonymous access to successfully install <strong>the</strong> ADS/ADX or SCT software.After ADS/ADX or SCT installation is complete, you may disable anonymous access <strong>for</strong> <strong>the</strong> default website as asecurity measure. However, disabling anonymous access to <strong>the</strong> default website is only necessary if required bysome o<strong>the</strong>r third-party software application. See Enabling <strong>and</strong> Disabling Anonymous Access on <strong>the</strong> Default WebSite. At ADS/ADX <strong>and</strong> SCT runtime, it is not necessary <strong>for</strong> <strong>the</strong> default website of IIS to allow anonymous access;however, it is necessary to always allow anonymous access to <strong>the</strong> Metasys or SCT virtual website <strong>and</strong> MetasysIIIvirtual folder.For more in<strong>for</strong>mation, refer to <strong>the</strong> ADS, ADX, <strong>and</strong> SCT Installation <strong>and</strong> Upgrade Instructions Wizard (L<strong>IT</strong>-12011521)or <strong>the</strong> ADS-Lite Installation <strong>and</strong> Upgrade Instructions Wizard (L<strong>IT</strong>-12011688).Enabling <strong>and</strong> Disabling Anonymous Access on <strong>the</strong> Default Web SiteEnable <strong>and</strong> disable anonymous access in <strong>the</strong> following order when installing <strong>and</strong> running <strong>the</strong> ADS/ADX or SCTsoftware:Note: These steps should only be followed if a user needs to disable anonymous access to <strong>the</strong> default web site <strong>for</strong>a third-party application requirement.1. Enable Anonymous Access on <strong>the</strong> default web site.2. Install <strong>the</strong> ADS/ADX or SCT software.3. Disable Anonymous Access on <strong>the</strong> default web site.4. Enable Anonymous Access <strong>for</strong> MetasysIII <strong>and</strong> SCT Virtual Directories <strong>and</strong> Metasys Web Site.The user who is assigned as <strong>the</strong> anonymous access user <strong>for</strong> <strong>the</strong> web site <strong>and</strong>/or <strong>the</strong> group that this user belongsto must have <strong>the</strong> following privileges:• access this computer from <strong>the</strong> network• allow logon locally• log on as a batch jobThe user who is assigned as <strong>the</strong> anonymous access user <strong>for</strong> <strong>the</strong> web site <strong>and</strong>/or <strong>the</strong> group that this user belongsto must not have <strong>the</strong> privilege deny access to this computer from <strong>the</strong> network.Be<strong>for</strong>e changing your customer’s IIS anonymous access settings, consult with your customer <strong>and</strong>/or your customer’s<strong>IT</strong> department to make sure <strong>the</strong> changes do not violate network security policies.For troubleshooting in<strong>for</strong>mation about anonymous access <strong>and</strong> <strong>the</strong> ADS/ADX, refer to <strong>the</strong> ADS, ADX, <strong>and</strong> SCTInstallation <strong>and</strong> Upgrade Instructions Wizard (L<strong>IT</strong>-12011521).DatabasesMicrosoft SQL Database ConsiderationsAll versions of SQL Server software must be set up in Mixed Mode Au<strong>the</strong>ntication <strong>and</strong> configured to use both <strong>the</strong>TCP/IP port 1433 <strong>and</strong> Named Pipes protocols. When upgrading to a new version of SQL Server software, you mustpreserve this configuration because <strong>the</strong> upgrade process turns off <strong>the</strong> network protocols.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>48


Consider <strong>the</strong> following general database recommendations:• The unified ADS/ADX is incompatible with server clusters. For a split ADX, <strong>the</strong> Database Server computer canbe part of a server cluster.• Run SQL Server databases in Simple Recovery mode to reduce <strong>the</strong> risk of system failure due to lack of diskspace. Simple recovery mode allows you to restore from <strong>the</strong> previous night’s backup only. For point-in-timerecovery, run <strong>the</strong> databases in Full Recovery mode <strong>and</strong> back up your transaction log at least every 24 hours.Failure to per<strong>for</strong>m Transaction log backups at this interval eventually results in system failure due to lack ofavailable disk space.• Confirm that SQL Server database backups are being per<strong>for</strong>med correctly <strong>and</strong> consistently to prevent datacorruption. Check periodically to make sure <strong>the</strong> backups are present <strong>and</strong> restorable. Create backups using <strong>the</strong>Metasys Database Manager or <strong>the</strong> tools listed in Database Management: SQL Server Tools. Each backup shouldbe saved in separate locations.• Check periodically to make sure your database indexes are healthy because fragmented indexes greatly reducedatabase per<strong>for</strong>mance. Rebuild indexes as necessary using tools available from <strong>the</strong> <strong>IT</strong> department or <strong>the</strong> MetasysDatabase Manager. See Database Management: Metasys Database Manager <strong>and</strong> Database Management: SQLServer Tools.• Do not use third-party backup programs to backup <strong>the</strong> Metasys databases. Instead, use <strong>the</strong> tools provided bySQL Server software or use <strong>the</strong> Metasys Database Manager.• During installation, <strong>the</strong> ADS/ADX software installation program requires a user account with administrator accessto SQL Server databases to create <strong>and</strong> manage <strong>the</strong> ADS/ADX databases <strong>and</strong> SQL Server user accounts usedduring runtime of <strong>the</strong> ADS/ADX. This may be ei<strong>the</strong>r a SQL Server user account or a Windows operating systemuser account that has administrative rights in SQL Server databases. After <strong>the</strong> installation program creates <strong>the</strong>ADS/ADX databases <strong>and</strong> SQL Server user accounts, <strong>the</strong> account with administrator access to SQL Server isno longer used. You may remove SQL Server database administrator rights from this user.• During runtime, <strong>the</strong> ADS/ADX software uses <strong>the</strong> SQL Server user accounts that were created by <strong>the</strong> ADS/ADXinstallation program. For in<strong>for</strong>mation about managing <strong>the</strong> SQL Server user accounts used by <strong>the</strong> ADS/ADX(account rename <strong>and</strong> password changes), contact Johnson Controls technical support.The default location <strong>for</strong> <strong>the</strong> Metasys system databases is <strong>the</strong> following:• Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2 with SP1, <strong>and</strong> Windows Server 2008SP2: C:\ProgramData\Johnson Controls\MetasysIII\SQLData• Windows XP: C:\Documents <strong>and</strong> Settings\All Users\Application Data\Johnson Controls\MetasysIII\SQLDataThe historical databases <strong>for</strong> <strong>the</strong> ADS/ADX are JCIEvents, JCIAuditTrails, JCIHistorianDB, JCIAnnotations, <strong>and</strong>JCIReporting. Non-historical databases <strong>for</strong> <strong>the</strong> ADS/ADX include MetasysIII, XMS, MetasysTranslationDictionary(Metasys Advanced Reporting System only), <strong>and</strong> MetasysReporting (Metasys Advanced Reporting System only).CCT creates <strong>the</strong> CCT_DB <strong>and</strong> FDB_Control databases. The NavTreeCache database <strong>and</strong> any current MetasysSCT archive databases (SCT archive database names are user configured) also may be present.For in<strong>for</strong>mation on installing SQL Server software <strong>for</strong> use with a Metasys system, refer to <strong>the</strong> ADS, ADX, <strong>and</strong> SCTInstallation <strong>and</strong> Upgrade Instructions Wizard (L<strong>IT</strong>-12011521) or ADS-Lite Installation <strong>and</strong> Upgrade InstructionsWizard (L<strong>IT</strong>-12011688).Database Management: Metasys Database ManagerThe Metasys Database Manager allows you to purge, back up, restore, <strong>and</strong> monitor your Metasys system SQLServer databases. This tool is included on all ADSs/ADX media <strong>and</strong> is compatible with all versions of SQL Serversoftware supported by <strong>the</strong> installed release of Metasys software. Refer to <strong>the</strong> Metasys Database Manager Help(L<strong>IT</strong>-12011202) <strong>for</strong> more in<strong>for</strong>mation.Database Management: SQL Server ToolsIn addition to or instead of <strong>the</strong> Metasys Database Manager, you can use <strong>the</strong> following Microsoft Corporation toolsto maintain your SQL Server databases:<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>49


Table 13: SQL Server Software Maintenance ToolsSQL Server Software Family Microsoft Corporation Database ToolIncluded with SQL ServerSoftware? 1SQL Server 2008 SoftwareSQL Server 2008 Express SoftwareSQL Server Management StudioMicrosoft SQL Server Management StudioExpress (SSMSE)YesNo 21 All tools are available on http://www.microsoft.com/downloads.2 Available with versions that include Management Tools or Advanced Services.For specific steps on how to back up <strong>and</strong> manage Metasys system databases using <strong>the</strong>se tools, go tohttp://www.microsoft.com. You do not need to stop Metasys system services to per<strong>for</strong>m a database backup.Historical Data StorageNAE35s/NAE45s/NAE55s/NIE55s/NCE25s store a limited amount of alarm, trend, <strong>and</strong> audit trail in<strong>for</strong>mation. Afterengines collect data, you can <strong>for</strong>ward <strong>the</strong> data to an ADS/ADX <strong>and</strong> save <strong>the</strong> data on <strong>the</strong> hard disk <strong>for</strong> long-termstorage.Historical data on engines <strong>and</strong> ADSs/ADXs can be copied to <strong>the</strong> clipboard <strong>and</strong> pasted into a spreadsheet, wordprocessor, or database program. You can use Metasys Export Utility software to extract <strong>the</strong> historical data from <strong>the</strong>Metasys system to as many as six different file <strong>for</strong>mats (such as Microsoft Excel) <strong>for</strong> easier viewing.Data SharingADSs/ADXs store collected system data in a SQL Server database. Johnson Controls support channels can providedatabase schemas via <strong>the</strong> schema release process upon request.Data Backup/RestoreFor in<strong>for</strong>mation on SQL Server software backups, see <strong>the</strong> Microsoft SQL Database Considerations section.Use <strong>the</strong> System Configuration Tool (SCT) to back up <strong>and</strong> restore Metasys user accounts/privileges <strong>and</strong> to back up,restore, <strong>and</strong> create archives of Metasys configuration data. Refer to <strong>the</strong> SCT <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201534) <strong>for</strong>details.Site Management Portal U<strong>IT</strong>he Site Management Portal UI comprises a Java application, which runs with a private JRE. See Java Software<strong>and</strong> Private JREs <strong>for</strong> a definition of private JREs. The Java security model allows only trusted applications to per<strong>for</strong>mcertain activities such as printing, connecting to <strong>the</strong> network, retrieving system in<strong>for</strong>mation, <strong>and</strong> accessing yourcomputer’s local file system. Trusted applications must be digitally signed <strong>and</strong> must be granted permissions by <strong>the</strong>end user.The Metasys Site Management Portal UI is digitally signed with a certificate provided by <strong>the</strong> VeriSign CertificateAuthority (CA). The certificate verifies that <strong>the</strong> Metasys system application has not been tampered with <strong>and</strong> isdistributed by Johnson Controls, Inc. A message appears stating that <strong>the</strong> security certificate was issued by a companythat is trusted <strong>and</strong> indicates whe<strong>the</strong>r your certificate is expired.Metasys Advanced Reporting System U<strong>IT</strong>he Metasys Advanced Reporting System offers a separate HTML-based UI in which you can run reports on systemconfiguration <strong>and</strong> per<strong>for</strong>mance. This system allows you to use a restricted access UI <strong>and</strong> avoid Java softwaredownloads <strong>for</strong> users with limited report <strong>and</strong> configuration needs.The Metasys Advanced Reporting System can be used only on ADXs running SQL Server 2008 R2 software or SQLServer 2008 software with SQL Server Reporting Services. Local Metasys system users with St<strong>and</strong>ard Accessaccess type privileges are authorized with <strong>the</strong> Advanced Reporting option in <strong>the</strong> Security Administrator System.Currently, Active Directory service users cannot access <strong>the</strong> Metasys Advanced Reporting System.For more in<strong>for</strong>mation, refer to <strong>the</strong> Metasys Advanced Reporting System Help (L<strong>IT</strong>-12011312).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>50


Java Software <strong>and</strong> Private JREsThe Site Management Portal (SMP) <strong>and</strong> SCT are Java applications, requiring a JRE plug-in on <strong>the</strong> local clientcomputer. Security vulnerabilities were often discovered in <strong>the</strong> public version of <strong>the</strong> JRE, which required <strong>the</strong> developerto release updated versions <strong>and</strong> <strong>for</strong> Johnson Controls to issue patches to <strong>the</strong> SMP <strong>and</strong> SCT software. To alleviatethis problem, Metasys no longer relies on a public JRE plug-in <strong>for</strong> Release 6.0 or later. Instead, it uses an internalprivate JRE that is bundled with an application <strong>and</strong> is installed locally on <strong>the</strong> computer <strong>for</strong> that application only. Theprivate JRE is not exposed to possible security risks <strong>and</strong> is compatible with <strong>IT</strong> department policies.To support <strong>the</strong> use of <strong>the</strong> private JRE, a new application called <strong>the</strong> Launcher was developed to allow you to managea list of all engines, ADS, ADX, SCT, LCS85, NIE, Ready Access Portal, Metasys Advanced Reporting, or anygeneric website links. The Launcher is a simple user interface that launches <strong>the</strong> UI <strong>for</strong> any Metasys release, butonly manages <strong>the</strong> local Java files <strong>for</strong> Release 6.x systems.If you need to configure your proxy settings, you must do so in <strong>the</strong> Launcher tool, not in <strong>the</strong> Java control panel. Fordetails, refer to Launcher Help (L<strong>IT</strong>-12011742).Public JRE files are still required <strong>for</strong> older versions of Metasys. Public JREs are installed in a public location (suchas C:\Program Files\Java\) <strong>and</strong> are known by <strong>the</strong> operating system to allow certain applications, such as Internetbrowsers, to access that JRE.Web Browser RecommendationsThe Windows Internet Explorer web browser (Version 8.0, 9.0, or 10.0) is required <strong>for</strong> downloading <strong>the</strong> Launcher.O<strong>the</strong>r web browsers may work but are not fully tested.The Launcher is a software application that is installed on each client computer that logs in to <strong>the</strong> Metasys ADS/ADXserver, SCT, or supervisory engine. The Launcher lets you access any Metasys server or supervisory engine on<strong>the</strong> building network, regardless of its software version. Starting at Release 6.0, you use <strong>the</strong> Launcher, not a webbrowser, to reach <strong>the</strong> log in screen of <strong>the</strong> NAE. For details, refer to Launcher Help (L<strong>IT</strong>-12011742).Note: We strongly advise that you do not browse to <strong>the</strong> Metasys Site Management Portal UI from a computerrunning a server class operating system. By default, Windows Internet Explorer Enhanced SecurityConfiguration is enabled on server class operating systems, <strong>and</strong> may block <strong>the</strong> Launcher download pagefrom which you install <strong>the</strong> Launcher application <strong>for</strong> access to <strong>the</strong> Site Management Portal. Open <strong>the</strong> SiteManagement Portal UI from a computer that is not running a server class operating system.Launcher Download Options <strong>and</strong> Proxy SettingsWhen <strong>the</strong> SMP is downloaded <strong>for</strong> <strong>the</strong> first time at Release 6.1, <strong>the</strong> Windows Launcher Download screen (Figure19) appears.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>51


Figure 19: Windows Launcher DownloadThe Launcher Download screen provides two choices: Full Launcher Installer <strong>and</strong> Single Site Connection.Full Launcher Installer DownloadIf you click Full Launcher Installer, a security warning screen appears (Figure 20. This screen gives you <strong>the</strong> optionto Run, Save, or Cancel.Figure 20: File Download - Security Warning ScreenClick Run on <strong>the</strong> File Download - Security Warning screen. The Internet Explorer - Security Warning screen mayappear (Figure 21).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>52


Figure 21: Internet Explorer - Security Warning ScreenFor this screen, click Run to allow local installation of <strong>the</strong> Launcher software. For more details, refer to <strong>the</strong> LauncherInstallation Instructions (L<strong>IT</strong>-12011783).Single Site Connection DownloadIf you click Single Site Connection, a file download screen appears (Figure 22).Figure 22: File Download - Single Site ConnectionThe File Download screen gives you <strong>the</strong> option to Open, Save, or Cancel. Click Save <strong>and</strong> save <strong>the</strong>MetasysResource.zip file to a location on your computer. Refer to <strong>the</strong> Launcher Installation Instructions (L<strong>IT</strong>-12011783)<strong>for</strong> details on how to unzip <strong>the</strong> files <strong>and</strong> run <strong>the</strong> Launcher.Launcher Proxy SettingsThe full version of <strong>the</strong> Launcher tool lets you update certain options, including proxy settings (Figure 23).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>53


Figure 23: Application Options ScreenThree options are proxy settings that you need to configure if <strong>the</strong> building network uses a proxy server <strong>for</strong> connectionto <strong>the</strong> Internet:• Proxy Host: IP address of <strong>the</strong> proxy server.• Proxy Port: port number required by <strong>the</strong> proxy server.• Proxy Auto Config URL: check box to indicate <strong>the</strong> network requires an automatic configuration script. If youmark this check box, you need to type <strong>the</strong> address of <strong>the</strong> automatic configuration script in <strong>the</strong> field.You use <strong>the</strong> Test button to test <strong>the</strong> proxy settings. If <strong>the</strong> test passes, <strong>the</strong> message Success appears. If <strong>the</strong> test doesnot pass, <strong>the</strong> message Failure appears. For more details about <strong>the</strong> Application Options Screen, refer to <strong>the</strong> LauncherHelp (L<strong>IT</strong>-12011742).Pop-up Ad BlockersAt Release 6.1, you do not need to disable third-party pop-up ad blockers on <strong>the</strong> computer you use to browse to <strong>the</strong>Metasys system UI in order to ensure Metasys system UI functionality. For previous releases, you must disablepop-up ad blockers or <strong>the</strong> Login screen may not launch. To disable pop-up ad blockers, turn off <strong>the</strong> third-party pop-upad blocker <strong>for</strong> all sites or <strong>for</strong> <strong>the</strong> address of <strong>the</strong> Metasys system Site Director. If you cannot turn off or configure <strong>the</strong>third-party pop-up ad blocker, uninstall it from <strong>the</strong> computer.Turning Off <strong>the</strong> Internet Explorer Web Browser Pop-up BlockerThis procedure applies to <strong>the</strong> Internet Explorer pop-up blocker. If you have third-party pop-up blockers, use <strong>the</strong>manufacturer’s instructions to disable <strong>the</strong>m.To turn off <strong>the</strong> pop-up blocker:1. Open Internet Explorer.2. On <strong>the</strong> Tools menu, select Pop-up Blocker > Turn Off Pop-up Blocker.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>54


Note: For in<strong>for</strong>mation on allowing pop-ups from specific sites only, refer to <strong>the</strong> Internet Explorer Help.Sleep Power Option on Windows 8 <strong>and</strong> Windows 7 ComputersIf you use a computer with Windows 8 or Windows 7 to browse into <strong>the</strong> Metasys system, be aware that <strong>the</strong> SiteManagement Portal UI session in<strong>for</strong>mation is lost if you are logged in when <strong>the</strong> operating system goes to sleep. Thesession terminates at <strong>the</strong> time <strong>the</strong> operating system goes to sleep, regardless of <strong>the</strong> Inactive Session Propertysetting that applies to your Metasys user account; <strong>for</strong> example, if Never Terminate is set <strong>for</strong> your account, <strong>the</strong> SiteManagement Portal UI session still terminates. The Sleep option is enabled <strong>for</strong> 2 hours by default, so you may wishto increase this setting or disable it.Disabling User Account ControlNote: This procedure is required if you want to use CCT software, HVAC PRO software, or GX-9100 tool softwarein Passthru mode from SCT on a Windows 8 or Windows 7 computer. If you do not per<strong>for</strong>m <strong>the</strong>se steps,Passthru mode does not function. Also, follow this procedure if you need to download resource files <strong>for</strong> aVND integration into a supervisory engine.1. In Control Panel, click System <strong>and</strong> Security > Action Center. The Action Center window appears.2. Click Change User Account Control settings. The User Account Control window appears (Figure 24).Figure 24: Disabling User Account Control3. Move <strong>the</strong> slider bar to <strong>the</strong> bottom position called Never notify.4. Click OK.5. Restart <strong>the</strong> computer to make <strong>the</strong> change effective.Metasys Dial-up <strong>Network</strong>ingPoint-to-Point Protocol (PPP) is used <strong>for</strong> all Metasys network dial-up communication between <strong>the</strong> Metasys clientcomputer (web browser) <strong>and</strong> <strong>the</strong> ADS/ADX <strong>and</strong> engine. Refer to <strong>the</strong> Metasys System Extended Architecture DirectConnection <strong>and</strong> Dial-Up Connection Application Note (L<strong>IT</strong>-1201639).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>55


Data Sharing with Published Web ServicesJohnson Controls provides published web services <strong>for</strong> third-party applications to access a limited set of Metasyssystem functions. Access is tied to access controls within <strong>the</strong> Metasys system using local Metasys system useraccounts only. Refer to <strong>the</strong> Metasys System Extended Architecture Secure Data Access DLL <strong>Technical</strong> <strong>Bulletin</strong>(L<strong>IT</strong>-1201663) <strong>for</strong> details on <strong>the</strong> web services <strong>and</strong> access controls associated with <strong>the</strong>m.<strong>Network</strong> Interface Cards (NICs)We do not support dual enabled NICs on a computer running Metasys software (including SCT, ADS/ADX, NxE85,<strong>and</strong> LCS85 software).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>56


Appendix: Microsoft® Windows® Operating System <strong>and</strong> SQLServer Software License RequirementsWindows Operating System License RequirementsThe Microsoft operating system software used by <strong>the</strong> ADX requires licenses called Client Access Licenses (CALs).A CAL is a license that gives you <strong>the</strong> right to access <strong>the</strong> services of <strong>the</strong> server. Two types of Microsoft operatingsystem CALs are available: a device-based CAL <strong>and</strong> a user-based CAL. These Microsoft CALs are purchasedseparately from <strong>the</strong> ADX software as described in Purchasing <strong>and</strong> Designating CALs.Note: The ADS does not require purchased operating system CALs.Operating System CALsEvery site requires a combination of both device <strong>and</strong> user CALs.Operating System - Device CALs: A device CAL is required <strong>for</strong> every device that accesses <strong>the</strong> ADX server,regardless of <strong>the</strong> number of users who access <strong>the</strong> ADX. A device CAL is <strong>the</strong> best choice if your organization hasusers who access <strong>the</strong> Metasys network by sharing <strong>the</strong> same computer during <strong>the</strong>ir work shifts. Each NAE requiresone device CAL. For example, if 15 NAEs are connected to <strong>the</strong> ADX, a total of 15 device CALs are required. Or, if100 NAEs are connected to <strong>the</strong> ADX, a total of 100 device CALs are required.Operating System - User CALs: A user CAL is required <strong>for</strong> every user who accesses <strong>the</strong> ADX server, regardlessof <strong>the</strong> number of computers <strong>the</strong>y use <strong>for</strong> that access. A user CAL is <strong>the</strong> best choice if your organization has Metasysusers who need roaming access to <strong>the</strong> Metasys network using multiple computers. For example, if two users log into <strong>the</strong> ADX from different locations, two user CALs are required. Or, if 50 users log in to <strong>the</strong> ADX, 50 user CALs arerequired.Ano<strong>the</strong>r example is a security guard station. Security guards during different shifts often use a single workstation,requiring <strong>the</strong> use of only one device CAL. However, if <strong>the</strong> security guards use multiple workstations throughout <strong>the</strong>facility, one user CAL per guard is required. In this example, a single user CAL is more cost-effective, because asingle ADX connection requires only one user CAL.Total Number of CALs: The total number of device <strong>and</strong> user CALs required equals <strong>the</strong> total number of devices <strong>and</strong>users connected to <strong>the</strong> ADX.Example One: If you have 100 NAEs <strong>and</strong> 10 users who use different workstations to log in, you need 110 CALs(100 device CALs <strong>and</strong> 10 user CALs).Example Two: If you have 100 NAEs <strong>and</strong> 10 users who use <strong>the</strong> same workstation to log in, you need 101 deviceCALs (100 device CALs <strong>for</strong> NAEs <strong>and</strong> 1 device CAL <strong>for</strong> workstation).Table 14 lists <strong>the</strong> ADX software components <strong>and</strong> examples of what CAL combinations are required. Refer to <strong>the</strong>Metasys System Extended Architecture Overview <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201527) <strong>for</strong> <strong>the</strong> number of devices anADX supports.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>57


Table 14: ADX License <strong>and</strong> CAL ExamplesADX Offering Optional MVE RecommendedOfferingNumber of CALs toPurchaseWindows Operating System CAL ExamplesADX10MVE555 CALs = 2 user CALs + 3 device CALs(up to 10 users)(up to 5 users)5 CALs = 3 user CALs + 2 device CALsMVE101515 CALs = 10 user CALs + 5 device CALs(up to 10 users)15 CALs = 8 user CALs + 7 device CALsADXSWOMVE253030 CALs = 25 user CALs + 5 device CALs(up to 25 users)(up to 25 users)30 CALs = 10 user CALs + 20 device CALsADX50MVE506060 CALs = 50 user CALs + 10 device CALs(up to 50 users)(up to 50 users)60 CALs = 10 user CALs + 50 device CALsIf you purchase Metasys system software separately from <strong>the</strong> hardware, use Table 14 to determine how many CALsyou need to purchase from Microsoft. If you purchase Metasys system software as part of an ADS/ADX Turnkey orADS/ADX Ready product, <strong>the</strong> appropriate number of CALs is included in <strong>the</strong> purchase. For more details, seePurchasing <strong>and</strong> Designating CALs.Purchasing <strong>and</strong> Designating CALsYou need to purchase one additional device CAL <strong>for</strong> every NAE added to your Metasys system. You may also needto purchase additional user CALs as you exp<strong>and</strong> <strong>the</strong> number of authorized Metasys system users. If you currentlyhave an ADS <strong>and</strong> you exp<strong>and</strong> your system to require more than 10 connections, upgrade to an ADX.For CAL purchasing in<strong>for</strong>mation, log in to <strong>the</strong> Johnson Controls employee portal website, go to <strong>the</strong> Tools & Applicationspage, <strong>the</strong>n click <strong>the</strong> Computer Price List (ADS/ADX Turnkey Info) link in <strong>the</strong> Procurement/Purchasing section.The Computer Price List page appears. Review this page to learn how to access <strong>the</strong> Insight/JCI website(http://www.insight.com/jci) that contains in<strong>for</strong>mation about purchasing CALs.When you purchase CALs, you receive a paper certificate from Microsoft. There is no method in <strong>the</strong> operating systemto designate or configure <strong>the</strong> number of device or user CALs. So make sure you keep <strong>the</strong> Microsoft CALs certificatein safekeeping at <strong>the</strong> customer site in case of an audit. You may be subject to a fine if a security audit reveals thatyour system is not correctly licensed.If Metasys system software is purchased separately, <strong>the</strong> customer is responsible <strong>for</strong> purchasing <strong>the</strong> correct numberof CALs <strong>and</strong> <strong>for</strong> properly designating each CAL. A device CAL cannot be transferred to a user CAL, or vice versa.If a Metasys Ready or Turnkey computer is purchased, <strong>the</strong> proper number of CALs come with <strong>the</strong> purchase, so noadditional CALs are required. You must purchase additional CALs if <strong>the</strong> number of devices exceeds 5 or 10, dependingon <strong>the</strong> size of <strong>the</strong> purchased Metasys system. Ultimately, <strong>the</strong> customer must determine how to split <strong>the</strong> total numberof CALs between device <strong>and</strong> user.For additional in<strong>for</strong>mation on CALs, licensing, <strong>and</strong> downgrading operating system CALs, refer tohttp://www.microsoft.com/licensing/about-licensing/client-access-license.aspx.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>58


Licensing Modes <strong>and</strong> CAL ExamplesFigure 25 illustrates <strong>the</strong> use of CALs in a Metasys network.Figure 25: Example <strong>Network</strong> in Per Device or Per User Operating System Licensing ModeSQL Server 2008 Licensing RequirementsThe SQL Server 2008 software editions used by <strong>the</strong> ADX product, including SQL Server 2008 R2 St<strong>and</strong>ard orEnterprise <strong>and</strong> SQL Server 2008 St<strong>and</strong>ard or Enterprise, require CALs. However, <strong>the</strong> SQL Server 2008 softwareeditions used by <strong>the</strong> ADS product, including SQL Server 2008 Express R2 <strong>and</strong> SQL Server 2008 Express, do notrequire CALs.If your ADX computer has a single processor, we recommend you purchase one Processor License to allow anunlimited number of users, NAE/NIE/NCE devices, <strong>and</strong> ADS/ADX computers to access <strong>the</strong> SQL Server 2008database on that computer. If your ADX computer running SQL Server 2008 software has multiple processors,purchase Processor Licenses <strong>for</strong> all of <strong>the</strong> processors on that computer. Licensing is based on <strong>the</strong> number of physicalCPUs in <strong>the</strong> computer, not <strong>the</strong> number of core processors. For example, if <strong>the</strong> computer has a single quad-coreprocessor, only one processor license is required.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>59


For a split ADX, SQL Server 2008 software is installed on <strong>the</strong> database server computer. You must purchase asingle processor license <strong>for</strong> <strong>the</strong> database server computer if <strong>the</strong> computer has a single processor. If <strong>the</strong> databaseserver computer has more than one processor, you must purchase one SQL Server 2008 processor license <strong>for</strong> eachprocessor.For a split ADX with <strong>the</strong> Metasys Advanced Reporting System, <strong>the</strong> database engine component of SQL Server 2008software is present on <strong>the</strong> database server computer, <strong>and</strong> <strong>the</strong> reporting services component of SQL Server 2008software is installed on <strong>the</strong> web/application server computer. You must purchase a single processor license <strong>for</strong> both<strong>the</strong> database server computer <strong>and</strong> <strong>the</strong> web/application server computer.Table 15 lists <strong>the</strong> ADS/ADX software components <strong>and</strong> <strong>the</strong> operating system license types that <strong>the</strong>y require.Table 15: SQL Server 2008 License RequirementsADX Offering Optional MVE Offering SQL Server 2008 Software CurrentlySupportedSQL Server 2008Processor LicenseADX10 (up to 10 users)MVE5 (up to 5 users)SQL Server 2008 R2 Software1 Processor LicenseMVE10 (up to 10 users)ORADXSWO (up to 25 users)MVE25 (up to 25 users)SQL Server 2008 SoftwareADX50 (up to 50 users)MVE50 (up to 50 users)SQL Server 2012 Licensing RequirementsSQL Server 2012 St<strong>and</strong>ard or Enterprise software uses a per core licensing model instead of <strong>the</strong> per processorlicensing model that SQL Server 2008 uses. The cost of four core licenses in SQL Server 2012 is equivalent to <strong>the</strong>cost of one processor license in SQL Server 2008 R2. And just as with SQL Server 2008 Express, no CALs arerequired <strong>for</strong> SQL Server 2012 Express software.To determine <strong>the</strong> licensing needs <strong>for</strong> SQL Server 2012 software:• count <strong>the</strong> number of cores in <strong>the</strong> processor• purchase <strong>the</strong> adequate number of core licensesTo assist you in counting <strong>the</strong> number of processor cores, refer to <strong>the</strong> specifications provided by <strong>the</strong> computermanufacturer or download <strong>the</strong> free Microsoft Assessment <strong>and</strong> Planning Toolkit(http://www.microsoft.com/sam/en/us/map.aspx). This toolkit may require <strong>the</strong> assistance from an <strong>IT</strong> professional.After you determine <strong>the</strong> number of processor cores, purchase <strong>the</strong> appropriate number of core licenses to allow anunlimited number of users, NAE/NIE/NCE devices, <strong>and</strong> ADS/ADX computers to access <strong>the</strong> SQL Server 2012database on that computer. If <strong>the</strong> ADX computer running SQL Server 2012 software has multiple cores in <strong>the</strong>processor, purchase one license <strong>for</strong> each physical core in <strong>the</strong> processor. For example, if <strong>the</strong> computer has a singlequad-core processor, purchase four core licenses.For a split ADX without <strong>the</strong> Metasys Advanced Reporting System, SQL Server 2012 software is installed only on<strong>the</strong> database server computer. You must purchase one core license <strong>for</strong> each physical core in <strong>the</strong> processor of <strong>the</strong>database server computer.For a split ADX with <strong>the</strong> Metasys Advanced Reporting System, <strong>the</strong> database engine component of SQL Server 2012software is present on <strong>the</strong> database server computer, <strong>and</strong> <strong>the</strong> reporting services component of SQL Server 2012software is installed on <strong>the</strong> web/application server computer. You must purchase one core license <strong>for</strong> each physicalcore in <strong>the</strong> processor <strong>for</strong> both <strong>the</strong> database server computer <strong>and</strong> <strong>the</strong> web/application server computer.Table 16 lists <strong>the</strong> number of core licenses required based on <strong>the</strong> number of physical cores in <strong>the</strong> processor.Table 16: SQL Server 2012 License RequirementsPhysical Cores in <strong>the</strong> Processor124SQL Server 2012 Core Licenses Required 1444<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>60


Table 16: SQL Server 2012 License RequirementsPhysical Cores in <strong>the</strong> Processor68SQL Server 2012 Core Licenses Required 1681 SQL Server 2012 software requires a minimum of four core licenses, even <strong>for</strong> processors with less than four cores.ADS RequirementsThe ADS <strong>and</strong> ADS-Lite software that runs on Windows XP <strong>Professional</strong> or Windows 7 do not come with, <strong>and</strong> do notrequire, device or user CALs. Also, <strong>the</strong> ADS uses <strong>the</strong> free version of SQL Server Express software, so you do notneed to purchase SQL Server CALs.To avoid ADS connection <strong>and</strong> network communication per<strong>for</strong>mance issues, <strong>the</strong> number of users <strong>and</strong> <strong>the</strong> numberof NAE/NIE/NCE devices <strong>and</strong> ADS/ADX computers that transfer trend data, event messages, <strong>and</strong> audit messagesshould not exceed 10. If a Metasys site with a single ADS configured as <strong>the</strong> Site Director <strong>and</strong> default repositoryexceeds that number of connections, consider one of <strong>the</strong> following options:• Configure one ADS to be <strong>the</strong> Site Director. Install <strong>and</strong> configure ano<strong>the</strong>r ADS (or more) to provide <strong>the</strong> ADSrepository function. When you install a separate ADS to provide <strong>the</strong> repository function, it allows you to dedicatefive connections on <strong>the</strong> alternate ADS <strong>for</strong> system users <strong>and</strong> ano<strong>the</strong>r five connections on <strong>the</strong> alternate ADS toNAE/NIE/NCE devices <strong>and</strong> ADS/ADX computers <strong>for</strong> transferring trend data, event messages, or audit messages.Note: The ADS-Lite cannot be <strong>the</strong> Site Director <strong>for</strong> ano<strong>the</strong>r ADS of any type.• Upgrade to an ADX. Configure <strong>the</strong> Windows Server of <strong>the</strong> ADX computer with <strong>the</strong> number of CALs equal to <strong>the</strong>total number of users <strong>and</strong> devices accessing <strong>the</strong> ADX. In addition, configure <strong>the</strong> SQL Server database with oneSQL Server Processor license.Refer to <strong>the</strong> Metasys System Extended Architecture Overview <strong>Technical</strong> <strong>Bulletin</strong> (L<strong>IT</strong>-1201527) <strong>for</strong> per<strong>for</strong>manceguidelines <strong>and</strong> limitations.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>61


Appendix: SNMP Agent Protocol ImplementationThis appendix provides in<strong>for</strong>mation <strong>for</strong> network managers to interpret <strong>the</strong> SNMP traps <strong>and</strong> Gets received by <strong>the</strong>Metasys system <strong>and</strong> provides explanations related to available agent functionalities. The Trap Examples sectionincludes several Trap message examples <strong>for</strong> your reference. The in<strong>for</strong>mation applies to Metasys systems at Release3.0 <strong>and</strong> later.OverviewThe Metasys SNMP agent implementation provides IP st<strong>and</strong>ard SNMP functionality in <strong>the</strong> Metasys system, enablingnetwork administrators to manage Metasys network per<strong>for</strong>mance, find <strong>and</strong> resolve issues related to <strong>the</strong> Metasysnetwork, <strong>and</strong> plan <strong>for</strong> future growth of <strong>the</strong> Metasys system. SNMP uses st<strong>and</strong>ard SNMP Versions 1, 2C, <strong>and</strong> 3(which excludes SNMP encryption <strong>and</strong> au<strong>the</strong>ntication support). The Metasys system allows delivery of unsecuredSNMP traps <strong>for</strong> Metasys alarm events via a <strong>Network</strong> Management System (NMS). The Metasys SNMP agent alsocan monitor Metasys system point objects, select diagnostic attributes, <strong>and</strong> control sequence objects. You canconfigure <strong>the</strong> filter on <strong>the</strong> agent using <strong>the</strong> filtering capabilities of <strong>the</strong> DDA.LimitationsThe following are <strong>the</strong> limitations of NMS <strong>and</strong> Metasys SNMP agent functionality:• NMS does not provide <strong>the</strong> ability to acknowledge <strong>and</strong>/or discard Alarms via an SNMP Set message.• NMS cannot modify <strong>the</strong> supervisory device via an SNMP Set message.• Metasys SNMP Agent functionality does not allow <strong>the</strong> NMS to detect when <strong>the</strong> supervisory device suffers apower failure or to initiate any action based on such detection.• SNMP Get requests are not proxied through <strong>the</strong> site; that is, you must query <strong>the</strong> device of interest directly <strong>and</strong>not through <strong>the</strong> Site Director.• With <strong>the</strong> SNMP Version 3 implementation, user au<strong>the</strong>ntication <strong>and</strong> data encryption are not available <strong>for</strong> SNMPtraps <strong>and</strong> Gets.• The Get Bulk request, which returns data from multiple objects with one request, is not supported.Metasys SNMP MIB FilesThree Johnson Controls® MIB files are provided on <strong>the</strong> product media <strong>and</strong> on <strong>the</strong> Metasys system website <strong>for</strong>download (Table 17). The NMS software can read <strong>the</strong>se MIB files, as well as <strong>the</strong> st<strong>and</strong>ard MIB files.Table 17: List of Johnson Controls <strong>and</strong> St<strong>and</strong>ard MIB FilesJohnson Controls MIB FilesSt<strong>and</strong>ard MIB Files 1jcicontrolsgroup.mi2johnsoncontrolsinc.mi2msea.mi2SNMPV2_MIB.mibSNMPV2_SMI.mibSNMPV2_TC.mib1 St<strong>and</strong>ard MIB files are available on <strong>the</strong> Internet.These MIB files define <strong>the</strong> data available from <strong>the</strong> Metasys SNMP feature. They provide <strong>the</strong> object identifier (OID)that describe <strong>the</strong> traps <strong>and</strong> point types available in <strong>the</strong> Metasys system. For example, an OID is available to describe<strong>the</strong> alarm state of a point. Loading <strong>the</strong> MIB files into <strong>the</strong> NMS provides translation of <strong>the</strong> Metasys data.Enterprise ID NumberThe assigned enterprise ID number <strong>for</strong> Johnson Controls is 4399. This number is part of all OIDs used in <strong>the</strong> Metasyssystem.SNMP TrapsTrap FormatWhen an object with an alarm extension generates an event in <strong>the</strong> Metasys system, <strong>the</strong> SNMP service sends a trapto <strong>the</strong> NMS. No matter what type of event occurs, <strong>the</strong> Trap OID sends out <strong>the</strong> same set of attributes. Table 18 lists<strong>the</strong> attributes.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>62


Configuring Trap FilteringOf <strong>the</strong> available attributes listed in Table 18, configure <strong>the</strong> NMS interface to filter <strong>the</strong> attributes to be trapped. Youalso must select <strong>the</strong>se attributes when you configure <strong>the</strong> SNMP DDA alarm notifications <strong>and</strong> destinations in <strong>the</strong>device object. For details, refer to <strong>the</strong> NAE Commissioning Guide (L<strong>IT</strong>-1201519) <strong>and</strong> <strong>the</strong> ADS/ADX CommissioningGuide (L<strong>IT</strong>-1201645). This list applies to Metasys alarm events only.Table 18: Available Attributes <strong>for</strong> Trap FilteringField NamesackRequiredeventDetectionTimestampeventMessageeventPreviousStatuseventUniqueIdentifiereventValueevPriorityitemCategoryitemDescriptionitemFullyQualifiedReferenceitemNameSiteNameAgent Restart TrapWhen an Agent Restart occurs, a coldstart trap is sent when <strong>the</strong> supervisory device (NAE, <strong>for</strong> example) powers on.Table 19 lists <strong>the</strong> attributes that are sent.Table 19: Attributes <strong>for</strong> Coldstart TrapAttribute NameshostNameipAddressmacAddressunitssubnetMaskAlarm Raised TrapWhen an object with an alarm extension generates an event in <strong>the</strong> Metasys system, <strong>the</strong> SNMP Agent sends <strong>the</strong>same Alarm Type that was raised in <strong>the</strong> system (NAE/ADS). Examples include High Warning <strong>and</strong> Low Alarm. EachTrap OID also sends <strong>the</strong> attribute values that were selected <strong>for</strong> <strong>the</strong> trap (Table 18).Alarm Clear TrapWhen an alarm Return to Normal state occurs, <strong>the</strong> SNMP Agent reacts in <strong>the</strong> same manner as when <strong>the</strong> alarm wasraised. In this way, <strong>the</strong> Alarm situation is cleared with a NormalEvent message.Alarm SynchronizationThe Metasys SNMP Agent does not support Alarm Synchronization, a function that indicates to <strong>the</strong> NMS whichMetasys objects went into alarm while <strong>the</strong> NMS was offline. The SNMP Agent assumes that <strong>the</strong> NMS received <strong>the</strong>alarm <strong>and</strong>, <strong>the</strong>re<strong>for</strong>e, does not rebroadcast it. Even though alarm synchronization is not per<strong>for</strong>med, <strong>the</strong> SNMP Agentallows <strong>the</strong> NMS to poll points <strong>and</strong> device attributes to determine <strong>the</strong>ir statuses. From this in<strong>for</strong>mation, <strong>the</strong> NMS c<strong>and</strong>etermine which points are reporting Alarms <strong>and</strong> react accordingly.Trap CasesSupervisory Device Offline/OnlineAccording to how <strong>the</strong> SNMP is configured, <strong>the</strong> Metasys Site Director sends an offline/online notification when anyof its children (NAEs as supervisory devices) are considered offline or online. These events have a structure similarto <strong>the</strong> Alarm Raised structure, <strong>and</strong> reports <strong>the</strong> same set of attributes (Table 18). The eventValue attribute indicatesOffline or Online.When a supervisory device is rebooted or restored after a power failure, <strong>the</strong> SNMP Agent on <strong>the</strong> Site Director sends<strong>the</strong> offline/online notification, <strong>and</strong> <strong>the</strong> supervisory device sends <strong>the</strong> agent coldstart in<strong>for</strong>mation.Field Device Offline/OnlineField devices (<strong>for</strong> example, FECs <strong>and</strong> VMAs) are treated <strong>the</strong> same way as supervisory devices. If <strong>the</strong> field devicehas <strong>the</strong> appropriate alarm extension defined, <strong>the</strong> controller generates online/offline alarms (Traps) as <strong>the</strong>y occur.Field Device Disable/EnableWhen <strong>the</strong> user or a process disables communication to a field device, <strong>the</strong> SNMP Agent sends a trap regarding <strong>the</strong>Disable comm<strong>and</strong> in a similar manner as <strong>the</strong> Alarm Raised trap. The eventValue indicates Comm Disabled.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>63


When a Comm Enabled comm<strong>and</strong> to <strong>the</strong> device occurs, <strong>the</strong> SNMP Agent sends a trap regarding <strong>the</strong> Enable comm<strong>and</strong>as well as a separate alarm trap regarding <strong>the</strong> return to online status.SNMP Get RequestsSNMP Get requests allow <strong>the</strong> NMS to request in<strong>for</strong>mation <strong>for</strong> a specific variable. The SNMP agent, upon receivinga Get message, issues a GET-RESPONSE message to <strong>the</strong> NMS with ei<strong>the</strong>r <strong>the</strong> in<strong>for</strong>mation requested or an errorindication as to why <strong>the</strong> request cannot be processed.The Metasys SNMP Agent allows you to per<strong>for</strong>m SNMP Gets on pre-defined OIDs of certain objects (<strong>for</strong> example,Analog Value [AV], Binary Value [BV], <strong>and</strong> Multistate Value [MV] objects). For a list of <strong>the</strong> attributes that are available<strong>for</strong> polling, see Table 20.Note: To use Gets, you must query <strong>the</strong> specific supervisory device (NAE55, NIE55, or NCE25, <strong>for</strong> example) onwhich <strong>the</strong> object appears. Site Directors do not <strong>for</strong>ward Get requests to o<strong>the</strong>r devices on <strong>the</strong> site <strong>and</strong> youcannot per<strong>for</strong>m Gets on ADSs/ADXs.The Metasys SNMP Agent also allows you to determine <strong>the</strong> health of <strong>the</strong> device by polling <strong>the</strong> OIDs listed underTable 21. These attributes include data such as battery condition <strong>and</strong> object count.You can poll all <strong>the</strong> points on <strong>the</strong> NAE, but realize <strong>the</strong>re is a throttle on SNMP Gets, which is two requests per secondon an NAE55 <strong>and</strong> one request per second on an NAE45. For example, polling 500 points on a single NAE takesabout 5 minutes.Get Request DefinitionThe length of <strong>the</strong> OID <strong>for</strong> a Get request has one limitation relating to <strong>the</strong> SNMP protocol: <strong>the</strong> maximum number ofsubidentifiers per message is 128 characters. The reference of <strong>the</strong> item or object you are requesting is containedwithin <strong>the</strong>se subidentifiers. To determine <strong>the</strong> item reference you should use, log on to <strong>the</strong> Metasys user interface<strong>and</strong> open <strong>the</strong> Focus window of <strong>the</strong> item/object. Locate <strong>the</strong> Item Reference field under <strong>the</strong> Advanced view of <strong>the</strong>Focus window. The <strong>for</strong>mat of <strong>the</strong> fully qualified item reference is:Site:Device/ItemThe only part of this string that you need to specify is <strong>the</strong> Item section. Here is an example:MyADS:NAE-1/N2-1/AHU-3/ZN-TThe only part of this item reference that is required is: N2-1/AHU-3/ZN-T.Get Request Base OIDThe Base OID <strong>for</strong> any Get Request is as follows:1.3.6.1.4.1.4399.2.1.1.1.1.4.1.1.x.ywhere x is an integer that represents <strong>the</strong> attribute of <strong>the</strong> point (Table 20) <strong>and</strong> y is an representation <strong>for</strong> <strong>the</strong> nameof <strong>the</strong> Metasys point.Table 20: Point Attributesx.85.103.117.661.1006.32527DescriptionPresent ValueReliabilityUnitsDisplay PrecisionAlarm StateItem ReferenceThe two primary Get Requests are <strong>the</strong> Point Attribute Get Request <strong>and</strong> <strong>the</strong> Device Diagnostics Get Request.Point Attribute Get RequestThis Get Request obtains point attribute in<strong>for</strong>mation.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>64


Base OID1.3.6.1.4.1.4399.2.1.1.1.1.4.1.1.x.ywhere x is an integer that represents <strong>the</strong> attribute of <strong>the</strong> point <strong>and</strong> y is an ASCII representation <strong>for</strong> <strong>the</strong> name of <strong>the</strong>Metasys point (Table 20).Example #11.3.6.1.4.1.4399.2.1.1.1.1.4.1.1.85.3.65.86.49Returned value: present value of Metasys object called AV1.In this example, <strong>the</strong> Present Value attribute breaks out as:1.3.6.1.4.1.4399.2.1.1.1.1.4.1.1.85The name of <strong>the</strong> Metasys point breaks out as:3.65.86.49where <strong>the</strong> first digit (3) is <strong>the</strong> length, <strong>and</strong> <strong>the</strong> remaining digits are <strong>the</strong> ASCII representations of <strong>the</strong> letters (AV1).Example #21.3.6.1.4.1.4399.2.1.1.1.1.4.1.1.1006.10.69.110.101.114.103.121.46.66.86.49Returned Value: point alarm state of a Metasys object called Energy.BV1.In this example, <strong>the</strong> Alarm State attribute breaks out as:1.3.6.1.4.1.4399.2.1.1.1.1.4.1.1.1006The name of <strong>the</strong> Metasys point breaks out as:10.69.110.101.114.103.121.46.66.86.49where <strong>the</strong> first digit (10) is <strong>the</strong> length, <strong>and</strong> <strong>the</strong> remaining digits are <strong>the</strong> ASCII representations of <strong>the</strong> letters(Energy.BV1).Device Diagnostic AttributesThis Get Request obtains device diagnostic in<strong>for</strong>mation.Base OID1.3.6.1.4.1.4399.2.1.1.1.1.3.xwhere x is an integer that represents <strong>the</strong> attribute of <strong>the</strong> point (Table 21).Table 21: Device Diagnostic AttributesxDescription.647.650.651.844.2395.2579.2580.2581.2582.2583.2584.32565Battery ConditionChange of Value Receives Per MinuteChange of Value Transmits Per MinuteObject CountEstimate Flash AvailableCPU Temp (Not Available on NAE-45)Board TemperatureMemory UsageObject MemoryCPU UsageFlash UsagePager Dial Status<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>65


Example1.3.6.1.4.1.4399.2.1.1.1.1.3.2580Returned value: board temperatureIn this example, <strong>the</strong> Board Temperature attribute breaks out as:1.3.6.1.4.1.4399.2.1.1.1.1.3.2580Translating Attribute ValuesAs highlighted in <strong>the</strong> Trap Examples section, each Trap OID sends <strong>the</strong> same set of attributes. You can translateattributes values (evPreviousState) using <strong>the</strong> key values in Table 22.Table 22: Device Diagnostic AttributesKeyTextKeyText0Normal68Alarm1Fault69Trouble2Off Normal70Status3High Limit71Offline4Low Limit72Shutdown64Low Warning73Unreliable65High Warning75Online66Low Alarm65535Unknown Previous State67High AlarmExampleThe difference between <strong>the</strong> SNMP Trap generated <strong>for</strong> a binary point that goes into Alarm <strong>and</strong> one whose statustransitions to Return to Normal is outlined in Table 23.Table 23: SNMP Trap Attribute ExampleSNMP Trap Attribute Alarm ValueNormal ValuesnmpTRAPOID.OEventValueEventPreviousStatusEventMessagealarmEventActive0 (see Status Value Table)Alarm message defined in Metasys UInormalEventInactive68 (see Status Value Table)Return to Normal message defined in MetasysU<strong>IT</strong>rap ExamplesThe following sections shows several trap examples captured from a live system.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>66


Binary Point AlarmFigure 26: Binary Point Alarm Example<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>67


Binary Point Return to NormalFigure 27: Binary Point Return to Normal<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>68


Analog Point High WarningFigure 28: Analog Point High Warning<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>69


Analog Point High AlarmFigure 29: Analog Point High Alarm<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>70


Analog Point Low WarningFigure 30: Analog Point Low Warning<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>71


Analog Point Low AlarmFigure 31: Analog Point Low Alarm<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>72


Analog Point Return to NormalFigure 32: Analog Point Return to Normal<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>73


Supervisory Device Agent Restart (ColdStart)Figure 33: Supervisory Device Agent Restart (ColdStart)<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>74


Field Device OfflineFigure 34: Field Device Offline<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>75


Field Controller OnlineFigure 35: Field Controller Online<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>76


Field Controller DisabledFigure 36: Field Controller Disabled Example<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>77


Field Controller EnabledFigure 37: Field Controller Enabled Example<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>78


Appendix: Active Directory ServiceThis appendix provides additional in<strong>for</strong>mation to network managers <strong>for</strong> configuring Active Directory service <strong>for</strong> usewith <strong>the</strong> Metasys system on a computer that has <strong>the</strong> ADS/ADX or SCT software.OverviewThis appendix lists questions <strong>and</strong> actions that help facilitate <strong>the</strong> interaction with <strong>the</strong> customer’s <strong>IT</strong> department <strong>for</strong>configuration of <strong>the</strong> Metasys system <strong>for</strong> use with Active Directory services. You need to obtain this in<strong>for</strong>mation <strong>and</strong>complete <strong>the</strong> configuration be<strong>for</strong>e <strong>the</strong> feature is enabled <strong>and</strong> Active Directory service users are added to <strong>the</strong> Metasyssystem. Keep in mind that <strong>the</strong>se actions are most likely per<strong>for</strong>med by <strong>the</strong> customer’s <strong>IT</strong> department. Fur<strong>the</strong>rmore,several <strong>IT</strong> teams may need to be involved; <strong>for</strong> example, assistance from <strong>the</strong> Active Directory Service Team, <strong>IT</strong>Security Team, Infrastructure Team, <strong>and</strong> <strong>Network</strong> Team may be needed. Make sure you allow time <strong>for</strong> any necessaryteam interaction. Also, keep in mind that:• <strong>the</strong>se questions focus only on <strong>the</strong> <strong>IT</strong> needs of <strong>the</strong> Active Directory service feature <strong>and</strong> not on <strong>the</strong> Metasys system.The Metasys system should be properly configured with a version of <strong>the</strong> ADS/ADX (<strong>and</strong> SCT) software thatsupports <strong>the</strong> Active Directory feature. Example logistics that fall outside <strong>the</strong>se questions include:- administrative access to <strong>the</strong> ADS/ADX computer- proper SQL Server rights to install or upgrade <strong>the</strong> ADS/ADX software- firewalls between Metasys system devices• <strong>the</strong>se questions assume that <strong>the</strong> person ga<strong>the</strong>ring <strong>the</strong> in<strong>for</strong>mation is familiar with <strong>the</strong> Active Directory servicefeature.Infrastructure QuestionsTable 24 is a worksheet that outlines <strong>the</strong> questions that need to be answered as part of <strong>the</strong> Active Directory serviceimplementation on <strong>the</strong> Metasys system.Table 24: Active Directory Service WorksheetQuestionAnswerAction StepsHow many Active Directory servicedomains contain users who are to beadded as Metasys system users?Are <strong>the</strong>re any firewalls between <strong>the</strong>ADS/ADX <strong>and</strong> <strong>the</strong> Active Directoryservice domain?1More than 1YesNoJoin <strong>the</strong> ADS/ADX or SCT computer to <strong>the</strong> domain. Create onlyone Service Account under that domain. Specify <strong>the</strong> Service Accountunder Metasys Security Administration. For details, see ServiceAccount.If trusts exist between all domains that contain Metasys systemusers, <strong>the</strong> ADS/ADX or SCT can be in any domain. Use a singleService Account within Active Directory service with access to alldomains with Metasys system users.If trusts Do Not exist between all domains, <strong>the</strong> ADS/ADX can stillbe joined to any domain; however, if an Active Directory serviceuser is in a domain that does not trust <strong>the</strong> domain <strong>the</strong> ADS/ADX isin, that user is not able to take advantage of SSO login-free accessto <strong>the</strong> Metasys system, but <strong>the</strong>y can still use <strong>the</strong>ir Active Directoryservice user name, password, <strong>and</strong> domain at <strong>the</strong> Metasys loginscreen. Create one Service Account per domain that containsMetasys system users. For details, see Service Account Rules <strong>and</strong>Service Account Permissions.Firewalls must be correctly configured to allow Active Directoryservice port <strong>and</strong> protocol access between <strong>the</strong> ADS/ADX <strong>and</strong>domain(s). This is a Microsoft prerequisite of joining domain. Fordetails, see Protocols, Ports, <strong>and</strong> Connectivity <strong>for</strong> <strong>the</strong> MetasysSystem.No action required.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>79


Table 24: Active Directory Service WorksheetQuestionAnswerIs each client computer that can run<strong>the</strong> UI joined to an Active Directoryservice domain that is in <strong>the</strong> samedomain as <strong>the</strong> ADS/ADX or in a trusteddomain?YesNoAction StepsVerify that Active Directory service is configured to allow <strong>the</strong> userto log in to <strong>the</strong>ir Windows Desktop with Active Directory servicecredentials.Can <strong>the</strong> client computers be added to <strong>the</strong> domain that <strong>the</strong> ADS/ADXis joined to or to some o<strong>the</strong>r trusted domain?Do you plan to specify Active Directoryservice users or Active Directoryservice user groups under <strong>the</strong>MSEA-SSO user group? 1UsersGroups• Yes - SSO login-free access is available.• No - SSO login-free access is unavailable, but <strong>the</strong> user can stillspecify Active Directory service credentials on Metasys systemlogin screen.To provide SSO login-free access to <strong>the</strong> Metasys system, add eachActive Directory service user to <strong>the</strong> MSEA-SSO local Windowsgroup on <strong>the</strong> ADS/ADX <strong>and</strong> SCT computer. 2 For details, seeMSEA-SSO User Group.To provide SSO login-free access to <strong>the</strong> Metasys system, add eachActive Directory service user group to <strong>the</strong> MSEA-SSO local Windowsgroup on <strong>the</strong> ADS/ADX <strong>and</strong> SCT computer. 31 These are two suggested methods. Contact your local <strong>IT</strong> department <strong>for</strong> <strong>the</strong> preferred method.2 In order to per<strong>for</strong>m this step, you must be using an Active Directory service user account with sufficient privileges to search <strong>for</strong>users within Active Directory service. These privileges must span all domains that contain users who have SSO access to <strong>the</strong>Metasys system.3 Active Directory service groups are normally managed by <strong>the</strong> <strong>IT</strong> department. A process <strong>for</strong> managing <strong>the</strong> addition <strong>and</strong> removalof Metasys system users who are also Active Directory service users must be enacted.Primary RequirementsThe following is a list of requirements <strong>for</strong> using Active Directory service with <strong>the</strong> Metasys system at <strong>the</strong> customer’ssite. The steps <strong>for</strong> setting up Active Directory service are primarily <strong>the</strong> responsibility of <strong>the</strong> customer’s <strong>IT</strong> department.Installation of <strong>the</strong> Metasys software is usually per<strong>for</strong>med by o<strong>the</strong>rs, but often supervised by <strong>IT</strong> personnel. Theserequirements are based on answers given <strong>for</strong> <strong>the</strong> questions posed in Table 24, though not all requirements applyto every installation.ADS/ADX ComputerThe computer with <strong>the</strong> ADS or ADX software must be:• installed with Release 4.1 or later of <strong>the</strong> Metasys systemNote: O<strong>the</strong>r devices on <strong>the</strong> site do not need to be at Release 4.1• joined to an Active Directory service domain (or trusted domain) where <strong>the</strong> Metasys system users are located• added to an Active Directory service domain where <strong>the</strong> computer is not affected by group policiesIn addition, configure any firewalls to allow appropriate Active Directory service communication.SCT ComputerThe computer with <strong>the</strong> SCT software must be:• installed with Release 4.1 or later of <strong>the</strong> Metasys system software• joined to an Active Directory service domain (or trusted domain) where <strong>the</strong> Metasys system users are locatedIn addition, configure any firewalls to allow appropriate Active Directory service communication.Client ComputerThe client computer used to run <strong>the</strong> ADS/ADX or SCT UI must be joined to an Active Directory service domain where<strong>the</strong> ADS/ADX <strong>and</strong> SCT are located or to a trusted domain.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>80


Additional RequirementsThe following are additional requirements:• Obtain <strong>the</strong> fully qualified domain names <strong>for</strong> all domains that are to contain Metasys system users. The namemust be <strong>the</strong> domain level (<strong>and</strong> not <strong>the</strong> <strong>for</strong>est level or some o<strong>the</strong>r level).Note: This in<strong>for</strong>mation is necessary at <strong>the</strong> time when Active Directory service users are added to <strong>the</strong> Metasyssystem with <strong>the</strong> Security Administration tool. For details, see User Account Rules.• Obtain <strong>the</strong> corresponding pre Windows 2000 domain names (short <strong>for</strong>mat of <strong>the</strong> domain name). This in<strong>for</strong>mationis useful because <strong>the</strong> Metasys system user can specify this <strong>for</strong>mat at <strong>the</strong> login screen of <strong>the</strong> Site ManagementPortal UI.For additional requirements, see Service Account <strong>and</strong> MSEA-SSO User Group.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>81


Appendix: Windows Server OS ConsiderationsNote: Release 6.1 supports three server operating systems: Windows Server 2012 (64-bit), Windows Server 2008R2 with SP1 (64-bit), <strong>and</strong> Windows Server 2008 SP2 (32-bit) with SP2.Important: We strongly advise that you do not browse to <strong>the</strong> Metasys Site Management Portal UI from a computerrunning a server class operating system. By default, Windows Internet Explorer Enhanced SecurityConfiguration is enabled on server class operating systems <strong>and</strong> may block <strong>the</strong> Launcher downloadpage from which you install <strong>the</strong> Launcher application <strong>for</strong> access to <strong>the</strong> Site Management Portal. Open<strong>the</strong> Site Management Portal UI from a computer that is not running a server class operating system.See Internet Explorer Enhanced Security Configuration.For in<strong>for</strong>mation on firewall settings required <strong>for</strong> Metasys system communication, refer to <strong>the</strong> ADS, ADX, <strong>and</strong> SCTInstallation <strong>and</strong> Upgrade Instructions Wizard (L<strong>IT</strong>-12011521) <strong>and</strong> ADS-Lite Installation <strong>and</strong> Upgrade InstructionsWizard (L<strong>IT</strong>-12011688).Administrator RightsDepending on your operating system login privileges, you may need to per<strong>for</strong>m <strong>the</strong> steps listed in Table 25 to useMetasys software (including logs) or access Windows operating system features <strong>and</strong> SQL Server software on yourWindows Server operating system.Table 25: Login Privileges <strong>and</strong> StepsLogin PrivilegesNot Logged in as <strong>the</strong> Windows Account withusername of Administrator.Logged in as <strong>the</strong> Windows Account with <strong>the</strong>username of Administrator.Steps to Run SoftwareTo run <strong>the</strong> software:1. Right-click <strong>the</strong> software icon on your desktop or software name in amenu.2. Select Properties.3. Select Run As Administrator.4. Click Allow.Refer to <strong>the</strong> documentation <strong>for</strong> <strong>the</strong> specific Metasys software you are using<strong>for</strong> more in<strong>for</strong>mation on how to per<strong>for</strong>m tasks that require Administratorprivileges.Run <strong>the</strong> software without additional steps.ServicesADS/ADX software installs <strong>and</strong> uses <strong>the</strong> Metasys III Device Manager Service <strong>and</strong> Metasys III Action Queue Service.Both Services must be run on <strong>the</strong> Local System account.Internet Explorer Enhanced Security ConfigurationImportant: We strongly advise that you do not browse to <strong>the</strong> Metasys Site Management Portal UI from a computerrunning a server class operating system. By default, Windows Internet Explorer Enhanced SecurityConfiguration is enabled on server class operating systems <strong>and</strong> may block <strong>the</strong> Launcher downloadpage from which you install <strong>the</strong> Launcher application <strong>for</strong> access to <strong>the</strong> Site Management Portal. Open<strong>the</strong> Site Management Portal UI from a computer that is not running a server class operating system.This section applies to <strong>the</strong> web browser on any computer running Windows Server 2012, Windows Server 2008 R2SP1, or Windows Server 2008 SP2. By default, Internet Explorer Enhanced Security Configuration is enabled onthis operating system. When you start <strong>the</strong> Internet Explorer web browser, <strong>the</strong> Internet Explorer Enhanced SecurityConfiguration is enabled message appears (Figure 38).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>82


Figure 38: Internet Explorer Enhanced Security Configuration is Enabled MessageThe Internet Explorer Enhanced Security Configuration establishes a configuration <strong>for</strong> your computer <strong>and</strong> <strong>for</strong> <strong>the</strong>Internet Explorer web browser. This configuration decreases <strong>the</strong> exposure of your server to potential attacks thatmay occur through web content <strong>and</strong> application scripts. As a result, some websites may not display or per<strong>for</strong>m asexpected. For example, <strong>the</strong> Enhanced Security Configuration may prevent <strong>the</strong> download of <strong>the</strong> Launcher application.To disable Enhanced Security Configuration in Windows Server 2012, start Server Manager <strong>and</strong> select Local Server.Locate <strong>the</strong> IE Enhanced Security Configuration setting. Click On to open <strong>the</strong> Internet Explorer Enhanced SecurityConfiguration window. Click Off <strong>for</strong> administrators <strong>and</strong> users as recommended by <strong>the</strong> <strong>IT</strong> administrator.To disable Enhanced Security Configuration in Windows Server 2008 R2 or Windows Server 2008, start ServerManager <strong>and</strong> locate <strong>the</strong> Security In<strong>for</strong>mation section. Click Configure IE ESC to open <strong>the</strong> Internet Explorer EnhancedSecurity Configuration window. Click Off <strong>for</strong> administrators <strong>and</strong> users as recommended by <strong>the</strong> <strong>IT</strong> administrator.Software Supported on Windows Server Plat<strong>for</strong>msWindows Server 2012, Windows Server 2008 R2, <strong>and</strong> Windows Server 2008 supports <strong>the</strong> following Metasys software<strong>and</strong> technologies:• ADX• SCT• CCT• Metasys Advanced Reporting System• Site Management Portal UI client computer (computer browsing to <strong>the</strong> Site Management Portal UI)• Metasys Database Manager• Metasys Export Utility• Metasys System Secure Data Access• Ready Access Portal software• Ready Access Portal client computer (computer browsing to <strong>the</strong> Ready Access Portal UI)Software <strong>and</strong> technologies not listed here are not supported. Refer to <strong>the</strong> appropriate technical literature <strong>for</strong> <strong>the</strong>technology you are using to verify compatibility with Windows Server operating systems.Configuring <strong>the</strong> Computer as an Application Server <strong>for</strong> Use as an ADXFor in<strong>for</strong>mation on configuring <strong>the</strong> computer as an application server, refer to <strong>the</strong> installation instructions <strong>for</strong> <strong>the</strong>Metasys software you are using (<strong>for</strong> example, ADS/ADX, Ready Access Portal, or SCT).<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>83


Appendix: Windows Desktop OS ConsiderationsNote: Release 6.1 supports three desktop operating systems: Microsoft Windows 8 <strong>Professional</strong> <strong>and</strong> Enterprise(64-bit), Windows 7 <strong>Professional</strong>, Enterprise, <strong>and</strong> Ultimate Editions (32-bit or 64-bit) with SP1, <strong>and</strong> WindowsXP <strong>Professional</strong> with SP3.Windows 8 <strong>and</strong> Windows 7 offer increased network security that impacts Internet <strong>and</strong> intranet communication,including communication among Metasys system components. Additionally, Windows 8 <strong>and</strong> Windows 7 have folderstructures that differ from those used in <strong>the</strong> Windows XP.Use <strong>the</strong> in<strong>for</strong>mation in this appendix to configure Windows 8 or Windows 7. For in<strong>for</strong>mation on firewall settingsrequired <strong>for</strong> Metasys system communication, refer to <strong>the</strong> ADS, ADX, <strong>and</strong> SCT Installation <strong>and</strong> Upgrade InstructionsWizard (L<strong>IT</strong>-12011521) <strong>and</strong> ADS-Lite Installation <strong>and</strong> Upgrade Instructions Wizard (L<strong>IT</strong>-12011688).Folder StructureThe folder structure in Windows 8 <strong>and</strong> Windows 7 is different from <strong>the</strong> folder structure that Windows XP uses. Table26 shows <strong>the</strong> differences in <strong>the</strong> folder structures used by <strong>the</strong> operating systems.Table 26: Folder Structure - Windows XP, Windows 8, <strong>and</strong> Windows 7Windows 8 <strong>and</strong> Windows 7 LocationsWindows XP Location 1Program FilesDocuments <strong>and</strong> SettingsDocuments <strong>and</strong> Settings\All UsersDocuments <strong>and</strong> Settings\All Users\Application DataDocuments <strong>and</strong> Settings\All Users\DocumentsDocuments <strong>and</strong> Settings\\My DocumentsDocuments <strong>and</strong> Settings\\Application DataDocuments <strong>and</strong> Settings\\CookiesDocuments <strong>and</strong> Settings\\Local SettingsDocuments <strong>and</strong> Settings\\Local Settings\ ApplicationDataDocuments <strong>and</strong> Settings\\Local Settings\ HistoryDocuments <strong>and</strong> Settings\\Local Settings\ TemporaryInternet FilesDocuments <strong>and</strong> Settings\All Users\DesktopDocuments <strong>and</strong> Settings\Default UserProgram FilesUsersProgramDataProgramDataUsers\Public\DocumentsUsers\\DocumentsUsers\\AppData\RoamingUsers\\AppData\Roaming\Microsoft\Windows\CookiesUsers\\AppData\LocalUsers\\AppData\LocalUsers\\AppData\Local\Microsoft\Windows\HistoryUsers\\AppData\Local\Microsoft\Windows\Temporary Internet FilesUsers\Public\DesktopUsers\Default1 is <strong>the</strong> username of <strong>the</strong> person currently logged in to <strong>the</strong> Windows Operating System.Note <strong>the</strong>se o<strong>the</strong>r changes:• Add/Remove Programs in Windows XP exists in Windows 8 <strong>and</strong> Windows 7 as Programs <strong>and</strong> Features. Theseitems are found in Control Panel.• Folder settings, such as showing/hiding file extensions <strong>and</strong> system files, now exist in Control Panel underAppearance <strong>and</strong> Personalization > Folder Options. Changes must be done on a per-user basis.Refer to <strong>the</strong> documentation <strong>for</strong> each specific Metasys software tool <strong>for</strong> details on how file locations may be differentin Windows 8 <strong>and</strong> Windows 7.Administrator RightsAdministrative privileges function differently on Windows 8 <strong>and</strong> Windows 7 than on Windows XP. Depending onyour operating system login privileges, you may need to per<strong>for</strong>m additional steps to use Metasys software (includinglogs) or access Windows operating system features <strong>and</strong> SQL Server software.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>84


Table 27: Login Privileges <strong>and</strong> StepsLogin PrivilegesNot Logged in as <strong>the</strong> Windows Accountwith username of AdministratorSteps to Run SoftwareTo run <strong>the</strong> software with Windows 7:1. Right-click <strong>the</strong> application icon on your desktop or software name in a menu.2. Select Properties.3. Select Run As Administrator.4. If prompted, enter your credentials.5. Click Yes.To run <strong>the</strong> software with Windows 8:1. Right-click <strong>the</strong> application tile on <strong>the</strong> Start screen.2. Select Run As Administrator on <strong>the</strong> bottom of <strong>the</strong> screen.3. If prompted, enter your credentials.4. Click Yes.Refer to <strong>the</strong> documentation <strong>for</strong> <strong>the</strong> specific Metasys software you are using <strong>for</strong>more in<strong>for</strong>mation on how to per<strong>for</strong>m tasks that require Administrator privileges.Logged in as <strong>the</strong> Windows Account with<strong>the</strong> username of AdministratorRun <strong>the</strong> software without additional steps.ServicesADS/ADX software installs <strong>and</strong> uses <strong>the</strong> Metasys III Device Manager Service <strong>and</strong> Metasys III Action Queue Service.Both Services must be run on <strong>the</strong> Local System account.Internet Explorer Web Browser SettingsActiveX Controls are not required to access Release 6.1 sites, such as SMP <strong>and</strong> SCT.Operating system administrator rights are required to download <strong>and</strong> install <strong>the</strong> Launcher Tool.If you do not follow <strong>the</strong> Administrator guidelines here, you may not be able to adjust <strong>the</strong> Internet Explorer web browsersettings or you may not be able to save <strong>the</strong> changes you make <strong>for</strong> <strong>the</strong> next browser session. If you experienceproblems similar to <strong>the</strong>se, check your access rights.Software SupportedWindows 8, Windows 7, <strong>and</strong> Windows XP support <strong>the</strong> following Metasys software <strong>and</strong> technologies:• ADS• SCT• CCT• Site Management Portal UI client computer (computer browsing to <strong>the</strong> Site Management Portal UI)• Metasys Database Manager• Metasys Export Utility• Metasys System Secure Data Access• Ready Access Portal software• Ready Access Portal client computer (computer browsing to <strong>the</strong> Ready Access Portal UI)Software <strong>and</strong> technologies not listed here are not supported. Refer to <strong>the</strong> appropriate technical literature <strong>for</strong> <strong>the</strong>technology you are using to verify compatibility with <strong>the</strong> operating system.Windows Features Not Supported by Metasys SoftwareMetasys software does not support <strong>the</strong> following Windows features:• Sleep feature. If you install an ADS or SCT on Windows 8 or Windows 7, you must turn off <strong>the</strong> Sleep feature.Failure to turn off this feature can result in communication problems when <strong>the</strong> ADS or SCT goes to sleep.• Fast User Switching feature. Users must log off instead of switching users.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>85


Windows Scheduled FeaturesSome features of Windows 8 or Windows 7 should be rescheduled depending on <strong>the</strong> load <strong>for</strong> <strong>the</strong> ADS. By default,<strong>the</strong> Windows Defender spyware identification <strong>and</strong> removal tool scans <strong>the</strong> operating at 2 A.M. every day <strong>and</strong> DiskDefragmentation runs every Wednesday at 1 A.M. If <strong>the</strong> ADS is busy at <strong>the</strong>se times, you should reschedule <strong>the</strong>scan/defragmentation <strong>for</strong> a time when <strong>the</strong> ADS is less busy.Building Efficiency507 E. Michigan Street, Milwaukee, WI 53202Metasys® <strong>and</strong> Johnson Controls® are registered trademarks of Johnson Controls, Inc.All o<strong>the</strong>r marks herein are <strong>the</strong> marks of <strong>the</strong>ir respective owners. © 2013 Johnson Controls, Inc.Published in U.S.A.<strong>Network</strong> <strong>and</strong> <strong>IT</strong> <strong>Guidance</strong> <strong>for</strong> <strong>the</strong> <strong>BAS</strong> <strong>Professional</strong> <strong>Technical</strong> <strong>Bulletin</strong>www.johnsoncontrols.com86

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!