system configuration tool technical bulletin - viking...

61
Technical Bulletin Issue Date March 31, 2003 © 2003 Johnson Controls, Inc. www.johnsoncontrols.com Code No. LIT-1201534 Software Release 1.0 System Configuration Tool System Configuration Tool................................................................... 3 Introduction......................................................................................................... 3 Key Concepts...................................................................................................... 5 System Configuration Tool (SCT) Overview ..................................................................... 5 SCT in a Metasys Network ................................................................................................ 6 SCT Flowchart .................................................................................................................. 6 Metasys Modes ................................................................................................................. 8 Security Scenarios ............................................................................................................ 9 Archive Database .............................................................................................................. 9 Archive Backup ................................................................................................................. 9 Database Generation ........................................................................................................ 9 Network Automation Engine (NAE) ................................................................................. 10 NAE Point Mapping ......................................................................................................... 10 Network Integration Engine (NIE) ................................................................................... 10 Site .................................................................................................................................. 10 Site Organization............................................................................................................. 11 Site Object ....................................................................................................................... 11 Site Director .................................................................................................................... 11 Object Names ................................................................................................................. 12 Integration Overview ....................................................................................................... 12 N2 Integration.................................................................................................................. 13 Other Integrations ........................................................................................................... 13 Uploading and Downloading ........................................................................................... 14 Simulation ....................................................................................................................... 14 Wizards ........................................................................................................................... 15 Auto Discovery ................................................................................................................ 15 Logic Connector Tool (LCT) ............................................................................................ 15 User Graphic Tool ........................................................................................................... 16

Upload: leduong

Post on 04-Jul-2018

225 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

Technical BulletinIssue Date March 31, 2003

© 2003 Johnson Controls, Inc. www.johnsoncontrols.comCode No. LIT-1201534 Software Release 1.0

System Configuration Tool

System Configuration Tool...................................................................3

Introduction......................................................................................................... 3

Key Concepts...................................................................................................... 5

System Configuration Tool (SCT) Overview ..................................................................... 5SCT in a Metasys Network................................................................................................ 6SCT Flowchart ..................................................................................................................6Metasys Modes ................................................................................................................. 8Security Scenarios ............................................................................................................ 9Archive Database.............................................................................................................. 9Archive Backup .................................................................................................................9Database Generation ........................................................................................................ 9Network Automation Engine (NAE)................................................................................. 10NAE Point Mapping......................................................................................................... 10Network Integration Engine (NIE) ................................................................................... 10Site .................................................................................................................................. 10Site Organization............................................................................................................. 11Site Object....................................................................................................................... 11Site Director .................................................................................................................... 11Object Names ................................................................................................................. 12Integration Overview ....................................................................................................... 12N2 Integration.................................................................................................................. 13Other Integrations ........................................................................................................... 13Uploading and Downloading ........................................................................................... 14Simulation ....................................................................................................................... 14Wizards ........................................................................................................................... 15Auto Discovery ................................................................................................................ 15Logic Connector Tool (LCT)............................................................................................ 15User Graphic Tool ........................................................................................................... 16

Page 2: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin2

Supported N2 Configuration Tools.................................................................................. 16PassThru......................................................................................................................... 17Related Documentation................................................................................................... 18

Detailed Procedures......................................................................................... 19

Starting the SCT.............................................................................................................. 19Creating a New Archive Database .................................................................................. 20Opening an Archive Database ........................................................................................ 21Copying an Archive Database......................................................................................... 21Deleting an Archive Database......................................................................................... 21Populating an Archive Database..................................................................................... 21Adding Sites to an Archive Database.............................................................................. 23Adding a Metasys Server (ADS or ADX) to an Archive Database .................................. 25Adding Supervisory Devices to an Archive Database..................................................... 27Adding N2 Integrations to an Archive Database ............................................................. 28Adding N2 Field Devices to an Archive Database .......................................................... 30Adding N2 Field Devices Online Using Auto Discovery .................................................. 34Adding Extensions to an Object ...................................................................................... 37Deleting Extensions From an Object............................................................................... 45Copying Extensions to a Field Device or Field Point ...................................................... 46Adding N2 Field Points to an Archive Database ............................................................. 47Exporting Part of an Archive Database to a File ............................................................. 54Importing Part of an Archive Database from a File ......................................................... 57Backing up an Archive Database .................................................................................... 58Restoring an Archive Database ...................................................................................... 59Inserting a User View ...................................................................................................... 59Launching Configuration Tools in Passthru Mode .......................................................... 60Launching the LoaderUI.................................................................................................. 60

Page 3: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 3

System Configuration Tool

IntroductionThe System Configuration Tool (SCT) allows you to easily engineer,install, and commission the features of your Metasys® system. Thisdocument describes how to set up an archive database offline using theSCT. It also describes basic setup of an N2 network online to illustratesome key differences between working with the Metasys systemextended architecture from both points of view.

Note: There is extensive user information covered in the Metasyssystem online help. Also see the Related Documentation section in KeyConcepts for further references.

This document describes how to:

• start the SCT

• create a new archive database

• open an archive database

• copy an archive database

• delete an archive database

• populate an archive database

• add sites to an archive database

• add a Metasys Server (ADS or ADX) to an archive database

• add supervisory devices to an archive database

• add N2 integrations to an archive database

• add N2 field devices to an archive database

• add N2 field devices online using Auto Discovery

• add extensions to an object

• delete extensions from an object

• copy extensions to a field device or field point

• add N2 field points to an archive database

Page 4: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin4

• export part of an archive database to a file

• import part of an archive database from a file

• back up an archive database

• restore an archive database

• insert a User View

• launch Configuration Tools in Passthru mode

• launch the LoaderUI

Page 5: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 5

Key ConceptsSystem Configuration Tool (SCT) Overview

The SCT assists in all phases of engineering, installing, andcommissioning of devices that make up the Metasys system extendedarchitecture. Use the SCT offline to create archive databases todownload to a Metasys system – either to a Network AutomationEngine (NAE), Network Integration Engine (NIE), or to anApplication and Data Server or Extended Application and Data Server(ADS/ADX). The SCT uses the same User Interface (UI) as theNAE/NIE and ADS/ADX. The SCT can be used for various functionsonline with a Metasys system extended architecture network, such asscheduling downloads to NAEs.

The SCT allows commissioning of N2 devices by allowingHVAC PRO software, GX-Tool software, and XTM Configuratorsoftware to access the Metasys system.

Upload databases modified in the Metasys system extendedarchitecture to the SCT for archiving or editing. The SCT includesfeatures to enable the synchronization of the archived and onlinedatabases. You can configure these features to run at specified times.

There is extensive user information contained in the Metasys systemonline help.

Page 6: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin6

SCT in a Metasys NetworkFigure 1 shows the SCT as part of an overall Metasys system extendedarchitecture network. Figure 1 shows an ADS with SCT installed and aportable Personal Computer (PC) with SCT that can be connecteddirectly to an NAE.

Printer

ADS Serverwith SCT

Web Browser

NIE NAENAE

Internet

Firewall

Field Bus(N2)

Field Bus(N2)

Field Bus(N2)

L W ®ON ORKSNetwork

L W ®ON ORKSNetwork

Web Browser

Dial-Up RemoteBuilding

NAE

SCT-Local Configuration

IP network

SCTNetwork

Figure 1: SCT as Part of a Metasy Network

SCT FlowchartThe flow chart in Figure 2 shows one of the possibilities for using theSCT to help set up a job. In the left branch the archive database isconfigured. This is done offline with the SCT and could be done priorto going to a job site. The right side of the flow chart shows the initialsetup of NAEs at a site, which is done online.

Page 7: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 7

Add and configure NAEs and NIEsSet up Network ConfigurationConfigure modemsSet up SNMP (optional)

Build Metasys DatabaseAdd integration trunks, field devices, andfield points. See the SystemConfiguration Tool Technical(LIT-1201534).Add Programming Logic Using LCT. Seethe Metasys system online help.Configure Alarm, Audit Trail, and TrendArchive. See the Metasys system onlinehelp.Configure Alarm Destinations. See theMetasys system online help.Build Graphics. See the Metasys systemonline help.

Add and configure a Site. See the SystemConfiguration Tool Technical Bulletin

(LIT-1201534).

Archive database complete and ready toDownload to NAEs / NIEs.

NOTE : Before download, ensure that the settingcreated during online steps (time zone, etc...) are

correct in the archive. If they do not match, thedownload overwrites what you entered

at the NAE.

Install NAESee Installing the NAE/NIE Technical

Bulletin (LIT-1201161)

Configure NAE for Connectivity with aMetasys Network See Configuring an NAEfor Connectivity in the Configuring theNetwork Automation Engine (NAE)Technical Bulletin (LIT-1201519), which listsfive network scenarios for which instructionsare included. These steps include:

set time, date, and time zoneif the NAE is not going to be the SiteDirector, demote itassign a name and IP address (ifnecessary) to the NAE. This namemust match the name assigned toNAE in the archive database in theSCT. W hen the name or IP address ischanged the device needs to be reset,this can take 10 minutes.

Add Users to the System in the SiteDirector. See the Security AdministratorSystem Technical Bulletin (LIT-1201528)

Designate an NAE as Site Director. SeeDesignating a Site Director in the

Configuring the Network Automation Engine(NAE) Technical Bulletin (LIT-1201519). If

you have an ADS or ADX, it is automaticallythe Site Director. See the Configuring theADS Technical Bulletin (LIT-1201645) formore information about the ADS or ADX.

Prepare NAE Hardwareat Jobsite.

Do you have additionalNAEs or NIEs on the

jobsite?

No

Yes

The NAE is now ready to have a databasedownloaded. Use the Load W izard to downloadthe archive database to the NAE from the SCT.

See the Metasys system online help.

Configure archivedatabase offline in SCT

Figure 2: SCT Flowchart

Page 8: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin8

Metasys ModesMetasys software can operate in three different modes. You canperform online tasks, such as monitoring and commanding, when youare connected to the NAE/NIE or ADS/ADX. You can perform offlinemode system configuration tasks, such as configuring point objectsand features, when you are connected to the SCT. The SCT has theability to test the system logic for an NAE/NIE while offline inSimulation mode. Some key differences in functionality betweenrunning the SCT in these different modes is shown in Table 1.

Table 1: Metasys Functions by Mode of OperationFunction Offline Mode (SCT) Online Mode (Site Director or

NAE)Scope of Default Navigation Items in an archive the database

for single or multiple sitesItems in the site can be viewed inthe Site Director. Any NAE can

view the items within.View User Defined NavigationTrees

X

View or Edit Items in theNavigation Tree

X X

Restrict Access via SecurityDatabase

Only at login X

Provides Administration Toolfor Security Database

X X

Create a Site XCreate a NAE XCreate a Metasys Server(ADS/ADX)

X

Create a Navigation Tree X XCreate a System, including theLogical Connector Tool (LCT)

X X

Create Graphics X XCreate all other items supportedby an NAE or Site Server

X X

Delete Items X XCopy or Paste Items and theirchildren

Can create archive copies as wellas copy or paste items and

devices.Simulate a Single NAE XUpload, Download, andSynchronize ConfigurationDatabases to and from NAEs

X

Create Configurations for N2devices (HVAC PRO, GX Tool)

X

Commission all Items on a Site X

Page 9: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 9

Security ScenariosWhen the SCT is part of a Site, there are three scenarios of how theSecurity Administration System integrates into the Site:

Note: For more information on Security, including setting up rolesand users, see the Security Administrator System Technical Bulletin(LIT-1201528).

1. On a Site where the SCT is not installed on the same PC as anADS that is the Site Director, the only function the SecurityAdministration System plays is to add users and passwords forauthentication to the SCT. Neither the Object-based nor System-based permissions affect the use of the SCT even though all thefunctions are available.

2. On a Site where the SCT and ADS are installed on the same PCand the ADS is the Site Director, the Security AdministrationSystem on either the SCT or ADS administer the Security Systemfor the Site.

3. On a Site where the SCT and ADS are installed on the same PCand the ADS is not the Site Director (the ADS is only used forData Storage), the Security Administration System function on theSCT only adds users and passwords for authentication to the SCT.The Site Director for the Site is the Security Administration for theADS acting in the Data Storage Capacity.

Archive DatabaseThe SCT uses the archive database to hold all of the configurationinformation for the devices that make up a single, or multiple sites.The archive database contains information about controllers, points,and alarms. A single server can contain multiple archive databases.

Archive BackupAn archive backup is a backup file of an archive database. You mustrestore the archive backup into an archive database before it can beused. A backup can be created and moved to another PC running SCT.

Database GenerationUse the SCT to initially generate databases. To generate a database,create an archive database and add information and references to sites,controllers, communications trunks, and objects (such as schedules,energy management objects, and operators).

You can also generate a database online in a single NAE or NIE andupload the information to the SCT for editing and archiving.

Page 10: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin10

Network Automation Engine (NAE)The NAE is an Ethernet-based supervisory controller. The NAEprovides features including alarm and event management, trending,archiving, energy management, data exchange, scheduling, dialfeatures, and password protection through the Web browser UI.

NAE Point MappingThe NAE maps controller point data to objects in the NAE so thatpoints in the controller are identified with objects in the NAE. Pointmapping allows the NAE to read and write to the points of thecontroller and view/acknowledge alarms.

Field device objects must be mapped to an integration object such asan N2 Trunk. Field points are then mapped to field devices.

There are several ways to map points to an NAE. In the SCT you canattach a resource file to a field device and then use assisted pointdefinition to map the points from the file. In the SCT you can alsomanually map individual points. When you are online to an NAE youcan use the Auto-Discovery feature to discover devices and points on aconnected network, the data from the Auto-Discovery can then beuploaded to an archive database in the SCT for editing. You can alsomanually insert points online using the Insert Point Wizard.

Johnson Controls recommends mapping to the N2 Integration object inmost cases. If you are integrating a BACnet™ network see the BACnetSystem Integration with NAE Technical Bulletin (LIT-1201531). Tointegrate an N1 Network refer to the N1 Migration with the NIETechnical Bulletin (LIT-1201535).

Network Integration Engine (NIE)The NIE is a specialized version of the NAE that provides for themigration of an N1 network into the Metasys system extendedarchitecture. The NIE supports all functions of the NAE, except forN2, BACnet, and LONWORKS® system integration. The NIE UI isvery similar to the NAE UI.

Microsoft® Internet Explorer Browser RecommendationsAlways open a new browser window to access the Metasys UserInterface or SCT (if accessing from a Web browser). Do not use theMetasys User Interface browser window to navigate to any other Website. If you access a Web site that requires a Java® plug-in,configuration and runtime problems may arise.

Launching Microsoft Internet Explorer from a shortcut on the desktop,or typing a Universal Resource Locator (URL) in the address field ofthe task bar may replace the Metasys application if Microsoft InternetExplorer is configured to reuse windows when launching shortcuts.

Page 11: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 11

Application and Data Server (ADS)ADS software consists of two parts, a Site Director component and adata storage component. Use the data storage component to providestorage for historical data in an NAE system. Once you add an ADS tothe site, it is designated as the Site Director. The Site Director andStorage components do not have to reside on the PC.

SiteA site is a logical grouping of supervisory level devices (NAEs) andtheir field level devices that are on the same Local Area Network(LAN). A site may consist of one or many supervisory devices.

Site OrganizationThe SCT provides a number of ways to help organize your site. Thetwo main methods are folders and User Views.

Use folders as containers to assist in organizing your archive database.The default NAE database contains Energy, Programming, andSchedule folders.

User Navigation Views group object references for quick access. Youcan add references to any object in the site and add folders to userviews. User Navigation Views can be added for each user of a site andappear when that user logs into a database.

Site ObjectThe Site object defines the attributes that represent the characteristicsof a site. If the Site object exists on a device, that device is consideredthe Site Director. The Site object maintains time-of-daysynchronization for a site. See Setting the Time, Date, Time Zone, andTime Synchronization section in the Configuring the NetworkAutomation Engine (NAE) Technical Bulletin (LIT-1201519) forinstructions on checking and setting the time.

Site DirectorThe Site Director is the NAE, or a PC running ADS software,designated to hold the Site object. When using a browser to view allthe data on a site, point the browser to the Site Director. The SiteDirector allows you to see all the other components on a site.

Page 12: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin12

Object NamesAn object name is a unique name for an object. Providing an objectname is optional, but if it is defined, it must be unique throughout thesite. If it is not defined, the full reference becomes the identifier (forexample, Building1Floor2).

Note: The following characters are not allowed: @ . , ? * $ # : ‘ " "/ \ [ or ].

Integration OverviewIn Metasys system extended architecture, information coming from anintegrated network (N2 or BACnet network) appears in the sameframework as data native to the NAE. After all points have beenmapped, the following functions are available in integrated systems:

• basic monitoring and commanding

• alarm and event management

• Heating, Ventilating, and Air Conditioning (HVAC) controls

• scheduling

• event programs (interlocking)

• energy optimization

• historical data management (trend)

• audit trails (transaction data management)

• system diagnostics and serviceability

• advanced applications

Page 13: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 13

N2 IntegrationThe NAE supports all current N2 devices except the N2 Dialer, DigitalControl Module (DCM), and DCM-140. IFC-2020 and IFC-1010 aresupported in a limited capacity. Addresses for N2 devices are in therange of 1 to 254.

For a Metasys system extended architecture network with N2Integration, note the following:

• devices connected to N30s appear as native N30 objects and whenthe N30 connects to an NAE, all objects and devices appear asnative NAE objects and devices

• N2 integration supports Metasys Integrator® units.

• Metasys system extended architecture / N2 integration supportsPassthru downloading to Application Specific Controllers (ASCs)using the XTM Tool, HVAC PRO software, N2 Loader UI, andGX-Tool software. See the Passthru section in this document

• Metasys system extended architecture / N2 integration storesconfiguration information for N2 devices separate from the objectand device definitions in the NAE. The data is stored in theconfiguration database of the Configuration Server (if the NAE isoffline) or the NAE configuration database (if NAE is online).

• practical performance and native trunk limits are defined in projectdesign. The system does not impose limits on the number ofN2 objects or devices supported.

The Insert Field Device and Insert Field Point wizards guide youthrough the process of discovering controllers, and the importing, andmapping of N2 points. When you are online with an NAE through theMetasys system extended architecture UI, not through the SCT, theInsert Field Device wizard can use Auto-Discovery to discovercontrollers connected to each N2 trunk. With Auto-Discovery manualentry of controller addresses and controller types is not necessary. Youcan then map Field Points within each controller using N2 controllerconfiguration files or manual point definition. The database created atthe NAE using Auto-Discovery can then be uploaded to an archivedatabase in the SCT for storing or editing.

Other IntegrationsThe SCT can also integrate BACnet networks and migrate N1networks to an archive database. See the BACnet System Integrationwith NAE Technical Bulletin (LIT-1201532) and the N1 Migrationwith the NIE Technical Bulletin (LIT-1201535) for details.

Page 14: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin14

Uploading and DownloadingUse the Load Wizard to download, upload, and synchronize databases.Access the Load Wizard by selecting Load Archive. . . from the Toolsmenu in the offline mode. The Load Wizard collects necessaryinformation to perform the load such as load type, controller names,and load time. Once you complete the wizard, the supervisorycontroller sends the load commands to the ActionQ. ActionQ initiatesand monitors the load. The Load Archive options are described in thefollowing sections:

Note: For more information on using these features, see the LoadWizard and ActionQ topics in the Metasys system online help.

UploadThe Load Wizard’s upload option archives NAE databases into thearchive database of the configuration server. The NAE databaseoverwrites the configuration server’s archive database. The directionof an upload is from the NAE to the SCT.

DownloadThe Load Wizard’s download option downloads (copies) the archivedatabase from the configuration server into NAE devices. Theconfiguration server’s archive database overwrites the NAE database.The direction of a download is from the SCT to the NAE.

SynchronizeThe Load Wizard’s synchronize option synchronizes an NAE devicewith the archive database. When you synchronize a database, the NAEdatabase is uploaded to the SCT and checked for consistency with thearchive database. Then, only the changes in the archive database aredownloaded back to the NAE. The load completion status indicatesany conflicts with the synchronization and prompts you to examine thechanges to the archive database.

SimulationSimulation allows you to test the system logic created for an NAE orNIE when the Metasys system is offline. In Simulation, you can entercommands and see how an online system would react if commanded toperform the same action. The Simulation mode uses the same userinterface and command features of the online system.

Simulation is run from the SCT in offline mode. You cannot runsimulation on the same PC as an ADS/ADX because ADS/ADX ispart of the online system. Simulation supports the simulation of oneNAE or NIE on one site and, if you attempt to start a secondsimulation, the first simulation must be stopped.

Page 15: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 15

In Simulation mode, you can perform the following tasks including:

• viewing a control system created using the Logic Connector Tool

• simulating Inputs/Outputs (I/O)

The menu choices are different in Simulation than in online or offlinemodes. Simulation does not support moving logic or items from withinthe simulated system to the archive database or online system.

Simulation runs in a new browser window labeled Metasys Simulationin the title bar of the browser. Only the information for the simulateddevice appears in the simulation session (not the entire site).

For more information on Simulation, see the Metasys system onlinehelp.

Note: Do not run simulation on server class machines becausestopping simulation resets Internet Information Server (IIS). Thiswould require you to log in to the SCT again. Any scheduled taskswould not run until the SCT was logged into again.

WizardsWizards help you perform complicated operations and present tasks ina consistent format. A wizard consists of a series of steps, eachcorrelating to a screen presented to the user.

A wizard may appear when you select an option from the Insert menu,and when you prompt certain complex actions. For example, a wizardappears when you select Object from the Insert menu, or when youadd an input or output attribute to a system using the Logic ConnectorTool (LCT).

Auto DiscoveryAuto-discovery allows an online NAE to automatically find fielddevices and field points on a connected network. Auto-discovery isonly available when you are online (logged into a specific NAE) andnot available through the SCT. However, you may discover points ordevices through an NAE and then upload the NAEs database with thediscovered information to an archive database in the SCT, where youcan store and edit the discovered information.

Logic Connector Tool (LCT)Use the LCT to create a graphical representation of control logicwithin a system. The control logic may include system blocks,reference blocks and logic blocks. The Layout mode allows you to editthe logic offline while the View mode allows limited onlinecommanding capabilities.

Note: Commands are not available offline.

Page 16: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin16

The LCT allows system viewing and editing via any browser loggedinto any online or configuration server with access to a System object.Create new logic systems from any browser with access to the NAE.See the Metasys system online help for instructions on using the LCT.

User Graphic ToolUse the User Graphics tool to view, create, and edit graphics forMetasys systems. You can monitor and control a facility through agraphical interface representing the functionality and location of fans,controllers, and other Heating, Ventilating, and Air Conditioning(HVAC) equipment. See the Metasys system online help forinstructions on using the User Graphic tool. Graphics provide a visualrepresentation of the monitored systems that enable you to quicklycheck the status of system symbols and recognize unusual systemconditions. Graphics can be designed to allow you to move throughbuildings, floors, and other areas, viewing building systems andcontrol processes. You can create new systems/logic from any browserwith access to the NAE.

Backgrounds are static images displayed in the background of agraphic. Backgrounds represent buildings, floor plans, mechanicalequipment, and any other picture that represents the location orfunction of the equipment in the graphic. By default, a newly createdgraphic has a gray background. You can insert a background imageusing a file based on SVG, SVGZ, or JPEG graphic format. You canthen bind data to items on the graphic.

Supported N2 Configuration ToolsConfiguration Tools are used in Passthru mode to commission N2devices in the Metasys system. Configuration Tools can exist on aclient PC or on the Configuration Server itself. In either case, theConfiguration Tools must reside on the client machine performing alegacy tool operation. In addition, Resource files, which are filescreated by N2 Configuration tools, can be attached to field devices asextensions and then used to assist in field point generating andmapping.

Refer to Table 2 for the file extension of the legacy tools supported bythe NAE.

Page 17: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 17

Table 2: Supported Legacy ToolsDevice/ControllerType

Configuration Tool File Name ExpectedDuring Import*

ASCs HVAC PRO, LoaderUI PRN**VMAs HVAC PRO PRN**Vendor Vendor PRNXPs XTM Tool, LoaderUI HMCDXs GX-9100 Tool, LoaderUI DMOMIG Metasys Integrator unit VCT* The files required by the N2 integration import utility for generating XML. The

original Configuration Tool files are not stored in the NAE.** When generating PRN files from HVAC PRO, use the long format.

PassthruIn Passthru mode, a Configuration Tool (such as HVAC PRO softwareor GX-9100 software) communicates directly to a controller throughthe NAE over the LAN, and the N2 device appears offline at the NAE.Commands from the software tool go directly to the N2 device andalarms and other messages return directly to the software tool (HVACPRO and GX-9100, for example). In Passthru, you can view bothN2 trunks of an NAE at the same time. The Configuration Tools showthe object name as it appears in the NAE of the device undergoingPassthru. This object name contains the name of the trunk to help youdetermine which trunk the device is located on.

HVAC PROHVAC PRO configures Variable Air Volume Modular Assembly(VMA) 1400 Series controllers, Unitary controllers (UNTs), and AirHandling Unit (AHU) controllers. HVAC PRO supports operation inPassthru mode.

In Passthru mode, you can use the HVAC PRO software to downloadApplication Specific Controller (ASC) configurations directly throughan NAE.

In addition, Passthru mode makes it easier to identify and managecontrollers for common tasks by showing the user a complete list ofcontrollers currently mapped in an NAE. The first step in any Passthruoperation from HVAC PRO is to select a controller from a list.Subsequent Passthru operations such as Controller Information andUpload / Download are performed on the selected controller.

For more information on Passthru with HVAC PRO, see the UsingHVAC PRO Software in Pass Through Mode chapter (LIT-63750418)in the HVAC PRO User’s Guide.

Page 18: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin18

Loader User Interface (LoaderUI) ToolThe Loader User Interface (LoaderUI) tool provides a generic methodof downloading and uploading DX, UNT, Variable Air Volume(VAV), AHU, and XTM configuration files. The LoaderUI tool candownload the same file to multiple controllers and can upload multiplecontrollers at once.

Note: You cannot upload XTM files.

For more information on LoaderUI, see the GX-9100 SoftwareConfiguration Tool User’s Guide (LIT-6364060).

Related DocumentationTable 3 contains a list of documents that are related to the Metasyssystem extended architecture.

Table 3: Related DocumentationFor information on See document Lit NumberInstalling an NAE or NIE Installing the NAE/NIE Technical Bulletin LIT-1201161Troubleshooting the NAE Troubleshooting the NAE/NIE Technical

BulletinLIT-1201417

Dialing in to Metasys system extendedarchitecture from a PC

Direct Connect and Dial-up Connection onWindows 2000 or Windows XP OperatingSystems Application Note

LIT-1201639

Metasys system extended architecture Metasys System Extended ArchitectureOverview Technical Bulletin

LIT-1201527

System Configuration Tool (SCT) System Configuration Tool TechnicalBulletin

LIT-1201534

Using N2 devices with the Metasys systemextended architecture

System Configuration Tool TechnicalBulletin

LIT-1201534

Integrating BACnet devices to the Metasyssystem extended architecture

BACnet System Integration with NAETechnical Bulletin

LIT-1201531

Migrating N1 networks to the Metasyssystem extended architecture

N1 Migration with the NIE Technical Bulletin LIT-1201535

Daily use of the Metasys system extendedarchitecture

Metasys system online help On the HelpMenu, selectMetasys Help

General Network and InformationTechnology definitions and concepts

Network and Information Technology (IT)Considerations Technical Bulletin

LIT-1201578

Security issues, including adding usersand roles to the system

Security Administrator System TechnicalBulletin

LIT-1201528

Page 19: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 19

Detailed ProceduresNote: If the PC that the SCT is installed on is reset, the SCT shutsdown until someone logs in to it again. If a load had been scheduledand the SCT PC was reset, the load does not start until someone logsinto the SCT. The person who logs in does not need to do anything tostart any scheduled processes. The login is enough to start the SCTagain.

Starting the SCTFrom the PC where the SCT is InstalledTo start the SCT from the computer where the SCT is installed:

1. On the Windows Start Menu, select Programs > Johnson Controls> Metasys > Metasys SCT. The Welcome to Metasys screenappears.

Note: The SCT install should also place a Metasys SCT icon onyour Windows® operating system desktop. Double-clicking this iconalso starts the SCT.

2. Press the Close Window button. A dialog box lets you know thatthe application is trying to close the window. Click Yes to allow itto do so.

3. When the Metasys Login screen appears, enter your user nameand password and press Enter.

4. If archive databases have been created, the Open Archive dialogappears.

5. Select the desired database and click OK. The SCT screenappears.

Note: If an archive database has not been created, the Create NewArchive wizard starts. See Creating a New Archive Database in thisdocument.

From a PC without the SCT InstalledTo start the SCT from a computer without the SCT installed:

1. Start your Web browser.

2. Type the Uniform Resource Locator (URL) of the ConfigurationServer, the Metasys Server, or an NAE, in your browser and pressEnter. In Microsoft® Internet Explorer the URL field is calledaddress. In Netscape® Navigator® browser the URL field iscalled Location. The Welcome to Metasys screen appears.

Page 20: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin20

3. Press the Close Window button. A dialog box lets you know thatthe application is trying to close the window. Click Yes to allow itto do so.

4. When the Metasys Login screen appears, enter your user nameand password and press the Login button.

5. If archive databases have been created, the Open Archive dialogappears. Select the desired database and click OK.

Note: If an archive database has not been created, the Create NewArchive wizard starts. See Creating a New Archive Database in thisdocument.

Creating a New Archive DatabaseTo create a new archive database:

1. On the item menu of the Tool UI, select New Archive. The NewArchive Wizard screen appears.

2. Enter a name for the Archive. Note the following restrictions:

• Archive names are not case sensitive. All archive files arecreated in the same directory.

• Archive names cannot be longer than 120 characters.

• The first character can only be an alphabet character from a toz.

• No special characters can be in the name. For example, !, @, #,$, %, ., and & are not allowed

• Archive names cannot include spaces

• Archive names cannot be an SQL reserved word. For example,you cannot create an archive and name it create, database, orselect. There are a number of SQL reserved words, and anerror message appears if you attempt to use one.

3. Click the Create button. An archive is created. You are promptedif you want to add a site to the new archive. See Adding Sites toan Archive Database in this document for more information.

Note: If an archive is open you are prompted to close it. The openarchive must be closed before the new one is created.

Page 21: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 21

Opening an Archive DatabaseTo open an archive database:

1. On the Item menu, select Open Archive. The Open ArchiveWizard appears.

2. Choose an archive from the list and click the Open button. If anarchive is already open you are prompted to close the currentdatabase.

Copying an Archive DatabaseTo copy an archive database:

1. With an archive open, select Create Archive Copy on the Itemmenu. The Copy Archive Wizard appears.

2. Select the Archive to copy from the list.

Note: The Archive copy must have a unique name. By default, thenew archive has the same name as the one you are copying with anumber appended to the name.

3. Click the Copy button.

4. Select Yes when prompted to close the current database. The newArchive copy opens.

Deleting an Archive DatabaseTo delete an archive database:

1. On the Item menu, select Delete Archive. The Delete ArchiveWizard opens.

2. Select the archive to be deleted and press the Delete button.

3. Confirm the deletion.

Note: Only one archive can be deleted at a time. An open archivecan be deleted.

Populating an Archive DatabaseThe following procedures can assist you in configuring an archivedatabase for a Metasys system extended architecture system. They arelisted in the order in which they should be performed when creating anew archive database. For example, to add a supervisory device to adatabase archive you must first have a site defined in the archive. Inaddition to the following procedures you can speed up your work bystarting with copies of archive databases, importing previouslyexported portions of databases, and by copying and pasting itemswithin an archive database. Importing and exporting portions ofdatabases is described later in this document.

Page 22: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin22

Note: These instructions are written from the point of view ofbuilding an archive database for an N2 network.

To populate an archive database:

1. Add sites to an archive database. In Figure 3, the archive databaseis MyArchive2 and the Sites are labeled Site1 and Site 2.

2. Add Metasys servers to an archive database if applicable. InFigure 3 the Metasys server is an ADS labeled ADS1.

Note: The Object Category pull down menu shown in the rightpanel of Figure 3 allows you to select a category for any item exceptthe Site object. Permission to view or act on different object categoriesis assigned to users and or roles based on a user’s security level. Seethe Security Administrator System Technical Bulletin (LIT-1201528)for more information.

3. Add supervisory devices to an archive database. The supervisorydevices visible in Figure 3 are NAE1 and NIE1. An NIE isrequired to add an N1 Integration to an archive database.

4. Add an N2 integration trunk to an archive database. The archivedatabase in Figure 3 shows two N2 trunks (N2 Trunk 1 and N2Trunk 2) added to NAE1. NAE1 also contains a BACnetintegration trunk labeled BACnet1.

Note: See the BACnet System Integration with NAE TechnicalBulletin (LIT-1201532) and the N1 Migration with the NIE TechnicalBulletin (LIT-1201535) for information on BACnet and N1 systemintegrations.

5. Add N2 Field Devices to an archive database. Visible fielddevices in Figure 3 are AHU-1 and TC-2.

6. Add N2 Field Points to an archive database. See ZN-T under theAnalog inputs folder of TC-2 in Figure 3 for an example of anadded N2 field point.

Page 23: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 23

Figure 3: SCT with Archive Database

Adding Sites to an Archive DatabaseTo add sites to an archive database:

Note: You must have at least one archive database defined. SeeCreating a New Archive Database in this document for details.

1. With the Archive Database open, select Site on the Insert Menu.The Insert Site Wizard’s Destination screen opens (Figure 4).

Page 24: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin24

Figure 4: Insert Site Wizard - Destination Screen2. Select an archive database and click Next.

Note: You must already have created at least one database topopulate.

3. Follow the prompts on the screen to configure each Site in thearchive. Refer to Table 4 for details.

Table 4: Insert Site Wizard ScreensScreen PurposeDestination Enter or select the archive database to which you are adding the site.Identifier Enter a unique name for the site.Configure Set the editable attributes of the Site object you are configuring, including Connection type

and Time Zone and Time Servers (via Simple Network Time Protocol [SNTP]). See the SiteObject online help for further information. Clicking the Advanced button on this screen allowsyou to access the BACnet system features of the Site Object.

Summary View the basic parameters of the Site just added.

Page 25: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 25

4. Click the Finish Button. A site is created with the parameters youhave selected and you are prompted to create a supervisory deviceor a Metasys Server in the new site. See Adding a Metasys Server(ADS or ADX) to an Archive Database or Adding SupervisoryDevices to an Archive Database in this document for moreinformation.

Adding a Metasys Server (ADS or ADX) to an Archive DatabaseThis procedure assumes an ADS or ADX is installed. After an ADSdownload, you must restart the PC where the ADS is loaded. If the PCis not restarted, there may be communication problems between theADS and other devices on the Site. For more information aboutconfiguring an ADS or ADX, see the Configuring the ADS TechnicalBulletin (LIT-1201645).

When there is an ADS or ADX on a site, it is automatically the SiteDirector. If there are multiple ADS or ADX added to a site, the firstADS or ADX added is the Site Director by default.

To add an ADS or ADX to an archive database:

1. With the Archive Database open, select Metasys Server on theInsert menu. The Insert Metasys Server Wizard starts (Figure 5).

Page 26: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin26

Figure 5: Insert Metasys Server Wizard- Select Object Type Screen2. Follow the prompts on the screen to configure the Metasys

Server. Refer to Table 5 for details.

Table 5: Insert Metasys Server WizardScreen PurposeObject Type Select the type of Metasys Server you are adding. For example, ADS Version 1.0.Destination Select the site where the Metasys Server resides.Identifier Enter a unique name for the Metasys Server. A unique name is required for each Metasys

Server in an archive. By default the name of the object has a number appended to keep itunique. Therefore, if adding an ADS to a site for the first time, the default name is ADS1.

Configure Access features of the Metasys Server, including:• Email – Setup SMTP and POP destinations. Add email addresses for the Metasys Server

to send messages to.• Pager – Enter phone number information for sending messages to a pager.• SNMP – Enable SNMP and add destinations.

Summary View the basic parameters of the Metasys Server just added.

3. Click the Finish button.

Page 27: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 27

Adding Supervisory Devices to an Archive DatabaseTo add Supervisory Devices to an archive database:

1. With the archive database open, select Supervisory Device on theInsert Menu. The Insert Device Wizard Select Object Type screenappears (Figure 6).

Figure 6: Insert Device Wizard - Select Object Type Screen2. Follow the prompts on the screen to configure the Supervisory

Device. Refer to Table 6 for details.

Page 28: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin28

Table 6: Insert Device WizardScreen PurposeObject Type Select the type of Supervisory Device you are adding.Destination Select the Site where the Supervisory Device resides.Identifier Enter a unique name for the supervisory device. A unique name is required for each

supervisory device. By default the name of the object being entered has a number appendedto keep it unique. Therefore, if adding an NAE to a site for the first time, the default name isNAE1.

Configure Access NAE features, including (See the online help file for the NAE Device object for adescription of the attributes on these screens, including default values and ranges):• Configuration – If Basic is selected, you can edit parameters such as name and

description. If you select Advanced, you can configure additional parameters such asEngineering values, Alarm snooze, Audit Trail, and Site information.

• Communications – Configure the serial port, internal, and external modems.• Network – Enter the LAN address and configure dial-up settings for accessing the network

over dial-up connections.• Email – Setup SMTP and POP destinations. Allows you to add email addresses for the

NAE to send messages to.• Pager – Enter phone number information for sending messages to a pager.• SNMP – Enable SNMP and add destinations.

Summary View the basic parameters of the Supervisory device just added.

3. Click the Finish button.

Adding N2 Integrations to an Archive DatabaseTo add N2 Integrations to an archive database:

1. With the archive database open, select Integration on the Insertmenu. The Insert Trunk Wizard starts (Figure 7).

Page 29: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 29

Figure 7: Insert Trunk Wizard2. Follow the prompts on the screen to configure the Integration.

Refer to Table 7 for details.

Note: For information on adding BACnet integration, see theBACnet System Integration with NAE Technical Bulletin(LIT-1201531). For information on migrating an N1 Network to aMetasys system extended architecture system, see the N1 Migrationwith the NIE Technical Bulletin (LIT-1201535).

Table 7: Insert Trunk WizardScreen PurposeObject Type Select the type Integration. For example, N2 Integration or BACnet system Integration.Destination Select the Supervisory Device which connects to the trunk you are integrating.Identifier Enter a unique name for the trunk. A unique name is required for each Integration in an

archive. By default the name of the object being entered has a number appended to keep itunique. Therefore, if adding an N2 Integration to a site for the first time, the default name isN2 Integration1.

Configure Configure information about the integration such as Trunk number and a brief description.Selecting the Advanced button allows you to edit the BACnet Object Identifier.

Summary View the basic parameters of the Integration just added.

3. Click the Finish button.

Page 30: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin30

Adding N2 Field Devices to an Archive DatabaseNote: You can create objects whether your system is online oroffline using the Insert Field Device Wizard.

To add N2 field devices to an archive database:

1. With the archive database open, select Field Device on the Insertmenu. The Insert Field Device Wizard starts (Figure 8).

Figure 8: Insert Field Device Wizard – Destination Screen2. Select the trunk where you are inserting the device and click Next.

The Insert Field Device Wizard Select Definition Mode screenappears (Figure 9).

Page 31: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 31

Figure 9: Insert Field Device Wizard – Select Definition Mode Screen3. Select the Manual Device Definition radio button (Figure 9). The

Insert Field Device Wizard Identifier screen appears (Figure 10).

Notes: The Manual Device Definition page of the wizard allows youto select the type of device and an N2 address for the device you arecreating. All N2 addresses in the drop down combo box are valid N2addresses because the list is updated each time a new controller objectis created. After choosing an N2 address, click Next.

Auto-Discovery is only available online for field devices. See AddingN2 Field Devices Online Using Auto Discovery in this document.

Page 32: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin32

Figure 10: Insert Field Device Wizard - Identifier Screen4. Choose a unique name (within the parent object) for the new

controller object and click Next. The Insert Field Device WizardConfigure screen appears (Figure 11).

Note: When using Manual Device Definition, the default name isalways Controller plus an incremental number. The incrementalnumber ensures that the suggested name is unique within the contextof the parent object, in this case an N2 Integration.

Page 33: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 33

Figure 11: Insert Field Device Wizard - ConfigureNote: The fields of the Configure screen have default data based onthe previous information entered. This information includes the objecttype and naming parameters of the new controller being created.

5. Click Next, the Summary Screen appears (Figure 12).

Page 34: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin34

Figure 12: Insert Field Device Wizard - Summary Screen6. If satisfied with the Summary, click Finish (otherwise click Back

and correct any problems). The object is created and you aregiven the opportunity to add extensions to the new controllerobject. See Adding Extensions to an Object in this document formore information.

Adding N2 Field Devices Online Using Auto DiscoveryWhen you are logged into an NAE through the Metasys systemextended architecture UI and that NAE is online to a network, you canautomatically discover field devices.

This procedure is not done through the SCT, however, the devices thatare discovered on the network and added to the NAE database can beuploaded to the SCT for archiving or editing.

Note: Using this procedure requires that the NAE be online andconnected to an N2 network. To connect to an N2 network, verify yourNAE is connected to the N2 bus via the N2 port. See Installing theNAE/NIE Technical Bulletin (LIT-1201161) for more information onwiring the NAE. See the Configuring the NAE Technical Bulletin(LIT-1201519) for information on configuring and accessing an NAE’sUI.

Page 35: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 35

To add N2 field devices online using auto discovery:

1. In the NAE UI, select Field Device on the Insert Menu. The InsertField Device Wizard Destination screen appears (Figure 13).

Figure 13: Insert Field Device Wizard (Online) - Destination Screen2. Select the N2 Trunk you want to map the field devices to and

click next. The Select Definition Mode Screen appears(Figure 14).

Note: The Assisted Mode and Invoke Auto Discovery options arenot available from the SCT. This method of discovering devices isdescribed here because the information discovered can be uploaded toan archive database in the SCT.

Page 36: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin36

Figure 14: Insert Field Device Wizard (Online) –Select Definition Mode Screen

3. Press the Invoke Auto Discovery button. The Auto Detect Utilitystarts (Figure 15).

Figure 15: Auto Detect Utility (Online Only)4. Select the device you want to map. If the device is already

mapped you are notified. If the device is not mapped, the InsertField Device Identifier screen appears (Figure 16).

Page 37: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 37

Figure 16: Insert Field Device Wizard (Online) – Identifier Screen5. Enter a unique identifier for the device and click Next. The Insert

Field Device Wizard’s Configure screen appears. This screen issimilar to the offline Insert Field Device Wizard’s configurescreen (Figure 11) except the information is based on a devicediscovered on the network.

6. Click Next. The Insert Field Device Summary screen appears.This screen is similar to the offline Insert Field Device Wizard’sSummary screen (Figure 12) except the information is based on adevice discovered on the network.

7. If satisfied with the Summary, click Finish (otherwise click Backand correct any problems). The object is created and you aregiven the opportunity to add extensions to the new controllerobject. See Adding Extensions to an Object in this document formore information.

8. When you have added all discovered devices, use the SCT toupload the NAE database to an archive database in the SCT.

Adding Extensions to an ObjectAdd trend, totalization, and alarm extensions to increase thefunctionality of a field device or field point object.

To add extensions to an object:

1. Select an object.

Page 38: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin38

Note: After creating a field device object or a field point object, theExtension Wizard automatically starts.

2. On the Action menu, select Show Extensions. The ExtensionWizard starts (Figure 17).

Figure 17: Extension Wizard3. To add Extensions, click the new button in the row next to the

type of extension you want to add and follow the prompts on theWizard that appears. See Adding a Resource File Extension,Adding a Trend Extension, Adding a Totalization Extension, orAdding an Alarm Extension in this document for moreinformation.

4. Follow the prompts on the screen to configure the extension andclick the Finish button when you are done. The Extension Wizardappears with the new extension listed in the appropriate row(Figure 18).

Page 39: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 39

Figure 18: Extensions Wizard With Extensions Added5. Click the Done button when finished. The Field Device Extension

screen opens (Figure 19).

Page 40: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin40

Figure 19: Field Device Extension Screen6. Add field points under the newly created controller object by

selecting the New button in the Field Points panel of the FieldDevice Extension wizard. See the Adding N2 Field Points to anArchive section for instructions on adding N2 points.

Adding a Resource File ExtensionThe resource file object extension is the most important extension tothe N2 controller objects. N2 configuration files are imported in theResource File Object wizard. These files provide predefined pointinformation that is used for the creation of N2 point objects in theInsert Field Point wizard. Resource files enable the Assisted pointdefinition mode in the Insert Point wizard. They also provide the viewinformation used in the Engineering view of the N2 Trunks. If theN2 device does not have a resource file extension, Assisted mode isnot available in the Insert Point Wizard.

When importing configuration files from HVAC PRO software, uselong format configuration files. Long format files contain unit and userinformation that is not present in the short format files.

Page 41: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 41

To add a resource file extension:

1. In the Extension Wizard, select the New button by the ResourceFile row. The Insert Resource File Wizard Select File screenappears (Figure 20).

Figure 20: Insert Resource File Wizard – Select File Screen2. Click the Browse button and locate the resource file to import to

the object. The default file type is based upon the file typeexpected for the controller object just created. For example, for aUNT controller, the default file type is .prn.

Note: After you select a file, the wizard validates the file based onthe controller type of the newly created object. If the selected file doesnot appear to be correct for the controller, a red error message appearsin the user text area of the resource file wizard showing the expectedcontroller type from within the selected file.

3. After you select a valid import file, click Next. The InsertResource Wizard’s Configure screen appears).

Page 42: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin42

Note: The description property shows the original file location andfile name of the selected import file as reference. The convertedExtensible Markup Language (XML) file based on the selected file isnot accessible to the user.

4. If the Configure screen looks correct, click Next. The InsertResource Wizard’s Summary screen appears.

5. Click Finish. The Extensions Wizard panel appears with the newResource File listed under Resource Files.

Adding a Trend ExtensionAdding trend extensions to objects allows you to create Trend Studiesto view historical data about items in the Metasys system extendedarchitecture. For more information on Trend Studies, see the Metasyssystem online help.

To add a trend extension:

1. In the Extensions screen select the New button in the Trend row.The Insert Trend Wizard Select Attribute screen appears(Figure 21).

Figure 21: Insert Trend Wizard - Select Attribute Screen

Page 43: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 43

2. Follow the prompts in the wizard to complete the addition of aTrend Extension.

Adding a Totalization ExtensionTo add a totalization extension:

1. In the Extensions screen select the New button in the Totalizationrow. The Insert Totalization Wizard Select Attribute screenappears (Figure 22).

Figure 22: Insert Totalization Wizard - Select Attribute Screen2. Select either event or a runtime totalization.

3. Select an object in the top half of the screen and an attribute in thebottom half and click Next.

Note: Display a list of attributes available by clicking the buttonlabeled other in the middle of the screen.

4. Follow the prompts in the wizard to complete the addition of aTotalization Extension.

Page 44: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin44

Adding an Alarm ExtensionTo add an alarm extension:

1. In the Extensions screen select the New button in the Alarm row.The Insert Alarm Wizard Select Attribute screen appears(Figure 23).

Figure 23: Insert Alarm Wizard - Select Attribute Screen2. Select an object you want to add the Alarm extension to in the top

half of the screen and an attribute in the bottom half and clickNext.

Note: Display a list of attributes available by clicking the buttonlabeled other in the middle of the screen.

3. Follow the prompts in the wizard to complete the addition of anAlarm Extension.

Page 45: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 45

Deleting Extensions From an ObjectTo delete extensions from an object:

1. Select a field device or a field point that contains extensions youwant to delete.

2. On the Action menu, select Show Extensions. The ExtensionWizard starts Figure 24.

Figure 24: Extension Wizard3. Check the boxes next to the extensions you want to delete.

4. Click the Delete button.

Note: Pressing the Delete button in any extension row only deletesthe checked extensions in that row. In the example in Figure 24 youwould have to click both the Resource delete button and the Alarmdelete button to delete both checked extensions.

5. Click Done when finished.

Page 46: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin46

Copying Extensions to a Field Device or Field PointTo copy extensions to a Field Device or Field Point:

1. Select a field device or a field point that contains extensions youwant to copy.

2. On the Action menu, select Show Extensions. The ExtensionWizard starts Figure 24.

3. Check the extensions that you want to copy and click the CopyChecked Extensions button at the bottom of the Wizard.

4. Click Done.

5. Select the field device or field point to which you want to addthese extensions.

6. On the Edit menu, select Paste. The copied extensions are addedto the Field Device or Field Point you have selected.

7. Drag the Field Device or Field Point to the right panel of thescreen to verify that the new extensions are correct (Figure 25).

Figure 25: Alarm and Resource Extensions Pasted into AHU-1

Page 47: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 47

Adding N2 Field Points to an Archive DatabaseTo add N2 field points to an archive database:

1. With the Archive Database open, select Field Points on the Insertmenu. The Insert Point Wizard Select Destination screen appears(Figure 26).

Figure 26: Insert Point Wizard - Select Destination Screen2. Choose a controller or folder in which to insert the new field

points and click Next. The Insert Point Wizard Select DefinitionMode screen appears (Figure 27).

Page 48: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin48

Figure 27: Insert Point Wizard - Select Definition Mode Screen3. There are two methods of adding field points. If you have created

a Resource file extension for the field device you are addingpoints to, then Assisted definition mode is available. OtherwiseAssisted mode is grayed out and your only choice for adding fieldpoints is manual mode. Depending on which mode you are using,see Adding Field Points Using Assisted Mode Definition orAdding Field Points Using Manual Mode Definition in thisdocument.

Adding Field Points Using Assisted Mode DefinitionIf you have created a Resource file extension for the field device youare adding points to, then assisted mode definition is enabled. Assistedmode definition is the fastest way to add field points to a field device.To add field points using assisted mode definition:

1. On the Insert Point Wizard’s Select Definition Mode screen(Figure 27) select the Assisted Mode radio button.

2. Press the Use Point Definition File button. The Point MappingUtility starts (Figure 28).

Page 49: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 49

Figure 28: Point Mapping Utility3. Select individual points to map by double-clicking them or click

the Map All button to map all available points from the file. Eachpoint that is mapped appears in the Points to Map panel on theright and is also marked with a green checkmark to show that it isa mapped point (Figure 29).

Figure 29: Point Mapping Utility with Several Points Mapped

Page 50: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin50

4. In the Point Mapping Utility you can edit information aboutindividual points in the Points to Map panel. You can also unmapindividual points by double-clicking the point in the middle panelor clicking the unmap all button. Selecting a folder in the middlepanel displays the points mapped from that folder in the Points toMap panel, while selecting the Field Device in the middle paneldisplays a summary of all points mapped to that device in thePoints to Map panel.

5. Click Next when you have mapped all desired points. The InsertPoint Wizard Summary screen appears (Figure 30).

Figure 30: Insert Point Wizard Summary Screen6. If satisfied with the Summary, click Finish, otherwise, click the

Back button and edit as needed.

Adding Field Points Using Manual Mode DefinitionTo add Field Points Using Manual Mode Definition:

1. On the Insert Point Wizard’s Select Definition Mode screen(Figure 27) select the Manual Mode radio button. The Insert FieldPoint Wizard switches to Manual Mode (Figure 31).

Page 51: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 51

Figure 31: Insert Field Point Wizard - Manual Definition Mode2. Select the type of point that you want to add and click Next. The

Select Data Source screen appears (Figure 32).

Note: The point information on the Data Source page ispre-configured, based on the object type selected in the SelectDefinition Mode screen. However, on the Data Source screen you canedit some properties of the point that cannot be edited in the Configurescreen. Depending on how many points of each type were added to acontroller, the values available in the drop down boxes changes soyour available selections are valid.

Page 52: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin52

Figure 32: Insert Point Wizard - Select Data Source Screen3. Edit the point properties as necessary and click Next. The Insert

Point Wizard Identifier screen appears (Figure 33).

Figure 33: Insert Point Wizard - Identifier Screen

Page 53: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 53

4. Enter a unique name for the new Field Point object. The defaultname is based on the object type of the new field point.

5. Click Next. The Insert Point Wizard Configure screen appears(Figure 34).

Figure 34: Insert Point Wizard - Configure Screen6. Review the Configuration and Hardware tabs. Edit if necessary

and click Next. The Summary screen appears (Figure 35).

Note: Properties edited in the Manual Point Data Source page arenot editable in the normal Configuration view of the object.

Page 54: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin54

Figure 35: Insert Point Wizard - Summary Screen7. The object type and naming parameters of the new point appear in

the Summary screen. When you click Finish, the object is createdand you are prompted to add extensions to the new point objectthrough the Extension wizard.

Exporting Part of an Archive Database to a FileTo export part of an archive database to a file:

1. Open an Archive.

2. On the Item menu select Export Item. The Export Archive Wizardstarts (Figure 36).

Note: The source must be at a level lower than a Site object. Youcannot export an entire site as an item.

Page 55: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 55

Figure 36: Export Archive Wizard - Source Screen3. Select the item to export and click Next. The Export Archive

Wizard Identifier screen appears (Figure 37).

Page 56: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin56

Figure 37: Export Archive Wizard – Identifier Screen4. Enter a unique name for your export file. This is the name that

appears in the Import Archive Wizard’s Select File screen(Figure 39).

5. Click Next. The Export Archive Wizard Summary screen appears(Figure 38). This screen displays the information that appearswhen the user presses the info button on the Import ArchiveWizard’s Select File screen.

Page 57: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 57

Figure 38: Export Archive Wizard – Summary Screen6. If the Summary appears correct, click Finish. Otherwise, click

Back and edit as necessary.

Importing Part of an Archive Database from a FileTo import part of an archive database from a file:

1. Open an archive database.

2. On the Item menu, select Import Item. The Import Wizard appears(Figure 39).

Page 58: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin58

Figure 39: Import Wizard3. Select the file you want to import and click the Import button. If

an item of the same name already exists, a dialog checks to verifythat you want to overwrite the existing item.

Note: Importing a file discards all change statuses from yourdatabase.

4. When the import is complete, the new item appears in yournavigation tree.

Backing up an Archive DatabaseTo back up an archive database:

1. Open an archive database.

2. On the Tools menu, select Database > Create Backup. A messageappears telling you that the backup was successful.

Note: Backups are saved as .zip files and stored in C:\Documentsand Settings\All Users\Application Data\JohnsonControls\MetasysIII\DatabaseFiles by default.

Page 59: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 59

Restoring an Archive DatabaseTo restore an archive database:

Note: The database backup file that you are going to restore mustbe in the following directory (the default directory for backing up anarchive database):

C:\Documents and Settings\All Users\Application Data\ JohnsonControls\MetasysIII\DatabaseFiles.

1. On the Tools menu, select Database > Restore Backup. TheRestore Archive Wizard appears.

Note: You can only restore a backup of a file that is not in use.Files that are in use are locked and unavailable.

2. Click Restore. The Confirm Delete and Replace message appears(Figure 40).

Figure 40: Confirm Delete and Restore Message3. Click Yes to Delete the current archive with the name selected in

Step 1 and replace it with the most recent backup of that archive.

4. Open the restored archive if desired. The version now available inthe Open Archive Wizard is the last version that was backed up.

Inserting a User ViewTo insert a user view:

1. Open an archive database.

2. On the Insert menu, select User View. The Create New UserNavigation Tree Wizard starts.

3. Follow the prompts on the screen to configure the MetasysServer. Refer to Table 8 for details.

4. Click Finish when you are done.

Page 60: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin60

Table 8: Insert User View WizardScreen PurposeDestination Select the site and user tree for the new user view.Identifier Enter a unique name for the User View. A unique name is required for each User View in a

site. By default the name of the object being entered has a number appended to keep itunique. Therefore, if adding a User View to a site for the first time, the default name is UserView1.

Configure Configuration information about the User View. Click on the Tree View tab to add and removereferences to the objects that you want to appear in your new User View. Organize your viewby adding folders to group your references according to your preferences. Note that the Roottree view or folder that you want to add a reference to must be selected for the AddReference button to work.

Summary View the basic parameters of the User View just added.

Launching Configuration Tools in Passthru ModeNote: N2 Devices are configured using Configuration Tools inpassthru mode in the SCT. To use the Configuration Tools in passthrumode, install Configuration Tools on the machine where you are usingthem.

To launch Configuration Tools in Passthru mode:

1. Open the archive database in the SCT or log in to the NAE.

2. On the Tools menu, select N2 Tools and the Configuration Toolthat you want to use. The selected tool opens in Passthru mode.

Note: If you are launching a Passthru session from the SCT, youare guided through a login sequence to log in to the Site Director thatcontains the devices that contain the N2 controllers.

Launching the LoaderUINote: To use the GX9100 tool in Passthru mode with the NAErequires changing some settings to launch the LoaderUI from theNAE.

To launch the Loader UI:

1. Change the default setting in the GX9100.INI file (located in theWindows operating system directory) that enables download andupload via NAE:[Settings]

NAEDownload=Yes

NAEExecutable=<path of the LoaderUI.exe program>

The default second line entry is:

NAEExecutable=C:\PROGRA~1\JOHNSO~1\SYSTEM~1\LOADERUI.EXE

Page 61: System Configuration Tool Technical Bulletin - Viking …vikingcontrols.com/_documents/product/1201534.pdf · System Configuration Tool ... Related Documentation ... some key differences

System Configuration Tool Technical Bulletin 61

Notes: The full path in M-Tool is: C:\Program Files \Johnson Controls \ System Tools\ Loaderui.exe

If System Tools is not installed in the default directory, specify thepath of the LoaderUI.exe program. If the NAEDownload entry is notpresent in the GX9100.INI file, or the entry is No, the Download viaNAE and Upload via NAE menu items do not appear in the Actionmenu.

If the [Settings] section is not present, add it, using squarebrackets as shown above.

2. Change the URL that defines the location of the Web Servicesrequired for Pass Through, to localhost.

3. From the Action menu, select Download via NAE or Upload viaNAE.

Refer to the Downloading and Uploading a DX Controller via an N30Supervisory Controller section of the GX-9100 SoftwareConfiguration Tool User’s Guide (LIT-6364060) for the rest of thesteps.

Controls Group507 E. Michigan StreetP.O. Box 423 www.johnsoncontrols.comMilwaukee, WI 53201 Published in U.S.A.