1201519-NAE Commissioning Guide
1201519-NAE Commissioning Guide
Document Introduction.............................................................................................................5
Summary of Changes................................................................................................................5
NAE Commissioning Overview................................................................................................6
Network Automation Engines (NAEs)...............................................................................................6
NAE35 Models......................................................................................................................................7
NAE45 Models......................................................................................................................................7
NAE55 Models......................................................................................................................................7
NAE-S Model........................................................................................................................................7
NIE55 Models........................................................................................................................................8
NCE25 Models......................................................................................................................................8
NxE85 Model.........................................................................................................................................8
MS/TP Communications Bus.............................................................................................................8
Metasys Network Sites.......................................................................................................................9
NAE Commissioning.........................................................................................................................11
NAE Configuration............................................................................................................................12
Site Management Portal User Interface..........................................................................................14
Metasys UI.........................................................................................................................................15
Metasys Help Files............................................................................................................................15
Browser Recommendations for Downloading the Launcher.......................................................16
System Configuration Tool..............................................................................................................16
CCT.....................................................................................................................................................17
Archive Databases............................................................................................................................17
NAE Disk Image Updates and Archive Database Upgrades.........................................................17
Site Director.......................................................................................................................................17
NAE Computer Name........................................................................................................................18
NAE Object Name.............................................................................................................................18
Basic Access Operating Mode........................................................................................................19
Login User Names and Passwords.................................................................................................19
NAE Connectivity..............................................................................................................................19
Modems and Dial-Out Features.......................................................................................................20
Time Zone, Date, and Time Management........................................................................................21
Alarms and Events............................................................................................................................22
Serial Printer DDA (Alarm Printer)...................................................................................................23
Recommended Serial Printer..............................................................................................................23
Serial Printer Installation Considerations............................................................................................26
Email Notification..............................................................................................................................26
Pager Notification.............................................................................................................................27
Syslog DDA........................................................................................................................................28
Simple Network Management Protocol (SNMP) Notification........................................................30
RADIUS Overview.............................................................................................................................31
Initial Default NAE Configuration....................................................................................................32
Allow HTTP........................................................................................................................................33
System and User Preferences.........................................................................................................35
Reset Device Command...................................................................................................................35
Detailed Procedures................................................................................................................36
Commissioning Guide 2
Troubleshooting Guide........................................................................................................................88
NAE Diagnostic Tools.......................................................................................................................91
NAE LED Status Indicators.................................................................................................................91
NAE35/NAE45 LED Startup Sequence..............................................................................................95
NAE55/NIE55 LED Startup Sequence................................................................................................95
NCE25 LED Startup Sequence...........................................................................................................95
Diagnostic Tab.....................................................................................................................................95
Summary Tab......................................................................................................................................97
Troubleshooting Procedures...........................................................................................................99
Verifying Ethernet Network Communications (Ping)...........................................................................99
Pre-Boot Execution Environment (PXE).............................................................................................99
Determining the NAE IP Address and Device Name for a Network Connection................................99
Determining the NAE IP Address By Using the NCT..........................................................................99
Determining the NAE IP Address and Device Name By Using a Serial Port Monitor.........................99
Setting a Computer to be Compatible with APIPA.......................................................................100
Related Documentation.........................................................................................................101
Technical Specifications.......................................................................................................102
Appendix: Time Zone, Date, and Time Management..........................................................108
Time Zone, Date, and Time Management Introduction................................................................108
Overview of Time Synchronization...............................................................................................108
ADS/ADX/ODS Site Director with Network Engines.........................................................................108
NIE and Child Devices......................................................................................................................109
Time Synchronization Methods.....................................................................................................109
Windows Time Synchronization........................................................................................................109
Multicast Time Synchronization........................................................................................................110
BACnet Time Synchronization..........................................................................................................110
Example Network............................................................................................................................110
Multiple Time Zones........................................................................................................................111
Site Time Server..............................................................................................................................112
Time in Device Object and User Interface Status Bar.................................................................112
Steps for Successful Time Management......................................................................................113
Verifying the Site Director Defined for an Engine/Server..................................................................113
Setting the Time Synchronization Method........................................................................................114
Network Engine as Site Director.......................................................................................................115
ADS/ADX/ODS as Site Director........................................................................................................118
Configuring Additional Multicast Time Synchronization Settings......................................................121
Appendix: Configuring and Maintaining Preferences........................................................123
Configuring and Maintaining Preferences Introduction..............................................................123
Preferences Concepts....................................................................................................................123
System and User Preferences..........................................................................................................123
Managing Preferences......................................................................................................................125
Detailed Procedures.......................................................................................................................126
Configuring Preferences...................................................................................................................126
Restoring Default System Preferences.............................................................................................126
Copying Preferences between Devices............................................................................................126
Restoring Default User Preferences.................................................................................................126
Removing User Preference Files......................................................................................................127
Copying User Preferences to Another User......................................................................................127
Preserving Preferences for a Network Engine Update.....................................................................127
Appendix: Certificate Management......................................................................................128
Certificate Management Introduction...........................................................................................128
Commissioning Guide 3
Certificate Signing Request (CSR)................................................................................................130
Import Certificate............................................................................................................................130
Export Certificate............................................................................................................................131
Certificate List View........................................................................................................................131
Certificate Tree View.......................................................................................................................132
Download Certificate......................................................................................................................133
Detailed Procedures.......................................................................................................................133
Requesting a Certificate....................................................................................................................133
Importing a Certificate.......................................................................................................................136
Exporting a Certificate.......................................................................................................................138
Downloading a Certificate.................................................................................................................139
Uploading a Certificate......................................................................................................................140
Deleting a Certificate.........................................................................................................................142
Deleting a Certificate Request..........................................................................................................142
Replacing a Self-Signed Certificate..................................................................................................142
Backing Up a Certificate...................................................................................................................143
Commissioning Guide 4
Document Introduction
This document describes how to:
• commission a Network Automation Engine (NAE), Network Integration Engine (NIE), or Network Control Engine
(NCE) for network connectivity in several network scenarios
• access the Metasys® system Site Management Portal UI on an NAE
• configure the basic NAE parameters for initial operation on the network
• troubleshoot an NAE
• configure the NAE Destination Delivery Agents (DDAs) for sending alarm and event messages through email,
pager, and Simple Network Management Protocol (SNMP)
• configure a Syslog DDA for sending events and audits to an external Syslog server
• disable the Microsoft® Windows® firewall on an NCE25, NAE35, or NAE45 for the purpose of improving the
overall performance of these network engine models
This document does not describe how to mount, wire, or power on an NAE. Also, this document does not describe
how to build or download an archive database for a Metasys system site or how to configure an NAE to monitor and
control a building automation system (BAS).
Note: In this document, NAE refers to all NCE25, NAE35, NAE45, NAE45-Lite, NAE55, NIE55, and NxE85 models,
unless noted otherwise.
Also, in addition to this document, refer to the following literature for information specific to your model of NAE:
• Secure NAE-S: refer to the NAE-S Commissioning Guide (LIT-12012269), a confidential Johnson Controls
document
• NxE85 Series: refer to the NxE85 Commissioning Guide (LIT-12011044)
• NCE25 Series: refer to the NCE Technical Bulletin (LIT-12011267)
• NIEx9 Series: refer to the NIEx9 Commissioning Guide (LIT-12011922)
Summary of Changes
The following information is new or revised:
• Updated screens throughout to indicate the new release number.
• Added Windows Server® 2016 as a supported operating system.
• Updated Launcher screen examples throughout the document.
• Updated Figure 71 to include the Time Zone attribute.
• Removed Ready Access Portal option from all network diagrams.
• Added information about enabling encrypted and trusted communication between the Metasys Server and
network engines to Appendix: Certificate Management.
• Modified the steps for preparing an NAE for communication over the building network. The affected sections
include: Preparing an NAE for a Network That Supports DHCP and DNS, Preparing an NAE for a Network without
DHCP and without DNS Support When the NAE Uses APIPA, Preparing an NAE for a Network without DHCP
and without DNS Support When the NAE Uses a Static IP Address, Preparing an NAE for a Network That
Supports DHCP but Not DNS, and Preparing an NAE for a Network That Supports DNS but Not DHCP.
• Added new section called Allow HTTP.
NAE45 Models
The NAE45 models:
• support either one RS485 field bus or one LONWORKS network trunk into a Metasys system network. The NAE451x
models integrate one N2 Bus or one BACnet MS/TP trunk with up to 100 field controllers. The NAE452x models
integrate a single LONWORKS trunk with up to 127 LONWORKS devices.
• monitor and control up to 50 BACnet IP field devices over Ethernet at the supervisory level
• serve as a Site Director supervising a maximum of two additional network engines, which can be NAE35, NAE45,
or NCE25 model engines only
Notes:
• The NAE45-Lite supports the MS/TP bus and BACnet IP communication to third-party devices. The NAE45-Lite
does not support the N2 Bus, N1 integration, VND integration, Xl5K integration, LONWORKS network, or
wireless supervisor (N2).
• The NAE45-Lite must have an ADS-Lite-A as its Site Director, or be stand-alone. The NAE45-Lite cannot
be a Site Director to other engines.
NAE55 Models
The NAE55 models:
• support up to two RS485 field buses into a Metasys system network. The NAE551x models integrate two N2
Buses, two BACnet MS/TP trunks, or one N2 Bus and one BACnet MS/TP trunk. Each bus or trunk may contain
up to 100 field controllers. The NAE552x models can also integrate a LONWORKS network trunk with up to 255
LONWORKS devices. NAE55 models can also monitor and supervise a number of BACnet IP devices; the total
number of BACnet IP devices depends on the number of objects each device supports.
• supervise BACnet/IP field controllers from Johnson Controls, such as the FAC4911 Advanced Application Field
Equipment Controller and the VMA1930 Variable Air Volume Modular Assembly.
• serve as a Site Director supervising a maximum of four other network engines, which can be NAE35, NAE45,
NCE25, NAE55, or NIE55 model engines
NAE-S Model
The NAE-S model:
• supports up to two RS485 field buses into a Metasys system network. The NAE551S model integrates two N2
Buses, two BACnet MS/TP trunks, or one N2 Bus and one BACnet MS/TP trunk. Each bus or trunk may contain
up to 100 field controllers. A LONWORKS network NAE-S model is not offered. The NAE-S can also monitor and
NIE55 Models
The NIE55 models:
• migrate N1 networks into a Metasys system network. NIEs do not integrate BACnet networks, N2 trunks, or
LONWORKS networks
• serve as a Site Director supervising a maximum of four other supervisory devices, which can be NAE35, NAE45,
NCE25, NAE55, or NIE55 model engines
NCE25 Models
The NCE25 models:
• support either one field bus or one LONWORKS® network trunk into a Metasys system network, specifically:
- NCE256x-x: one BACnet® MS/TP trunk with up to 32 MS/TP controllers
- NCE251x-x: one N2 Bus with up to 32 N2 controllers
- NCE252x-x: one LONWORKS trunk with up to 32 LONWORKS devices
• monitor and control up to 50 IP BACnet field devices over Ethernet at the supervisory level
• provide an integral MS/TP Field Equipment Controller with 33 Input/Output (I/O) points
• cannot serve as Site Director except in stand-alone applications
NxE85 Model
The NAE85 model:
• migrates large N1 networks into a Metasys system network
• supervise BACnet/IP field controllers from Johnson Controls, such as the FAC4911 Advanced Application Field
Equipment Controller and the VMA1930 Variable Air Volume Modular Assembly.
• serves as a Site Director supervising a maximum of four other supervisory devices, which can be NAE35, NAE45,
NCE25, NAE55, NIE55, or NxE85 model engines
Refer to the NxE85 Commissioning Guide (LIT-12011044) for additional information specific to the NxE85 Series
network engines.
Larger Metasys network sites can comprise multiple NAEs and one or more Application and Data Servers (ADSs)
or Extended Application and Data Servers (ADXs) with access to multiple remote sites. On any site with one or more
ADSs/ADXs, an ADS/ADX is designated as the Site Director. Figure 3 shows an example of a simple Metasys
network with multiple NAEs and an ADS as the Site Director.
For customers that require a highly secure system, one or more NAE-S network engines can be part of the Metasys
network. Figure 4 shows a network that features a secure NAE-S network engine with other unencrypted NAE
engines reporting to an ADS/ADX Site Director. For more details, refer to the NAE-S Commissioning Guide
(LIT-12012269).
NAE Commissioning
NAE commissioning includes preparing the NAE for connectivity, connecting to the NAE, adding the NAE to the
profile list in Launcher, and accessing and logging in to the Site Management Portal UI. To commission the NAE-S,
refer to the NAE-S Commissioning Guide (LIT-12012269) for specific instructions that apply only to this secure NAE
model (confidential Johnson Controls document).
Each Metasys network installation, commissioning, and configuration scenario is unique. In some scenarios, the
NAEs (on a Metasys network) may be commissioned and configured before they are installed and connected to the
network; in other scenarios, the NAEs are mounted and wired to the network before they are commissioned and
configured.
Note: NAE installation includes locating, mounting, wiring, and powering on an NAE. See Related Documentation
for references to NAE installation instructions for the various NAE models.
The commissioning tasks, the task order, and the required attribute values (at commissioning) for an NAE are
determined by the specific Metasys network installation, commissioning, and configuration scenario for the site. The
NAE commissioning procedures presented in this document are the procedures required for most scenarios regardless
of when commissioning occurs.
NAE Configuration
NAE configuration is preparing an NAE in the Site Management Portal UI and the System Configuration Tool (SCT)
to operate on a specific Metasys network site, and communicate with, monitor, and control specific BAS field devices
on that site. Configuration also includes preparing the NAE to compile, generate, and communicate information
about site status, alarms, events, and trends.
You can typically accomplish NAE configuration by downloading a pre-built archive database (from the SCT) that
contains the device objects, object references, attribute values, logic, graphics, user information, and other references
and data required for the NAE to perform its specific tasks on the network.
You can create and edit an archive database online in the Site Management Portal UI, but in almost all cases, you
should create and edit the NAE archive database offline in the SCT. When you download the database, the values
in the archive database overwrite the existing values on the commissioned NAE. Refer to the Metasys® SCT Help
(LIT-12011964) for information on creating and downloading archive databases.
After you configure an NAE with an archive database containing user information, you can set up the email, pager,
Syslog, and SNMP DDAs and create specific alarm and event notifications for delivery to specific email, pager,
Syslog server, and network management destinations.
When you view the online NAE Site Management Portal UI, the border around the panels is blue (Figure 6). When
you view the offline SCT UI, the border is black (Figure 7).
Menus, tab screens, attribute lists, values, and units of measure in the Site Management Portal UI are dynamic and
change in the displayed screen according to the item you select from the navigation tree. Refer to the Object and
Feature Tabs section in the Metasys® SMP Help (LIT-1201793) for descriptions of menu items.
Metasys UI
In addition to the Site Management Portal UI, the Metasys UI is installed with Metasys server software. The Metasys
UI is a mobile-optimized software component that consolidates existing Metasys user interface products into a single,
simplified, and easy-to-learn interface. The Metasys UI provides a simple location-based navigation approach to
finding information about the Metasys site, including the ability to search for any location or equipment by name and
to bookmark a location or equipment in a web browser. All data displayed in the Metasys UI is organized in a
dashboard format that gives you the overview of what is happening within a space, equipment, or central plant. You
can also and create and manage graphics and their associations to equipment and spaces. Access the Metasys UI
from any type of client device with any screen size. For more details, refer to the Metasys® UI Technical Bulletin
(LIT-12012115).
Archive Databases
A Metasys archive database contains the configuration information for ADSs/ADXs, NAEs, BAS network integrations,
field devices, and field points that make up a single site or multiple sites on a Metasys system network. Multiple
archive databases, representing multiple sites, can reside on a single ADS/ADX running the SCT. The SCT navigation
panel in Figure 7 provides graphical representation of some of the items that may be in a Metasys archive database.
An NAE archive database, which resides in the NAE internal memory, contains only the specific configuration
information that makes up the network integrations, field devices, and field points that the NAE is supervising. Each
NAE retains only its own archive database. You can also save the NAE database in a Metasys archive database
on an ADS/ADX or another computer using the SCT. A graphical representation of some of the items contained in
an NAE archive database is shown in Figure 6 in the Site Management Portal UI navigation panel.
You can upload an NAE archive database to the SCT where it can be saved to a hard disk or other long-term storage
media. You can also edit an NAE archive database offline in the SCT and download the edited archive database to
the NAE.
Site Director
For each Metasys system network site, a single network engine or a Metasys server is designated as the Site
Director. The Site Director UI provides a single point of access to the site and all of the web-enabled devices on the
site; and supports functions such as user login, user administration, user views, time synchronization, and data traffic
management.
On larger Metasys system networks with one or more ADSs, ADXs, or ODSs, an ADS, ADX, or ODS is designated
as the Site Director. On small network sites without an ADS, ADX, or ODS, you must designate one of the NAEs as
the Site Director.
All NAEs are shipped factory-designated as Site Directors. You must demote any NAE that is not the designated
Site Director on a site. See Changing Site Director Status of an NAE for more information.
Note: You can establish or change the login user name and password for the NAE only when the NAE is designated
as a Site Director. Establish these values before demoting an NAE from the Site Director.
If an ADS/ADX is on a site, an NAE cannot be the Site Director. You must demote the NAE to be a child of an
ADS/ADX or ODS. See Changing Site Director Status of an NAE for more information.
Note: The NAE45-Lite cannot be a Site Director to other engines. The NAE45-Lite can only be a child device of an
ADS-Lite-A. You must demote the NAE to be a child of an ADS/ADX or ODS. See Changing Site Director
Status of an NAE for more information.
Important: The NAE/NIE Update Tool places restrictions on the Host Name (Computer Name) values you can
use for NAE35, NAE45, or NCE25 models. Name values must start with a letter, end with either a letter
or a number, and may contain dashes only in the interior of the name. The Host Name must contain a
letter other than or in addition to the letter A and digits. For example, A522446 is not valid, but either
A522446B or AB52446 are valid. B522446 or C522446 are valid Host Names. This restriction is caused
by a known problem with Microsoft Windows® CE. Failure to follow the Host Name restrictions results
in the Computer Name value changing when an NAE35, NAE45, or NCE25 is updated. Refer to the
NAE/NIE Update Tool Help (LIT-12011524) for more information on Host Name restrictions.
Note: Before building the archive database in SCT, you should consult the network administrator or Information
Technology (IT) department to determine if there is an existing protocol for host names (computer names)
on the network.
NAE Connectivity
You can establish a connection between a computer and an NAE using one of the following procedures:
• Establishing a Direct Connection to an NAE
• Preparing an NAE for a Network That Supports DHCP and DNS
• Preparing an NAE for a Network without DHCP and without DNS Support When the NAE Uses APIPA
With the presence of two modems, the NAE is capable of communicating over an incoming modem connection and
an outgoing modem connection simultaneously. The supported modem configuration scenarios are summarized in
Table 5. As an example, the NAE’s internal modem can handle communications to an ADS/ADX and accept incoming
connections, while its external modem can send out pages. An example of an unsupported combination is for the
same modem (internal or external) to handle all three communication types: dial-out, dial-in, and paging. Table 6
lists the unsupported modem scenarios.
Table 5: Supported Modem Configuration Scenarios for NAE
Dial Out Dial In Paging
Modem enabled Modem enabled Modem enabled
Use internal modem Use internal modem Use external modem
Modem enabled Modem enabled Modem enabled
Use external modem Use external modem Use internal modem
Modem enabled or disabled Modem enabled or disabled Modem disabled
Use internal or external modem Use internal or external modem No modem in use
Modem disabled Modem disabled Modem enabled
No modem in use No modem in use Use internal or external modem
Important: If the site depends on alarm paging, printing, or emailing alarms, the Metasys system manages the
NAE repositories according to the following criteria to avoid a loss of notification if the repository becomes
full:
• Events forwarded to an ADS or ODS Event Repository are always removed before events that are
not forwarded.
• The lowest priority event with the oldest time stamp and Acknowledge Required flag set to false is
replaced first.
• If the event about to be created is of a higher priority than at least one event in the repository, the
event with the oldest time stamp and the lowest priority is replaced.
• If all events are of the same priority, the event with the oldest time stamp is replaced.
• If the event about to be created is of a lower priority than all other events in the Event Repository,
no event is replaced and the new event is discarded.
A loss of alarm paging, printing, or emailing can result if the NAE is not commissioned with strict
adherence to these criteria. To avoid managing events in this way, move ADS/ADX and the notification
DDAs to the server.
You can designate multiple alarm and event sources in an NAE and in the connected field devices, and then configure
the conditions that trigger those alarms or events. You can also define multiple notification types and multiple
notification destinations for each alarm or event.
The NAE also has several pre-configured internal diagnostic features that are factory set to generate alarms. NAE
device diagnostic features with factory-set default alarm values include those listed in the following table.
Table 7: Default Network Engine Alarm Values
Audit Rate Events Lost
BACnet Broadcast Receive Rate Event Rate
Battery Condition Flash Usage
Board Temperature Memory Usage
COV Rcv Rate Samples Lost
CPU Temperature Sample Rate
CPU Usage Transfer Buffer Full
You can check the status of these diagnostic features on the Diagnostic tab.
Refer to the Introduction to Alarm and Event Management in the Metasys SMP system Help for more information.
Note: After an alarm is generated, anyone who acknowledges the alarm clears that alarm notification for all other
users. If an ADS/ADX or ODS is the Site Director, you can set the ADS/ADX or ODS to deliver alarm and
event notifications to a network printer.
Important: Alarms are sent directly to the printer and are not queued or stored by the supervisory device. Alarms
sent to an alarm printer that is offline, turned off, or out of paper are not printed and cannot be recovered.
Figure 8 and Figure 10 show the possible printer connections to a Site Director NAE/NIE.
Figure 8 shows a Metasys system with the alarm printer connected to the Site Director NAE/NIE, and alarms for
NAEs/NIEs (2 and 3) are routed to the Site Director NAE/NIE (1) for printing. All alarms from the NAEs/NIEs (1, 2,
and 3) print on the serial printer. The serial printer DDA must be enabled on all NAEs/NIEs (1, 2, and 3).
Figure 8: Metasys System with One Alarm Printer
Figure 9 shows a Metasys system with a local alarm printer (A) connected to an NAE/NIE (3) for printing. Only alarms
from this NAE (3) print on this printer. The alarms from all NAEs/NIEs (1, 2, and 3) are routed to the Site Director
NAE/NIE (1), and all alarms are printed to serial printer B. The serial printer DDA must be enabled on all NAEs (1,
2, and 3).
Figure 10 shows a Metasys system with one local Alarm Printer. The alarms from only one NAE/NIE (3) print on a
serial printer (A). Only that NAE/NIE(3) has the serial printer DDA enabled. The Site Director NAE/NIE (1) and
NAE/NIE (2) do not have the serial printer DDA enabled.
Figure 10: Metasys System with One Local Alarm Printer
Important: Use care and follow instructions carefully when using NCT to access an engine or computer. Failure
to follow the steps as written can render your engine or computer inoperable.
Email Notification
You can configure an NAE to generate alarm and event messages by sending email to one or more email destinations
using the email DDA. The steps require you to configure custom email messages and specify email message
destinations in the Email tab of the Site Management Portal UI. The following figure provides an example of an email
message destination that is active Monday through Friday from 7:00 A.M. to 4:00 P.M.
Pager Notification
You can configure an NAE to generate alarm and event messages using Telelocator Alphanumeric Protocol (TAP)
to one or more pager destinations using the pager DDA. The steps require you to configure custom pager messages
and specify the pager message destinations in the Pager tab of the Site Management Portal UI. (TAP is an
ASCII-based protocol that allows the submission of a numeric or alphanumeric message).
The following figure provides an example of how to define a set of pager destinations that can route a fire alarm to
the same pager over the weekend (4:00 P.M. Friday to 7:00 A.M. Monday). Note that this application requires the
definition of three separate pager destinations.
Syslog DDA
An NAE configured as a Site Director has the optional capability of sending its configured audit log entries and alarm
notifications to the central repository of an external, industry-standard, Syslog server, conforming to Internet published
RFC 3164. After you save the Syslog DDA configuration, all messages are sent immediately to the configured Syslog
server. You can then open a user interface at the Syslog server and use the provided filters to interrogate or apply
forensic analysis on these messages. To assist in reading the log, a vertical bar symbol (|) separates individual fields
of each Metasys message and a single character dash (-) replaces any blank field.
By default, the Syslog option is disabled. Changing the Syslog Reporting Enabled attribute to True on the Syslog
window enables the Syslog function. The prerequisities to the Syslog DDA are as follows:
• The Syslog server must be installed and running on a computer server or virtual machine that is reachable by
the NAE.
• The NAE must be running Release 8.0 software or later.
• No more than three Syslog destinations can be specified.
• The firewall port must be open.
The definition of the Syslog DDA requires:
• label to identify the Syslog server
• IP address of the Syslog server
• port numbers for the UDP send port and UDP receive port (for example, 514 for both)
• event and audit filters to apply against all events and audit messages. Only those events and audit messages
that match the filters are passed to the Syslog server.
The Syslog DDA attribute called Syslog Reporting Enabled appears on the Shared Configuration section of the
Syslog tab of an NAE device object (Figure 13). This attribute has two selections: True or False.
Figure 14 shows an example of Metasys system messages as they appear on the Kiwi Syslog® Server Console
user interface. Use the console to filter the messages. If you do not have a tool, open a web browser and type the
following URL:
http://<IP of the server>>:<Port>/Events.aspx
For example:
http://SysLogserver1:8088/Events.aspx
When you browse to this site, type a valid username and password when prompted to gain access to the Syslog
server. A user interface appears with the captured messages.
If you run into any trouble while implementing the Syslog DDA functionality, consult this following table.
Table 10: Syslog Server Troubleshooting
Scenario Behavior
The engine is starting up but the SysLog DDA has not yet All generated audits and events are cached and sent to Syslog
started. DDA once it is started. The maximum size of the cache is 1,000
audits and 1,000 events per hour.
The Syslog server crashes. All generated audits and events that the engine sends to the
Syslog server are lost; nothing is cached.
The Syslog server goes offline or is unreachable. All generated audits and events that the engine sends to the
Syslog server are lost; nothing is cached. No data is sent to the
Syslog server until it comes back online or becomes reachable.
The IP address, name, or port numbers of the Syslog server All generated audits and events that the engine sends to the
as defined in the engine's object are invalid. Syslog server are lost; nothing is cached. No data is sent to the
Syslog server until you correct the invalid parameters in the
Syslog DDA.
The Syslog Reporting Enabled parameter is set to True, but All generated audits and events that the engine sends to the
no Syslog parameters are defined. Syslog server are lost; nothing is cached. No data is sent to the
Syslog server until you specify the parameters that the Syslog
DDA requires.
The UDP Send Port or UDP Receive Port is blocked by a All generated audits and events that the engine sends to the
firewall. Syslog server are lost; nothing is cached. No data is sent to the
Syslog server until the ports on the Syslog server are opened.
A parameter of the Syslog server changes, but the All generated audits and events that the engine sends to the
corresponding parameter in the Syslog DDA of the engine Syslog server are lost; nothing is cached. No data is received
is not likewise changed. at the Syslog server until you correct the invalid parameters in
the Syslog DDA.
RADIUS Overview
You can optionally configure the NAE to authenticate non-local user access through a Remote Authentication Dial-In
User Service (RADIUS) server. RADIUS is used by the NAE to authenticate the identity of authorized non-local
users of the system.
All RADIUS users must have a Metasys system user defined for which Metasys authorization is created and
maintained. The NAE RADIUS implementation adheres to the following Internet RFC documents:
• RFC 2865 - Remote Authentication Dial In User Service
• RFC 2548 - Microsoft Vendor-specific RADIUS Attributes
• RFC 2759 - Microsoft Point-to-Point Protocol (PPP) Challenge Handshake Authentication Protocol (CHAP)
Extensions, Version 2
The Metasys system implementation of RADIUS is as follows:
• Before you add a RADIUS user account to the security system of a network engine, first add the network engine
as a client of the RADIUS server. If you first configure the RADIUS server settings in the network engine before
you perform this prerequisite step, you may get the message Unable to login - Unexpected Error when you
try to log in. If this error appears, reset the network engine from the SMP UI. Then try to log in again. The RADIUS
server authenticates the user and login is successful.
• The Metasys system does not import authorization; all Metasys system users, both local (Metasys) and non-local
(RADIUS), are authorized through user configuration done online in the SMP, then stored in the Metasys Security
Database.
• The user ID must match what is expected to be authenticated by the RADIUS server, with or without the @domain
as defined by the local RADIUS implementation.
• Since the Metasys system performs no local authentication of non-local users, all password functions are
unavailable or ignored when creating and maintaining non-local Metasys user accounts. RADIUS passwords
are never stored in the Metasys Security Database.
• Authorization for a RADIUS user may be configured as Administrator, User, Operator, Maintenance, or any
custom roles created in the Metasys system.
• When a non-local user receives a number of consecutive RADIUS failures to authenticate and the account has
been set up to lock after receiving that many failed login attempts, the Metasys system authorization locks,
prohibiting the user from accessing the Metasys system device until a Metasys system administrator unlocks
the account.
• When a non-local user is authenticated by RADIUS, and the Metasys system schedule prohibits access during
the login time, the user's login attempt fails.
When a user provides a non-local username to the Metasys system for login, after confirming the supplied password
conforms to Metasys complexity rules, the controller passes the credentials, including the username and password,
to the configured RADIUS server for authentication. After the RADIUS server confirms authenticated access,
authorization is permitted as specified in the Metasys Security Database.
Messages reporting errors in RADIUS authentication are intentionally obscure to hinder possible intrusion from
unauthorized users. See RADIUS Errors for some situations that may result in error messages. Descriptive Metasys
system login failure messages are presented to the user only when RADIUS is disabled. When RADIUS is enabled,
local and non-local authentication failure messages are identical and obfuscated.
1 The Windows operating system login ID and password are used with dial-up and direct connections.
1 The Windows operating system (OS) has two administrator level user accounts. For security reasons, we strongly recommend
changing the Windows OS login password for both accounts when you commission the engine. You can disable the
administrator account, but do not disable the MetasysSysAgent account.
Allow HTTP
A network engine at Metasys system Release 8.1 or later has an attribute called Allow Http located under the
Network tab of the engine in the SMP UI. This attribute controls whether the Windows Firewall in the network engine
blocks incoming network traffic over the HTTP port (port 80). By default, the Allow Http attribute is set to True for all
network engines upgraded to Release 8.1 or later. Changing this attribute to False blocks all incoming network traffic
over port 80 at the network engine. Doing so does not interfere with NAE/NIE Update Tool operations.
Figure 15: Allow Http Attribute for Network Engine
Important: To avoid losing data, do not push the RE-BOOT SYSTEM switch on the NAE to initiate a device reset.
Pushing the RE-BOOT SYSTEM switch initiates a CPU reset and restart of the NAE, which causes all
unsaved data to be lost, including recent attribute value changes.
4. Enter the host name (or IP address) of the NAE including the domain name if required, and then click Discover.
The Launcher searches for the device on the building network. When the device is found, the Add New window
refreshes to indicate the found device.
Figure 19: Add New: Found Device
5. Make sure the Add box next to SMP is selected. You can enter a descriptive name for the NAE in the Description
field to make the NAE easier to find in the profile list, or you can keep the default IP address. Click Save. The
NAE is added to the profile list on the SMP tab.
Note: If the device has SCT installed, you can also add its SCT profile (as shown).
6. Select the NAE from the SMP profile list and click Launch. If the device you are adding has not yet been
downloaded and installed on your computer, a Downloading window appears, followed by an Installing window.
The windows close when the download and installation steps are complete.
3. Enter the host name (or IP address) of the NAE, including the domain name if required.
4. Click Launch. The system login window appears.
5. Enter the initial Username and Password values for the NAE and click Login. See Login User Names and
Passwords.
6. If necessary, set the time, time zone, and date. See Appendix: Time Zone, Date, and Time Management.
7. Go to the Network tab and verify the Computer Name and Domain Name values. Change these values to the
assigned values for your network site. Also verify the Allow http attribute. If trusted certificates are not deployed
to the engine, communication between the engine and its clients occurs over port 80. If you need to close the
network engine's incoming http communication port (port 80), select False for Allow http. Doing so does not
interfere with NAE/NIE Update Tool operations. Otherwise, keep this attribute at its default value (True).
Figure 23: NAE Network Tab - Edit Mode
Depending on the DNS server configuration, the NAE should be reachable from the subnet on which the NAE resides
or from other subnets.
Preparing an NAE for a Network without DHCP and without DNS Support
When the NAE Uses APIPA
This scenario is typical when you install an NAE on a stand-alone network designated as a building control network
only. Perform these steps from a computer attached to the network. The NAE uses APIPA to automatically assign
an IP address. For this procedure, do not attach an Ethernet crossover cable directly to the NAE. In this scenario,
a direct connection to the NAE may affect the assignment of an IP address.
1. Attach the NAE to the network using an Ethernet patch cable.
Preparing an NAE for a Network without DHCP and without DNS Support
When the NAE Uses a Static IP Address
This scenario is typical when you install the NAE on a stand-alone network dedicated to building control only. Do
not use this scenario when the NAE uses APIPA. The steps can be performed from a computer that is attached to
the network or a computer that is connected directly to the NAE with an Ethernet crossover cable. If the computer
is attached to the network, the computer must be connected to the same subnet as the NAE. To connect to the NAE
with this procedure, you may need to know the IP address of the NAE.
1. Check the network IP address and the subnet mask of the computer. If needed, change the IP address and the
subnet mask of the computer so that the computer and the NAE are on the same subnet. The IP address assigned
to the computer must be unique for the subnet.
2. With your computer or commissioning laptop connected to the building network, start NCT. This tool listens for
and shows the IP address information of the NAE as it comes online.
3. Connect supply power to the NAE and wait for the NAE to complete startup and initialization. Startup and
initialization is complete when the NAE green RUN LED is on steady and the PEER COM LED is either off or
flickering to show activity. The startup and initialization sequence may take up to 10 minutes to complete. The
NCT indicates the current IP address of the network engine.
4. Go to Installing Launcher to Access the NAE, follow all instructions, then return to the next step in this section.
5. After you have completed the steps in Installing Launcher to Access the NAE, including the step for logging in
to the NAE, demote the NAE from Site Director if the NAE is not going to be the Site Director.
6. Select the NAE device object from the Navigation panel of the Site Management Portal UI and drag it to the
Display panel. The NAE device object UI opens in the Display panel.
7. Select the Network tab of the NAE device object and click Edit.
8. Change the Computer Name value, if desired. Change DHCP Enabled attribute value to False. This disables
DHCP and APIPA. Specify the IP Address, IP Mask, IP Router Address, and the DNS Server IP Addresses. The
network administrator typically assigns these values. Record the assigned IP address for the NAE for future
reference. Click Save. The NAE automatically logs you out and resets.
9. Wait for the NAE to complete the startup and initialization sequence.
Note: Startup and initialization is complete when the NAE green RUN LED is on steady and the PEER COM
LED is either off or flickering to show activity. The startup and initialization sequence may take up to 10
minutes to complete.
Initial setup is complete.
Note: If you connected your computer directly to the NAE with an Ethernet crossover cable, disconnect the
crossover cable and connect the NAE to the network with an Ethernet patch cable.
You can log in to the NAE by entering its IP address in Launcher on any subnet of the network.
Preparing an NAE for a Network That Supports DHCP but Not DNS
This scenario is common to many building networks. The NAE should only use DHCP without DNS if you have
configured DHCP to always assign the same IP address after device resets and lease renewals. If this is not the
case, use static IP addresses as described in Preparing an NAE for a Network without DHCP and without DNS
Support When the NAE Uses a Static IP Address.
1. Attach the NAE to the network using an Ethernet patch cable.
2. With your computer or commissioning laptop connected to the building network, start NCT. This tool listens for
and shows the IP address information of the NAE as it comes online.
3. Connect supply power to the NAE and wait for the NAE to complete initialization. The NCT indicates the current
IP address of the network engine.
Preparing an NAE for a Network That Supports DNS but Not DHCP
This scenario is not typical of modern networks. The steps are identical to the steps in the Preparing an NAE for a
Network without DHCP and without DNS Support When the NAE Uses APIPA and Preparing an NAE for a Network
without DHCP and without DNS Support When the NAE Uses a Static IP Address.
Using the NAE Ethernet MAC address (from the NAE label), the network administrator can update the DNS server
and the assigned computer name. If this is done, you can enter dns-name in Launcher on any computer on the
building network.
5. At the command prompt, type net pause miiidm to pause the Device Manager.
6. At the command prompt, type notepad and press Enter. Microsoft Notepad opens in a new window.
12. Delete <!-- at the beginning and --> at the end of the serial printer DDA line (see circled text):
3. Click Save.
4. Select the Advanced option and click Edit.
5. Edit the advanced attribute values as needed. (Refer to the NAE Device Object Help and Audit Trails Help in
the Metasys® SMP Help (LIT-1201793) for guidance.) If the NAE is on a site with an ADS/ADX, enter the
ADS/ADX’s IP address in Local Site Director field in the Site section of this screen so the NAE can find the
ADS/ADX.
2. To establish a serial port connection to the RS232C A Serial port on NAE35/NAE45 models or Serial Port A on
NAE55/NIE55 models, edit the attribute values in the Serial Port Cable Config section.
5. Enter the Destination values according to Table 15. (Refer to the Alarm and Events Management section in the
Metasys® SMP Help (LIT-1201793) for additional information on setting the attribute values for alarm and event
notifications.)
Table 15: Shared Attributes for All Email Destinations
Attribute Description (Value Requirement/Range) Initial Value
SMTP Server Host Specifies the server name that handles outgoing email. (Required Value) Fully qualified host
name
SMTP Port Specifies the TCP port that the server uses to deliver email message. 25
(Required Value/1 to 25)
Authentication Type Specifies the Authentication Type the NAE uses to log in to the outgoing None
email server. Select SMTP, Post Office Protocol (POP) before SMTP, or
None.
SMTP User Name Specifies the user name the NAE uses to log in to the SMTP server that –
handles outgoing email messages. (Required only if SMTP is selected
for Authentication Type.)
SMTP Password Specifies the password the NAE uses to log in to the SMTP server that –
handles outgoing email messages. (Required only if SMTP is selected
for Authentication Type.)
POP Server Hostname Specifies the POP server name for incoming email messages. (Required –
only if the email server requires POP before SMTP, before it accepts
email messages from client. If this field is left blank, POP before SMTP
is disabled.)
POP User name Specifies the POP user name. (Required only if POP Authentication is Maximum 20
required and there is a value specified for POP server host.) characters
6. Click New to the right of Destination Email Addresses. The Email Import dialog box appears. Import user names
and the associated email addresses from the list of user names for the site. (Refer to the Metasys® SMP Help
(LIT-1201793) for more information.)
7. To filter the email messages that are sent to a destination, click New next to the Filters section of the Email
Destination Configuration tab. The Add Filter dialog box appears.
Figure 34: Add Filter Dialog Box
8. Select the Item, Operator, and Value (from the drop-down lists) for the condition that you want to trigger the
email notification. (Refer to Event Message Routing, Filtering, and Destinations in the Metasys® SMP Help
(LIT-1201793) for additional information on filters.)
9. Click OK.
10. Enable the Format characteristics for email notifications sent to the specified destinations by selecting the check
boxes next to the Format characteristic.
11. Add additional email destinations with filters and formats as required.
12. Click Save.
3. Enter the Shared Configuration values using Table 20 and Table 21 as references. (These fields establish
values for attributes that are common to all pager alarm notifications generated from this NAE. Refer to Alarm
and Event Management in the Metasys® SMP Help (LIT-1201793) for additional information on setting the
attribute values for alarm and event notifications.)
Table 20: Shared Attributes for All Pager Destinations
Attribute Description (Value Requirement/Range)
Connect Using Specifies the connection type: Internal Modem, External Modem.
Access Number Specifies the service or modem phone number that the NAE uses to access phone
service. (This is not a pager destination phone number.)
Redial Attempts Specifies the number of attempts the NAE makes to connect with the destination
pager before stopping.
Time Between Redial Attempts Specifies the time-delay interval between subsequent attempts to connect with a
destination pager.
Idle Time Before Hanging Up Specifies the amount of idle time allowed on the connection before disconnecting.
Redial If Line Is Dropped Specifies whether to redial if connection with destination pager is broken.
4. In the Destination section (Figure 35), click New. The Destinations Configuration edit fields appear (Figure 36).
Note: The Max Characters field defines the length of the text string that is sent to the pager. This field cannot
have a value of zero (Figure 36).
5. Enter the appropriate values for the specified pager message destination.
Note: These fields establish values for attributes that are specific to the pager destination and message for
specified alarm notifications generated from this NAE. Refer to Alarm and Event Management in the
Metasys SMP Help for additional information on setting the attribute values for alarm and event
notifications.
6. To filter the conditions that trigger a pager notification, click New next to the filters section of the Pager Destination
Configuration tab (Figure 36). The Add Filter dialog box appears (Figure 37).
Figure 37: Add Filter Dialog Box
7. Select the item, operator, and value of the condition that you want to trigger a pager notification. (Refer to Event
Message Routing, Filtering, and Destinations in the Metasys SMP Help for additional information on adding
filters.)
8. Add additional pager destinations and filters as desired.
9. Click OK.
10. Click Save (Figure 36).
3. In the Shared Configuration section, set SNMP Enabled value to True if your network application uses SNMP
monitoring.
4. Type the IP address or host name values of the SNMP Management device (computer).
5. In the Read Only Community and Read/Write Community fields, enter the community string used by the
Enterprise/Network Management Systems (E/NMS) to retrieve data from objects maintained by managed devices
(Table 22).
Table 22: Share Attributes for SNMP Destination
Attribute Description (Value Requirement/Range) Initial Value
SNMP Enabled Enables or disables SNMP DDA on the NAE. (True, False) False
SNMP Trap Version Specifies the version of SNMP used on the network on which the NAE SNMP Version 1
resides. (Not required if SNMP Enabled is set to False)
6. Click New in the Destinations section. The Destination Configuration edit screen appears (Figure 39).
Figure 39: SNMP Destination Configuration Tab - Edit Mode
7. Enter the Destination information for the SNMP trap (Table 23).
3. Click the down arrow for the Syslog Reporting Enabled attribute and select True.
4. In the Destinations section, click New. The Destination Configuration edit fields appear.
5. Enter the Destination Configuration values according to the following table.
Table 24: Attributes for Specific Syslog Destinations
Attribute Description (Value Requirement/Range)
Label Specifies a name for the Syslog server (for example,
Syslog1).
Syslog Server Specifies the IP address or resolvable host name of the
Syslog server that is configured to receive events and audits
from the NAE.
UDP Send Port Specifies the Syslog port that is used to send messages to
an NAE.
UDP Receive Port Specifies the Syslog port that is used to receive messages
from an NAE.
Event Filters Specifies the rules for filtering the alarms and events that are
sent to the Syslog server. Each filter has an Item, Operator,
and Value.
Audit Filters Specifies the rules for filtering the audit messages that are
sent to the Syslog server. Each filter has an Item, Operator,
and Value.
6. In the Event Filters section, click New. The Add Filter dialog box appears.
7. Select the item, operator, and value of the condition that you want to trigger a message to the Syslog server.
8. Add any additional event filters as desired.
9. In the Event Filters section, click New. The Add Filter dialog box appears.
Figure 42: Add Filter Dialog Box: Audits
10. Select the item, operator, and value of the condition that you want to trigger a message to the Syslog server.
11. Add any additional audit filters as desired.
12. Add additional Syslog destinations and filters as desired.
13. Click OK.
14. Click Save.
4. Select the Enable RADIUS Authentication check box to enable the fields on the Configure RADIUS screen.
5. Fill in the fields of the Configure RADIUS screen using the information in the following table.
Table 25: RADIUS Configuration Fields
Field Value Description
Enable RADIUS Authentication Checked or unchecked Check box to configure and enable
RADIUS server authentication. The
check box defaults to unchecked. If it is
not checked, all fields in the RADIUS
Configuration screen are not editable.
RADIUS Server IPv4 address or a DNS name IPv4 address of the RADIUS server.
RADIUS Server Port 0 - 65535 Port on the RADIUS server to which
Metasys directs messages.
RADIUS Client Port 0 - 65535 Port on the network engine that is used
to send requests to and receive
responses from the RADIUS server.
Note: The default port for RADIUS is
1812.
Shared Secret Text string A secret that is used to verify the validity
of messages sent by the RADIUS server
to the client. Knowing the Shared Secret
does not grant access to a RADIUS
server.
6. Click Save.
Note: At any time, RADIUS may be disabled by clearing the Enable Radius Authentication check box and
applying or saving the configuration. While RADIUS is disabled, only local users can authenticate. Login
errors display when a user attempts to log in with a RADIUS account.
3. Select items in the Select Item(s) list to edit existing alarms. (To create new alarms, see Creating a New Alarm.)
4. Click Edit. The NAE Alarm edit screen appears (Figure 48).
5. Edit the desired Attributes for the NAE or field device, and click Save to save the edited alarm settings.
3. Select the device Attribute for which you want to create an alarm.
4. Follow the Wizard instructions and create or edit the values for the Attribute for which you want to create an
alarm.
5. Click Save when you have finished creating the desired alarm parameters for the device Attribute.
6. Type the host name or IP address of the NAE or ADS/ADX that you want to designate as the local Site Director.
7. Click Save. A confirmation message box appears (Figure 51).
Figure 51: Confirmation for Demoting Site Director
Moving Security Database and Clearing It from Demoted Site Director Prior to Release 6.0
1. Create a backup of the Security database of the demoted device, but only if you are using the same set of users
on the new or existing Site Director.
2. Create a backup of the Security database from one of the devices (NAE/NIE/ADS/ADX) on the site that has
never been a Site Director and has never had a Site Director’s Security database restored to it (in other words,
has a clean Security database with only the default user accounts).
3. Restore the clean copy of the Security database that you created in Step 2 to the device that was demoted from
the Site Director.
4. If you are using the Security database of the demoted device on the new Site Director, restore the Security
database that you backed up in Step 1 to the new or existing Site Director.
5. Create a backup of the Security database from the device that was demoted and restored with a clean database
in Step 3.
This step ensures that the device Security database in the SCT matches the clean Security you restored to the
device in Step 3.
Moving Security Database and Clearing It from Demoted Site Director Release 6.0 or Later
Note: Starting at Release 6.0, the security database backup is performed as part of the SCT upload, regardless of
whether or not the supervisory controller or ADS/ADX is a Site Director.
1. In the SCT, go to Tools > Security Copy to verify that a security database exists for the demoted supervisory
controller. This database is the security backup that was originally used by the Site Director.
Note: If the security database does not exist, it means the controller has never been accessed from the Site
Management Portal and uploaded to the SCT.
If the security database does not exist, go to Step 2. If the security database does exist, go to Step 5.
2. Log in to the demoted controller from the Site Management Portal.
3. Change your password when prompted at the login.
Note: Changing your password creates the security database automatically the next time the SCT database is
uploaded.
3. Make sure that the ADS/ADX or ODS Connection Type value is Dial (Figure 52).
4. Verify that the ADS/ADX or ODS Repository attribute is the first IP address in the range specified when configuring
the ADS/ADX to accept incoming connections. (Refer to the ADS/ADX Commissioning Guide (LIT-1201645)
or the ODS Commissioning Guide (LIT-12011944) for more information.)
5. Edit the other ADS/ADX or ODS attributes as needed.
6. Click Save.
7. Select the Network tab and click Edit. The Network edit screen appears. Scroll down to the ADS Dial-up section
(Figure 53).
8. In the Connect Using drop-down box, select Internal modem or External modem.
9. Type in the Access Number value, which is the complete telephone number of the ADS/ADX, the ODS, or the
Internet service provider (ISP) to which the NAE is dialing.
10. Verify that the ADS/ADX or ODS Dial-up ISP Username and ISP Password values match either the account
(user name and password) selected for incoming messages to the ADS/ADX or ODS or the user name and
password assigned by the ISP.
Note: The user name and password values need not match the Metasys system account values because these
values are used for establishing dial-up connections only.
11. In the Enable DCHP drop-down box, select True or False. If you select False, specify the static IP Address of
the ADS/ADX or ODS computer.
12. Click Save.
8. Press Enter to exit and close the NCT. Disconnect the network engine from the NCT.
9. Log in to the Metasys SMP of the NCE25, NAE35, or NAE45. To apply this change, you need to restart the
network engine from the SMP. Issue a Reset Device command. After a few minutes, the network engine comes
back online with the Windows firewall disabled.
Figure 58: Issuing Reset Device Command
10. To re-enable the firewall, perform Step 1 to Step 9, and answer Y to the prompt:
Firewall is disabled. Do you want to enable it? Y/N
3. Select True for the U.S. Department of Defense (DoD) Banner attribute.
4. Click Save. The setting takes from 3 to 5 minutes to become effective at the network engine.
If you want to disable the Warning Banner in the future, select False and click Save.
Replacing an NAE
To replace an NAE on a network site, update the site registration to ensure that devices on the site communicate
with the new (replacement) NAE; otherwise, devices may attempt to communicate with the NAE that was removed
from the site.
If you do not remove an NAE from a site correctly, the Site Director may attempt to send messages to the old NAE,
creating unnecessary network traffic.
If the NAE’s trend data is stored in an ADS repository, forward the data prior to beginning the upgrade by following
these steps for each engine:
1. Select a supervisory engine in the Navigation tree.
2. Select Action > Commands. A list of available commands appears.
3. Select Archive, then click Send. The archived trend data is sent to the ADS/ADX.
To replace an NAE:
1. Using the SCT, upload the current copy of the NAE database.
2. Physically replace the old NAE with the new NAE, connect the new NAE to the network, and power on the new
NAE.
3. Do one of the following:
Troubleshooting
This section describes the most common problems you may encounter when you set up and operate NAEs. Use
the general solution guidelines and procedure references in this section to avoid or resolve these problems. Table
26 provides a list of common NAE problems and their solutions. To troubleshoot the NAE-S, also refer to the NAE-S
Commissioning Guide (LIT-12012269) for specific information that applies only to this secure NAE model.
This section is not a troubleshooting guide for Metasys system networks, customer networks, BAS networks, or the
field devices connected to the NAE.
Field device troubleshooting is covered in the field device documentation. Refer to the appropriate field device
documentation for additional information.
Note: To effectively troubleshoot an NAE, it may be necessary to isolate the NAE from the Ethernet network and
the associated field trunks and field devices, and then direct-connect to the NAE with a computer to browse
the Site Management Portal UI.
Update and upgrade related problems may also occur when the SCT software, NAE software, and the NAE archive
databases are of incompatible versions. When you update the NAE disk image, you must update the NAE archive
database to match the new software version. The SCT application used to configure a Metasys or NAE must also
be of the same software version as the NAE software.
Refer to the NAE/NIE Update Tool Help (LIT-12011524) and see the Related Documentation section of this document
for additional information on disk image updates and archive upgrades and downloads.
Login Problems
Login problems may occur when the user name or password is incorrectly entered at login. If the default user name
and password fail, the initial values may have been changed by an administrator-level user. You need the designated
user name and password to log in to an NAE.
Whenever you change the Security System database for an N40-class network engine with Release 8.0 or later
(NxE35, NxE45, or NxE25), you must issue the Reset Device command to ensure that the security database is
archived to non-volatile memory. This step is not required for N50-class engines (NxE55s). If you do not perform
this step for a network engine that has a poor or dead battery, and that engine loses power, the latest changes to
the Security System database are lost.
As a last resort, you can also reload the NAE with the NAE/NIE Update Tool, but that process deletes the archive
database. For details, refer to the NAE/NIE Update Tool Help (LIT-12011524).
The RADIUS error message in Figure 61 appears if you try to log in to an NAE with a non-complex password and
RADIUS is not enabled.
Figure 61: Non-Complex Password Error - RADIUS Disabled
Situations When Metasys System Login Screen Appears for RADIUS Users
The following situations produce the Metasys system login screen for RADIUS users.
1 LED labeled FC BUS on models that support MS/TP Bus or N2 Bus and labeled LON on models that support LONWORKS
network.
2 Modem LEDs are only on NCE25 models with internal modems.
Diagnostic Tab
The Diagnostic tab displays NAE hardware status information that may aid troubleshooting.
With the NAE object selected, click the Diagnostic tab to view current information about the NAE hardware status.
Figure 67 shows an example.
You can also select and drag Network Protocol objects into the Display panel and click the Diagnostic tab to view
information for the selected Network protocol (Figure 68).
Summary Tab
The Summary tab (Figure 69) in the Site Management Portal UI provides a quick view of the status of the objects
and items currently in your site.
Select, drag, and drop an object from the Navigation panel in the Display panel, and click the Summary tab. When
you first click the Summary tab, the NAE requests the status of the items in the Display panel (Figure 69). This
request may take a few minutes.
For additional information and explanations of the attributes found in the Summary and Diagnostic tabs, refer to the
Object Help in the Metasys® SCT Help (LIT-12011964) or the Metasys® SMP Help (LIT-1201793).
Determining the NAE IP Address and Device Name for a Network Connection
The IP address determined by this procedure is the IP address used on a building network connection, not serial or
dial connections.
Determining the NAE IP Address and Device Name By Using a Serial Port Monitor
When an NAE35, NAE45, NAE55, NIE55, or NCE25 is powered on, it sends a text string to its serial port that contains
helpful information, such as its current IP address and device name. For the NAE35 or NAE45, this data stream is
sent to the RS232C A Serial Port. For the NAE55 or NIE55, this data stream is sent to Serial Port B; for the NCE25,
the data is sent to the RS232C port. Table 28 and Table 29 provide examples of the data that is sent.
Table 28: Example NAE35, NAE45, NCE25 Startup Data Stream
Device Information Example Output
Host Name NAE-1
DHCP Enabled Yes
Note: The IP address and device name are internal to the NAE and change if the NAE is attached to a network
using DHCP, unless the DHCP server is configured to assign a static IP address. Also, if the NAE has an IP
address and is then disconnected from the network, a VT100 terminal emulator sees zeros as the IP address
until the NAE is restarted.
To determine the NAE IP address and device name, attach an RS232 DB9 cable between the serial ports of the
computer and the NAE, then connect a computer monitor. Install a VT100 terminal emulator program on the computer
that connects to the device. Check with your IT department (or technical support team) for a recommended VT100
terminal emulator program to use with your Windows operating system. (In the terminal emulator program, use these
settings: baud rate=115200 bps; data length=8 bit; no parity; one stop bit.)
Related Documentation
Table 30: NAE Related Documentation
For Information On See Document
Overview of the Metasys System Network Features and Functions Metasys® System Configuration Guide (LIT-12011832)
Definition of Terms, Concepts, and Acronyms Commonly Used to Metasys System Extended Architecture Glossary
Describe the Metasys System Technical Bulletin (LIT-1201612)
General Network and Information Technology Definitions and Network and IT Guidance Technical Bulletin
Concepts, and Creating a Printer DDA for an NAE (LIT-12011279)
Daily Operation of the Metasys System Network, Navigating the SMP Metasys® SMP Help (LIT-1201793)
UI or SCT UI, Monitoring and Controlling BAS Networks, and
Metasys® SCT Help (LIT-12011964)
Connecting to Cloud-Based Applications
Installation Considerations and Guidelines, Mounting, Wiring, and NAE35/NAE45 Installation Instructions (Part No.
Starting up an NAE35 or NAE45 24-10050-6)
Installation Considerations and Guidelines, Mounting, Wiring, and NAE55/NIE55 Installation Instructions (Part No.
Starting up an NAE55 or NIE55 24-10051-43)
Installation Considerations and Guidelines, Mounting, Wiring, and NAE55-S Installation Instructions (Part No.
Starting up an NAE-S 24-10051-108)
Installation Considerations and Guidelines, Mounting, Wiring, and NCE25 Installation Instructions (Part No. 24-10143-63)
Starting up an NCE25
Additional Guidelines for Commissioning and Configuring and NCE Technical Bulletin (LIT-12011267)
NCE25 Network Engines
Additional Guidelines for Commissioning NxE85 Network Engines NxE85 Commissioning Guide (LIT-12011044)
Additional Guidelines for Commissioning NxE89 Network Engines NIE89 Commissioning Guide (LIT-12011920)
Commissioning NIEx9 Network Engines NIEx9 Commissioning Guide (LIT-12011922)
Updating the NAE/NIE Disk Image to New Software Release Versions NAE/NIE Update Tool Help (LIT-12011524)
Installing the ADS and ADX Software Metasys Server Installation and Upgrade Instructions
Wizard (LIT-12012162)
Installing the ADS-Lite Software Metasys Server Lite Installation and Upgrade
Instructions Wizard (LIT-12012258)
Installing the ODS Software ODS Installation and Upgrade Instructions Wizard
(LIT-12011945)
Installing the SCT Software SCT Installation and Upgrade Instructions Wizard
(LIT-12012067)
Creating, Editing, and Loading Archive Databases with the SCT Metasys® SCT Help (LIT-12011964)
Managing Trusted Certificates Created for Network Engines Metasys® SCT Help (LIT-12011964)
Integrating N2 Devices into the Metasys System Network N2 Integration with the NAE Technical Bulletin
(LIT-1201683)
How to Install the CCT Software CCT Installation Instructions (LIT-12011529)
Using the Controller Configuration Tool Controller Tool Help (LIT-12011147)
Technical Specifications
Table 31: NCE25
Power Requirement Dedicated nominal 24 VAC, Class 2 power supply (North America), safety extra-low voltage
(SELV) power supply (Europe), at 50/60 Hz (20 VAC minimum to 30 VAC maximum)
Power Consumption 25 VA maximum for NCE25 only
Note: The 25 VA rating does not include any power supplied by the NCE to devices connected
at the NCE binary outputs (BOs). BO devices connected to and powered by an NCE
can require an additional 125 VA (maximum).
Ambient Operating Conditions 0 to 50°C (32 to 122°F), 10 to 90% RH, 30°C (86°F) maximum dew point
Ambient Storage Conditions -40 to 70°C (-40 to 158°F), 5 to 95% RH, 30°C (86°F) maximum dew point
Data Protection Battery Supports data protection on power failure. Rechargeable NiMH battery: 3.6 VDC 500 mAh,
with a typical life of 5 to 7 years at 21°C (70°F); Product Code Number: MS-BAT1020-0
Processors Supervisory Controller: 192 MHz Renesas® SH4 7760 RISC processor
Field Controller: 20 MHz Renesas H8S2398 processor
Memory Supervisory Controller: 128 MB flash nonvolatile memory for operating system, configuration
data, and operations data storage and backup and 128 MB synchronous dynamic random
access memory (SDRAM) for operations data dynamic memory
Field Controller: 1 MB flash memory and 1 MB RAM
Operating System Microsoft Windows CE embedded 6.0
BACnet International: BACnet Testing Laboratories™ (BTL) 135-2010 Listed BACnet Building
Controller (B-BC)
Table 34: NAE-S Technical Specifications (North America and Canada Only)
Power Requirements NAE551S-2 Engine:
Dedicated nominal 24 VAC, Class 2 power supply (North America), at 50/60 Hz (20 VAC minimum to
30 VAC maximum)
Internal Module with Embedded Encryption Technology:
Input: Dedicated nominal 100–240 VAC, Class 1 power supply (North America), at 50/60 Hz (85 VAC
minimum to 264 VAC maximum)
Output: 24 VDC (22 VDC minimum to 26 VDC maximum)
Power Consumption 50 VA maximum
Power Specifications Dedicated nominal 24 VDC, input voltage range 85–264 VAC (120–375 VDC), output current 2.0A
for Encryption Board
Ambient Operating 32 to 122°F (0 to 50°C); 10 to 90% RH, 86°F (30°C) maximum dew point
Conditions
The performance specifications are nominal and conform to acceptable industry standard. For application at conditions
beyond these specifications, consult the local Johnson Controls office. Johnson Controls shall not be liable for
damages resulting from misapplication or misuse of its products.
Important: Edit the Device Time Servers attribute or Time Sync Period attribute in the Site object only.
Note: To ensure that the correct time appears on the Site Management Portal user interface accessed from a client
computer, apply the most recent Daylight Saving Time (DST) patch for the operating system on all clients
that access the Site Director. The latest DST patch is available from Microsoft Corporation.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 108
4. When the ADS/ADX/ODS receives the IAmLive message, it attempts to validate the security credentials of the
network engines. If the time in the network engines is different than the time in the ADS/ADX/ODS by 5 or more
minutes (also taking into account the time zone of each network engine), the engine security credentials are
invalidated.
5. Network engines come online and check in with the Site Director.
6. Every 15 seconds, the network engines check for ADS/ADX/ODS online/offline conditions. If the ADS/ADX/ODS
is offline, the network engines send an IAmLive message to the ADS/ADX/ODS every 20 seconds.
7. When the network engine receives back an invalidated credential, the network engines request the current time
from the ADS/ADX/ODS and update the engine time to match (also taking into account the time zone of each
network engine).
Note: Time between an ADS/ADX/ODS and network engines synchronizes only if the time differs between the
ADS/ADX/ODS and network engines by 5 or more minutes. In the worst case scenario, one network
engine could be 4 minutes and 59 seconds ahead of the ADS/ADX/ODS, and another network engine
could be 4 minutes and 59 seconds behind the ADS/ADX/ODS.
8. After time is synchronized and the ADS/ADX/ODS is online, the network engines send IAmLive messages to
the ADS/ADX/ODS every 5 minutes (instead of every 20 seconds).
Note: Time synchronization is affected if you change the network engine's Site Director from an ADS/ADX/ODS
in one time zone to an ADS/ADX/ODS in a different time zone. If you make this change online, as an
interim step, promote the network engine to be its own Site Director, wait several minutes, then assign
to the network engine the ADS/ADX/ODS Site Director in the new time zone. This interim step ensures
proper time sychronization.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 109
If you use Windows time synchronization, you must define a device time server in the Site Director using the Device
Time Servers attribute.
Note: If you implement an intentional time change for your site, in less than 5 minutes, all other devices on the site
update with the new time with Windows time synchronization.
Example Network
Figure 70 shows an example system with a common time zone, date, and time management setup. This example
is representative of the Multicast and Windows time synchronization methods.
The ADS/ADX/ODS Site Director is configured to receive the date and time from an intranet time server. The date
and time originates at an Internet time server (such as the Naval atomic clock). Using Simple Network Time Protocol
(SNTP), the intranet time server requests the time from the Internet time server. The Site Director requests the time
from the intranet time server. Then, using the Metasys system automatic time synchronization, and the manually
configured time zone, the Site Director automatically provides the time zone, date, and time to the other engines/server
on the Metasys network.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 110
Figure 70: Time Management Sample System
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 111
Table 37: Time Zone Examples
Device Release Time Zone Time Zone Used
NAE 7.0 Central Site Director's time zone (Central)
NAE 8.0 or later Pacific Pacific Standard Time
NAE 8.0 or later Eastern Eastern Standard Time
Note: If your system consists of a network engine Site Director with multiple child network engines, make sure you
use the Default Time Zone attribute of the Site object, not the Time Zone attribute in the engine, or undesirable
behavior may occur.
For a network engine at Release 8.0 or later, the local time and date shown on the device object's focus window is
based on the default time zone set for the device. If the engine is located in a different time zone than the Site
Director, the current time and date shown for each differs.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 112
In the ADS/ADX/ODS Site Director, the time zone, date, and time in the device object of the device are set by you
or by the designated site time server. In a non-Site Director network engine, the time zone, date, and time in the
device object come from the Site Director. The device object then passes the time zone, date, and time along to the
Status Bar for display. If the device is busy, it may take a few minutes for the time zone, date, and time to update
correctly in the Status Bar.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 113
Notes:
• The Local Site Director may be entered as an IP address or host name. If entered as a host name, the name
is case-sensitive (for example, NxE-THREE is not the same as nxe-three).
Figure 72: Site Director Field
• If the Site Director field contains the wrong device or is empty, click Edit. Edit the Site Director entry and click
Save.
5. Go to Setting the Time Synchronization Method.
6. If you select Windows time, enter a device time server in the Device Time Servers attribute. A device time server
is required for Windows time synchronization.
7. Click Save.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 114
Important: When the Time Sync Method is set to Multicast and the ADS/ADX/ODS computer is synchronized
with a time source other than itself, the Site Time Server must be an SNTP Time Server to allow
the ADS/ADX/ODS to perform time synchronization. Time synchronization occurs when a change
is detected in the ADS/ADX/ODS computer local clock, or at the Site configured Time Sync Period.
Enabling Multicast time synchronization terminates the Windows win32time service, but changing
the Time Sync Method back to Windows does not re-enable the service. If you change the Time
Sync Method back to Windows, you must manually start the win32time service, or restart the Site
Director.
Note: When the Time Sync Method is set to Windows, also set the Internet Time Server in the Windows operating
system of the Site Director to match the IP Address specified for the Site Time Server. In Control Panel
of the Site Director, search for Date and Time. On the Date and Time dialog box, click the Internet Time
tab. Click Change Settings and enter in the Server field the same IP address that you defined in the Site
Time Server attribute. Click OK to apply the change.
8. Go to Network Engine as Site Director or ADS/ADX/ODS as Site Director.
Setting the Default Time Zone in the Site Director Network Engine
1. Log in to the Site Director network engine.
2. Drag the Site object to the Display frame.
3. Click Edit.
4. In the Time section, in the Default Time Zone drop-down box, select the correct time zone for the device (Figure
74).
Figure 74: Default Time Zone in the Site Object
5. Click Save.
Note: The Site object's focus window is updated immediately to indicate the current time and selected time
zone, but the blue status bar in the lower right corner does not update until you log off, then log in to the
network engine again.
If you are also manually setting the date and time in the Site Director network engine, go to Setting the Date and
Time in the Site Director Network Engine.
If you are selecting a time server for the Site Director network engine, go to Selecting a Site Time Server for the
Site Director Network Engine.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 115
Setting the Date and Time in the Site Director Network Engine
Before you manually set the date and time in the Site Director network engine, follow the steps in Setting the Default
Time Zone in the Site Director Network Engine.
1. In the navigation tree, right-click the Site object and select Command. The Command dialog box appears.
2. Click Set Time and enter a value in the text box (Figure 75).
Figure 75: Time in a Site Director Network Engine
3. Click Send.
Note: If you have a site time server selected, do not attempt to set the time manually. If you have one or more
site time servers defined, sending this command generates an error.
4. In the navigation tree, right-click the Site object and select Command. The Command dialog box appears.
5. Click Set Date and select a date from the calendar (Figure 76).
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 116
Figure 76: Date in a Site Director Network Engine
6. Click Send.
Note: If you have one or more site time servers defined, sending this command produces an error. If you have
a site time server defined, do not attempt to set the time manually.
The Site Director time zone, date, and time are now set and propagate to all other engines on the site.
Selecting a Site Time Server for the Site Director Network Engine
Before you select a site time server for the Site Director network engine, follow the steps in Setting the Default Time
Zone in the Site Director Network Engine.
1. Reset the network engine for the time zone change to take effect.
2. Log in to the network engine.
3. Drag the Site object to the Display frame.
4. Click Edit.
5. In the Time section, in the Site Time Servers field, click the browse button.
Note: The Device Time Servers field should be blank unless you are using Windows time synchronization. Do
not change the value for the Time Sync Period attribute.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 117
Figure 77: Site Time Servers in the Site Object
8. Click OK.
9. Click Save. The Site Director now requests the date and time from the selected time server and propagates it
to all other engines on the site.
10. Go to Configuring Additional Multicast Time Synchronization Settings, if needed.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 118
Setting the Time Zone in the Site Director ADS/ADX/ODS
1. In the lower-right corner of the ADS/ADX/ODS computer screen, click the time. The Date and Time Properties
box appears (Figure 79). The appearance of this screen varies depending on the operating system.
Figure 79: Time and Date on a Site Director ADS/ADX/ODS
2. Click Change date and time settings, then click Change time zone. The Time Zone Settings box appears
(Figure 80).
Figure 80: Time Zone on a Site Director ADS/ADX/ODS
Selecting a Site Time Server for the Site Director ADS/ADX/ODS (Windows Method Only)
If you set up a site time server for your Site Director, you can set the date and time manually in the ADS/ADX/ODS,
but the manual settings are overridden at the end of the Time Sync Period.
Before selecting a site time server for the Site Director ADS/ADX/ODS, follow the steps in the Setting the Time Zone
in the Site Director ADS/ADX/ODS section.
1. On the ADS/ADX/ODS computer, press the Windows key + R. The Run dialog box appears (Figure 81).
Figure 81: Run Dialog Box
2. Type Net time /setsntp:"10.10.16.1 10.10.16.2 ...", where 10.10.16.1 and 10.10.16.2 are example IP addresses
of time servers.
Note: The IT department should provide the address of a suitable time server.
Be sure that the quotation marks are included (especially when listing multiple time servers).
3. Click OK.
The Site Director now requests the date and time from the selected time server and propagates it to all other
engines/servers on the site.
Selecting a Site Time Server for the Site Director ADS/ADX/ODS (Multicast Method Only)
Before selecting a site time server for the Site Director ADS/ADX/ODS, follow the steps in the Setting the Time Zone
in the Site Director ADS/ADX/ODS section.
1. Log in to ADS/ADX/ODS.
2. Drag and drop the Site object to the Display frame.
3. Click Edit.
4. In the Time section, in the Site Time Servers field, click the browse button (Figure 82).
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 120
Note: Leave the Device Time Servers field blank. Do not change the value for the Time Sync Period attribute.
Figure 82: Site Time Servers in the Site Object
6. Enter the IP address of the SNTP server from which the Site Director receives its time.
Note: Specify a host name only if a DNS server is available to the Site Director. Leave the Device Time Servers
field blank.
For Multicast time synchronization, if you add more than one address, the Site Director ADS/ADX/ODS
tries to contact only the first address.
7. Click OK.
8. Click Save. The Site Director now requests the date and time from the selected time server and propagates it
to all other engines/servers on the site.
9. Go to Configuring Additional Multicast Time Synchronization Settings.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 121
3. Click Edit.
4. Select Advanced.
5. In the Time section, modify the attributes listed in Table 38 (Figure 84).
Figure 84: Multicast Time Synchronization Fields
6. Click Save.
NAE Commissioning Guide: Appendix: Time Zone, Date, and Time Management 122
Appendix: Configuring and Maintaining Preferences
Configuring and Maintaining Preferences Introduction
The Metasys system provides customized preferences for the user interface. The preferences allow authorized users
to configure how the user interface behaves, including the sounds and colors, the startup view, and the ability to
add links to external applications that can be accessed from within the user interface of the ADS/ADX/ODS/SCT/NAE
device.
Some steps in the following sections involve certain file operations, such as copying files and navigating to specific
folders. The tool used for these operations is Windows File Explorer (ADS/ADX/ODS, SCT, NAE55, NIE55, or
NxE85), Windows Internet Explorer®, or the Apple® Safari® web browser (NAE35, NAE45, or NCE25). For an
NAE55/NIE55, log in to the device remotely using the NxE Information and Configuration Tool (NCT), then use the
Remote Desktop function in the NCT. Type explorer at the command prompt. For an NAE35/NAE45/NCE25, use
the Start FTP function in the NCT. Access the NAE contents with Internet Explorer or Safari and type ftp://<NAE IP
Address> in the Address line. For information on the NCT, refer to the NxE Information and Configuration Tool
Technical Bulletin (LIT-1201990).
Preferences Concepts
System Preferences
System preferences apply to all users who log in to the site or device. System preferences affect the performance
and operation of the system. Only the MetasysSysAgent user and the BasicSysAgent user have authorization to
configure system preferences. An audible alarm notification change is an example of a system preference. The SCT
supports a subset of system preferences. If the SCT is installed on an ADS/ADX/ODS, the preferences are shared
by the SMP user interface and the SCT.
Before you make system preference changes, the preferences are read from the DefaultSystemPreferences.xml
file. Once you make system preference changes, a new file called SystemPreferences.xml is created (Figure 85).
Both of these files are located in the directory on the Metasys system device as indicated in Table 39.
Table 39: Location of Preferences Files
Metasys System File Locations
Device
NAE55/NIE55 C:\Documents and Settings\All Users\Application Data\Johnson Controls\MetasysIII\Preferences
C:\Program Files (x86)\Johnson Controls\MetasysIII\UI\audio
NAE85/NIE85 C:\ProgramData\Johnson Controls\MetasysIII\Preferences
C:\Program Files (x86)\Johnson Controls\MetasysIII\UI\audio
NAE35/NAE45/NCE25 \Storage\Metasys\Preferences
\Storage\Metasys\wwwroot\metasysIII\UI\audio
The procedure to synchronize system preferences within a site or to reuse the system preferences on another site
is a manual copy and paste process. Use the process to copy system preferences to other devices on the site or to
other sites. See Copying Preferences between Devices.
User Preferences
User preferences apply to a specific Metasys system user. User preferences define how the information is displayed
in the user interface and do not affect the operation of the system. The colors and marker styles of a trend display
are examples of user preferences. Each user is authorized to view and edit their own user preferences.
The system automatically assigns a numbered user preference file name for each user called
UserPreferences-userID.xml, where userID is the identification number of the user. Using an identification number,
rather than using the actual user name, serves two purposes. First, it avoids any conflicts that might arise if the user
name contains special characters. Second, it allows the user to be renamed without breaking the connection to the
user preferences file.
To view user identification numbers, open the Security Administrator screen and select User Preference File Names
under the View menu (this option is available only to the MetasysSysAgent user). The user preference file names
appear in the Roles and Users pane (Figure 86) and correspond to files on the Metasys device in the directory as
indicated in Table 39. As shown by two callouts in Figure 86:
• 1: User preference file name as seen in the Security Administration in the user interface.
• 2: User preference file as seen when accessing a network engine using Remote Desktop in the NCT.
The procedure to synchronize user preferences within a site or to reuse the user preferences on another site is a
manual copy and paste process. Use the manual process to copy user preferences to other devices on the site or
to other sites. See Copying Preferences between Devices.
Managing Preferences
System and user preferences stored in a network engine are not saved in the archive database by SCT, and they
are not part of the archive upload/download process. Additionally, preferences are not saved during a security backup
when you upgrade. You must manage preferences manually.
For information on managing preferences for each preference type, see the following sections:
• System Preferences
• User Preferences
Configuring Preferences
Note: To configure the preferences of a specific user, you must log in as that user or as a user with Administrator
rights.
1. On the Tools menu of the user interface, click Configure Preferences. The Metasys Preferences dialog box
appears.
2. Set the preferences according to the Preferences section of the Metasys® SMP Help (LIT-1201793).
If you specified Level 1-4 Sound Files on the Alarm Settings tab, place the alarm sound files into the audio folder
on the Metasys system device. The audio folder is located in the following directory:
For NAE55/NIE55/NAE85/NIE85:
C:\Program Files (x86)\Johnson Controls\MetasysIII\UI\audio
For NAE35/NAE45/NCE25:
\Storage\Metasys\wwwroot\metasysIII\UI\audio
Note: If a sound file is missing from the folder, the Metasys system uses the default system beep for that alarm
priority.
The following table explains each column in the Certificates window. Click inside a column header to sort the column.
Table 40: Description of Certificates Table
Column Name Description
Status A security shield icon that indicates the connection status afforded by the certificate.
: encrypted, but either the certificate chain to the site or engine is broken, the certificate has a
name mismatch, or the certificate has expired.
Checkbox Icon A check box to select the device that you want to work with.
Issued To The name of the device to which the certificate is issued.
Type The type of certificate: root, intermediate, or server.
Device The device to which the certificate is bound (single or multiple for intermediate and root certificates).
Expiration The date on which the certificate expires. The certificate management tool highlights all certificates
that will expire within the number of days specified by the Certificate Renewal Period attribute of
the Site object (or have already expired). Also, the Certificate Renewal Period attribute in the Site
object controls when certificate expiration reminders begin. It specifies the number of days prior to
security certificate expiration before the operator is notified daily that a certificate is about to expire.
This attribute is synchronized to all child devices. Certificate Renewal Period applies only to devices
at Release 8.1 or later.
Details A clickable arrow that opens an expanded panel with more detailed information about the certificate.
Important: The private key that is generated when the CSR is created can be associated with the new certificate
only if the device name in the SCT archive and the subject common name for the device match.
Therefore, before requesting a device CSR, verify that the device name is correct. If not, the newly
purchased certificate could be worthless because of the device name mismatch. A common mistake
is to forget to include the company domain name with the CSR. No workaround is available that can
recover the use of the new certificate.
Import Certificate
Use SCT to import certificates and private keys from the local file system. Three file formats are supported: *.pem,
*.cer, and *.crt. Typically, each device has two or three certificate files to import: one root, one intermediate, and
one server certificate. Some devices may have more than one intermediate certificate. Whatever the case, always
import every certificate file that the customer's IT department or CA provides from the CSR you sent them.
SCT supports the import of only one certificate at a time. For example, if the root and intermediate certificate
information comes in a single file, you need to split it into two different files, one for the root and the other for the
intermediate certificate.
When you import a server certificate, SCT pairs the imported server certificate with the private key from the associated
CSR. If a server certificate is imported that contains an identical Issued To Common Name (CN) as an existing
certificate, the imported certificate replaces the existing certificate, but the private key is retained; it is not replaced.
The following example shows the certificate chain view when a certificate is missing.
Download Certificate
Use the Download Certificate option to download server certificates independently from other actions. This method
is much faster than if you were to download the full database with the Download To Device option under Manage
Archive.
When you download certificates to a site device, SCT determines the correct set of certificates required by that
device for successful site configuration. If any certificates are missing, SCT includes the set of certificates that it
recognizes during the download, but the missing certificates need to be imported before trusted connections can be
established. Also, no certificates are downloaded if the server certificate and private key for that device are not
present in the SCT archive.
Detailed Procedures
Follow these procedures to manage certificates in a network engine.
Requesting a Certificate
To request a certificate for a network engine in an archive database:
1. Open the archive database.
2. Verify that the network device name in the archive matches the subject common name of the online network
engine. If not, change the network device name in the archive to match the online network engine name.
3. On the Tools menu, select Certificate Management. The Certificate Management screen appears.
4. Click the Devices tab. The Devices screen appears.
5. Click the network engine for which you want to request a certificate. Click Request Certificate(s). The Request
Certificate(s) form appears.
6. Complete all the fields on the form. Click Save CSR Details. An Export CSR(s) confirmation window appears.
Figure 93: Export CSR(s) Confirmation
7. Click Yes to continue. The Export CSR(s) - Select Folder window appears.
8. Browse to a folder where you want to save the CSR file and click Export. The certificate request file with a .PEM
extension is exported to the selected folder. For example, the certificate request file for a network engine called
NAE-1 on a computer called ADX-1 would be ADX-1_NAE-1_CSR.PEM for a network engine with a fully qualified
name of ADX-1:NAE-1.
9. Send the certificate request file to the IT department to obtain your trusted certificate. When you receive the file,
go to Importing a Certificate to import the certificate into SCT for the network engine.
Importing a Certificate
To import a certificate for a network engine in an archive database:
1. Open the archive database.
2. On the Tools menu, select Certificate Management. The Certificate Management screen appears.
3. Click Import Certificates. The Import Certificates dialog box appears.
4. Select the certificate file. The file has a .crt, .cer, or .pem extension. Click Import. The certificate for the network
engine is imported.
Figure 96: Import Certificates Screen
Exporting a Certificate
To export a certificate for a network engine in an archive database:
1. Open the archive database.
2. On the Tools menu, select Certificate Management. The Certificate Management screen appears.
3. Click the Devices tab. A table of devices with certificates appears. Select the device whose certificate you want
to export.
Figure 98: Exporting a Certificate
5. Click Export Certificate(s). The certificate file is exported to the selected folder location. For example, if the
name of the NAE is NAE-1, the certificate file would be called NAE-1.pem.
Downloading a Certificate
To download a certificate to a network engine from an archive database:
1. Open the archive database.
2. On the Tools menu, select Certificate Management. The Certificate Management screen appears.
Figure 100: Downloading a Certificate
3. Select the device that has the certificate you want to download. (If you need to download the certificates of
multiple engines, you can select more than one from the devices table.) Click Download. The Certificate Download
Wizard appears.
4. Specify the username and password of the network engine (or click Communicate via Site Director to use the
Site Director's credentials). Click Test Login. When the login is confirmed, click Next to complete the remaining
steps in the Certificate Download Wizard. The ActionQ window appears to indicate the progress of the download.
A completion status of OK indicates that the certificate download process was successful.
5. Close the ActionQ window.
Uploading a Certificate
To upload a certificate from a network engine to an archive database:
1. Open the archive database.
2. On the Tools menu, select Certificate Management. The Certificate Management screen appears.
3. Click the Devices tab. A table of devices with certificates appears. Select the device that has a certificate you
want to upload. (If you need to upload the certificates of multiple engines, you can select more than one from
the devices table.)
Deleting a Certificate
To delete a network engine certificate from an archive database:
1. Open the archive database.
2. On the Tools menu, select Certificate Management. The Certificate Management screen appears.
3. Select the device whose certificate you want to delete. Click Delete. A confirmation message appears.
4. Click OK to delete the certificate. The certificates list refreshes indicating that the certificate is removed.
4. Click OK to delete the certificate request. The certificate requests list refreshes indicating that the certificate
request has been removed.
Backing Up a Certificate
To back up a certificate for a network engine, create a backup of the archive database using the traditional method
in SCT (Tools > Database > Create Backup). In addition to backing up the archive database, this process also
backs up the network engine certificates. You can also back up and store certificates for safekeeping by exporting
each certificate file to a computer or removable media. Lastly, certificates are also backed up and stored when you
export the archive database. For details on these operations, refer to Metasys® SCT Help (LIT-12011964).
Important: As an important restriction for creating and restoring database archive backups that contain network
engine certificates, you must use the same SCT computer for both operations. Do not restore the
archive using a different SCT computer, or the certificate data is deleted. This is a security precaution
that protects against certificate theft.