NxE Information and Configuration Tool Technical...

NxE Information and Configuration Tool Technical BulletinCode No. LIT-1201990Software Release 7.0

Issued December 5, 2014Refer to the QuickLIT website for the most up-to-date version of this document.

Document Introduction.............................................................................................................2Features of the NCT............................................................................................................................2NCT Overview......................................................................................................................................2Related Documentation......................................................................................................................3

Component Overview................................................................................................................3NCT and Connections Tab.................................................................................................................3Tools Tab..............................................................................................................................................7Performance Monitor............................................................................................................................9Device Snapshot...............................................................................................................................12Trace Feature......................................................................................................................................14Set Date and Time Button...................................................................................................................15FTP Sessions Between NCT and NxEs..............................................................................................15Explorer Tab......................................................................................................................................16Directories...........................................................................................................................................18Get All Debug Files.............................................................................................................................18About, Etc. Tab..................................................................................................................................18

Detailed Procedures................................................................................................................20Installing the NCT..............................................................................................................................20Minimum Computer and Operating System Requirements................................................................20Installation Steps.................................................................................................................................20Metasys Software Requirements for NxEs Connecting to the NCT....................................................25IT Considerations................................................................................................................................25Finding the IP Address of an NxE...................................................................................................26Finding the IP Address of an NxE Using the NCT to Discover the Device.........................................26Finding the IP Address of an NxE Using the NCT to Capture the SNMP Broadcast..........................26Using the Advanced Mode...............................................................................................................26Enabling Advanced Mode...................................................................................................................27Using FTP and Telnet Servers in the Advanced Mode.......................................................................27Transferring Files..............................................................................................................................29Finding Crash Files...........................................................................................................................29Finding Non-Crash Files on an NxE................................................................................................31Using Remote Desktop with the NCT..............................................................................................32Using Remote Desktop with Windows 7 and Later Operating Systems.............................................32Monitoring Engine Messages..........................................................................................................32Synchronizing the Time between the NxE and Your Computer...................................................33

Troubleshooting.......................................................................................................................34Windows Security Alert....................................................................................................................34Determining Possible Reasons for an NCE25 NAE35 or NAE45 Shutdown...............................34Remote Desktop to NxE55 May Not Enable Access to the Local Drive.......................................35

1NxE Information and Configuration Tool Technical Bulletin

http://cgproducts.johnsoncontrols.com/default.aspx

Document IntroductionThis document describes how to install the Network Engine (NxE) Information and Configuration Tool (NCT) anduse the NCT to discover, identify, monitor, collect configuration information, and troubleshoot NxEs on Metasys®networks. It also describes how to transfer files between a computer running the NCT and NxEs.

Unless otherwise specified, the term NxE in this document refers to all of the supported models. See Features ofthe NCT and NCT Overview for more information on the NxEs supported by this release.

Features of the NCTThe NCT includes the following features:

• The NCT is compatible with all redesigned NxE55xx-2 engines.• The NCT is compatible with NxE55xx-1 engines that are updated with compatible disk images. Currently,

compatible NxE55xx-1 disk images are available for Releases 4.1, 5.0, 5.1, 5.2, 6.0, 6.1, 6.5, and 7.0.• The NCT is required if you want to access an NxE55 engine with Remote Desktop. To improve network

security, the capability to access an NxE55 from anyWindows computer on the building network with the RemoteDesktop Connection application has been disabled.

• The NCT identifies the Metasys software release version and build number when a compatible NxE is discovered.• The NCT can discover NxEs on your Metasys networks, so IP Tracker is no longer required to discover NxEs.• The NCT can run on a computer at the same time as the NAE/NIE Update Tool.• Multiple instances of the NCT can run at the same time on the same computer.• Discovered NxEs can be sorted according to model number, MAC address, host name, IP address, or order

discovered. Advanced users, such as field technicians, should use the NCT for device discovery.Note: At Release 7.0, the SCT can be used for device discovery.

• The NCT can collect device debug files. Advanced users, such as field technicians, should use the NCT to collectdevice debug files.

Note: At Release 7.0, the SCT can be used to collect device debug files.

NCT OverviewThe NxE Information and Configuration Tool (NCT) is a software tool that allows you to quickly discover MetasysNetwork Engines (NxEs) on Ethernet networks and display some basic information regarding the discovered NxEssuch as model number, MAC address, IP address, host name, NxE operating system (OS) version, and Metasyssoftware release version.

The NCT can also connect to individual NxEs and allow you to retrieve, copy, and transfer NxE files; diagnose andtroubleshoot NxE problems; and edit NxE parameters. After connecting to an NxE, you can also monitor SimpleNetwork Management Protocol (SNMP) traps and start the NxE’s Site Management Portal user interface.

The NCT supports NAE35, NAE45, NCE25, NAE55, and NIE55 Series engines that are loaded with compatibleMetasys software. See Metasys Software Requirements for NxEs Connecting to the NCT for more information.

The NxE85 and NIE89 models cannot be discovered and are not supported by the NCT.

Note: The hardware platforms, operating systems, and other features of the NAE35, NAE45, and NCE25 enginesdiffer from the NAE55 and NIE55 engines; therefore, some of the NCT diagnostic information, features, andprocedures differ depending on the NxE type. These differences are called out in this document whereapplicable.

Note: Currently, a Release 4.1.11 or later version disk image is required for an NxE55xx-1 engine to be discoveredby, connect to, and communicate with the NCT.


Related DocumentationTable 1: Related Documentation

See DocumentFor Information onNAE/NIE Update Tool Help (LIT-12011524)How to update a Network Automation Engine (NAE) or Network

Control Engine (NCE)

NAE Commissioning Guide (LIT-1201519)How to set up an NAE for network connectivity, how to access theNAE user interface via a web browser, and how to set the basicNAE parameters

NCE Technical Bulletin (LIT-12011267)How to set up an NCE25 for network connectivity, how to accessthe NCE25 user interface via a web browser, and how to set thebasic NCE25 parameters

Metasys® SCT Help (LIT-12011964)How to use the SCT for device discovery and device debugging

Component OverviewThis section describes the NCT screens, tabs, features, functions, and the associated user actions for the NCT userinterface.

Note: The NCT can operate in Normal mode or Advanced mode. Typically, you should use the NCT in Normalmode. Use the Advanced mode with the guidance of your local Johnson Controls® service/supportrepresentative. The NCT screens in this document are shown in the Advanced mode to display all availablefeatures. Items that appear only in Advanced Mode are highlighted in gray. See Using the Advanced Modefor more information.

NCT and Connections TabUse the Connections tab (Figure 1 and Figure 2) to connect to the NxE, determine which NxEs are online, and logconnection errors. Figure 1 shows the NCT when the NCT is started, prior to discovery of NxE engines and prior toconnecting to an NxE engine.

When you start the NCT, the Connections tab appears as the default screen. Prior to connecting to an NxE, theNCT displays a red banner with Disconnected displayed on the banner. Also, only the Connections and About,Etc. tabs are available prior to connecting to an engine.

The Connections tab presents different options depending on whether you are using the NCT in Normal mode orAdvanced mode. The Advanced mode includes all of those options present in Normal mode, as well as options thatare only available in Advanced mode. All options are shown in Table 2.


Figure 1: NCT and Connections Tab Prior to Discovery of NxEs and Connection to an NxE

Figure 2 shows the NCT with NxE engines discovered and one of the discovered engines connected to the NCT.


Figure 2: NCT Showing Connections Tab in the Advanced Mode1

1 Shaded callouts signify those features that are only available in Advanced Mode. Features are described in the followingtable.


Table 2: Connections Tab Features and User ActionsUser Action, Item Function, and Item DescriptionItem NameCallout

NumberSee the following information regarding user actions, item functions, and itemdescriptions on the Connections tab.

Connections Tab1

Click Tools to display the Tools tab. See Tools Tab for more information.Tools Tab2

Click Explorer to display the Explorer tab. See Explorer Tab for more information.Explorer Tab3

Click About, Etc. to display the About, Etc. tab. See About, Etc. Tab for moreinformation.

About, Etc. Tab4

Click Connect to connect the NCT to the NxE entered in the Connect to: field.Connect Button5

ClickDisconnect to disconnect the NCT from the NxE to which the NCT is currentlyconnected.

Note: Clicking Disconnect does not exit the NCT application.

Disconnect Button6

Click Quit to exit the NCT application.

Note: ClickingQuit immediately disconnects you from the NxE. Any unsaved dataopen in the Connections tab or other tabs is lost.

Quit Button7

Click Discover to find compatible NxEs within range.

Note: The NCT can discover only those NxEs that are connected on the samesubnet as the NCT. See Metasys Software Requirements for NxEsConnecting to the NCT for additional NxE software requirements.

Discover Button8

Click Clear List to clear all devices from the Discovered Devices list.Clear List Button9

ClickConnect UI to start theWindows® Internet Explorer®web browser and connectto the Site Management Portal of the NxE listed in the Connect to: field.

Note: The NCT does not have to be connected to a device to successfully connectvia the web browser to the device’s Site Management Portal.

Connect UI Button10

Click Remote Display or Remote Desktop to open a remote display or RemoteDesktop window for the NxE entered in the Connect to field.

Note: The button displays Remote Display when the NCT is connected to anNAE35, NAE45, or NCE25. The button displays Remote Desktop whenconnected to an NAE55 or NIE55.

Remote Display Button orRemote Desktop Button

111

Click Connect Telnet to connect to the Telnet server on the connected NxE.

Note: The Connect Telnet button is available only when the NCT is connectedto an NAE35, NAE45, or NCE25. When connected to an NxE55 engine,use Remote Desktop to transfer files.

Connect Telnet Button121

ClickConnect FTP to connect to the FTP server on the connected NxE. SeeConnectFTP on the Connections Tab for more information.

Note: The Connect FTP option is available only when the NCT is connected toan NxE55-1, NxE55-2, NAE35, NAE45, or NCE25.

Connect FTP Button131

ClickClear Messages to clear all of the messages displayed in theMessages fromSelected Device field.

Clear Messages Button14

Displays the NCT’s current mode of operation (Normal or Advanced). The defaultmode of operation is Normal Mode. Figure 2 shows an NCT in Advanced Mode.See Using the Advanced Mode for more information.

Mode Bar15

Displays the NCT connection status. When the NCT is connected, the ConnectionStatus bar displays the DNS name or IP address of the connected NxE (entered inthe Connect to: field).

Connection Status Bar16


Table 2: Connections Tab Features and User ActionsUser Action, Item Function, and Item DescriptionItem NameCallout

NumberRecords and displays activities performed, status messages, any connection errorsyou encounter, and connection remedy messages while working from any of theNCT tabs. The Connection Activity Log provides valuable diagnostic and remedyinformation regarding the activities performed from NCT.

Connection Activity Log17

Select the Always On Top check box to force the NCT window to remain on top ofthe other open windows on your computer. Selecting the check box does notdeactivate the other windows, but the NCT on top may hide important informationdisplayed in other windows if the NCT window is not placed or sized well.

Always On Top Check Box18

Displays the history of events and messages from the NxEs selected in theDiscovered Devices field. The messages are shown in chronological order with timestamps. Displays SNMP Trap messages.

Messages from SelectedDevice Field

19

The device (in the Discovered Devices field) that is currently connected to the NCTis highlighted in dark blue. Click Disconnect to disconnect the currently connecteddevice. Select another device and double-click the selection to connect to theselected device, or select another device and click Connect to connect to theselected device.

Device Connected to NCT20

This field lists the devices from which the tool has received a message. Devicessend messages for various reasons, including startup and IP address change. Themessages appear in the Messages from Selected Device field.

Discovered Devices Field21

Click Sort By to establish the sort criteria and create a sorted list of devices. Youcan sort by Order Found, Model Number, MAC Address, IP Address, or host name.

Sort By Button22

After selecting a Sort By category, click the ascending/descending order (arrow)button to reverse the sort order of the listed devices.

Ascending or DescendingOrder Button

23

Enter the same login password you use to connect to the NxE’s Site ManagementPortal. If the default password has changed, you must enter the new password toconnect to the NxE.

Password Field24

Type in the IP address (or domain name system (DNS)) of the NxE to which youwant to connect. If you have a device in the Discovered Devices list, double-clickthe entry to connect to the device. The IP address is automatically entered in theConnect to field and the device as listed is highlighted.

Connect to: Field25

1 Shaded rows signify features that are only available in Advanced Mode.

Tools TabUse the Tools tab (Figure 3) to gather different types of data from an NxE, to synchronize the date and time on theNxE with the date and time on your computer, and to start and stop the FTP and Telnet servers.

The Tools tab presents different options depending on whether you are using the NCT in Normal mode or Advancedmode. The Advanced mode includes all of those options present in Normal mode, as well as options that are onlyavailable in Advanced mode. Both options are shown in Table 3.


Figure 3: NCT Showing Tools Tab in the Advanced Mode1


Table 3: Tools Tab Features and User ActionsUser Action, Item Function, and Item DescriptionItem NameCalloutClickGet Device Snapshot to display a dialog box populated with recent data messagesand updates regarding several critical areas of the controller’s memory. See DeviceSnapshot for more information.

Get Device SnapshotButton

1

Click Set Time and Date to synchronize the time on the connected NxE with the timeon your NCT computer. The command sent from the NCT to the NxE contains the timein Coordinated Universal Time (UTC) format. This feature allows the NCT to work acrosstime zones and stay in sync. The correct time zones must be configured in the NxE SiteManagement Portal and the NCT computer. See Set Date and Time Button andSynchronizing the Time between the NxE and Your Computer for more information.

Important: Be aware that you can cause devices to go offline if your computer timediffers by more than 5 minutes from the time on the Site Director.

Set Time and Date Button2

Click Save Registry to save registry information to persistent storage.

Important: Use the Save Registry button only with the assistance of your localJohnson Controls service/support representative.

Save Registry Button3

Click Start FTP Server to start the FTP server on NAE55-1, NAE55-2, NAE35, NAE45,and NCE25 engines. To use the NxE’s FTP server, you need to have an FTP applicationorWindows Internet Explorer web browser running on your laptop or computer to transferfiles between your computer and the NxE. See FTP Sessions Between NCT and NxEsand Using FTP and Telnet Servers in the Advanced Mode for more information.

Start FTP Server41

Click Stop FTP Server to exit the FTP server application. See FTP Sessions BetweenNCT and NxEs and Using FTP and Telnet Servers in the Advanced Mode for moreinformation.

Stop FTP Server Button51


Table 3: Tools Tab Features and User ActionsUser Action, Item Function, and Item DescriptionItem NameCalloutClick Start Telnet Server to start the Telnet server application on NAE35, NAE45, andNCE25 engines. See Using FTP and Telnet Servers in the Advanced Mode for moreinformation.

Note: The Start Telnet Server button is not available for NxE55s. NxE55s use RemoteDesktop to transfer files.

Start Telnet Server Button61

Click Stop Telnet Server to exit the Telnet server application. See Using FTP andTelnet Servers in the Advanced Mode for more information.

Note: The Stop Telnet Server button is not available for NxE55s. NxE55s use RemoteDesktop to transfer files.

Stop Telnet Server Button71

Click Disable Device Manager to disable the Metasys Device Manager.

Important: Disabling the Device Manager and saving the changes prevents theMetasys Site Management Portal from running after restarting.

Important: Use the Disable Device Manager button only with the assistance of yourlocal Johnson Controls service/support representative.

Disable Device ManagerButton

8

Click Enable Device Manager to enable the Metasys Device Manager.

Important: Use the Enable Device Manager button only with the assistance of yourlocal Johnson Controls service/support representative.

Enable Device ManagerButton

9

Click Get NAE Information to display a message box with the Windows time, Metasystime zone, Metasys software version number, Microsoft OS version number, Java®Runtime Environment (JRE) version number, and the NxE model number for theconnected NxE engine. For NxE55 series engines, the basic input/output system (BIOS)firmware version number is also included.

Get NAE InformationButton

10

Click Restart Device to force a reset of the connected NxE.

Important: Clicking Restart Device forces a restart of the NxE without performingan archive. Any changes you made since the last archive of the NxE arelost when you click this button.

Restart Device Button11

Click PerformanceMonitor to start the Performance Monitor. The Performance Monitorgathers device performance data from the connected NxE. The NxE’s Windows OSsupplies this data; it is not supplied by the Metasys system application. See PerformanceMonitor for more information.

Performance MonitorButton

12


Performance MonitorStart the Performance Monitor from the NCT Tools tab. See Tools Tab for more information. When you clickPerformance Monitor, the Performance Monitor screen appears (Figure 4).

Important: When the NCT Performance Monitor is running, it places additional load on the NxE processor. If theNxE processor is close to being overloaded, this additional load may cause the NxE to reset.

Note: The NCT must be connected to an NxE to start and run the Performance Monitor.


Figure 4: NAE35, NAE45, and NCE25 PerformanceMonitor (Top), and NAE55 and NIE55 PerformanceMonitor(Bottom)1

1 Shaded callouts signify features which may vary based on the engine in use.


Table 4: Performance Monitor Features and User ActionsUser Action, Item Function, and Item DescriptionItem NameCalloutIndicates the percentage of processor time used. Lower values are better for computerperformance. If the value climbs to 100% or remains higher than 50 to 75% for morethan a few seconds, there is a large load on the NxE processor that you should address.

Processor Usage Indicator1

Indicates the percentage of NxE usage. The percentage shown to the right of theindicator bar and the length of the bar represents the percentage of total RAM consumedby the OS, applications, and others. Calculate the actual total amount of RAM bycombining the Object Store and the System Memory values shown on the right of theObject Store and System Memory bars.

For example, using the top screen capture shown in Figure 4:

Object Store: 7,144 KB of RAM

System Memory: 107,200 KB of RAM

Total Memory: 114,344 KB of RAM

The percentage fluctuates with usage; however, check for problems if the valueincreases dramatically. For instance, if the value increases over 50% for no apparentreason and stays there, there may be a problem.

Note: The Total Memory usage indicator is available only when NCT is connectedto an NAE35, NAE45, or NCE25 engine. When the NCT is connected to anNxE55 engine, the Memory usage indicator is available. The Memory usageindicator displays the total NxE55memory available and the amount of memorycurrently in use.

Total Memory UsageIndicator

(NCE25, NAE35, NAE45Engines Only)

Memory Usage Indicator

(NxE55 Engines Only)

21

Indicates the percentage of RAM that the Windows OS and Metasys system use fortemporary storage. The percentage shown to the left of the meter is the portion of totalmemory reserved for the Object Store. The values shown to the right of the meterindicate how much of the object store is used, its total size, and the percentage used.The total is assigned by the operating system upon startup and remains fixed. Thepercentage used should not change dramatically after the database has beendownloaded. If you see dramatic changes up or down, these file changes may indicatea problem, such as a virus or a hacking attempt.

Note: TheObject Store usage indicator is available only when the NCT is connectedto an NAE35, NAE45, or NCE25 engine. When the NCT is connected to anNxE55 engine, this indicator is not available.

Object StoreUsage Indicator


31

Indicates the amount of RAM available to applications after the RAM file system hasbeen allocated.

Note: The System Memory usage indicator is available only when the NCT isconnected to an NAE35, NAE45, or NCE25 engine. When the NCT isconnected to an NxE55 engine, this indicator is not available.

System Memory UsageIndicator


41

Indicates the percent usage of the total storage space available on the flash memory.Storage in the NxE is not like storage in a personal computer. A standard computerhas a hard disk drive while the NxE has a flash memory chip. The storage bar displaysthree values (to the right of the indicator bar): the total amount of storage space onthe flash chip available to the NxE, the current amount of flash space used by the NxE(represented by the bar), and the percent usage of the total storage available.

Storage Usage Indicator5


Table 4: Performance Monitor Features and User ActionsUser Action, Item Function, and Item DescriptionItem NameCalloutIndicates integrity of the NCT/NxE connection. When blinking, these circles with reddots represent a good connection between the NCT performance monitor and the NxE.If the circles are not blinking, the connection to the NxE may have been lost. If theconnection is lost, the data in the performance monitor is no longer dynamic.

Note: Updates to the performance monitor (including the receiving data indicators)may pause during certain operations of the tool, such as receiving a file usingthe Explorer tab.

Receiving Data Indicator6

Select the Always On Top check box to force the Performance Monitor to remain ontop of other applications on the desktop. This selection is recommended, as it issometimes difficult to get back to this window in time to see transient results.

Always On Top Check Box7

Select the Log Update interval (in seconds) of the NxE performance data using the upand down arrow buttons.

Log Update Interval Value8

Click Browse to navigate to and select the filepath/folder for storing NxE performancedata logs on the NCT computer.

Browse Button9

Select the Enable Logging check box to capture NxE performance data in the selectedlog file.

Enable Logging Check Box10

1 Shaded callouts signify features which may vary based on the engine in use.

Device SnapshotWhen you click Get Device Snapshot on the NCT Tools tab, you create a snapshot (Figure 5) of several criticalareas of the controller’s memory. The snapshot shows the readings for those memory areas at the moment that youclicked the button.

Figure 5: Device Snapshot Window


The information in each of the window panes provides details from the memory of the connected NxE. The informationin the panes is not dynamic. To refresh the information in a device snapshot, close the window and click DeviceSnapshot again; however, you can save any particular snapshot to a file by clicking Save Snapshot to File on theDevice Snapshot screen. Figure 6 shows an example of a snapshot log file in a Notepad window.

The Device Snapshot window includes the following information:

• Processes – This pane lists the processes running at the time of the snapshot.• Threads – This pane lists the open threads at the time the snapshot was taken. A thread can be thought of as

an application within a process. Threads consume the resources allocated by the process.


• Modules – This pane lists the modules (dynamic-link library (DLL) files) that are currently called for use by theProcesses and Threads. A dynamic link library is a small program that is not resident in RAM memory until it iscalled by a process or thread. Modules consume additional resources when called; therefore, DLL modules areonly called when required.

• Windows – This pane lists the window shells called and currently open inside the controller. Use the data hereto help determine whether the processes currently running are complete and correct. For example, a missingwindow might indicate an operating system problem.

Figure 6: Snapshot Log File

Trace FeatureThe trace feature in the Device Snapshot tool allows you to determine which:

• threads are associated with which process• modules (DLL files) are associated with which process• window is held open by which process

Click any line in any pane and all of the connections are highlighted for you. In Figure 7, the selection in the Processespane causes the associated threads, modules, and windows to be highlighted in their respective panes.


Figure 7: Device Snapshot Trace Feature

Set Date and Time ButtonThis feature allows you to synchronize the NxE’s date and time to the date and time on the computer running NCT.The command sent from the NCT to the NxE contains the time in UTC format. This feature can synchronize NxEdate and time across time zones when the correct time zones are configured on the NxE and the computer.

Important: Take care in using this tool. You can cause devices to go offline if your computer time differs more than5 minutes from the time on the Site Director.

When date and time synchronization is successful, it is recorded in the Connection Activity log at the bottom of theNCT window.

FTP Sessions Between NCT and NxEsYou can transfer files between the NCT computer and NAE55-1, NAE55-2, NAE35, NAE45, and NCE25 enginesby establishing an FTP session between the NCT and NxE. Using the NCT, you can initiate an FTP session usingone of two different methods: clicking the Connect FTP button on the Connections tab, or clicking the Start FTPbutton on the Tool tab.

Note: There is potential risk in copying files back into the NxE using the FTP utility; therefore, we recommend thatyou use this utility as a read-only tool. That is, copy files that aid in troubleshooting, but do not copy thesefiles into other NxEs or write them back into the same NxE.

Important: FTP allows anonymous authentication (user: anonymous, password: anything), so anyone on thenetwork can connect to the device while the FTP server is enabled. The FTP server is automaticallystopped when the last NCT connection to the device is closed. If an NxE’s FTP server is started butnot in use and you plan on keeping the NCT connected to the NxE, stop the NxE’s FTP server.

Note: The FTP connection does not use significant resources within the NxE except during an actual file transfer.


Connect FTP on the Connections TabWhen your NCT computer is connected to an NAE55-1, NAE55-2, NAE35, NAE45, or NCE25 and the NCT is runningin Advanced mode, you can click Connect FTP on the Connections tab to automatically start an FTP session usingInternet Explorer. The FTP session stops when you disconnect the NxE from the NCT. You can also stop the FileTransfer Protocol (FTP) session by clicking Stop FTP on the Tools tab.

Using the Connect FTP button on the Connections tab is the recommended method for setting up an FTP session.See Using FTP and Telnet Servers in the Advanced Mode for more information.

Start FTP on the Tools TabWith an NAE55-1, NAE55-2, NAE35, NAE45, or NCE25 connected, click Start FTP Server on the Tools tab to startthe FTP server on the NxE. You need an FTP application on your NCT computer to transfer files between yourcomputer and the NxE’s FTP server. Internet Explorer has a built-in FTP application.

When you click Start FTP Server on the Tool tab, the comment ...request made appears in the Connection ActivityLog (Figure 8) indicating that a thread is started on the NxE, which starts the NxE’s FTP server.

Note: If a high-priority thread is using the NxE’s processor, starting the FTP server could cause the application andthe NCT to become inactive; therefore, ...request made does not necessarily mean that FTP service hasstarted.

If the NxE is running normally and is not overburdened, then most likely the service has started. If the NCT connectsto FTP client on the NxE, the service has started.

Figure 8: Connection Activity Log

Start the FTP application on the computer connected to the NxE and execute the required tasks. In the InternetExplorer web browser, type ftp://xxx.xxx.xxx.xxx, where xxx.xxx.xxx.xxx is the IP address of the connected NxE.

See Using FTP and Telnet Servers in the Advanced Mode for more information.

Explorer TabUse the Explorer tab (Figure 9) to quickly locate and retrieve copies of files from an NxE. The Explorer tab does notallow file deletion.


Figure 9: NCT Showing Explorer Tab in the Advanced Mode (Connected to an NAE35, NAE45, or NCE25)

Table 5: NCT Explorer Tabs, Advanced Mode Features, and User ActionsUser Action, Item Function, and/or Item DescriptionItem NameCallout

NumberWhen you highlight a directory in the Directories Pane, the Files pane displays thefiles located in the highlighted folder. You can retrieve a copy of any file byhighlighting the file in the Files pane and clicking Get File. You can select only onefile at a time.

Files Pane1

ClickGet File to copy the files you select in the Files pane. For information on usingthis function, see Finding Non-Crash Files on an NxE.

Get File Button2

Click Get All Debug Files to retrieve and store several log files created by the OSand Metasys applications. These files help when troubleshooting NxE problems.For information on using this function, see Finding Crash Files.

Important: The Get All Debug Files tool places additional load on the NxEprocessor. If the NxE processor is close to being overloaded, thisadditional load may cause the NxE to reset.

Get All Debug FilesButton

3

Displays a navigation tree showing the directory structure of the NxE when youclick Refresh Device Contents. The paths/directories can be expanded andcontracted to browse through the NxE. The Directories feature is read-only anddoes not allow you to act on the directories that appear.

Directories Pane4

ClickRefresh Device Contents to command the NCT to read the directory structureof the connected NxE and display the directory content (as a navigation tree) in theDirectories pane.

Important: The Refresh Device Contents tool places additional load on theNxE processor. If the NxE processor is close to being overloaded,this additional load may cause the NxE to reset.

Refresh DeviceContents Button

5


DirectoriesWhen connected to NCE25, NAE35, and NAE45 engines, the Directories pane of the Explorer tab (Figure 9) showsthe directories on the NxE; however, these directories are not necessarily in the same physical location. The Storagedirectory is mapped directly to the flash on a device. TheWindows directory is a special, read-only section of memory;the contents of which are not included in the memory numbers shown on the performance monitor. In general, youshould not need to access the Windows directory unless instructed by your local Johnson Controls service/supportrepresentative. The rest of the directories are part of the object store described in Performance Monitor. Becausethe contents of the object store are lost at restart, the NxE copies some items (for example, Events) to storage duringits shutdown process.

Note: TheWindows directory is not displayed in the Directories pane when the NCT is connected to NxE55 engines.

Get All Debug FilesThe Get All Debug Files function allows you to retrieve and store the debug files that the NCT generates.

The NCT saves several types of debug files, including .log, .map, .txt, and others. Table 8 shows an example of theDevice Manager log file (dmlog.txt) file from an NCE25, NAE35, or NAE45 engine.

The debug files are saved in the same directory structure as they are stored on the NxE. The directory created bythe Get All Debug Files process for an NAE35, NAE45, or NCE25 is shown in the square in Figure 21.

For more information on using this feature, see Finding Crash Files.

About, Etc. TabThis tab provides the user with additional details about the tool and a quick link to the NCT log file. The log file sectionof the tab is viewable only in the Advanced mode. Use the Advanced mode only with assistance from your localJohnson Controls service/support representative.

Note: The Messages from Selected Device field on the Connections tab are more helpful to the general user thanthe Log File View button. We strongly recommend that you do not use the Empty button to empty the log fileunless directed to do so by your local Johnson Controls service/support representative.


Figure 10: NCT Showing About, Etc. Tab in the Advanced Mode1


Table 6: NCT About, Etc. Tab, Advanced Mode Features and User ActionsUser Action, Item Function, and/or Item DescriptionItem NameCalloutProvides some additional details about the NCT, including copyright, port usage,NCT version number, and a list of devices supported by NCT.

NCT Information Pane1

Appears only in the Advanced mode and contains the View button and Emptybutton.

Log File Section21

Click View to open a new window that displays the entire NCT log file.

Note: The Messages from Selected Device field on the Connections tab aremore helpful to the general user than the Log File View button.

View Button31

Click Empty to erase the log file. This function permanently deletes all informationin the log file. You cannot undo the Empty command.

Important: Use the Empty button with caution. We strongly recommend thatyou do not click Empty unless directed to do so by your localJohnson Controls service/support representative.

Empty Button41

Select the Log all network data check box to include all communication databetween the NCT and the connected NxE.

Log all network dataCheckBox

5

Select a value to establish the amount of time (in seconds) in which commandssent from the NCT wait before they return a lack of response error. For example,if you have trouble starting the performance monitor tool (which could be due tonetwork delays), you could increase this value by 5-second increments until thelack of response error messages stop appearing.

Command Timeout Box6



Detailed Procedures

Installing the NCT

Minimum Computer and Operating System RequirementsTable 7 provides the minimum computer and OS software requirements for installing the NCT on a laptop, computer,or server.

Table 7: System Requirements for Installing the NCTIntel® Core™ 2 Duo E6700 or higher (Intel Core 2 Duo E4300 minimum)

20 GB free hard disk space available (600 MB minimum)

DVD drive

RecommendedComputer/Server Platform 1

Computer Platforms: 2 GB RAM (1 GB RAM minimum)

Server Platforms: 4 GB RAM (2 GB RAM minimum)Recommended Memory 1

Windows® 8.1 Pro and Windows 8.1 Enterprise Editions (64-bit)

Requires .NET Framework Version 3.5.

Windows 8 Pro and Windows 8 Enterprise Editions (64-bit)


Windows 7 Professional, Enterprise, or Ultimate Editions with SP1 (64-bit)

Requires .NET Framework Version 3.5.1.

Windows 7 Professional, Enterprise, or Ultimate Editions with SP1 (32-bit)


Windows Server® 2012 R2 Standard and Enterprise Editions


Windows Server 2012 Standard and Enterprise Editions


Windows Server 2008 R2 Standard and Enterprise Editions with SP1


Windows Server 2008 Standard and Enterprise Editions with SP2 (32-bit)


Supported Operating Systems

Ethernet network interface card 10/100/1,000Mbps (a 100 or 1,000 Mbps network connectionis recommended)

Network Communication

1 Our computer platform and memory recommendations are not meant to imply that older or slower machines are not usable.Refer to the Network and IT Guidance for the BAS Professional Technical Bulletin (LIT-12011279) for more informationregarding computer/server recommendations.

Installation StepsNote: The laptop, computer, or server on which you intend to install the NCT must meet the minimum requirements

described inMinimum Computer and Operating System Requirements. Also, you must remove any previousrelease of NCT before installing a new release of the NCT.

To install the NCT:


1. Navigate to the NAE Configuration Tool folder on the product disk and double-click the setup.exe file. TheWelcome screen appears (Figure 11).

Figure 11: NCT Installation Wizard Start Screen

Note: If the WinPcap utility is not already installed on your computer, a WinPcap installation prompt messageappears. If WinPcap is already installed on your computer, the WinPcap installation prompt messagedoes not appear. Go to Step 5 to continue installing the NCT.

2. Click Next in the WinPcap Installation Wizard welcome screen (Figure 12) to start the WinPcap installation.


Figure 12: WinPcap Setup Screen

3. Accept the default values and settings, and click Next in the installation wizard screens until the Completing theWinPcap Setup Wizard screen appears (Figure 13).


Figure 13: WinPCap Installation Wizard Finish Screen

4. Click Finish (Figure 13). TheWinPcap installation wizard closes, and the NCT installation wizard welcome screenappears (Figure 14).


Figure 14: NCT Installation Wizard Start Screen

5. Click Next (Figure 14). Follow the instructions on the installation wizard screens to install the NCT.6. Click Finish in the NCT InstallShield Wizard complete screen (Figure 15).


Figure 15: NCT Installation Wizard Complete Screen

The new version is installed on your computer and ready for use with the supported NxE engines on your Metasysnetworks.

Metasys Software Requirements for NxEs Connecting to the NCTAll NCE25, NAE35, and NAE45 engines (except NAE45xx-0 engines) with Release 3.0 or later disk images can bediscovered by, connect to, and communicate with the NCT.

NxE55xx-0 engines cannot be discovered and are not supported by the NCT.

NxE55xx-1 engines require downloading a new/compatible disk image. Currently, a Release 4.1.11 or later versiondisk image is required for an NxE55xx-1 engine to be discovered by, connect to, and communicate with the NCT.

Currently, NxE55xx-2 engines ship with the disk image for the latest release installed, which enables NxE55xx-2engines to be discovered by, connect to, and communicate with that release of the NCT.

Note: For an NxE55xx-1 or NxE55xx-2 engine before release 5.2 to respond to an NCT discovery request, theengine must be at a specific patch level for its release. These patch levels are 4.1.11.0900, 5.0.6.0600, and5.1.2.0500. NxE55xx-0 engines cannot be discovered regardless of release.

IT ConsiderationsThe NCT requires access to Transmission Control Protocol (TCP) port 9910 to communicate between the computerrunning NCT and the NxE.

The NCT connects to any NxE across routers and over the Internet as long as any firewalls the device has to crosshave TCP Port 9910 open; however, SNMP startup messages only work on the same physical network segments.

The NCT can be run in an advanced mode, which has more features and function than the normal mode. SeeComponent Overview and Using the Advanced Mode for more information.


Finding the IP Address of an NxEThis section describes ways that you can use the NCT to find the IP address of an NxE.

Finding the IP Address of an NxE Using the NCT to Discover the DeviceTo find the IP address of an NxE by using the NCT to discover the device, click Discover and look for the NxE inthe Discovered Devices list.

Note: The NxEsmust be connected to the same subnet as the NCT computer to be discovered by the NCT. NCE25,NAE35, and NAE45 engines must be at Release 3.0 or later to respond to the NCT discovery request. Foran NxE55xx-1 or NxE55xx-2 engine before release 5.2 to respond to an NCT discovery request, the enginemust be at a specific patch level for its release. These patch levels are 4.1.11.0900, 5.0.6.0600, and 5.1.2.0500.NxE55xx-0 engines cannot be discovered regardless of release.

Finding the IP Address of an NxE Using the NCT to Capture the SNMP BroadcastThe NCT captures SNMP broadcasts for any supported NxE, regardless of the disk image loaded on the engine.

Important: This method of finding an IP address requires you to disconnect power from the NxE, wait until all LEDsare off, and then reapply power. NxE shutdown may adversely affect the current conditions of yourMetasys system and the controlled equipment. Please verify with your customer that NxE shutdown isacceptable prior to shutting down the NxE.

Note: A message appears in the Recently Started Devices list if an NxE is assigned a new IP address after it sendsthe initial startup serial port message. The delay in IP address assignment occurs when an NxE is configuredfor Dynamic Host Configuration Protocol (DHCP), and the DHCP server is not responding or is respondingslowly. If you attempt to use a serial port monitor to find the IP address of the NxE at this time, the monitorreads 0.0.0.0. As soon as the NxE is assigned an IP address, a message appears in the Recently StartedDevices list with the correct address listed, and Step 2 and Step 3 are not required.

To determine the IP address of an NxE using the NCT to capture the SNMP broadcast:

1. Start the NCT on a computer connected to the LAN.2. Disconnect power from the NxE and wait for all NxE LEDs to go off.3. Reconnect power to the NxE.

In approximately 1 to 2 minutes for NCE25, NAE35, or NAE45 engines, or 2 or 6 minutes for NxE55 engines,the Recently Started Devices list shows information from the NxE you started. This list includes the date andtime started, the NxE name, the IP address, the OS version, and the MAC address.

Note: If no messages appear in the Recently Started Devices pane, the local network may be blocking broadcastmessages. In this case, connect your NCT computer on the same side of the router as the NxE andperform this procedure again.

4. When the NxE is in the RUN mode (RUN LED on), the SNMP broadcasts are captured for any supported NxEengine (including NxEs without compatible disk images.)

Note: For NCE25, NAE35, and NAE45 engines prior to Release 3.0, and for NxE55xx-1 engines without acompatible disk image, the IP address is broadcast via SNMP when the RUN light is on steady duringstartup.

Using the Advanced ModeThe Advanced mode of NCT enables use of the FTP servers on NAE55-1, NAE55-2, NAE35, NAE45, and NCE25engines only and Telnet servers on NAE35, NAE45, and NCE25 engines only. The Advanced mode is enabled byadding the /advanced switch to the NICTool.exe Target properties. The Advanced mode is a powerful option thatallows you to update files on the device; however, users should avoid indiscriminate use of the Advanced modefeatures. Only use the Advanced mode as directed in Johnson Controls documentation or under the direction ofyour local Johnson Controls service/support representative.

For information on enabling Advanced mode, see Enabling Advanced Mode.


Enabling Advanced ModeTo enable the Advanced mode on the NCT:

1. On the Start menu, go to Programs > Johnson Controls > Metasys and hover over NAE Information andConfiguration Tool to highlight the option.

2. With the NAE Information and Configuration Tool option highlighted, right-click and select Properties. The NAEInformation and Configuration Tool Properties dialog box appears (Figure 16).

Figure 16: NCT Properties Dialog Box

3. Select the Shortcut tab and enter a space followed by /advanced at the end of the string in the Target field(Figure 16).

4. Click OK. The properties are updated and properties box closes.

The next time you start the NCT, it runs in the Advanced mode.

Using FTP and Telnet Servers in the Advanced ModeUse these procedures to transfer files between your NCT computer and NAE35, NAE45, and NCE25 engines. FTPalso works with the NAE55-1 and NAE55-2.

Note: The NCT enables you to start/set up an FTP or Telnet session with the connected NxE on NAE35, NAE45,or NCE25 engines using the Connect FTP and Connect Telnet buttons on the Connections tab when theNCT is in Advanced mode. See Tools Tab for more information. We recommend starting an FTP or Telnetsession from the Connections tab.

To set up FTP and Telnet servers on the Connection tab:

1. Start the NCT in Advanced mode and click Discover on the Connections tab.2. Double-click the desired NxE from the Discovered Devices list or enter the IP address of the desired NxE in the

Connect to field (Figure 17) and click Connect.


Figure 17: NCT Connected to an NxE

3. ClickConnect FTP. The FTP directory appears. If you are connecting to an NAE55-1 or NAE55-2, a login windowmay appear. Enter the credentials for the MetasysSysAgent user, then click OK. If you are unable to login usingFTP, use Remote Desktop instead.

4. If you are using the Internet Explorer 8, 9, 10, or 11 web browser, click Page, then click Open FTP Site inWindows Explorer (Figure 18). A Windows Explorer user window appears.

Figure 18: Displaying Files and Folders with Windows Explorer – Internet Explorer 8 Browser

5. Use the Windows Explorer window to copy and paste files between your computer and the NxE. Consult withyour local Johnson Controls service/support representative regarding the files to transfer.

6. When you are finished with the FTP session, go to the Tools tab and click Stop FTP Server.7. To start a Telnet session, click Connect Telnet on the Connections tab window (Figure 17). A Telnet windows

appears (Figure 19).


Note: You can also start the Telnet server by clicking Start Telnet Server on the Tools tab (Figure 3).

Figure 19: Telnet Window

8. Perform your commands at the \> prompt. Consult with your local Johnson Controls service/support representativeregarding the Telnet commands.

9. When you are finished with the Telnet connection, go to the Tools tab and click Stop Telnet Server. The Telnetwindow closes in the background.

Transferring FilesThe NCT allows users to copy files from their local machine to engines. For information on copying files or transferringfiles, see Using FTP and Telnet Servers in the Advanced Mode and FTP Sessions Between NCT and NxEs.

Finding Crash FilesTo find crash files on an NAE45 or NAE55:

1. Start the NCT.2. On the Connections tab, select a device, then click Connect to connect to an NxE.3. On the Explorer tab, click Get All Debug Files, select a destination for the files, then click OK. This transfers

the crash and map files associated with the selected device. If you want to store your files in a new folder, clickMake New Folder (Figure 20).


Figure 20: Select Destination for Debug Files Screen

Note: The debug files are saved in the same directory structure as they are stored on the NxE. Figure 21 showsthe directory created by the Get All Debug Files process for an NAE35, NAE45, or NCE25.

Figure 21: Sample Debug File Directory

When the transfer is complete (refer to the Connection Activity pane for successful completion results), useWindows Explorer to browse to and open the files you saved.


Note: The dmlog.txt file is located in the subfolder \storage\dmlog.txt.4. Right-click the file and open with Notepad. The file should be similar to the example in Table 8.

Table 8: Example of a dmlog.txt File10/07/2011 10:20:47 N40 Device Manager Service started

*******************

10/07/2011 10:24:35 Line power is off, waiting before committing to shutdown

10/07/2011 10:24:39 Line power off 10/07/2004 10:25:02 App did not self-terminate

10/07/2011 10:25:04 Requesting Windows to shutdown, reason = 4

10/07/2011 10:29:39 N40 Device Manager Service started

*******************

10/07/2011 10:34:44 Line power is off, waiting before committing to shutdown

10/07/2011 10:34:48 Line power off

10/07/2011 10:35:12 App did not self-terminate

10/07/2011 10:35:14 Requesting Windows to shutdown, reason = 4

10/07/2011 10:38:04 N40 Device Manager Service started

*******************

Note: In this example, the shutdowns appear to be due to external circumstances, such as loss of power to theNxE. If the device is shut down by pressing the NCT’s Restart Device button, the device shuts downimmediately and no log of shutdown messages is recorded in dmlog.txt.

Finding Non-Crash Files on an NxEAlthough the NCT is typically only used to find crash files for troubleshooting, you can use it to find other types offiles as well. To find non-debug files on an NxE using the NCT, use the following instructions. For information onfinding crash files, see Finding Crash Files.

1. Start the NCT.2. On the Connections tab, select a device, then click Connect to connect to an NxE.3. Select the Explorer tab.4. If you are not sure where the file you are looking for is located, click Refresh Device Contents. The NxE Device

directory appears in the Directories pane of the Explorer tab. (Figure 22).


Figure 22: NAE55 Device in Explorer Tab

5. In the Directories pane, browse to the folder that contains the file you are looking for.6. In the Files pane, select the file you want to copy and click Get File.

Note: You can copy only one file at a time through the NCT.7. Select the location where you want to save the file and click OK.8. Repeat Step 5 through Step 7 for each file that you want to copy.

Using Remote Desktop with the NCTThe NCT allows users to connect remotely to an NxE.

Using Remote Desktop with Windows 7 and Later Operating SystemsTo use the Remote Desktop function with a Windows 7 or later operating system (which includes Windows 7,Windows 8, and Windows 8.1):

1. Using the NCT Tool in Advanced Mode, on the Connections tab, click Discover to discover devices.2. In the list of discovered devices, select an NxE, then click Connect.3. Click Remote Desktop. The command window appears.

Note: If the command window does not appear, press Ctrl+Alt+End, select Task Manager, select File > NewTask (Run...), enter cmd.exe, and click OK to launch the command window.

4. In the command window, type explorer and press Enter. Windows Explorer appears.

Monitoring Engine MessagesThe NCT allows users to monitor engine messages on the Connections tab. These messages relay high-level events,and they can be helpful when installing patches.

To view engine messages, look in the Messages From Selected Devices pane Figure 2

To clear messages, click Clear Messages.


Note: If you are using messages for troubleshooting, use the NAE/NIE Update Tool to monitor engine messages.For more information on this tool, refer to NAE/NIE Update Tool Help (LIT-12011524).

Synchronizing the Time between the NxE and Your ComputerImportant: If the current time on the NxE and a Site Director differs, several problems can occur. If the time

difference is greater than 5 minutes, the device may go offline or never report online to the Site Director.If the time difference is minor, reported alarm sequences or trend data may be out of sync.

The Metasys network manages time synchronization if the NxE is able to successfully report to the Site Director. Ifthe NxE is unable to report to the Site Director, connect to the NxE and synchronize the time manually.

To synchronize the time between the NxE and your computer:

1. Load the NCT on the server on which you want the time in the NxE synchronized, such as on an Application andData Server (ADS) or an Extended Application and Data Server (ADX) Site Director.

2. Start the NCT.3. Connect to the NxE.4. Verify that the current time on the computer is correct.5. Select the Tools tab in the NCT.6. Click Set Date and Time. When the date/time setup is successful, the Connection Activity pane displays Date

and Time set successfully (Figure 23).

Note: This command sends a time and date change command from the computer to the NxE in UTC format.

Figure 23: Device Time Set Message


Troubleshooting

Windows Security AlertThe following security alert may appear when you start the NCT on a 64-bit version of a Windows operating system.

Figure 24: Windows Security Alert

Click Allow access to start the NCT.

By default, many programs are blocked by the Windows Firewall to help make your computer more secure. To avoidthis message box in the future, allow the NAE Information and Configuration Tool to communicate through WindowsFirewall by following these steps:

1. In Control Panel, click System and Security > Windows Firewall.2. In the left pane, click Allow a program or feature through Windows Firewall.3. Click Allow another app. The Add an app window appears.4. Select NAE Information and Configuration Tool in the list.5. Click Add.6. In the Allowed Apps window, click OK.7. Close all windows.

Determining Possible Reasons for an NCE25 NAE35 or NAE45 ShutdownThe Device Manager log file (dmlog.txt) provides a history of shutdown and startup of the Metasys system devicemanager within the NCE25, NAE35, or NAE45 engine. This file can be used to determine why an NxE has shutdown unexpectedly. For information on finding crash files for troubleshooting, see Finding Crash Files.


Remote Desktop to NxE55 May Not Enable Access to the Local DriveTo access the local drive of the device from which the NCT is running in a remote desktop session to an NxE55,the local drive must have a volume label (also known as a volume name). If the local drive does not have a volumelabel, it appears as Local Disk (C:) in Windows Explorer.

If the local drive is not accessible from the NxE55 remote desktop session, set the volume label on the local driveand try again.

Building Efficiency507 E. Michigan Street, Milwaukee, WI 53202

Metasys® and Johnson Controls® are registered trademarks of Johnson Controls, Inc.All other marks herein are the marks of their respective owners.© 2014 Johnson Controls, Inc.

www.johnsoncontrols.comPublished in U.S.A.


Date post:	07-Sep-2018
Category:	Documents
Upload:	ledat
View:	223 times
Download:	0 times

NxE Information and Configuration Tool Technical...

Documents