PDF

Table of Contents
Operator Workstation User’s

Manual
Chapter 1 Getting Started ...........................................................1-1
Introduction...................................................................................................... 1-1
Key Concepts................................................................................................... 1-2

OWS Overview...............................................................................................................1-2
Summaries .....................................................................................................................1-2
Database Generation .....................................................................................................1-2
Network Control Programs .............................................................................................1-2
Objects ...........................................................................................................................1-3
Attributes ........................................................................................................................1-3
Systems .........................................................................................................................1-3
PC Groups .....................................................................................................................1-4
Slide Show .....................................................................................................................1-4
Password .......................................................................................................................1-4
Network Map Overview ..................................................................................................1-4
Items on the Network Map .............................................................................................1-5
Global Alarm Indicator on the Network Map ..................................................................1-7
Menus ............................................................................................................................1-7
Logon Overview ...........................................................................................................1-11
Detailed Procedures...................................................................................... 1-12

Logging on to OWS......................................................................................................1-12
Logging off Operator Workstation ................................................................................1-13
© June 18, 2004 Johnson Controls, Inc.

2 Tools
Chapter 2 Using the Network Map ......................................................2-1
Introduction...................................................................................................... 2-1
Key Concepts................................................................................................... 2-2

System Peek ..................................................................................................................2-2
Active Network ...............................................................................................................2-2
Window Options .............................................................................................................2-2
Window Size ..................................................................................................................2-3
Object Penetration .........................................................................................................2-3
Display Expanded ID......................................................................................................2-3
Detailed Procedures........................................................................................ 2-5

Filtering the Network Map ..............................................................................................2-5
Displaying the Expanded IDs .........................................................................................2-6
Setting Window Options .................................................................................................2-7
Activating a Network ......................................................................................................2-7
Chapter 3 Setting the Calendar ...........................................................3-1
Introduction...................................................................................................... 3-1
Key Concepts................................................................................................... 3-2

Time and Day Clock Overview .......................................................................................3-2
Schedule Calendar.........................................................................................................3-3
Daylight Saving Time .....................................................................................................3-3

Setting the Time and Day Using a Dial-Up PC ..............................................................3-4
Using the Schedule Calendar ........................................................................................3-5
Setting the Time and Day Clock.....................................................................................3-6
Setting Daylight Saving Time .........................................................................................3-8
Troubleshooting .............................................................................................. 3-9

Autoexec.bat ..................................................................................................................3-9
Chapter 4 Displaying Online Summaries ...........................................4-1
Introduction...................................................................................................... 4-1
Key Concepts................................................................................................... 4-2

Table of Contents 3
Online Summary Types..................................................................................................4-2

Types of Online Summaries...........................................................................................4-3
Access Cards Summary.................................................................................................4-4
Alarm Summary .............................................................................................................4-5
Critical Summary ............................................................................................................4-6
Disabled Summary.........................................................................................................4-7
Fire Object Input Device Summary ................................................................................4-7
Fire Object Output Device Summary .............................................................................4-9
Follow-Up Summary.....................................................................................................4-10
IP Address Configuration Summary .............................................................................4-11
Limits Summary ...........................................................................................................4-12
Lockout Summary ........................................................................................................4-13
N2 Dial Network Summary ...........................................................................................4-14
Offline Summary ..........................................................................................................4-15
Override Summary .......................................................................................................4-16
Schedule Summary......................................................................................................4-17
Standard Summaries ...................................................................................................4-18
Trouble Summary.........................................................................................................4-22
Utility Profile .................................................................................................................4-23
List Selected Items.......................................................................................................4-24

Displaying Online Summaries ......................................................................................4-25
Displaying Fire Object Input Device Summaries ..........................................................4-26
Displaying Fire Object Output Device Summaries .......................................................4-28
Displaying Standard Network, PC Group, or System Summaries................................4-28
Displaying the N2 Dial Network Summary ...................................................................4-29
Displaying the IP Address Configuration Summary .....................................................4-29
Printing Fire Object Input and Output Device Summaries............................................4-30
Changing the Display Order of an Access Card Summary ..........................................4-30
Chapter 5 Displaying Archived Summaries .......................................5-1
Introduction...................................................................................................... 5-1
Key Concepts................................................................................................... 5-2

Archived Summaries ......................................................................................................5-2
4 Tools
Operator Transaction Summary .....................................................................................5-3

Card Reader Summary ..................................................................................................5-6
Reports Destination Summary .......................................................................................5-8
Summary Management..................................................................................................5-9
Query Information ........................................................................................................5-10

Displaying the Reports Destination Summary..............................................................5-11
Clearing Archived Summary Reports ...........................................................................5-11
Saving Archived Summaries ........................................................................................5-12
Purging Archive Summaries.........................................................................................5-15
Restoring Archived Summaries....................................................................................5-15
Displaying Restored Summaries ..................................................................................5-17
Deleting Summaries from the ARCHIVE Directory ......................................................5-18
Setting Summary Limits ...............................................................................................5-18
Displaying the Operator Transaction or Card Reader Summaries...............................5-20
Chapter 6 Displaying Drawings...........................................................6-1
Introduction...................................................................................................... 6-1
Key Concepts................................................................................................... 6-2

Drawings Overview ........................................................................................................6-2
Monitor Facility Conditions .............................................................................................6-2
Handles ..........................................................................................................................6-3

Displaying Drawings.......................................................................................................6-4
Chapter 7 Managing Alarms and Change-of-State Reports .............7-1
Introduction...................................................................................................... 7-1
Key Concepts................................................................................................... 7-2

Alarm and COS Reports ................................................................................................7-2
Report Types..................................................................................................................7-2
Report Destinations........................................................................................................7-2
Critical Reports...............................................................................................................7-3
Archiving COS and Alarm Histories ...............................................................................7-3
Table of Contents 5
Critical Alarm Warning Box ............................................................................................7-3

Critical Alarm Reminder Box ..........................................................................................7-5
Critical Summary ............................................................................................................7-5
Follow-Up Summary.......................................................................................................7-7
Change the Priority of Follow-Up Reports......................................................................7-8
Alarm Summary .............................................................................................................7-9
Trouble Summary.........................................................................................................7-10
Status Summary...........................................................................................................7-11

Displaying Online Summaries ......................................................................................7-13
Printing Online Summaries ..........................................................................................7-13
Filtering and Sorting Online Critical and Follow-Up Summaries ..................................7-14
Displaying Archive Summaries ....................................................................................7-16
Moving a Critical Report to the Follow-Up Summary ...................................................7-16
Changing the Reminder Time ......................................................................................7-16
Disabling or Enabling the Alarm Horn ..........................................................................7-17
Changing the Display Settings .....................................................................................7-17
Clearing Archived Critical Reports ...............................................................................7-18
Changing Priority of Follow-Up Reports .......................................................................7-18
Annotating Follow-Up Reports .....................................................................................7-19
Chapter 8 Commanding Objects .........................................................8-1
Introduction...................................................................................................... 8-1
Key Concepts................................................................................................... 8-2

Commands.....................................................................................................................8-2
Operation Commands ....................................................................................................8-2
Communication Commands ...........................................................................................8-4

Performing an Operation Command ..............................................................................8-5
Making Adjustments on Analog Input Devices ...............................................................8-5
Performing a Communication Command .......................................................................8-6
Chapter 9 Scheduling Commands and Summaries ..........................9-1
Introduction...................................................................................................... 9-1
6 Tools
Key Concepts................................................................................................... 9-2

Scheduling .....................................................................................................................9-2
Assigning Different Schedules .......................................................................................9-2
Temporary Schedules ....................................................................................................9-2

Scheduling a Command.................................................................................................9-3
Copying a Schedule .......................................................................................................9-5
Scheduling Trend and Totalization.................................................................................9-6
Scheduling Summaries ..................................................................................................9-7
Scheduling Process Triggers .........................................................................................9-9
Scheduling Lighting Control Group (LCG) Events .......................................................9-10
Modifying Existing Schedules ......................................................................................9-11
Modifying DX-9100 Time Schedule Modules ...............................................................9-11
Clearing Schedules ......................................................................................................9-13
Printing a Summary of Schedules................................................................................9-13
Displaying a Summary of Schedules ...........................................................................9-14
Scheduling a Temporary Calendar Date ......................................................................9-14
Modifying a Calendar Date...........................................................................................9-15
Chapter 10 Using Object Focus Windows.......................................10-1
Introduction.................................................................................................... 10-1
Key Concepts................................................................................................. 10-2

Object Focus Windows ................................................................................................10-2
Types of Objects ..........................................................................................................10-2
History and Current Trend Charts ................................................................................10-3
Analog Object History and Current Trend Charts ........................................................10-3
Binary Object History and Current Trend Charts .........................................................10-4
Modify Attribute ............................................................................................................10-5

Displaying an Object Focus Window............................................................................10-6
Displaying the CS Object Focus Window.....................................................................10-6
Chapter 11 Using Online Help ..........................................................11-1

Table of Contents 7
Introduction.................................................................................................... 11-1
Key Concepts................................................................................................. 11-2

Online Help ..................................................................................................................11-2
Attribute Help ...............................................................................................................11-2
Using Operating Instructions........................................................................................11-3
Operator Help...............................................................................................................11-3
Task Help .....................................................................................................................11-3
Operating Instructions ..................................................................................................11-3
Feature Help (Metalink™).............................................................................................11-4
Modifiable and Non-modifiable Fields ..........................................................................11-4

Using Task Help...........................................................................................................11-5
Accessing Help for Modifiable Attributes......................................................................11-5
Accessing Attribute Help for Non-Modifiable Attributes................................................11-6
Displaying and Editing Operating Instructions .............................................................11-6
Writing a New Operating Instruction ............................................................................11-7
Chapter 12 Using Point History........................................................12-1
Introduction.................................................................................................... 12-1
Key Concepts................................................................................................. 12-2

Point History.................................................................................................................12-2
History Item and History Data Windows.......................................................................12-4

Displaying the Point History Item Window ...................................................................12-5
Displaying the History Item Window from a Window Displaying Objects .....................12-6
Displaying the History Item Window from a Reports Destination Summary.................12-6
Displaying the Point History Data Window ...................................................................12-6
Chapter 13 Using Totalization ..........................................................13-1
Introduction.................................................................................................... 13-1
Key Concepts................................................................................................. 13-2

Totalization...................................................................................................................13-2
8 Tools
Runtime or Event Totalization Dialog Box....................................................................13-3

Analog Totalization Dialog Box ....................................................................................13-4
Pulse Totalization Dialog Box ......................................................................................13-5
Totalization Value.........................................................................................................13-6
Totalization Data Table ................................................................................................13-6
Totalization Data Graph ...............................................................................................13-6

Displaying the Totalization Item Window .....................................................................13-7
Adding a Totalization Entry ..........................................................................................13-9
Beginning Totalization..................................................................................................13-9
Ending Totalization.......................................................................................................13-9
Resetting a Totalization Value ...................................................................................13-10
Modifying a Totalization Entry ....................................................................................13-11
Clearing a Totalization Entry ......................................................................................13-11
Clearing Selected Reports .........................................................................................13-11
Purging the File ..........................................................................................................13-12
Displaying the Totalization Data Window ...................................................................13-12
Archiving Totalization Data ........................................................................................13-13
Chapter 14 Using Trend ....................................................................14-1
Introduction.................................................................................................... 14-1
Key Concepts................................................................................................. 14-2

Trend............................................................................................................................14-2
Trend Item Window ......................................................................................................14-3
Trend Data Scales .......................................................................................................14-4
Scaling Trend Data ......................................................................................................14-5
Fast Trend....................................................................................................................14-5
Archiving Trend Data ...................................................................................................14-7

Displaying the Trend Item Window ..............................................................................14-8
Adding a Trend Entry ...................................................................................................14-9
Beginning Trend.........................................................................................................14-10
Ending Trend..............................................................................................................14-10
Table of Contents 9
Modifying a Trend Entry .............................................................................................14-10

Clearing a Trend Entry ...............................................................................................14-10
Displaying the Trend Data Window............................................................................14-10
Scaling Trend Data ....................................................................................................14-11
Activating Fast Trend .................................................................................................14-11
Archiving Trend Data .................................................................................................14-13
Clearing Archived Trend Data....................................................................................14-14
Chapter 15 Using Dial-Up with the NCM..........................................15-1
Introduction.................................................................................................... 15-1
Key Concepts................................................................................................. 15-2

Dial-Up .........................................................................................................................15-2
Dial-Up Window ...........................................................................................................15-3

Initiating a Call..............................................................................................................15-4
Canceling a Call ...........................................................................................................15-4
Ending a Call................................................................................................................15-4
Chapter 16 Using Dial-Up with the NDM..........................................16-1
Introduction.................................................................................................... 16-1
Key Concepts................................................................................................. 16-2

N2 Dial Network Summary ...........................................................................................16-2
Log Off the Metasys System ........................................................................................16-3

Displaying the N2 Dial Network Summary ...................................................................16-4
Refreshing the N2 Dial Network Summary ..................................................................16-4
Closing the N2 Dial Network Summary ........................................................................16-4
Dialing a Remote Site ..................................................................................................16-5
Disconnecting from a Remote Site...............................................................................16-6
Chapter 17 Online Generation Overview .........................................17-1
Introduction.................................................................................................... 17-1
Key Concepts................................................................................................. 17-2

10 Tools
Online Generation ........................................................................................................17-2

Minimum Database ......................................................................................................17-2
Detailed Procedure........................................................................................ 17-3

Performing Online Generation .....................................................................................17-3
Chapter 18 Defining Networks .........................................................18-1
Introduction.................................................................................................... 18-1
Key Concepts................................................................................................. 18-2

Network Definition ........................................................................................................18-2
Network Summary........................................................................................................18-2
Network Focus Window ...............................................................................................18-3
Network Activation .......................................................................................................18-4

Defining a New Network...............................................................................................18-5
Modifying a Network.....................................................................................................18-6
Deleting a Network.......................................................................................................18-7
Troubleshooting ............................................................................................ 18-8

Correcting Invalid Entries .............................................................................................18-8
Chapter 19 Defining Devices ............................................................19-1
Introduction.................................................................................................... 19-1
Key Concepts................................................................................................. 19-2

Devices Summary ........................................................................................................19-2
Device Focus Windows................................................................................................19-3
Default Report Destination ...........................................................................................19-3
Internet Protocol (IP) Address......................................................................................19-4
Unconfigured OWSs ....................................................................................................19-4

Defining a Device .........................................................................................................19-5
Modifying a Device Definition.......................................................................................19-7
Deleting a Device .........................................................................................................19-8
Defining or Modifying a Default Report Destination .....................................................19-8
Table of Contents 11
Deleting a Default Report Destination..........................................................................19-9

Setting Up or Modifying PC Ports ..............................................................................19-10
Modifying the IP Address of a Device ........................................................................19-12
Troubleshooting .......................................................................................... 19-14

Correcting Invalid Entries ...........................................................................................19-14
Chapter 20 Defining PC Groups .......................................................20-1
Introduction.................................................................................................... 20-1
Key Concepts................................................................................................. 20-2

PC Groups ...................................................................................................................20-2
PC Group Summary .....................................................................................................20-3

Defining a New PC Group............................................................................................20-4
Modifying the Expanded ID of a PC Group ..................................................................20-5
Deleting a PC Group ....................................................................................................20-5

Chapter 21 Defining Systems ...........................................................21-1
Introduction.................................................................................................... 21-1
Key Concepts................................................................................................. 21-2

Modifying a System ......................................................................................................21-2
System Display Order ..................................................................................................21-2
PC Groups ...................................................................................................................21-2

Defining a System ........................................................................................................21-3
Modifying a System ......................................................................................................21-5
Deleting a System ........................................................................................................21-6
Changing the System Display Order ............................................................................21-7
Moving a System to a New PC Group .........................................................................21-8

12 Tools
Chapter 22 Defining Software Models .............................................22-1
Introduction.................................................................................................... 22-1
Key Concepts................................................................................................. 22-2

Software Model Definition ............................................................................................22-2
Deleting a Software Model ...........................................................................................22-2
Print Options ................................................................................................................22-3
Software Model Summary ............................................................................................22-3

Defining a Software Model ...........................................................................................22-4
Viewing a Software Model............................................................................................22-7
Modifying a Software Model.........................................................................................22-8
Printing a Software Model ............................................................................................22-9

Chapter 23 Defining Objects ............................................................23-1
Introduction.................................................................................................... 23-1
Key Concepts................................................................................................. 23-2

Objects .........................................................................................................................23-2
Object Focus Window ..................................................................................................23-4
Object Display Order ....................................................................................................23-4
Online Help ..................................................................................................................23-4

Defining an Object........................................................................................................23-5
Deleting an Object........................................................................................................23-7
Changing the System Display Order of Objects...........................................................23-7

Chapter 24 Defining Passwords.......................................................24-1
Introduction.................................................................................................... 24-1
Key Concepts................................................................................................. 24-2

Password Definition .....................................................................................................24-2
Password Summary .....................................................................................................24-3

Adding a Password ......................................................................................................24-5
Modifying a Password ..................................................................................................24-7
Deleting a Password ....................................................................................................24-9
Chapter 25 Defining Report/Access Groups...................................25-1
Introduction.................................................................................................... 25-1
Key Concepts................................................................................................. 25-2

Report/Access Groups .................................................................................................25-2
Report/Access Group Summary ..................................................................................25-2
Default Report Destinations .........................................................................................25-3

Defining Report/Access Groups ...................................................................................25-4
Defining Destinations for a Report/Access Group........................................................25-6
Deleting a Destination ..................................................................................................25-8
Chapter 26 Creating Alarm Messages .............................................26-1
Introduction.................................................................................................... 26-1
Key Concepts................................................................................................. 26-2

Alarm Messages ..........................................................................................................26-2
Alarm Message Summary ............................................................................................26-2

Displaying the Alarm Message Summary ....................................................................26-3
Adding an Alarm Message ...........................................................................................26-3
Modifying an Alarm Message.......................................................................................26-4
Clearing an Alarm Message.........................................................................................26-5
Chapter 27 Defining Access Cards ..................................................27-1
Introduction.................................................................................................... 27-1
14 Tools
Key Concepts................................................................................................. 27-2

Access Cards Summary...............................................................................................27-2
Access Card Definition.................................................................................................27-3
Card Summary-Add Card Dialog Box ..........................................................................27-5
Superbase 4 Software..................................................................................................27-7
User Data Windows .....................................................................................................27-7
Photo and Signature Files..........................................................................................27-16
Emergency Files ........................................................................................................27-16
Displaying Access Controllers for an Access Card ....................................................27-16
User Definable Fields Titles .......................................................................................27-17
Detailed Procedures.................................................................................... 27-18

Displaying the Access Cards Summary .....................................................................27-18
Printing the Access Cards Summary .........................................................................27-19
Defining an Access Card............................................................................................27-20
Modifying an Access Card .........................................................................................27-23
Deleting an Access Card............................................................................................27-25
Defining User Data.....................................................................................................27-26
Modifying User Data...................................................................................................27-31
Modifying User Definable Field Titles.........................................................................27-32
Printing User Data......................................................................................................27-33
Quitting Superbase 4 Software ..................................................................................27-34
Displaying Access Controllers for an Access Card ....................................................27-34
Chapter 28 Defining Time Zones......................................................28-1
Introduction.................................................................................................... 28-1
Key Concepts................................................................................................. 28-2

Card Reader Time Zones.............................................................................................28-2
Binary Input Time Zone................................................................................................28-3
Access Card Time Zone...............................................................................................28-3
Time Zone Definition ....................................................................................................28-3

Defining a Time Zone...................................................................................................28-6
Modifying a Time Zone.................................................................................................28-7
Deleting a Time Zone...................................................................................................28-8

Printing a Time Zone Schedule....................................................................................28-9
Chapter 29 Uploading and Downloading Databases......................29-1
Introduction.................................................................................................... 29-1
Key Concepts................................................................................................. 29-2

Databases ....................................................................................................................29-2
NCM Upload.................................................................................................................29-3
NCM Download ............................................................................................................29-3
Global Upload ..............................................................................................................29-5
Global Download..........................................................................................................29-5
DSC8500 Download.....................................................................................................29-5
D600 Download............................................................................................................29-7
N2Open Download.......................................................................................................29-7
System 91 Download ...................................................................................................29-8
Upload/Download Summary ......................................................................................29-10

Performing a NCM Upload .........................................................................................29-13
Performing a NCM Download ....................................................................................29-13
Performing a DSC8500 Download .............................................................................29-15
Performing a D600 Access Controller Download .......................................................29-15
Performing an N2Open Download .............................................................................29-15
Performing a System 91 Download............................................................................29-16
Performing a Global Upload.......................................................................................29-18
Performing a Global Download ..................................................................................29-18
Aborting an Upload or Download ...............................................................................29-18
Clearing Upload and Download Status Lines.............................................................29-19
Chapter 30 Archiving CAL1 ..............................................................30-1
Introduction.................................................................................................... 30-1
Key Concepts................................................................................................. 30-2

Archiving CAL1 Files....................................................................................................30-2
16 Tools
DOS Command Options ..............................................................................................30-3

Modifying CAL1 Object Files........................................................................................30-3

Archiving CAL1 Object Files ........................................................................................30-4
Deleting CAL1 Object Files ..........................................................................................30-5

Common Errors............................................................................................................30-6
Chapter 31 Saving and Restoring Databases .................................31-1
Introduction.................................................................................................... 31-1
Key Concepts................................................................................................. 31-2

Saving Databases ........................................................................................................31-2
Restoring Databases....................................................................................................31-2
LOG Files .....................................................................................................................31-2
DOS Backup and Restore Utilities ...............................................................................31-3
Windows Backup and Restore Utilities ........................................................................31-4
Saving Files to Diskettes..............................................................................................31-4

Saving the Database....................................................................................................31-5
Restoring a Database ................................................................................................31-10
Chapter 32 Using Demand Limit/Load Rolling................................32-1
Introduction.................................................................................................... 32-1
Key Concepts................................................................................................. 32-2

Demand Limiting/Load Rolling Setup...........................................................................32-2
Load Group Focus Window..........................................................................................32-2
Utility Profile .................................................................................................................32-3
Commanding the Load Group Object ..........................................................................32-4
Online Help ..................................................................................................................32-6

Displaying the Load Group Focus Window ..................................................................32-7
Defining a Load Group Object......................................................................................32-7
Defining a Load ..........................................................................................................32-10

Modifying a Load........................................................................................................32-12
Deleting a Load ..........................................................................................................32-13
Displaying the Utility Profile........................................................................................32-14

Chapter 33 Using Diagnostics..........................................................33-1
Introduction.................................................................................................... 33-1
Key Concepts................................................................................................. 33-2

Network Diagnostics ....................................................................................................33-2
PC Diagnostics.............................................................................................................33-2
NC Diagnostics ............................................................................................................33-3
N2/L2/S2 Device Diagnostics Options .........................................................................33-9

Printing Network Diagnostics .....................................................................................33-10
Displaying PC Diagnostics .........................................................................................33-10
Displaying NC Diagnostics.........................................................................................33-11
Performing N2/L2/S2 Diagnostics ..............................................................................33-11
Updating Statistics .....................................................................................................33-12
Clearing Statistics ......................................................................................................33-12
Printing Diagnostics ...................................................................................................33-12
Chapter 34 Using Processes ............................................................34-1
Introduction.................................................................................................... 34-1
Key Concepts................................................................................................. 34-2

Process Programming Languages ...............................................................................34-2
Process Window ..........................................................................................................34-2
Process Disk Window ..................................................................................................34-3
Process Field Window..................................................................................................34-5
Process Focus Window................................................................................................34-6
Enabling and Disabling Processes...............................................................................34-7
Triggering Processes ...................................................................................................34-7
18 Tools

Displaying the Process Window...................................................................................34-8
Displaying a Process Focus Window ...........................................................................34-8
Adding a New Process.................................................................................................34-8
Importing an Existing Process......................................................................................34-9
Deleting Processes ......................................................................................................34-9
Editing a Process .........................................................................................................34-9
Printing Source and List Files ....................................................................................34-10
Disabling a Process ...................................................................................................34-10
Enabling a Process ....................................................................................................34-10
Compiling a Process ..................................................................................................34-10
Downloading a Process .............................................................................................34-12
Uploading a Process ..................................................................................................34-12
Triggering a Process ..................................................................................................34-12
Chapter 35 Editing Graphics ............................................................35-1
Introduction.................................................................................................... 35-1
Key Concepts................................................................................................. 35-2

Graphic Binding............................................................................................................35-2
Alarm Flashing .............................................................................................................35-2
Setting Colors...............................................................................................................35-2
Slide Show ...................................................................................................................35-3

Accessing Designer or DRAW .....................................................................................35-5
Unbinding Objects and Symbols ..................................................................................35-5
Binding Symbols and Objects ......................................................................................35-6
Setting Colors for a Symbol .........................................................................................35-9
Modifying a Bound Symbol ........................................................................................35-11
Deleting a Bound Symbol...........................................................................................35-11
Modifying the Slide Show Settings .............................................................................35-12
Chapter 36 Defining Queries ............................................................36-1
Introduction.................................................................................................... 36-1
Key Concepts................................................................................................. 36-2

Superbase 4 Software..................................................................................................36-2
Query Definition ...........................................................................................................36-2
Displaying a Query.......................................................................................................36-3
Query Title....................................................................................................................36-4
Query Output................................................................................................................36-5

Defining a Query ........................................................................................................36-13
Modifying a Query ......................................................................................................36-23
Deleting a Query ........................................................................................................36-24
Displaying a Query.....................................................................................................36-24
Printing a Query .........................................................................................................36-25
Saving a Query to a File.............................................................................................36-25
Exiting a Query...........................................................................................................36-25
Chapter 37 Defining Custom Applications......................................37-1
Introduction.................................................................................................... 37-1
Key Concepts................................................................................................. 37-2

Adding Custom Applications ........................................................................................37-2
CUSTMENU.INI ...........................................................................................................37-2

Setting Up Access to the Custom Applications Menu ..................................................37-4
Adding an Application to the Custom Applications Menu.............................................37-4
Modifying the Custom Applications Menu ....................................................................37-5
Deleting an Application from the Custom Applications Menu.......................................37-5
Starting a Custom Application......................................................................................37-5
Chapter 38 Defining Custom Summaries ........................................38-1
Introduction.................................................................................................... 38-1
Key Concepts................................................................................................. 38-2

Custom Summaries......................................................................................................38-2

20 Tools
Defining a Custom Summary .......................................................................................38-4

Copying a Custom Summary .......................................................................................38-6
Displaying a Custom Summary ....................................................................................38-7
Refreshing a Custom Summary ...................................................................................38-7
Printing a Custom Summary ........................................................................................38-7
Modifying a Custom Summary .....................................................................................38-7
Deleting a Custom Summary .......................................................................................38-8
Operator Workstation User’s Manual 1-1
Chapter 1
Getting Started
Introduction
This chapter explains Metasys® Operator Workstation (OWS)
concepts and how to log on and log off the OWS. This describes how
to:
• log on an OWS
• log off an OWS
Note: This section assumes the Metasys Building Automation
System (BAS) is installed and running. For information on
installing and commissioning Metasys software, refer to the
Operator Workstation Technical Bulletin (LIT-636013).
© November 1, 2001 Johnson Controls, Inc. www.johnsoncontrols.com

Code No. LIT-120165
1-2 Operator Workstation User’s Manual
Key Concepts
OWS Overview
The OWS is a graphics-based interface that provides advanced facility
management capabilities. The OWS gathers information from the
network and consolidates it into facility-wide reports and summaries.
Summaries
The OWS displays a variety of summaries. Each type of summary
focuses on a specific aspect of the facility. For example, an Override
summary lists objects in software or hardware override. A Critical
summary lists all alarms and changes-of-state defined as Critical report
types. Operators can schedule when summaries are printed.
Database Generation
The OWS archives data. For example, alarm histories, trend data, and
totalized values can be uploaded from the Network Control Modules
(NCMs) and stored in files at the workstation. Operators can view or
print the archived data from the workstation.
The OWS can create the initial database for a facility and edit an
existing database to accommodate additions or changes. Operators can
also use the OWS to download the databases into the NCMs.
Network Control Programs

Use the workstation to download the control processes that control the
operation of the facility. Create the processes on any Personal
Computer (PC) with Graphic Programming Language (GPL) or
JC-BASIC, then use the OWS to download them into the NCMs.
The workstation can connect to a network over the N1 Local Area
Network (LAN), or it can be connected to an NCM through a
dedicated serial port.
With a modem and phone line, operators can use one workstation to
control more than one remote network or control one network with
more than one workstation. These multiple workstations can act with
the same level of functionality, allowing for decentralized control
while retaining complete integration of information.
Objects
An object generally corresponds to an actual field point or control
process in the facility. For example, an object called RET-FAN might
correspond to a relay contact wired to a return air fan, control
processes (Proportional plus Integral plus Derivative [PID] loops or
routines created in GPL) and hardware such as the workstation itself, a
lighting controller, an NCM, or a printer.
The OWS allows operators to display detailed online information
about all the objects in a facility. Operators can monitor the current
value and status of objects and display point history, trend, and
totalization data. Operators can also command an object from any
window displaying the object and schedule commands to take place at
specific times.
Attributes
Each object has a number of attributes that characterize it. For
example, an object’s name, current value, and high alarm limits are all
attributes. Some attributes are assigned values when the object is
originally defined. For example, the object name is assigned in the
object’s Definition window. Other attributes reflect the realtime status
of the object. For example, the current value of the object is dynamic
data and changes according to field conditions and control processes.
View and modify attributes in Object Focus windows.
Systems
Objects are grouped together in systems. For example, all the hardware
and software objects related to the operation of one air handling unit
might comprise system AHU1.
To uniquely identify an object, the OWS uses both its system name
and object name. For example, AHU1\RET-FAN is the system\object
name of an object corresponding to a particular return air fan in the
AHU1 system. The entire Metasys system knows whether this fan is
On or Off because the continuously updating databases contain records
of current values and states for all objects. These records are kept
according to the object’s system\object name.
PC Groups
The PC group level of organization allows operators to group related
systems. For example, operators might want to group all systems from
one side of a facility in a PC group called WESTWING. A PC group
can contain systems or other PC groups. PC groups can be up to
three levels deep.
The PC group level is for the convenience of the operator only. Since
it is not global data, it is unique to the workstation where the group is
defined and is not used by the Metasys program to identify objects
(only system\object names are used to identify objects). However, PC
group names are included in change-of-state and alarm reports at the
workstation to help operators quickly locate the source of alarms.
Slide Show
When no one is currently logged on to the OWS, a slide show appears.
This slide show is a series of images that can represent a company
logo, or the buildings, floor plans, and equipment in your facility. Each
image is displayed for a defined period before the slide show cycles to
the next image. If a slide show is not defined, the Johnson Controls
logo appears on the screen, or an error message appears stating that no
slide show is defined.
Note: Critical Alarm messages display over the slide show.
However, operators must log on to respond to the alarms.
Password
Passwords protect the security of the BAS. The password determines
facility access. For example, if your password does not allow you to
command objects, the menu options for commanding objects are
unavailable.
Network Map Overview

A network consists of at least one NCM, all the devices connected to
this NCM and all the hardware and software objects associated with
these devices. The Network Map displays the organization of the most
recently activated network. The Network Map:
• displays the network, PC group, system, device, and PC file
• provides quick access to summary information within facilities
Figure 1-1: Example of a Network Map

Note: Since each facility is unique, your Network Map looks
different from this example.
When operators expand the Network Map, all the PC groups and
systems in the network appear. Filtering allows operators to view all
the systems within a network, regardless of their assigned PC group.
Items on the Network Map

Each item defined for the network is represented on the Network Map
with a button and the item’s name. Table 1-1 explains the items.
Table 1-1: Items on the Network Map

Item Description
PC Group Displays all the PC groups within the specified network
System Appears as the lowest level on the Network Map
Devices Contains all the PCs, Network Control Modules (NCMs), and printers defined for the
network
PC File Report Contains a PC file report destination for archived BAS data including: critical, follow-up,
Destinations status, history, trend, totalization, operator transaction, and card reader
Systems Contains names of systems that have not been assigned to any particular PC group on
the network
The Network Map gives you quick access to facility information. It

displays all the PC groups, systems, N1 devices, and PC files in the
currently active network. The system level is the lowest level
displayed on the map (objects and attributes do not appear).
Each network, PC group, system, and device is represented by both a

button and a boxed-in name on the Network Map. Clicking on buttons
or names produces different effects, depending on the types of items
they represent. Table 1-2 shows what occurs when operators click or
double-click on each type of item represented on the Network Map.
Table 1-2: Using the Mouse with Buttons and Names on the Network Map
Item Action Result
Network Button Click Expands network to show each PC group within the network
Network Name Double-click Displays Network summary
PC Group Button Click Expands to show each PC group and system within the PC
group
PC Group Name Double-click Displays PC Group summary
System Button Click Displays System Peek dialog box
System Name Double-click Displays System summary
DEVICES Button Click Expands to show all of the devices defined for the network
DEVICES* Double-click Displays the Devices summary
Device Name Double-click Displays the device’s Focus window
PC File Name Double-click Displays the Reports Destination summary
SYSTEMS Button Click Displays all systems on the network that are not assigned to any
other PC group
SYSTEMS* Double-click Displays PC Group summary
* Actual text appearing on the Network Map
Global Alarm Indicator on the Network Map

If an object goes into alarm, the buttons for the network, PC group,
and system for the object turn red on the Network Map. For example,
if the object HDQTRS\NC44\AHU1\BI4 goes into alarm, the buttons
representing the network HDQTRS, the PC group NC44, and the
system AHU1 appear in red on the Network Map.
IMPORTANT: The button color indicates the last reliable state of the
object. If the object goes into alarm, and then goes
unreliable, the color of the Network/PC group/System
remains red, even if the object is no longer in alarm.
Note: The Alarm Indication feature is automatically enabled when
OWS software is loaded. To disable this feature, change the
line ENAALMIND=0 in the Metasys section of the
METASYS.INI file. Refer to the Initialization Parameters
Technical Bulletin (LIT-636345).
Menus
The Metasys software uses the same menu options in every
workstation window (Table 1-3). There are two exceptions: the Action
menu and the Network Map’s three additional menu bar options
(Summary, SetUp, and Exit).
The Action menu for each window contains options specific to that
window. For example, the Action menu in an Object Focus window
displays options for commanding an object. The Action menu in the
Trend Item window displays options for setting up the collection of
trend data.
Table 1-3: Network Map Menus

Menu Option Description
Item Menu
New Allows you to define new items such as new networks, PC groups, systems, or objects
Save Saves any changes you make in a window
File Transfer Transfers files from any OWS to another OWS on the network.
Note: The destination device cannot be the same as the source device (you cannot
transfer files to the same PC).
Print Prints the current contents of the window
Change Printer Changes the specified destination for printouts of summaries and screen displays
Delete Deletes the selected item
About Displays information about the workstation software, including a revision number and date
of release
Edit Menu
Copy Copies the selected text to the Clipboard
Paste Only applies to the Scheduling window. Used in conjunction with the Copy option, Paste
allows you to copy a schedule from one day of the week to another.
Cut Only applies to the Scheduling window. Used in conjunction with the Paste option, Cut
allows you to move a schedule from one day of the week to another.
View Menu
Show as Text Displays the PC group or system as a textual list of items rather than as a drawing. This
option also displays Trend and Totalization information as textual summaries rather than
as line or bar graphs.
Show as Displays the PC group or system as a drawing rather than as a textual list of items. This
Drawing option also displays Trend and Totalization information as line and bar graphs rather than
as textual summaries.
Sort The Sort option allows you to change the order in which items appear on the current
screen. Different windows have different sort options.
Note: The Sort function is different from the System/Object Display Order function. The
Sort function applies to the current screen display and is effective for only as long
as the screen is displayed. The System/Object Display Order function
permanently alters the order in which systems or objects appear in summaries
and printouts.
Filter Filters out items displayed on the current screen
Current Page Displays the current page
All Pages Displays all networks, PC groups, and systems on the Network Map
Actual Size Displays the drawing in actual size
Zoom Zooms in or out on the drawing
Action Menu
Diagnostics Initiates diagnostics on the selected network, N1 device (NCM, PC, printer), or N2/L2
device (for example, DCM, XM). For example, you can generate a printout of complete
network configuration data.
NC Download Downloads the archive NCM database into the selected NCM. An NCM must be selected
on the Network Map for this option to be available.
NC Upload Copies the operational NCM database to the archive NCM database. An NCM must be
selected on the Network Map for this option to be available.
Download Downloads the archive global database from the workstation to the operational global
Global Data database
Upload Global Copies the operational global database to the archive global database stored at the
Data workstation
Continued on next page . . .

(Cont.)
Action Menu (Cont.)
Archive Data Archives current Trend and Totalization data to the Trend and Totalization archive
summaries. Because Trend and Totalization are NCM-based, you must select a single
NCM to perform this function.
Print COS Provides on demand printing of Change-of-State (COS) messages. COS messages can be
Buffers buffered by number of messages and a specified time interval.
Go To Menu
Selected Item Displays the summary or Focus window of the selected item. A single item must be
selected for this option to be available. For example, if you select PC group in the Network
Map and then click Selected Item, the PC Group summary appears. If you select an object
in a System summary and click Selected Item, the Focus window for the object appears.
Schedule Displays the Scheduling window where you can schedule commands and summaries. A
single item must be selected for this option to be available.
Process Displays the Process window. In this window, you can download GPL and JC-BASIC
control processes. A single system must be selected for this option to be available.
Trend Displays the Trend Item window. In this window, specify how trend data is collected. A
single system or object must be selected for this option to be available.
Trend Data Displays the Trend Data window where you view collected trend data for selected objects.
The Trend Data option is available in the Trend Item window only.
History Displays the History Item window. In this window, select which objects to display in the
History Data window. A single system or object must be selected for this option to be
available.
History Data Displays the History Data window where you view the collected history data for selected
objects. The History Data option is available in the History Item window only.
Totalization Displays the Totalization Item window. In this window, select which objects to display in the
Totalization Data window. A single system or object must be selected for this option to be
available.
Totalization Displays the Totalization Data window where you view totalization data for selected
Data objects. The Totalization Data option is available in the Totalization Item window only.
Accessory Menu
Notepad Displays the Microsoft® Notepad application, which is a text editor
Clock Displays the Clock window
Control Panel Displays the Microsoft Control Panel application. Control Panel allows you to change the
time of day and date as displayed in the Clock, set the cursor speed, select screen colors,
and perform other basic setup functions.
Calculator Displays the Microsoft Calculator application. The Calculator provides basic math
functions.
Clipboard Displays the Microsoft Clipboard application. Detailed information on Clipboard is in your
Windows® operating system manual.
Custom Allows you to use other applications, such as Microsoft Excel or XTM Configurator Tool
Applications without closing the Metasys system. To open other software using this option, it first must
be added to the Custom Applications menu.
Summary Menu
Summary Displays a dialog box listing the available summary types. For many summaries, operators
must select a PC group or system on the Network Map before accessing the Summary
dialog box. The Summary option is available in the Network Map only.

(Cont.)
Setup Menu
Scheduling Displays the Scheduling Calendar, which allows operators to specify whether the days in a
Calendar calendar year are Regular, Alternate, or Holiday
Daylight Displays the Daylight Saving dialog box, which allows operators to specify when the
Saving workstation software will switch to daylight saving time
Password Displays the Password summary, which allows operators to set up and modify the
password database
N2 Dial Displays the N2 Dial Network summary, which lists all remote sites defined on the network
that are connected via the N2 Dialer Module (NDM). From this summary, operators can
dial out to an NDM remote site, disconnect from an NDM remote site, or refresh the
summary using the Action menu.
Network Displays the Network summary, which lists all the networks in the facility. From this
summary, operators can display a Network Focus window to view and modify network
configuration or a Network Definition window to add a new network to the facility.
Operators can also activate a network.
Report/Access Displays the Report/Access Group summary, which allows operators to define and modify
Groups report/access Groups 1-16.
Enhanced Displays the Enhanced Report/Access Group summary, which allows operators to define
Report/Access and modify report/access Groups 17-32
Groups
PC Displays the PC Configuration window, which allows operators to set up the ports on the
Configuration workstation the operators are using
IP Address Displays the Internet Protocol (IP) Address Configuration summary, allowing operators to
Configuration display and modify the IP addresses of directly connected N1 devices on the Ethernet
LAN.
Alarm Displays the Alarm Message summary. Since alarm messages are NCM-based, a single
Messages NCM must be selected on the Network Map for this option to be available. The Alarm
Message summary lists all alarm messages stored in the selected NCM and allows
operators to add, delete, and modify messages.
System/Object Displays the System/Object Display Order dialog boxes, which allows operators to
Display Order permanently alter the order in which systems and objects appear on the screen and
printed. This function differs from the Sort function because a Sort is only effective for the
currently displayed screen.
Modify Group Displays the Modify Group Assignment dialog box, which allows operators to move a
Assignment system from one PC group to another. Operators must select one system on the Network
Map for the option to be available.
Software Displays the Software Model summary that allows operators to define software models,
Models either new, or by copying an existing model
PC User Displays the PC User Options dialog box that allows operators to specify what windows
Options open when operators click on a Network Map item with a mouse, and what size the
windows will be. Operators can also choose to display expanded IDs for each item on the
Network Map using this dialog box.
Exit Menu
Logoff Logs operators off the workstation and displays the slide show. Metasys system continues
operating, and Critical Alarm messages appear on the screen to immediately inform
operators of Critical alarms. However, until operators log on again, the operator’s only
option is to acknowledge the alarm by clicking the Look Later button.
Program Displays the Program Manager. When operators click the Program Manager option, a
Manager dialog box appears, asking whether operators want to keep the Metasys BAS running.
Note: If operators choose to close the BAS when operators exit, the operator
transaction may not be received at all destinations before the BAS stops running.
If operators want to record the exit to program manager, leave the BAS running.

(Cont.)
Exit Menu (Cont.)
GPL Logs operators off, closes the workstation software, and accesses the Graphic
Programming Language (GPL) program. Only certain password levels are allowed to use
this option.
Designer Starts Micrografx® Designer™ software, either closing or leaving the BAS open, depending
on operator’s Metasys software
Backup Utility Starts the backup or restore utility. Submenus of the Backup Utility option allow operators
to choose either Backup Data or Restore Data.
Help Menu
Using Help Displays instructions for using online help
Attribute Help Displays help about the attribute which the operators are defining, modifying, or viewing.
This option is available in Definition and Focus windows only.
Operating Displays the operating instruction for the selected object in the Notepad Editor. Operators
Instructions can view or modify the instruction or create a new instruction for the selected object. The
object’s operating instruction number appears in the object’s Focus window. This number
corresponds to the Notepad Editor text file that contains instructions for the object.
Feature Help Displays the Feature Help submenu, allowing operators to access help on Metasys
Metalink™ applications
Logon Overview
The Logon dialog box accesses the Operator Workstation (OWS) and
the Metasys System. Passwords determine which functions and
systems operators can access.
When no operator is logged on, a slide show appears on the screen.
This slide show can be a company logo or a series of dynamic
graphical images that represent the operator’s facility. Alarm messages
appear on the screen over the slide show. During this time, the only
alarm action available is clearing the message from the screen. Logged
on operators can manage alarms and perform the functions allowed by
their passwords.
Figure 1-2: Slide Show with Critical Alarm Message

Detailed Procedures
Logging on to OWS
To log on to the OWS:
1. From the Windows Start menu, select
Programs > Johnson Controls > Metasys. The Logon dialog box
appears (Figure 1-3).
Figure 1-3: FMS Logon Dialog Box
2. Select a Network.
3. Enter your password.
Note: If 30 seconds elapse between mouse clicks or keystrokes
during the log-on process, the Logon dialog box
automatically disappears.
4. Click OK. The Network Map appears.
Logging off Operator Workstation

To log off the Operator Workstation:
1. On the Menu, click Logoff. The Network Map dialog box appears
(Figure 1-4).
Figure 1-4: Logoff Dialog Box
2. Click Yes or No.

Chapter 2
Using the Network Map
Introduction
This chapter explains how to use the Network Map. The chapter
describes how to:
• filter the Network Map
• display the expanded IDs
• set window options
• activate a network

Code No. LIT-120166
Key Concepts
System Peek
The System Peek option is unique to the Network Map. This option
allows you to view the objects within a selected system without having
to leave the Network Map to display a System summary.
Active Network
Use the Activate Network option to switch between networks. A
maximum of five networks can be active at one time, using any
variation of the following:
• one to five N1 Direct networks
• up to two NC Dial networks
• up to four Direct Connect networks
The Network Map displays the most recently activated network. You
can have more than one active network at a time. Complete
functionality (for example, commanding, scheduling) is available in all
activated networks.
Note: To deactivate an NC-Dial (modem or Integrated Services
Digital Network [ISDN]) remote network, use the Hang Up
option in the Dial-Up Window Control menu.
Window Options
Specify the following options with the PC User Options dialog box:
• window size
• object penetration
• close previous window when penetrating
• display expanded ID
When changing these options, they are saved only for your password.
When using a different password, the Metasys program uses either the
default options or the last chosen options linked to that password. The
options are saved for that Operator Workstation only. If the same
options are desired on another OWS, you must set the options using
that OWS.
Window Size
Setting the window size allows operators to specify the size of
Metasys windows and the manner in which they appear. If no setting is
chosen, the default is Full Width and Height. Table 2-1 describes the
three window size options.
Table 2-1: Window Size Options

Widow Size Description
Full Width and Full Allows viewing of Metasys screens covering almost
Height the entire width and height of your PC monitor. This
allows you to view the most information without having
to scroll.
Full Width and This option is not available at this time
Cascaded
Default Size and Order Allows the windows to appear in a smaller size and a
scattered fashion on your monitor. This is the default
setting.
Object Penetration
Allows specification of what type of window appears when
double-clicking on an object. Choose either To Focus Window or
Default Action. If no setting is chosen, the default is
To Focus Window.
Table 2-2: Object Penetration

Option Description
To Focus Window Allows viewing of detailed information about the object
Default Action Allows commanding of the object. The default action is
either operation or communication, depending on the
type of object. For software objects, the default setting
is Action-Operation. For hardware objects, the default
is Action-Communication.
Close Previous Window When Penetrating

Choosing Close Previous Window When Penetrating closes
one Metasys window when opening another. If no setting is chosen,
the default is To Focus Window.
Note: An X appears in the Close Previous Window When
Penetrating option box.
Display Expanded ID
Choosing Display Expanded ID allows the expanded ID for each item
on the Network Map to appear. The expanded ID appears to the right
of the item’s icon and name. If no setting is chosen, the expanded IDs
do not appear.
Detailed Procedures
Filtering the Network Map
To filter the Network Map:
1. On the View menu, click Filter. The Network Map-Filter dialog
box appears (Figure 2-1).
Figure 2-1: Network Map Dialog Box
2. Select the system name.

3. Click OK. The appropriate PC group is expanded, and the system
you selected is highlighted.
4. Click the system to go to the System Peek dialog box (Figure 2-2).
Figure 2-2: System Peek Dialog

Box
IMPORTANT: For Metasys software releases prior to Release 10.02,

click the Cancel button to close the System Peek
dialog box (do not click on the X in the upper right
corner). This prevents reporting problems with the
Global Alarm indicator on the Network Map.
Displaying the Expanded IDs

To display expanded IDs:
1. On the SetUp menu, click PC User Options. The PC User Options
dialog box appears (Figure 2-3).
2. Click the box to the left of expanded ID.
3. Click Save.
Figure 2-3: PC User Options Dialog Box
Table 2-3: PC User Options Parameters

Field Description
Full Width and Full Allows viewing of Metasys screens covering most of the entire width and height of
Height your PC monitor
Full Width and Allows viewing of Metasys screens covering most of the entire width of PC monitor
Cascaded
Default Size and Order Restores object to default size and order
To Focus Window Allows viewing of detailed information about the object
Default Action Allows commanding of the object. The default action is either operation or
communication, depending on the type of object. For software objects, the default
setting is Action-Operation. For hardware objects, the default is
Action-Communication.
Close Previous Closes one Metasys window when opening another. If no setting is chosen, the
Window When windows close when penetrating.
Penetrating
Display Expanded ID Displays the expanded ID of the object
On Map
Setting Window Options

To set window options:
1. On the SetUp menu, click PC User Options. The Network
Map PC User Options dialog box appears (Figure 2-3).
2. Select the desired settings. Refer to Table 2-3.
3. Click Save.
Activating a Network
To activate a network:
1. On the SetUp menu, click Network. The Network Summary
Figure 2-4: Network Summary
2. Click the desired network.

3. On the Action menu, click Activate Network. The Network Map

displays the newly activated network.
Note: When a network is activated, certain windows remain open.
This allows operators to have windows from up to
five different networks displayed on the screen at one time.
Complete functionality (for example, commanding,
scheduling) is available in all active networks. If the facility
has multiple dial-up networks defined, switching from one
dial-up network to another results in the first being
disconnected if there are no windows open for that network
(with the exception of the Network Map).
Chapter 3 Setting the Calendar
Introduction
The calendar allows operators to specify whether each day in a
12 month period is Regular, Holiday, or Alternate. This chapter
explains how to use the calendar. This chapter describes how to:
• set the time and day using a dial-up PC
• use the schedule calendar
• set the time and day clock
• set daylight saving time
© June 18, 2004 Johnson Controls, Inc. www.johnsoncontrols.com

Code No. LIT-120167
Key Concepts
Time and Day Clock Overview
The Clock appears in the lower right corner of the screen. The Clock
displays the following information:
• initials of the operator currently logged on
• password level of the operator (1 through 5)
• name of Workstation
• time
• type of day (Regular, Holiday, or Alternate)
• day of week and date
Figure 3-1: Time and Day Clock

Once the year is changed in the Windows® Date/Time window, it also
changes in the Johnson Controls Date/Time box, even if the operator
does not click OK. The date change is also propagated to all nodes on
the Metasys® N1 network. This affects date sensitive programs, like
M-Historian, on any of the workstations in the Metasys N1 network.
Changing the network time or date setting affects the entire network;
however, it does not affect other dial-up or direct connect networks.
If there is a JC/85 Gateway on the network, the JC/85/40 controls the
headend time and date for the network. The JC/85/40 synchronizes the
time once every 24 hours and when the JC/85 comes online, overriding
any time or date changes made with the Metasys system.
If the current year is a Leap Year, the calendar automatically adds a
29th day to February.
If a dial-up PC is used to change the network time or date setting, you

must use the Network Time/Date option in the Control menu, on the
Dial-Up window.
IMPORTANT: Changing the BAS time and date causes all scheduled
functions to execute according to the new time and
date.
Changing the time and day format does not affect the entire BAS.
Only the following are affected:
• the time and date displayed in the Clock on the workstation screen
• the time and date displayed on the Network Terminal (NT) screen
• the time and date displayed on printouts of summaries
• the time and date displayed in Focus windows
Schedule Calendar
The Schedule Calendar allows operators to specify whether each day
in a 12 month period is Regular, Holiday, or Alternate.
The Regular, Holiday, and Alternate settings are used by the
Scheduling feature. These different settings allow operators to have
three different schedules.
Daylight Saving Time

Where applicable, standard time is moved ahead one hour on the first
Sunday in April and moved back one hour on the last Sunday in
October. The time changes by one hour at 2:00 a.m. on the day you
specify.
IMPORTANT: If multiple networks are on one OWS, the system uses

the time settings from the last network on which a
person was logged on. Therefore, it is important to
change the daylight saving time on each network.
To avoid problems, keep all N1 devices, including workstations,
online all night on the night when the change to standard or daylight
saving time occurs.
Detailed Procedures
Setting the Time and Day Using a Dial-Up PC
To change the date and/or time:
1. Go to the Dial-Up window.
2. On the Control menu, click Network Date/Time. The Network
Date/Time dialog box appears (Figure 3-2).
Figure 3-2: Network Dial-Up Date and Time Dialog Box

3. Change the date and time as necessary.
4. Click OK. The new date and time are sent to the network.
Note: If the network time and/or date is not successfully passed
down to the network, or if the network time and/or date is
not successfully read, an error message appears.
Using the Schedule Calendar

To use the schedule calendar:
1. On the SetUp menu, click Scheduling Calendar. The Schedule
Calendar dialog box appears (Figure 3-3).
Figure 3-3: Schedule Calendar

2. Select the day. The day appears highlighted.
3. On the Action menu, click the type of day (Regular, Alternate,
Holiday).
Note: The abbreviation Alt or Hol appears on days that have been
specified as Alternates or Holidays. No abbreviation appears
on Regular days.
4. On the Item menu, click Save.
Setting the Time and Day Clock

To set the time and day clock:
1. On the Start menu, select Settings.
2. On the Settings menu, click Control Panel. The Control Panel
Figure 3-4: Control Panel

3. Double-click the Date/Time icon. The Date/Time Properties
Figure 3-5: Date/Time Properties Dialog Box

4. Change the date, time, or time zone.
5. Click OK.
Note: You must clear the Windows automatic adjustment for
daylight saving changes box. All Daylight saving changes
should be done with Metasys only.
Setting Daylight Saving Time

To set daylight saving time:
1. On the SetUp menu, click Daylight Savings. The Network
Map-Daylight Savings dialog box appears (Figure 3-6).
Figure 3-6: Map-Daylight Savings Dialog Box

2. Enter the date that daylight saving time occurs.
3. Click OK.
4. Perform a Global Upload to ensure that your changes are not lost
in the event of a global download before standard time is in effect.
Troubleshooting
Autoexec.bat
When transitioning from standard time to daylight saving time or vice
versa, it is possible that the time on the OWS and Network Control
Module (NCM) are not set correctly. This problem also occurs in time
zones that do not support daylight saving time. If you encounter this
problem, add the appropriate line from below to the Autoexec.bat file
on each workstation on the Metasys Network. After the change is
made, you must restart the OWS.
Table 3-1: Autoexec.bat Commands

Command Description
SET TZ=CST6 Central Standard Time
SET TZ=EST5 Eastern Standard Time
SET TZ=MST7 Mountain Standard Time
SET TZ=PST8 Pacific Standard Time
SET TZ=IND5 Indiana, a time zone that does not support daylight saving
time
SET TZ=ASTx All other time zones. See Note.
Note: For all other time zones, x is the time zone difference in
hours from Greenwich Mean Time (GMT). For example, in
Hawaii the command is SET TZ-AST10. In New Delhi, the
command is SET TZ=AST5:30.
Chapter 4
Displaying Online Summaries
Introduction
Operator Workstation allows summaries of all points and
limits to be quickly available. This also includes summaries
of all points that have been overridden, in alarm, disabled, or
locked out state. This chapter describes how to:
• display online summaries
• display Fire Object input device summaries
• display Fire Object output device summaries
• display password summary
• display standard network, PC group, or System
summaries
• display the N2 Dial Network summary
• display the IP Address Configuration summary
For information on archived summaries, refer to the
Displaying Archived Summaries chapter (LIT-120169).

Code No. LIT-120168
Key Concepts
Online Summary Types
Online summaries contain current information about
selected parts of the facility. Below are general rules that
apply to summaries:
• allow operators to go to a Focus window for an object by
double-clicking the object name
• allow commanding the objects using the Operation and
Communication options
• allow refreshing the data in the summary
• allow operators to change how items are listed in
summaries using the Sort and Filter options
• allow operators to display the PC group or system as a
drawing using Show as Drawing feature
Online summaries display current information about
selected parts of the facility. Access these summaries from
the Network Map Summary dialog box.
Types of Online Summaries

There are 18 different types of online summaries provided
with the Metasys system:
• Access Cards
• Alarm
• Critical
• Disabled
• Fire Object Input Devices
• Fire Object Output Devices
• Follow-up
• IP Address Configuration
• Limits
• Lockout
• N2 Dial Network
• Offline
• Override
• Password
• Schedule
• Standard
• Trouble
• Utility Profile
The online summaries listed above contain specific
information about the current status of a selected item or
items in your facility. Some of these summaries have
parallel archive summaries that contain the same type of
data, saved as a historical record in a PC file.
Other types of information concerning your facility include
Point History, Trend, and Totalization information.
Access Cards Summary

The Access Cards summary lists all access cards defined on
the network.
The Access Cards summary allows operators to add new
access cards to the database, modify the settings for existing
access cards, and delete access cards.
Figure 4-1: Access Card Summary
Table 4-1: Access Card Summary Fields

Field Description
Card ID Displays the unique number encoded on the card
Last Name Displays the last name of the card holder
First Name Displays the first name of the card holder
Card Issue Level Displays the number of times the same access card has been issued
Exec Privilege Indicates whether or not the holder has executive privilege
Alarm Summary
The Alarm summary lists all objects in the selected PC
group or system that are currently in an Alarm state. If an
object transitions out of alarm after the summary appears, it
appears in the next summary.
For the Alarm summary option to be available, a PC group
or system must be selected on the Network Map. The Alarm
summary displays objects from only one system at a time.
Figure 4-2: Alarm Summary
Table 4-2: Alarm Summary Fields

Field Description
Status Displays HA or LA if the object’s high or low alarm limits are exceeded,
and HW or LW if the object’s high or low warning limits are exceeded
Item Displays the name of the object in Alarm
Description Displays the expanded ID of the object
Value Displays the value of the object when the object went into Alarm. This
value does not automatically update.
Units Displays the engineering units (if the value is analog)
Critical Summary
The Critical summary lists all Critical reports sent to the
Operator Workstation. These are reports of alarms or
changes-of-state that are assigned the Critical report type
during object or feature definition.
Figure 4-3: Online Critical Summary
Table 4-3: Critical Summary Fields

Field Description
Type Displays the type of Alarm or the feature that generated the report
Time Displays the time the report generated
Date Displays the date that the report generated
Item Displays the PC group\system\object name of the object that
generated the report. When applicable, an attribute name follows the
object name
Value Displays the value of the object or attribute when the Critical report
was generated
Units Displays the engineering units if the value is analog
Attribute Displays an attribute name when applicable
Description Displays the expanded ID of the object that generated the report
Text Displays the message text associated with the report
Disabled Summary
The Disabled summary lists all objects in a selected PC
group or system that have communications disabled by a
Disable command. A Disable command inhibits the object
from triggering and from sending reports resulting from
changes-of-state. In addition, a disabled object cannot
receive commands, except for an Enable command, the
reverse of Disable.
The Disabled summary option is only available when a PC
group or system is selected on the Network Map.
The Disabled summary displays objects from one system at
a time (Figure 4-4).
Figure 4-4: Disabled Summary
Table 4-4: Disable Summary Fields

Field Description
Item Displays the name of the disabled object
Description Displays the expanded ID of the disabled object
Fire Object Input Device Summary

Input Device summaries provide detailed information about
analog input devices (detectors) and/or binary input devices
(modules). Operators can view either analog or binary
devices singly or both at once. You can also view devices in

a particular state, such as trouble or alarm.
Figure 4-5: Fire Object Input Device Summary
Table 4-5: Input Device Summary Fields

Field Description
Status Displays an asterisk (*) to indicate that the object is in an Off Normal
state
Description Displays the expanded ID (custom label) of the object (a maximum of
20 characters)
Application Displays the type of application the Input device is used
Value Displays the value of the input device
Analog Reading Displays the percent of the alarm threshold value
Verify Count Displays the number of times an analog input exceeds its alarm
threshold momentarily. If the device is binary or if Verify is disabled,
this field will be blank.
Default Sensitivity Displays the normal default sensitivity setting for an analog input
device
Verify Indicates if Verify Count is enabled (Y=Yes, N=No)
Day/Night Adjustment Indicates if Day/Night Adjustment of sensitivity is enabled (Y=Yes,
N=No)
Loop Displays the loop number within the IFC-2020 associated with the
device
Type Indicates whether the input device is a module (binary) or a detector
(analog) device
Address Displays the address of the input device on the loop
Device ID Displays the 4-character ID unique to the device
Fire Object Output Device Summary

Output Device summaries provide detailed information
about Binary Output devices (modules).
You can select devices in a particular state, such as devices
that are in a Trouble, Alarm, or On state, or you can view all
of the devices associated with the fire zone or IFC-2020.
Figure 4-6: Fire Object Output Device Summary
Table 4-6: Fire Object Output Device Summary Fields

Field Description
Status Displays an asterisk (*) indicating that the object is in an Off Normal
state
Description Displays the expanded ID (custom label) of the object (a maximum of
20 characters)
Application Displays the type of application the Output device is used for
(control or Form C)
Value Displays the value of the Input device (for example, Normal, Trouble,
or On)
Loop Displays the loop number within the IFC-2020 associated with the
device
Type Indicates that the Output device is a module binary device
Address Displays the address of the Output device on the loop
Device ID Displays the 4-character ID unique to the device
Follow-Up Summary
The Follow-Up summary lists all Follow-Up reports sent to
the Operator Workstation and all Critical reports that were
transferred from the Critical summary to the Follow-Up
summary. This summary lists alarms and changes-of-state
that are assigned the Follow-Up or Critical report type
during object or feature definition.
Figure 4-7: Follow-Up Summary
Table 4-7: Follow-Up Summary Fields

Field Description
Follow-Up Time and Displays the time and date that the Follow-Up report occurred or the
Date time and date that the report was transferred from the Critical
summary to the Follow-Up summary
Item Displays the PC group\system\object name of the object that
generated the report. When applicable, the attribute name follows the
object name.
Value Displays the value of the object when it generated the report
Attribute Displays the attribute name when applicable
Transferred By Displays the initials of operator who transferred report to Follow-Up
from Critical summary
Critical Alarm Time If the Follow-Up report was transferred from the Critical summary, the
and Date time and date that the Critical report occurred. This field is not
displayed in an archive Follow-Up summary.
Annotation Displays Yes if annotation has been created for the object
Text Displays the message text associated with the report, if applicable
Alarm Message Displays the Alarm message assigned to the object or feature when
the object or feature was defined
IP Address Configuration Summary

The IP Address Configuration summary displays the
IP address of all N1 devices on the network. Use this
summary to modify the IP addresses of all Ethernet devices
and devices connected to an Ethernet Router.
Figure 4-8: IP Address Configuration Summary
Table 4-8: IP Address Configuration Summary Fields

Field Description
Item Displays the name of the Ethernet or ARCNET® device
Description Displays the expanded ID of the Ethernet or ARCNET device
Subnet Address Displays the subnet address that was defined for the device when it
was created
Node Address Displays the node address that was defined for the device when it
was created
IP Address Displays the Ethernet IP address. For ARCNET devices connected
through an Ethernet Router, the IP address is the IP address of the
Ethernet Router.
Limits Summary
The Limits summary lists the defined limits for all Analog
Input (AI), Analog Data (AD), and Annunciator Control
Module) ACM objects in the selected PC group or system.
Limits are defined through Operation commands at the
Operator Workstation or NT, and in GPL and JC-BASIC
processes.
The Limits summary option is only available when a PC
group or system is selected on the Network Map. The Limits
summary displays objects from one system at a time.
Figure 4-9: Limits Summary
Table 4-9: Limit Summary Fields

Field Description
Item Displays the name of the object
High Alarm Displays the High Alarm limit determined by the Setpoint and
Normalband
High Warn Displays the High Warning limit determined by the Setpoint and
Normalband
Setpoint Displays the object’s Setpoint
Normalband Displays the object’s Normalband
Low Warn Displays the Low Warning limit
Low Alarm Displays the set Low Alarm limit
Differential Displays the set differential
Units Displays the object’s engineering units
Lockout Summary
The Lockout summary lists all the objects in the selected PC
group or system that are commanded to have either triggers
or reports locked out. An object is locked out with a
Communication command from an Operator Workstation,
NT, GPL, or JC-BASIC process.
The Lockout summary is only available when a PC group or
system is selected on the Network Map. The Lockout
Figure 4-10: Lockout Summary
Table 4-10: Lockout Summary Fields

Field Description
Status Displays RPT if reports are locked and TRG if triggers are locked
Item Displays the name of the locked out object
Description Displays the expanded ID of the locked out object
Value Displays the current value of the object when the Lockout summary is
accessed
Units Displays the engineering units of the locked out analog object
N2 Dial Network Summary

The N2 Dial Network summary displays the status of all
connections from the OWS to remote sites.
It is also used to dial a remote site or disconnect from a
remote site.
Figure 4-11: N2 Dial Network Summary
Table 4-11: Lockout Summary Fields

Field Description
Dial State Indicates that the local network dialed a remote site (Dial-Out) or a
remote site dialed in to the local network (Dial-In)
Remote Site Name Displays the name of the remote site as it was defined when
configuring the local NDM using HVAC PRO software. (This is not the
System/Object name.)
Telephone # Displays the phone number for the remote site defined when
configuring the local NDM using HVAC PRO software
Offline Summary
The Offline summary lists all objects in the selected PC
group or system that are currently offline.
The Offline summary is only available when a PC group or
system is selected on the Network Map. The Offline
Figure 4-12: Offline Summary
Table 4-12: Offline Summary Fields

Field Description
Item Displays the name of the offline object
Description Displays the expanded ID of the offline object
Override Summary
The Override summary lists all the objects in the selected
PC group or system that are currently in hardware or
software override. An object is overridden by an Operation
command performed at the workstation or NT (software
override), or at an NCM by use of manual switches
(hardware override).
The Override summary is only available, when a PC group
or system is selected on the Network Map. The Override
Figure 4-13: Override Summary
Table 4-13: Override Summary Fields

Field Description
Status Displays HW, if the object is in hardware override and SW if the object
is in software override
Item Displays the object name of the object in override
Description Displays the expanded ID of the object in override
Value Displays the current value of the object when the Override summary is
accessed
Units Displays the engineering units of the object in override if analog
Schedule Summary
The Schedule summary lists all the current summaries for
the item selected.
Figure 4-14: Schedule Summary

Standard Summaries
There are three types of Standard summaries: Network,
PC Group, and System. These summaries list all items in the
selected network, PC group, or system.
Standard Network or PC Group Summary

Standard summaries for networks and PC groups list the
same type of information (Name and Description). The
Standard Network summary lists only the PC groups in the
selected network, while the PC Group summary lists:
• PC groups within the network (but not the PC groups
within other groups)
• all systems not assigned to a PC group
• SYSTEMS PC group (which contains all systems that
were defined on another workstation). The SYSTEMS
PC group appears only when systems were defined at
another workstation.
Figure 4-15: Standard Network Summary

Figure 4-16: PC Group Summary
Table 4-14: Standard Network/PC Group Summary Fields

Field Description
Name Displays the name of the PC group for the Network summary and the
name of the PC group or system for the PC group summary
Description Displays the expanded ID of the Network or PC group
Standard System Summary

A Standard System summary lists all objects within the
selected system and displays information about the objects.
Figure 4-17: System Summary

Table 4-15: System Summary Fields

Field Description
Status Displays the current status of the object. The standard summary can
represent 16 different statuses. If an object has more than one status,
the status with the highest priority appears. Below are the statuses,
descriptions, and priority levels.
Status Priority Description
XTE 17 XT Error
DCT 16 Disconnected
OFF 15 Offline
UNR 14 Unreliable
HWD 13 Hardware Disabled
DIS 12 Communications Disabled
HWO 11 Hardware Override
SWO 10 Software Override
ALM 9 Alarm
HA 8 High Alarm
LA 7 Low Alarm
HW 6 High Warning
LW 5 Low Warning
TBL 4 Trouble
TRG 3 Triggers Locked
RPT 2 Reports Locked
SIL 1 Signals Silenced
Item Displays the name of the object.
Description Displays the expanded ID of the object.
Value Displays the current value of the object. For Analog Input objects, this
value updates every 20 seconds. Analog output and binary objects
update whenever there is a change-of-state.
Units Displays the object’s engineering units if analog.
Trouble Summary
The Trouble summary lists all Fire, Zone, Binary Input (BI)
(N2 Open, FPU BIF, BIS, and ST-102 only) objects
currently in trouble in a selected PC group or system,
regardless of the report type or report destination. If an
object transitions out of trouble, it does not appear in the
Trouble summary the next time the summary is displayed. If
the object goes into a state with a higher priority, it does not
appear in the Trouble summary.
The Trouble summary option is only available, when a PC
group or system is selected on the Network Map. The
Trouble summary displays objects only from one system at a
time.
Figure 4-18: Trouble Summary
Table 4-16: Trouble Summary Fields

Field Description
Status Displays the status of the object. The only status for this summary is
Trouble (TBL)
Item Displays the name of the object in Trouble
Value Displays the value of the object when the object was displayed. This
value does not automatically update.
Units Displays the engineering units (if the value is analog). For the Trouble
summary, this field is always blank.
Utility Profile
The Utility Profile lists Load Group objects defined for the
Demand Limiting/Load Rolling (DLLR) feature and
displays information about their energy consumption in the
current and previous periods. Select a PC group or system
on the Network Map before accessing the Utility Profile.
Figure 4-19: Utility Profile

Notes: The information in the Utility Profile cannot be
changed.
The Utility Profile displays the system\object
name and expanded ID of the Load Group object.
Table 4-17: Utility Profile Fields

Field Description
Status Displays the Load Group’s current status: Normal or Alarm
Current Period Displays the date and time the current period began. Total
Consumption displays the amount of energy that has been consumed
during the current period. The Peak field displays peak interval
demand, and date and time of the peak. The Projected Peak field
displays the projected peak interval demand, and the date and time of
the projected peak.
Previous Period Displays the total consumption, peak, and projected peak for the
previous period
List Selected Items

The List Selected Items option in the Summary dialog box
lists all the items you have selected on the Network Map.
For example, if you select three PC groups and four systems
on the Network Map, the List Selected Items screen appears
as shown in Figure 4-20.
Figure 4-20: List Selected Items

Detailed Procedures
To display an online summary:
1. Select a PC group or system.
2. Click Summary. The Network Map-Summary dialog
Figure 4-21: Network Map-Summary Dialog Box

3. Select the summary name.
4. Click Display. The Disable Summary appears for the
selected object (Figure 4-22).
Figure 4-22: Disabled Summary Dialog Box
Displaying Fire Object Input Device Summaries

To display the Fire Object Input Device summaries:
1. Click Fire Controller. The Fire Controller Focus
window appears.
2. Select Input Devices. The Filter-Input Devices dialog
Figure 4-23: Filter-Input Devices Dialog Box

3. Select desired scope and criteria.
4. Click Display. The Input Devices summary appears.
Displaying Fire Object Output Device Summaries

To display the Fire Output Device summaries:
1. Select the desired Fire Controller. The Fire Controller
Focus window appears.
2. Select Output Devices. The Filter-Output Devices
Figure 4-24: Filter-Output Devices Dialog Box

3. Select the desired criteria.
4. Click Display. The Output Devices summary appears.
Note: The device summary is disabled until the data has
been collected but the ability to work in other
windows is still available.
Displaying Standard Network, PC Group, or System

Summaries
To display a Standard Network, PC Group, or System
summary:
1. Select the Network, PC Group, or System.
2. On the GoTo menu, click Selected Item. The Standard
summary appears (Figure 4-25).
Figure 4-25: Standard Summary Dialog Box
Displaying the N2 Dial Network Summary

To display the N2 Dial Network summary:
On the Setup menu, click N2 Dial. The N2 Dial Network
Figure 4-26: N2 Dial Network Summary Dialog Box
Displaying the IP Address Configuration Summary

To display the IP Address Configuration summary:
On the Setup menu, click IP Address Configuration. The
IP Address Configuration summary appears (Figure 4-8).
Printing Fire Object Input and Output Device Summaries

To print Fire Object Input or Output Device summaries:
1. On the Fire Controller Focus window, click Input
Devices or Output Devices. The Input (Figure 4-5) or
Output Filter (Figure 4-6) dialog box appears.
2. Select the desired data.
3. Click Print.
Changing the Display Order of an Access Card Summary

To change the order of an access card data display:
1. Display the Access Card.
2. On the View menu, click Filter. The Card
Summary-Filter cards dialog box appears (Figure 4-27).
Figure 4-27: Card Summary-Filter cards Dialog Box

3. Edit the fields. Refer to Table 4-18.
Table 4-18: Access Card Filter Parameters

Field Description
Card Number Displays summary of currently defined cards beginning with the card
number you specify. If the filter settings are not changed, the summary
displays card number starting with the lowest.
Card Holders Last Displays summary of currently defined cards by the specified last
Name name. If unsure how to spell a last name, type as much as possible
and then type an asterisk (*) at the end. If unsure about a specific
letter in a sequence of letters in the last name, type a
question mark (?).
4. Click Display. The Access Card summary appears with

the data displayed in the specified order.
Chapter 5
Displaying Archived Summaries
Introduction
Archive Summaries are archived BAS reports maintained in a PC file
called a Reports Destination summary. The Reports Destination
summary displays archived data. This chapter describes how to:
• display the Reports Destination summary
• clear archived summary reports
• save archived summaries
• purge archived summaries
• restore archived summaries
• display restored summaries
• delete summaries from the archive directory
• set summary limits
• display the Operator Transaction or Card Reader summaries
For more information about online summaries, refer to the Displaying
Online Summaries chapter (LIT-120168).

Code No. LIT-120169
Key Concepts
Archived Summaries
Some archive report summaries have parallel online summaries.
Table 5-1 lists some of the archived summaries. The archived
summaries display the same type of information that the online
summaries display, but the information is archived data from the PC
file rather than online data from the NCM. Therefore, any online
information is not included in archive summaries. The Metasys®
system provides three different types of archived summaries:
• Operator Transaction
• Card Reader
• Reports Destination
Table 5-1: Archived Summaries with Parallel Online

Summaries
Summary Description
Critical Summary Displays all critical reports received by the PC file
Follow-Up Summary Displays all follow-up reports received by the PC file
History Summary Displays all History reports received by the PC file
Trend Summary Displays all Trend reports received by the PC file
Totalization Summary Displays all Totalization reports received by the PC file
Status Summary Displays all Status reports received by the PC file
Archive summaries display data in the PC file that has been defined as
a destination for the reports. Access these summaries from a PC file
Reports Destination summary. The PC file names are displayed at the
bottom of the Network Map. Double-click the PC file name to display
its Reports Destination summary. Refer to Table 5-2 to manage alarms
and COS:
Table 5-2: Summaries to Manage Alarms and COS

Summary Description
Critical Online summary or archive PC file summary
Follow-Up Online summary or archive PC file summary
Alarm Online summary only
Trouble Online summary only
Status Archive PC file summary only
Transaction Archive PC file summary only
Operator Transaction Summary

The Operator Transaction summary lists all of the transactions
concerning the operation of your BAS (Figure 5-1). This summary
lists information involving four different types of transactions:
Reports, Logon, Feature, and Object. The Operator Transaction
summary displays one transaction per page.
Figure 5-1: Operator Transaction Summary

The Filter function allows operators to view records that meet specific
criteria. Operators are able to view the information in an Operator
Transaction summary using the Query function. Like the Filter
function, the Query allows operators to filter certain reports. Operators
can also select the field data that is displayed. Also, the data for each
report can be displayed on a single line, allowing you to view several
transaction reports on one screen.
Table 5-3: Operator Transaction Summary Parameters

Field Description
Transaction Type Displays the type of transaction that initiated the report. A number appears that
corresponds to the transaction type: 0 = Report, 1 = Logon, 2 = Object,
3 = Feature.
Location Displays the name of the PC file destination in which the transaction occurred. This
field is blank for all transactions except Report and Feature.
Group Displays the PC group in which the transaction occurred (NC-63). This field is
blank for all transactions except Feature, where a PC group is involved.
System Displays the name of the system in which the transaction occurred. This field is
blank for Logon transactions or if the Report, Object, or Feature transaction
involved a device.
Object Displays the name of the object for which the transaction was generated (for
example, RDR_01). This field is blank for Logon and Feature transactions.
Attribute Displays the name of the attribute for which the transaction was generated. This
field is blank for Logon transactions.
Access Level Displays the password level of the user that logs on, or the password level required
to perform a transaction
Device The name of the device where the transaction occurred (for example, PC_35)
Feature/Status Displays the value of the affected object or attribute (that is, Offline). For Report,
the field contains the value of the object in alarm for the report that is moved or
discarded. This field is blank for all other transactions.
Value Displays the engineering units if the object is analog. For Report, the field contains
the engineering units of the analog object in alarm for the report that is moved or
discarded. This field is blank for all other transactions.
Units Displays the initials of the operator who performed the transaction
Operator Displays the exact nature of the transaction (that is, object disabled)
Text Displays the original time and date that a Critical or Follow-Up alarm was
generated or moved to the Follow-Up summary
Original Timestamp Displays the original time and date that a Critical or Follow-Up alarm was
generated or moved to the Follow-Up summary
Types of Operator Transactions

There are four different types of operator transactions: Report, Logon,
Feature, and Object. When a transaction occurs, the transaction type
appears in the Type field of the Operator Transaction summary. Each
report type lists a specific type of information:
• Report—Lists all operator transactions that involve Critical
reports being discarded or moved to the Follow-Up summary, or
Follow-Up reports being discarded.
• Logon—Lists all valid and invalid attempts to log on the
Metasys system, as well as all logoff actions.
• Feature—Lists all transactions that involve commanding a feature
application.
• Object—Lists all transactions that involve commanding an object.
Notes: The Operator Transaction summary also includes reports
indicating transactions made at the IFC-1010/2020 Fire
Controller.
In order for these transactions to be monitored and recorded
at the workstation, Operator Transactions must have a
destination defined in the Access Report Group used, and the
Oper Report Enabled attribute must be set to Y in the
Fire Controller Focus window.
The operator transaction summary can also be displayed in a
standard summary (text) format, by editing the Metasys.ini
file and removing (or commenting out) the line:
OpTransView=SBRTS.EXE.
Card Reader Summary

The Card Reader summary provides information about all valid and
invalid transactions made at card readers (Figure 5-2). One report is
issued every time a card is inserted into the card reader.
Figure 5-2: Card Reader Summary

The Card Reader summary displays one transaction per page.
The Filter function allows operators to view only those reports that
meet specific criteria. For example, you can filter the summary so that
only those reports generated from a card reader with a normal status
appear.
View the information in a Card Reader summary using the Query

function. Like the Filter function, the Query allows you to filter certain
reports; operators can also select the field data that appears. The
displaying data for each report on a single line allows operators to
view several transaction reports on one screen.
Note: Do not insert an access card a second time if you do not gain
access immediately. A few seconds may elapse between the
time a card holder inserts an access card and the time when
access is granted. If the holder reinserts the card, both
transactions are recorded, even though the card holder
entered the building only once.
Table 5-4 details the Card Reader summary fields and the information
they provide.
Table 5-4: Card Reader Summary Fields

Field Description
Card Number Displays the number assigned to the access card used in the transaction
System Displays the name of the system from which the report was generated
Object Displays the name of the card reader that generated the report
Last Name Displays the last name of the user that the access card is assigned to
First Name Displays the first name of the user that the access card is assigned to
Status Displays the status of the card reader that generated the report (either Normal or
Abnormal)
Date Displays the date that the report was generated
Time Displays the time that the report was generated
Text Displays the exact transaction that occurred
Reports Destination Summary

The Reports Destination summary displays the archive summaries.
This summary appears at the bottom of the Network Map after
operators define a PC file as a report destination when defining
Report/Access Groups.
Table 5-5 details the fields in the Reports Destination summary and
the information they contain.
Table 5-5: Reports Destination Summary Fields

Field Description
Data Type Displays the type of report: Critical, Follow-Up, Status, History, Trend, Totalization,
Card Reader, and Transaction.
Records Displays the number of entries for each report type
Size Displays the size of the file in bytes
Date Displays the last date the summary file received an entry
Time Displays the last time the summary file received an entry
File Capacity Displays the maximum number of records that can be stored in the database.
When the File Capacity is reached, a critical alarm is issued at a priority level of
one. Once the maximum is reached, the database handles incoming reports
according to the setting in the Maximum File Capacity (MFC) Handling field. The
default is 15,000; however, it can be modified (up to 640,000) using the Setup
Options dialog box in the Action menu.*
This field only applies to Operator Transaction and Card Reader summaries. It is
blank for other summaries.
Warning Limit Displays the percentage of the database file capacity that is used before a Critical
alarm is issued at a priority level of two. The default is 80 percent.
Maximum File Displays the action taken when the Maximum File Capacity (MFC) is reached. If
Capacity (MFC) MFC Handling is set to Discard, incoming reports are discarded. If it is set to
Handling Replace, incoming reports replace reports already in the database on a First-In,
First-Out (FIFO) basis. Replace is the default.
Last Archive Displays the date and time when a summary was last archived to a floppy disk.
Default Destination Displays the name of the destination that will receive reports if the PC file cannot
receive the reports
*The default can be modified up to 64,000. In order to store 640,000 Operator Transaction records, 128 MB of
memory is required. For the Card Reader summary, 77 MB of memory is required to store 640,000 records.
Summary Management
Saving Archive Summaries
Two types of archive summaries can be saved to a floppy disk or tape:
the Operator Transaction summary and the Card Reader summary.
This allows operators to make a protected copy of a summary, as well
as clear the archive database for new Operator Transaction or Card
Reader reports.
The Operator Transaction or Card Reader summary is archived in a
two step process. First the summary is moved to the
\FMS\DATA\network\PCfilename\ARCHIVE directory on the hard
drive. Summaries are renamed according to the date and time they are
archived.
When you archive a summary, the name that the summary is
automatically given appears. Be sure to make note of the date and time
the summary was saved and the type of summary it is in case you want
to retrieve it later.
Once the transaction summary is moved to the ARCHIVE directory on
the hard drive, it is copied to the floppy disk or tape. This allows
collection of current Operator Transaction or Card Reader data in the
new summary while the old data is being saved to a floppy. This
prevents transaction summaries from being disabled for a long period
of time.
Purging Archive Summaries

Purging an archive summary allows operators to clear all of the reports
from a summary. The Operator Transaction, Card Reader, Trend, Point
History, and Totalization summaries can be purged.
Restoring Archived Summaries

Two types of archive summaries can be restored to a hard drive from a
floppy disk or tape: the Operator Transaction summary and the Card
Reader summary. This allows operators to recover a summary that was
deleted from the ARCHIVE directory during the archiving process.
Once the summary is restored, operators are able to view it. To restore
a summary, follow the directions appropriate for the Windows
software used to back up the summary.
Deleting Summaries from the ARCHIVE Directory

You can delete a summary that was saved or restored to the ARCHIVE
directory using DOS, the Windows® File Manager, or the Transaction
Main Menu in the Superbase® 4 program. To use the Disk Operating
System (DOS) or Windows File Manager, refer to the manuals or Help
that come with your DOS and Windows operating system software.
Setting Summary Limits

Two archive summaries, Operator Transaction and Card Reader, can
be managed by specifying the maximum number of records that can be
held in a summary and what action is taken when the maximum is
reached. This helps to ensure that important transaction information is
not lost when a database becomes full. Set the summary limits by
specifying File Capacity, Warning Limits, and Maximum File
Capacity Handling.
Query Information
The Query function maintains specific information from either Card
Reader or Operator Transaction summaries. Like the Filter function,
the Query allows operators to filter certain reports. Operators can also
select the field data that appears. Also, the data for each report can
appear on a single line, allowing operators to view several transaction
reports on one screen.
Detailed Procedures
Displaying the Reports Destination Summary
To display the reports Destination Summary:
Select the PC file name. The Reports Destination summary for the
selected PC file appears (Figure 5-3).
Figure 5-3: Reports Destination Summary
Clearing Archived Summary Reports

To clear archive summary reports:
1. Display a summary.
2. Select the desired report.
3. On the Action menu, click Clear Entry. The selected report is
deleted from the summary.
Saving Archived Summaries

Note: If you are using Windows 2000 Professional or Windows XP
Operating System (OS), use the Microsoft® Backup Utility.
A tape drive is required with this utility. Follow the
instructions that are appropriate for the version of
Windows software you are using.
Saving an Archive Summary Using Windows 2000

Professional or Windows XP Professional OS
To save an archive summary using Windows 2000 Professional or
Windows XP Professional OS:
1. Select Reports Destination. The Reports Destination summary
2. Select the desired summary type.
3. On the Action menu, click Archive File. The Archive File dialog
box appears.
Note: The file name is automatically given, based upon the date and
time of the archive command. Be sure to make note of the
time, date, and type of summary on the tape.
4. Write down the name of the archive .DBF file as it appears in the
Archive File dialog box.
Note: You need to know this name in order to select it for backup
in the Microsoft Backup window.
5. Click Archive. The Metasys system closes and the Windows
Backup window appears.
6. Click the check box next to the .DBF file name from Step 4.
\”Network Name”\”Transaction Filename”\ARCHIVE\
”Archive Filename”
Notes: “Network Name,” “Transaction Filename,” and “Archive
Filename” should be replaced with the actual name of the
network and files being backed up.
The subdirectory in which the files are located depends on
the two environment variables: where Metasys software was
installed (“FMSPATH”) and where the database is located
(“FMSDATA”).
7. Select Backup. The Backup Information dialog box appears.
8. Enter a name for the file.
9. Click OK. The backup begins.
10. When backup is completed, click OK.
Purging Archive Summaries

To purge an archive summary:
1. From the Network Map, select the Reports Destination file. The
Reports Destination summary appears.
2. Select the desired summary type.
3. From the Main Menu, select Action. The Action menu appears.
4. Select Purge File.
5. Click Purge. All of the reports in the file are deleted.
Restoring Archived Summaries

Restoring Archive Summaries Using the DOS Restore
Utility
To restore a summary using the DOS Restore Utility:
1. Click the Reports Destination file. The Reports Destination
2. On the Action menu, click Restore. The Restore File dialog box
Figure 5-4: Restore File Dialog Box

3. Type in the drive for the Restore From Drive field (A or B).
Note: If no drive is specified the default is A.
4. Type in the Archive File Name field.
Note: If no file name is entered, all files assigned to that particular
destination are restored.
5. Click Restore. The specified summary is restored to the hard
drive, and placed in the
\FMS\DATA\Network\PCfilename\ARCHIVE directory.
Restoring Archive Summaries Using Windows 2000

Professional or Windows XP Professional OS
1. Select Reports Destination. The Reports Destination summary
2. On the Action menu, click Restore. The Restore File dialog box
appears.
Note: You do not need to fill in any of the fields in the Restore File
dialog box when using the Microsoft Backup Utility with the
Windows program.
3. Click Restore. The Microsoft Backup window appears.
4. Click OK.
Displaying Restored Summaries

Note: To view a summary that has been archived to a floppy disk,
you must first restore it to the hard drive using the Restore
procedure discussed earlier in this document.
To display restored summaries:
1. On the Reports Destination summary, open the Operator
Transaction or Card Reader summary (depending on the type of
restored summary you want to view).
2. Click Cancel to close the current summary. The Transaction Main
Menu appears.
3. Click the Archive button. The Select Archive File dialog box
appears.
Note: Only the type of summary you have open appears in the
Select Archive File dialog box.
4. Select the desired summary.
5. Click OK. The summary appears.
Deleting Summaries from the ARCHIVE Directory

To delete summaries from the ARCHIVE directory:
1. On the Reports Destination summary, open the Operator
Transaction or Card Reader summary.
2. Click Cancel to close the current summary. The Transaction Main
menu appears.
3. Select Delete Archive. The Select Archive File dialog box appears
listing all of the archived Operator Transaction or Card Reader
summaries on the hard drive.
Note: Only the type of summary you have open appears in the
Select Archive File dialog box.
5. Click OK.
Setting Summary Limits

To set summary limits:
1. Display the Reports Destination summary (Figure 5-3).
3. On the Action menu, click File Setup. The summary’s File Setup
Figure 5-5: File Setup Dialog Box

4. Make desired modifications. Refer to Table 5-6.
Table 5-6: File Setup Parameters

Field Description
Data Type Displays the type of transaction
Characters per record Displays the number of characters
File Capacity Displays the maximum number of records the summary holds. The default is
15,000.
Warning Limit Displays the percentage of files recorded before a Critical alarm was issued at
priority Level 2. The default is 80 percent.
Maximum File Displays either Discard new reports or Replace oldest report with new report
Capacity Handling (FIFO) depending on selection in File Setup Dialog box (Figure 5-5).
Displaying the Operator Transaction or Card Reader Summaries

Note: Both the Operator Transaction and Card Reader summaries
are viewed using the Superbase 4 program.
Using the Browsing Controls

To use the browsing controls:
1. On the Access Card window, click the Access Cards button. The
Access Card summary appears (Figure 5-6).
Figure 5-6: Access Cards Summary Dialog Box

2. On the Action menu, click Modify Access Card. The Modify
Access Card dialog box appears.
3. Click User Data. The Employee Menu appears.
4. Click the Browse button. The browsing controls are activated.
Refer to Table 5-7.
?
browse
Figure 5-7: Browsing Controls

Table 5-7: Browsing Control Button Descriptions

Browse Button Icon Function
Pause Pauses a fast forward or rewind action when you want to stop to read the
screen while searching for a record. The space bar also activates this
button. Click Pause again to continue.
Stop Stops a fast forward or rewind action. Pressing the Ctrl and C keys at the
same time also activates this button.
First Displays the first record in the user data file, according to the current index.
The Home key also activates this button.
Rewind Displays the user data file, one record at a time, in reverse index order,
based on the current filter criteria. The Page Up key also activates this
button.
Previous Record Displays the user data record previous to the one currently displayed on
your monitor. The left arrow key also activates this button.
Current Record Redisplays the current record if the screen does not show any record data.
The up or down arrow keys also activates this button.
Next Record Displays the record in the user data file that follows the record that is
currently displayed (based on the current filter criteria). The right arrow key
also activates this button.
Fast Forward Displays the records in the user data file, according to the index order,
beginning with the record that is currently displayed and ending with the last
record in the file. The Page Down key also activates this button.
Last Displays the last record in the user data file, according to the current index.
The End key also activates this button.
Key Lookup Searches for an individual record based upon the value in the field by which
? the file currently is indexed.
Filter See the Using the Filter Function section later in this chapter.
Camera Toggles between displaying the contents of an imported file and the file
name.
Using the Filter Function

To use Filter function:
1. Click the Filter button. The Filter dialog box appears
(Figure 5-8).
Figure 5-8: Filter Dialog Box

1. Select the desired filter field.
2. Specify any limitations for your filter. Refer to Table 5-8.
Table 5-8: Operator Button Functions

Option Filter Function
= Displays a record with an exact value
<> Displays records excluding a specific value
< Displays values less than a specific amount
> Displays records with a value greater than a certain amount. For example, Card ID > 100
displays all records with Card IDs defined as 101 or more.
<= Displays records with a value less than or equal to a specific amount
>= Displays records with a value greater than or equal to a specific amount
( AND ) Displays records according to two expressions where one expression has higher priority
than the other
AND Displays records where two conditions are true
OR Displays records that meet one of two conditions
NOT Displays records with values that negate an expression
LIKE Displays a record with an exact value
+, -, *, / Buttons are used for mathematical computations of two or more numeric fields
Indexing Summary Data

To index summary data:
1. On the Superbase 4 Main Menu, click the desired user data button.
2. Click Index. The Index dialog box appears (Figure 5-9).
Figure 5-9: Index Dialog Box

3. Click the desired field to use as an index.
4. Click OK.
Exiting the Operator Transaction Summary

To exit the Operator Transaction summary:
1. Click Cancel to close the window. The Operator Transaction Main
menu appears.
2. Select Quit. The Superbase 4 program closes and returns to the
network map.
Exiting the Card Reader Summary

To exit the Card Reader summary:
1. Click Cancel to close the window. The Card Reader menu
appears.
network map.
Table 5-7: Browsing Control Button Descriptions

Browse Button Icon Function
Pause Pauses a fast forward or rewind action when you want to stop to read the
screen while searching for a record. The space bar also activates this
button. Click Pause again to continue.
Stop Stops a fast forward or rewind action. Pressing the Ctrl and C keys at the
same time also activates this button.
First Displays the first record in the user data file, according to the current index.
The Home key also activates this button.
Rewind Displays the user data file, one record at a time, in reverse index order,
based on the current filter criteria. The Page Up key also activates this
button.
Previous Record Displays the user data record previous to the one currently displayed on
your monitor. The left arrow key also activates this button.
Current Record Redisplays the current record if the screen does not show any record data.
The up or down arrow keys also activates this button.
Next Record Displays the record in the user data file that follows the record that is
currently displayed (based on the current filter criteria). The right arrow key
also activates this button.
Fast Forward Displays the records in the user data file, according to the index order,
beginning with the record that is currently displayed and ending with the last
record in the file. The Page Down key also activates this button.
Last Displays the last record in the user data file, according to the current index.
The End key also activates this button.
Key Lookup Searches for an individual record based upon the value in the field by which
? the file currently is indexed.
Filter See the Using the Filter Function section later in this chapter.
Camera Toggles between displaying the contents of an imported file and the file
name.
Using the Filter Function

To use Filter function:
1. Click the Filter button. The Filter dialog box appears
(Figure 5-11).

2. Select the desired filter field.
3. Specify any limitations for your filter. Refer to Table 5-8.
Table 5-8: Operator Button Functions

= Displays a record with an exact value
<> Displays records excluding a specific value
< Displays values less than a specific amount
> Displays records with a value greater than a certain amount. For example, Card ID > 100
displays all records with Card IDs defined as 101 or more.
<= Displays records with a value less than or equal to a specific amount
>= Displays records with a value greater than or equal to a specific amount
( AND ) Displays records according to two expressions where one expression has higher priority
than the other
AND Displays records where two conditions are true
OR Displays records that meet one of two conditions
NOT Displays records with values that negate an expression
LIKE Displays a record with an exact value
+, -, *, / Buttons are used for mathematical computations of two or more numeric fields
Indexing Summary Data

To index summary data:
1. On the Superbase 4 Main Menu, click the desired user data button.
2. Click Index. The Index dialog box appears (Figure 5-12).
Figure 5-12: Index Dialog Box

3. Click the desired field to use as an index.
4. Click OK.
Exiting the Operator Transaction Summary

To exit the Operator Transaction summary:
1. Click Cancel to close the window. The Operator Transaction Main
menu appears.
network map.
Exiting the Card Reader Summary

To exit the Card Reader summary:
1. Click Cancel to close the window. The Card Reader menu
appears.
network map.
Operator’s Workstation User’s Manual 6-1
Chapter 6
Displaying Drawings
Introduction
This chapter explains how to display the dynamic drawings that
represent the networks, PC groups, and systems in your facility. This
section explains how to:
• display drawings
Note: Micrografx Designer and Draw software are not supported at
Metasys Release 11.00 or later.

Code No. LIT-120170
Key Concepts
Drawings Overview
The Metasys Operator Workstation allows operators to display your
facility in both textual and graphical formats. Figure 6-1 shows a
System summary with an air handling unit as a textual list of objects.
Figure 6-2 shows a system drawing of the same system with graphical
symbols representing the objects.
AHU2 NCM Definition
Item Edit V iew Action Go To Accessory Help
HDQTRS
WEST
AHU2
Item Description Value

SFSST Supply Fan Start/Stop OFF
RFSST Return Fan Start/Stop OFF
SFSTAT Supply Fan Status OFF
RATEMP Return Air Temperature 71
Figure 6-1: AHU2 System Summary

Drawing - AHU2
DAMPERS RFSST RATEMP 71 DEG F
SFSST SPTEMP 72 DEG G

H
C
MIXTEMP 65 DEG F DISTEMP 90 DEG F

SFSTAT
DCM
Figure 6-2: AHU2 System Drawing
Monitor Facility Conditions

System drawings allow operators to monitor facility conditions
pictorially. The object’s current value appears next to the object
symbol. Analog Input objects update every 20 seconds. Analog Output
and Binary Input and Output objects update whenever there is a
change-of-state. Critical Alarm messages appear over the drawings,
immediately informing operators of alarms.
Handles
All Windows applications use up or consume Windows handles. Every
application uses handles, and 8,192 handles are available, including:
Windows operating system, Metasys software, and Metasys graphics.
The number of handles that each application uses is dependent on the
contents of the application. For example, an average graphic uses
around 500 Windows handles, although it may be more or less
dependent on the complexity of the drawing.
A graphic with a lot of objects uses more handles than a graphic with
just a few objects. Do not open several complex graphics that use a
large number of objects at one time. If you use up all of the available
handles, Windows operating system generates a General Protection
Fault and you must reboot the system.
Detailed Procedures
Displaying Drawings
To display drawings:
1. On the View menu, click Show as Drawing.
2. Select the desired system.
3. On the GoTo menu, click Selected Item. The system appears as a
drawing, displaying the current values and states of all bound
objects.
Note: If the drawing has not been modified, and only the default
symbols and default graphic binding settings are in effect, it
appears complete.
Chapter 7
Managing Alarms and

Change-of-State Reports
Introduction
This section tells you how to manage Alarm and Change-of-State
(COS) reports. This section includes:
• display online summaries
• print online summaries
• filter and sort online Critical and Follow-Up summaries
• display archive summaries
• print archive summaries
• acknowledge a report
• move a critical report to the Follow-Up summary
• discard a critical report
• change the reminder time
• disable enabling the alarm horn
• change the display settings
• clear archived critical reports
• change priority of follow-up reports
• annotate follow-up reports
• discard follow-up reports
• clear archived follow-up reports
• clear archived status reports

Code No. LIT-120171
Key Concepts
Alarm and COS Reports
The Metasys® system keeps operators completely informed about
every aspect of the facility. The Metasys system:
• records all Trouble, Alarm, and Change-of-State (COS) reports
• sends Trouble, Alarm, and COS reports to the appropriate
destinations
• prioritizes Trouble, Alarm, and COS reports
• informs operators of those Trouble and Alarm reports that might
need immediate attention
Reports are generated when an object enters a Trouble or Alarm state
or when the object changes state, even if it is not in Trouble or Alarm.
Alarm reports also cause the color of the network, PC group, and
system button in which the object is located to change to red.
Report Types
Alarm, Trouble, and Change-of-State reports can be assigned the
following report types: Critical, Follow-Up, or Status. If no report type
is specified, no report is generated.
For objects, specify the report type for Alarm, Trouble, and COS
reports in the object’s Definition or Focus window. For features,
specify the report type when you set up the feature.
Report Destinations
When defined, each system is assigned to one report group. The report
group specifies the destinations for each of the report types. When an
object in the system goes into Alarm or Trouble, or when an object
changes state, the report is sent to the destinations specified by the
system’s report group.
There are three report destinations: an OWS (PC), PC file, or printer.
An Operator Workstation can be a destination for Critical and
Follow-Up reports only. A printer can be a destination for Critical,
Follow-Up, Status, Operator Transaction, and Card Reader
Transaction reports. A PC file can be a destination for all report types.
COS messages can be sent to a buffer for on demand printing. Edit the
METASYS.INI file to specify the number of messages or a specified
time interval. See the Initialization Parameters Technical Bulletin
(LIT-636345) for more information.
If you are using a color printer, you can choose the color and style for
Critical, Follow-Up, Status, Operator Transaction, and Card Reader
Transaction reports. You can choose colors for reports, as well as
styles (Bold, Italic, and/or Shadow). The reports will be printed in
black and white with normal style unless you add any one of these
settings to the METASYS.INI file. For details, refer to the
Initialization Parameters Technical Bulletin (LIT-636345).
Critical Reports
A Critical report sent to an OWS generates a Critical Alarm Warning
message displayed on the workstation screen. This allows the operator
to respond immediately. In addition, the Critical report is sent to the
online Critical summary. This allows the operator to review the
Critical report at a later time and perform the appropriate Alarm
management functions as desired.
Archiving COS and Alarm Histories

A PC file contains archived reports (not online data from the NCM).
By assigning a PC file as a destination for Alarm and COS reports, you
can keep a history of all reports, ensuring that important information
about the alarms and COS in your facility is not lost.
Critical Alarm Warning Box

The Critical Alarm Warning box appears when an Alarm, Trouble, or
COS report with a Critical status occurs. The report must be assigned
as a Critical report type in the object’s Definition or Focus window,
and the workstation must be defined as a destination in the PC group’s
Report/Access Group Focus window. The highest priority and oldest
unacknowledged alarms are displayed first. An alarm that has been
acknowledged on one workstation still displays on other workstations
until it has been acknowledged on those workstations. If the alarm is
discarded or moved to the Follow-Up summary, it no longer displays
on any workstation.
When a Critical alarm is received, the Alarm Horn sounds and the
Critical Alarm Warning box appears over any window or application
except the Critical summary. However, if the Critical summary is
displayed and active, the Critical Alarm Warning box appears behind
the summary and the Alarm Horn does not sound.
For Windows® 2000 Professional or Windows XP software, a sound
board is required. Windows software does not provide support for the
PC speaker.
Figure 7-1: Critical Alarm Warning Box

This box displays the name of the network, the time and date of the
Alarm, the full PC group\system\object name and expanded ID of the
object in Alarm, the object’s status, current value and display units,
and the Alarm message associated with the object. Refer to Table 7-1.
Note: You can change the dialog box to omit the display of the
object’s PC group and system name by adding a
COSPCGroupNameDisplay parameter in the
METASYS.INI file.
Table 7-1: Critical Alarm Warning Parameters

Field Description
Look Later Removes the alarm from the screen. The alarm remains in the Critical Alarm
summary as an unacknowledged alarm. The Critical Alarm Reminder dialog box
reminds operators of unacknowledged alarms.
Acknowledge Allows operators to acknowledge the alarm without viewing it. The report remains
in the Critical summary.
Discard Alarm Allows operators to discard alarm. The report is deleted from the online Critical
summary.
Look Now Displays the online Critical summary. In the Critical summary, the report is listed in
red, along with other reports that have not been acted on.
Note: Acknowledging an alarm acknowledges it only on the OWS

you are using. It still appears in the Critical Alarm Warning
dialog box on other OWSs unless it is either acknowledged
at each OWS or discarded from the Critical summary.
Discarding the alarm on a single OWS discards it from all
OWSs.
Critical Alarm Reminder Box

If there are unacknowledged reports in the Critical summary, the
Critical Alarm Reminder box appears on the screen at set time
intervals. For example, if you select the Look Later option in the
Critical Alarm Warning box, it appears after a certain time to remind
you of the Critical report.
Figure 7-2: Critical Alarm Reminder Box
IMPORTANT: If you want the Critical Alarm Reminder box to appear

for all alarms (acknowledged and unacknowledged) in
the Critical summary, you can specify so in the
METASYS.INI file. For more information, refer to the
Initialization Parameters Technical Bulletin
(LIT-636345).
The Critical Alarm Reminder box displays the options described in
Table 7-2.
Table 7-2: Critical Alarm Reminder Parameters

Field Description
Look Later Allows the summary to be viewed at a later time. Unacknowledged alarms remain
in the Critical summary.
Look Now Displays the online Critical summary. The reports that are not acknowledged
appear red.
Critical Summary
The Critical summary lists all alarms and changes-of-state that are
assigned the Critical report type. The online Critical summary lists all
Critical reports that have the Operator Workstation defined as the
report destination. Alarms that have not been acted on are red.
If you are using a color printer, alarms in the Critical summary are
printed in black unless otherwise specified in the METASYS.INI file.
Alarms with highest priority and the newest alarms are displayed first.
Figure 7-3: Online Critical Summary

Note: When a Critical alarm is received, the Critical Alarm
Warning box appears over any window or application
(except the Critical summary) and the Alarm Horn sounds.
However, if the Critical summary is displayed and active
(that is, if the title bar is highlighted and a screen saver is not
activated), the Critical Alarm Warning box appears behind
the summary and the Alarm Horn does not sound.
In order for a report type to be reported as a Critical alarm, all of these
conditions must be met:
• An object or feature changes state or goes into an Alarm or
Trouble state.
• The Change-of-State is assigned a Critical report type in the
object’s Definition or Focus window.
• The PC, printer, or PC file is defined as the report destination in
the PC group’s Report/Access Focus window. The archive Critical
summary lists all Critical reports that have the PC file defined as
the report destination.
The Critical summary displays the information in Table 7-3.
Table 7-3: Critical Summary Fields

Field Description
Time Displays the time that the report was generated
Date Displays the date that the report was generated
Item Displays the PC group\system\object name of the object that generated the report.
When applicable, an attribute name follows the object name.
Value Displays the value of the object or attribute when the Critical report was generated
Attribute Displays an attribute name
Alarm Message Displays the Alarm message assigned to the object or feature when the object or
feature was defined
Follow-Up Summary
The Follow-Up summary lists all Trouble, Alarm, and Change-of-State
(COS) reports that are assigned the Follow-Up report type, and all
reports moved from the Critical summary for further follow-up action.
The online Follow-Up summary lists all reports that have the Operator
Workstation defined as the report destination. The reports are listed
chronologically unless the Change Priority option in the Action menu
has been used to reorder the reports.
Figure 7-4: Follow-Up Summary

Table 7-4: Follow-Up Summary Fields

Field Description
Follow-Up Time and Displays the time and date that the Follow-Up report occurred, or the time and date
Date that the report was transferred from the Critical summary to the Follow-Up
summary
Item Displays the PC group\system\object name of the object that generated the report.
When applicable, the attribute name follows the object name.
Attribute Displays the attribute name
Transferred By Displays the initials of the operator who transferred the report if the Follow-Up
report was transferred from the Critical summary. This field is displayed in an
online summary only.
Critical Alarm Time Displays the time and date that the Critical report occurred if the Follow-Up report
and Date was transferred from the Critical summary. This field is displayed in an online
summary only.
Annotation Displays Yes if annotation has been created for the object. This field is displayed in
an online summary only.
Alarm Message Displays the Alarm message assigned to the object or feature when the object or
feature was defined
Change the Priority of Follow-Up Reports

Follow-Up reports are sorted in two categories: priority and
non-priority. All prioritized Follow-Up reports are listed first in the
summary according to the date and time that they are entered into the
summary (from most recent to oldest). Once all of the prioritized
reports have been listed, all non-prioritized reports are listed. They
also are sorted by the date and time they were entered into the
Follow-Up summary.
You can assign priority to a non-prioritized report so it is included in
the first list, moving it somewhat closer to the beginning of the
summary. Once the report is assigned priority, it is placed in the first
list according to its date and time.
This option is not available in an archive Follow-Up summary.
Alarm Summary
The Alarm summary lists all objects currently in alarm in a selected
PC group/system, regardless of the report type or the report
destination. If an object transitions out of alarm, it is not displayed the
next time you access the summary. This is an online summary and can
only be accessed from the Network Map Summary dialog box.
Note: Fire Input and Output devices are not listed in this summary.
Use the Input Device summary or the Output Device
summary to find out the status for an input or output device.
Figure 7-5: Alarm Summary
Table 7-5: Alarm Summary Fields

Field Description
Status Displays HA or LA if the object’s high or low alarm limits are exceeded. Displays
HW or LW If the object’s high or low warning limits are exceeded
Item Displays the name of the object in Alarm
Value Displays the value of the object when the object went into Alarm. This value does
not automatically update.
Units Displays the engineering units (if the value is analog)
Trouble Summary
The Trouble summary lists all Fire, Zone, BI (N2 Open, FPU BIF,
BIS, and SST-102 only) objects that are currently in trouble in a
selected PC group/system, regardless of the report type or the report
destination. If an object transitions out of trouble, it does not appear
the next time the summary is accessed. If the object goes into a state
with a higher priority, the trouble status is overridden and it is not
displayed in the trouble summary.
This is an online summary and can only be accessed from the Network
Map Summary dialog box.
Note: Fire input and output devices are not listed in this summary.
Use the Input Device summary or the Output Device
summary to find out the status for an input or output device.
Figure 7-6: Trouble Summary

Table 7-6: Trouble Summary Fields

Field Description
Status Displays the status of the object. The only status for this summary is Trouble
(TBL).
Item Displays the name of the object in Trouble
Value Displays the value of the object when the object was displayed. This value does
not automatically update.
Units Displays the engineering units (if the value is analog). For the Trouble summary,
this field is blank.
Status Summary
The Status summary lists Alarms or Change-of-State reports that are
assigned the Status report type and that have the PC file defined as the
report destination. This Archive summary can be accessed only from a
Reports Destination summary.
Figure 7-7: Status Summary

Table 7-7: Status Summary Fields

Field Description
Type Displays the type of alarm, or the feature that generated the report
Time Displays the time that the Alarm or COS report occurred
Date Displays the date that the Alarm or COS report occurred
Item Displays the PC group\system\object name of the object that generated the report
Attribute Displays an attribute name when applicable
Text Displays the message text associated with the report, when applicable
Alarm Message Displays the alarm message assigned to the object or feature when the object or
feature was defined
Detailed Procedures
To display online summaries:
1. Select a PC group or system.
Note: Proceed to Step 3 to display a Critical or Follow-Up
summary.
2. Click Summary. The Summary dialog box appears (Figure 7-8).
Figure 7-8: Summary Dialog Box

3. Click the desired summary.
4. Click Display.
Printing Online Summaries

To print online summaries:
1. Add the CossumPrintColor initialization parameter to the
Metasys.INI. Refer to the Initialization Parameters Technical
Bulletin (LIT-636345).
2. On the Summary menu, click Critical Summary.
3. Select Print.
Filtering and Sorting Online Critical and Follow-Up Summaries

Filtering
To filter the Critical or Follow-Up summary:
1. Display the Critical or Follow-Up summary.
2. On the View menu, click Filter. The COS-Filter dialog box

3. Select the desired Filter Key. Refer to Table 7-8.
4. Enter the alphanumeric character string. Refer to Table 7-8.
Table 7-8: Filter Parameters

Field Description
Priority Displays all priority levels from highest to lowest when no text is in the Filter Text
field
Item Filters reports according to a specific system and object name in the Filter Text
field. The system and object name must be separated by a backslash (\) and
preceded by an equal (=)sign.
Date and Time Filters the reports according to a specific date and time. The date and time are
entered in the following format: YY/MM/DD HH:MM:SS. An operator must precede
the date and time.
Filter Text Filters the reports according to specific text
Enable Filter Enables the Filters
Table 7-9: Operators

Operator Description
= equal to
<= less than or equal to
< less than
>= greater than or equal to
> greater than
<> not equal to
5. Click the Enable Filter check box.

6. Click OK. The summary appears listing the reports according to
the filter defined.
Sorting
To sort the Critical or Follow-Up summary:
1. Display the Critical or Follow-Up summary.
2. On the View menu, click Sort. The COS-Sort dialog box appears
(Figure 7-10).
Figure 7-10: COS-Sort Dialog Box

3. Click the desired option button. Refer to Table 7-10.
Table 7-10: Sort Parameters

Field Description
No Sort Sorts the reports by priority (CRIT 1-4)
Item Name Sorts the reports by the object name in ascending alphanumeric order
Date and Time Sorts the reports by the date and time the reports are received from most recent to
least recent
4. Click OK.
Displaying Archive Summaries

To display archive summaries:
1. Click the name of the PC file that contains the desired report. The
Reports Destination summary for the selected PC file appears.
2. Select the type of summary to view.
Moving a Critical Report to the Follow-Up Summary

IMPORTANT: When you move a report on an OWS, it is deleted on
all other OWSs on the network.
To move a report from the Critical to the Follow-Up summary:
1. Select one or more reports in the Critical summary. The maximum
is 2000 items.
2. On the Action menu, click Move to Follow-Up.
Note: The Operator Transaction summary contains a record of all
reports moved to Follow-Up when they were moved, and the
initials of the operator who moved them.
Changing the Reminder Time

To change the reminder time:
1. On the Critical summary, click Action > Reminder Time. The
Reminder Time dialog box is displayed (Figure 7-11).
Figure 7-11: Reminder Time Dialog Box

2. Enter the new time interval.
3. Click OK.
Disabling or Enabling the Alarm Horn

To disable or enable the Alarm Horn:
1. On the Action menu, click Reminder Time. The Alarm Horn
dialog box appears.
Figure 7-12: Alarm Horn Dialog Box

2. Select either Enable or Disable.
3. Click OK.
Changing the Display Settings

To change the display settings:
1. On the Action menu, click View System. The View System dialog
Figure 7-13: View System Dialog Box

2. Modify the fields.
3. Click OK. The changes are saved.
Clearing Archived Critical Reports

To clear archived Critical reports:
1. Select one or more reports in the archive Critical summary. The
maximum is 2000 items.
2. On the Action menu, click Discard Entry. The selected reports are
deleted from the PC file.
Note: This can take an exceptionally long time and cause delays in
OWS performance. Perform this activity at non-critical times
during the day.
Changing Priority of Follow-Up Reports

To change the priority of Follow-Up reports:
1. Select a report from the reports that have not been prioritized.
2. On the Action menu, click Change Priority. The selected report is
assigned priority, and appears in the first list of reports according
to the date and time that it was originally placed in the summary.
Annotating Follow-Up Reports

To annotate a Follow-Up report:
1. Select the report you want to annotate or whose annotation you
want to view.
2. On the Action menu, click Annotate. The Annotation dialog box
Figure 7-14: Annotation Dialog Box

Note: If annotation exists for the selected report, it is displayed in
the Annotation dialog box. You can then view or edit the
annotation. If annotation does not exist for the selected
report, the box is blank, and you can create annotation by
simply typing it in.
3. Enter new annotation. The annotation can be up to
2,048 characters long.
4. Click OK.
Chapter 8
Commanding Objects
Introduction
This section tells you how to command objects. This chapter explains
how to:
• perform an Operation command
• make adjustments on Analog Input devices
• perform a Communication command

Code No. LIT-120172
Key Concepts
Commands
Commands tell an object to perform or to stop performing certain
functions.
There are two kinds of commands: Operation commands and
Communication commands. Operation commands direct the actual
functioning of the object.
Operation Commands
Operation commands are used to:
• turn objects On or Off
• put objects in override
• adjust analog output setpoints
• set an object’s High and Low Warning Limits
• adjust Fire Object Analog Input devices
The type of object you are commanding determines the available
Operation commands. The following Operation commands are
available:
• Adjust
• Auto
• State 0 (or Off, Stop)
• State 1 (or On, Start)
• Release All
• Override
Note: In the Command dialog boxes, State 0 and State 1 are
replaced by the display units specified for the selected object
(for example, Off/On, Stop/Start).
If commanding an Analog Input object, the following Operation
commands are available:
• Auto
• Override
• Alarm Limits
• Warning Limits
Though the Operation command options differ depending on the type

of object, the process of commanding is the same for all objects, with
the exception of Fire Object Analog Input devices.
Performing a Fire Object Analog Input Device Command

By using the Operation option in the Action menu while an Input
summary is displayed, operators can adjust some of the operations for
Analog Input devices (detectors). The adjustments include:
• adjust Default Sensitivity
• enable or disable the Verify attribute
• enable or disable Day/Night Adjustment
Default Sensitivity
The Default Sensitivity can be set to three different levels: High,
Medium, and Low. It tells the Analog Input device (detector) when to
consider input valid for triggering alarms. A setting of High makes the
detector very sensitive to even small amounts of smoke. Low
sensitivity means more smoke would have to be detected to trigger an
alarm. Operators can tell what the device is set to by looking in the
Default Sensitivity field in the Input Device summary.
Verify
Verify has two settings: Enable and Disable. If Verify is set to Enable,
it allows an Analog Input device (detector) to count the number of
times its threshold is momentarily exceeded. Enabling this setting can
help prevent unnecessary alarms. If this setting is disabled, the Verify
Count field in the Input Device summary will be blank.
Day/Night Adjustment
Day/Night Adjustment has two settings: Enable and Disable. If
Day/Night Adjustment is set to Enable, the sensitivity level can
automatically change according to the time of day. This prevents
unnecessary alarms. Day/Night Adjustment must be fully set up at the
IFC-1010/2020 before this feature operates properly.
Communication Commands
Communication commands determine how the object interacts with
other parts of the system. For example, use the Lock Triggers
Communication command to prevent an object from triggering a GPL
process. Use the Unlock Reporting command to allow reports
regarding an object to be sent to report destinations.
Communication commands are the same for all objects (except that
Unlock and Lock Reports commands are not available for DCM, XM,
LCD, DCDR, N2Open, and DSC hardware objects). The following
communication commands are available:
• Enable Communications
• Disable Communications
• Unlock Reports
• Lock Reports
• Unlock Triggers
• Lock Triggers
Detailed Procedures
Performing an Operation Command
To perform an Operation command:
1. Select the desired objects to command.
2. On the Action menu, click Selection Operation. The Operation
Figure 8-1: Operation Command Dialog Box for BO Object

3. Click the desired command.
4. Click OK.
Making Adjustments on Analog Input Devices

To make adjustments on Analog Input devices:
1. On the Input Device summary, click the Item to adjust.
2. On the Action menu, click Sensor Settings. The Input Device
Operation dialog box appears.
3. Make the necessary adjustments.
4. Click OK.
Note: When adjusting the Day/Night Adjustment, first define the
Day/Night Adjustment feature on the IFC-1010/2020.
Performing a Communication Command

To perform a Communication command:
1. Select the desired objects to command.
2. On the Action menu, click Communication. The Communication
Figure 8-2: Communication Command Dialog Box

3. Click the desired command option button.
4. Click OK.
Chapter 9
Scheduling Commands and

Summaries
Introduction
This section describes scheduling commands and summaries. This
section describes how to:
• schedule a command
• copy a schedule
• schedule Trend and Totalization
• scheduling summaries
• scheduling process triggers
• schedule Lighting Control Group (LCG) events
• view LCG scheduled events
• modify LCG scheduled events
• delete LCG scheduled events
• modify schedules
• modify DX-9100 Time Schedule Modules
• clear schedules
• print a summary of schedules
• display a summary of schedules
• schedule a temporary calendar date
• modify a calendar date

Code No. LIT-120173
Key Concepts
Scheduling
The Scheduling feature allows operators to specify when commands
and features take effect and when summaries are printed.
Assigning Different Schedules

Operators can create three different schedules: Regular, Alternate, and
Holiday. Operators assign each day in the calendar year to one of these
schedules in the Schedule Calendar window.
Temporary Schedules
Operators can schedule one-shot daily schedules. Use these Temporary
schedules for special events. Temporary schedules apply to
one specific calendar date only and are automatically deleted at the
end of that day. Temporary schedules override all commands
scheduled under Regular, Alternate, and Holiday schedules.
Each scheduled item (that is, object, system, or PC group) can have up
to 12 temporary schedule days with 32 schedules per day.
Detailed Procedures
Scheduling a Command
To schedule a command:
1. Click the button to the left of the system containing the desired
command. The Network Map-System Peek dialog box appears
(Figure 9-1).
Figure 9-1: System Peek Dialog Box

2. Select the object you want to schedule.
3. Click Schedule. The Scheduling window appears (Figure 9-2).
Note: If the selected summary has no schedule, the Scheduling dialog
box appears asking if you would like to copy an existing
schedule. If you don’t want to copy an existing schedule, click
No and go to Step 4.
Figure 9-2: Scheduling Window

4. Select a day of the week in the Regular, Alternate, or Holiday
schedule.
5. On the Action menu, click Add Schedule Operation or Add
Schedule Communication option. The Schedule Operation or
Schedule Communication dialog box appears.
Note: The options in the dialog box are appropriate to the type of
object you are scheduling.
Figure 9-3: Schedule Communication-Analog Device

6. Specify the type of command and specify the time you want the
command to take place.
7. Click OK. The new scheduled command is added to the row of the
day you selected in Step 4.
Figure 9-4: Scheduling Window with Warnings Command

8. On the Item menu, click Save. The new schedule is added to the
operational database
Copying a Schedule
To copy a schedule:
1. Click the button to the left of the system containing the desired
object. The Network Map-System Peek dialog box appears
(Figure 9-1).
2. Select the object to schedule for Trend or Totalization.
3. Click Schedule. A dialog box appears saying that no schedule
exists, and asks you if you want to copy an existing schedule.
4. Click Yes. The Schedule Copy dialog box appears (Figure 9-5).
Figure 9-5: Schedule Copy Dialog Box for an Object

5. Select the system and object with the desired schedule.

Note: If you are copying a summary, there is only one list box. Select
the PC group or system to copy.
6. Click OK. The object or summary Scheduling window appears
containing the same schedules as that of the object or summary
you copied.
Note: If you are copying the schedule of an analog object, both
objects must use the same engineering units.
7. Make necessary modifications.
Scheduling Trend and Totalization

To schedule Trend and Totalization:
1. Click the button to the left of the system containing the object.
The Network Map-System Peek dialog box appears (Figure 9-1).
2. Select the desired object to schedule for Trend or Totalization.
3. Click Schedule. The Scheduling window appears (Figure 9-2).
Note: If the selected object has no schedule, the Scheduling dialog
box appears asking if you would like to copy a schedule. If you
don’t want to copy an existing schedule, click No and go to
Step 5.
4. Select the desired day of the week.
5. On the Action menu, click Add Schedule Trend or Add Schedule
Totalization. The Schedule-Trend (Figure 9-6) or Schedule
Totalization dialog box appears.
Figure 9-6: Schedule-Trend Dialog Box

6. Select the attribute to be Trended or totalized. The attribute

appears in Attribute text box.
7. Click the appropriate operation button.
8. Specify the time you want Trend or Totalization to begin, end, or
reset in the Schedule Time text box.
9. Click OK. The new schedule is added to the row of the day you
selected.
10. On the Item menu, click Save. The new schedule is entered into
the database.
Scheduling Summaries
To schedule a summary:
1. Go to any window displaying a PC group or system.
2. Select the PC group or system.
3. On the Go To menu, click Schedule. The Scheduling window
Note: If the selected summary has no schedule, the Scheduling dialog
box appears asking if you would like to copy a schedule. If you
don’t want to copy an existing schedule, click No and go to
Step 5.
Figure 9-7: Scheduling Window (for Summaries)

4. Select a day of the week in the Regular, Alternate, or Holiday
schedule.
5. On the Action menu, click Add Schedule Summary. The Schedule

Summary dialog box appears (Figure 9-8).
Figure 9-8: Schedule Summary Dialog Box

6. Select the type of summary.
7. Select a defined printer or type the name of a print file in the
Destination text box (for example, C:\ALARMS.TXT).
Notes: If you specify a print file, the selected summary is sent to
the print file at the workstation you are using, at the time
you specify. You can then either print the file from DOS, or
view it in any ASCII text editor.
This temporary print file is not the same as a PC file report
destination displayed on the Network Map.
8. In the Schedule Time text box, specify the time you want the
summary to be sent to the destination.
9. Click OK. The scheduled summary is added to the row of the day
you selected.
10. On the Item menu, click Save. The new scheduled summary is
added to the database.
Scheduling Process Triggers

To schedule process triggers:
1. Click the system that contains the desired process to schedule.
2. On the Go To menu, click Process. The Process window appears.
3. Select the desired process.
4. On the Go To menu, click Schedule. The Scheduling window for
the selected process object appears, displaying the current
schedule.
Note: If the selected process has no schedule, the Scheduling dialog
box appears asking you if you would like to copy a schedule. If
you don’t want to copy an existing schedule, go to Step 8.
5. Select a day in the Scheduling window.
6. On the Action menu, click Add Schedule Process Trigger. The
Schedule – Process Trigger dialog box appears (Figure 9-9).
Figure 9-9: Schedule Process Trigger Dialog Box

7. Specify the time you want the process to be triggered.
8. Click OK. The scheduled trigger is added to the row of the day
you selected in Step 5.
9. On the Item menu, click Save. The new schedule is added to the
operational database.
Scheduling Lighting Control Group (LCG) Events

To schedule LCG events:
1. Select the LCG object.
2. On the Go To menu, click Schedule. The Scheduling window
Note: If the selected LCG has no schedule, the Scheduling dialog box
appears asking if you would like to copy a schedule. If you
don’t want to copy an existing schedule, go to Step 3.
3. On the Action menu, click Add Schedule Event. The Schedule-LC
Group dialog box appears (Figure 9-10).
Figure 9-10: Schedule-LC Group Dialog Box

4. Click the event line you want to schedule.
5. Click the type of schedule.
Note: The Lighting Controller supports only Holiday and Regular
schedules. All days that are designated as Alternate days in the
Schedule Calendar are treated as Regular days by the Lighting
Controller.
6. If you selected the Regular schedule type, specify the days by
clicking the appropriate option boxes. The event line displays the
selected days.
7. Select the event type. The event line displays the event selected.
8. Enter the Event On Time and Event Off Time.
9. To schedule another event, select another event line.
10. Click OK. The schedule is immediately saved.
Note: Unlike the scheduling of other objects, you do not have to save
the LCG schedule with the Save option in the Item menu. In
addition, LCG object schedules do not appear in the
Scheduling window. To view the schedule for LCG objects,
display the Scheduling-LC Group dialog box.
Modifying Existing Schedules

To modify existing schedules:
1. On the Scheduling window, click the scheduled command,
feature, or summary to modify. The selected event appears
highlighted.
2. On the Action menu, click Modify Schedule. The appropriate
Schedule dialog box appears.
3. Type in any changes.
4. Click OK. The changes appear in the Schedule.
5. On the Item menu, click Save. The changes are entered into the
Modifying DX-9100 Time Schedule Modules

Note: Each of the eight Time Schedule Modules has a single logical
output that is set to either On or Off according to the module’s
schedule. These outputs can be used as inputs to other
functions within the DX-9100. The feature described can only
be used to modify the schedules, not the logical connections of
the outputs to other functions. The term “event” is therefore
used in this context to mean simply the switching of a Time
Schedule Module’s output.
To modify DX9100 Time Schedule Modules:
1. Select the DX-9100.
2. On the Go To menu, click Scheduling. The object’s schedule
appears.
3. On the Action menu, click Modify Local Time Schedule. The
DX9100 Time Schedule Modules Definition dialog box appears
(Figure 9-11).
Figure 9-11: DX9100 Local Time Schedule Modules Definition Dialog Box
Note: The name in the title bar of the dialog box varies depending on
the name of the DX-9100. In Figure 9-11, for example, the
name of the DX9100 is DX91_90. Therefore, DX91_90
appears in the title bar.
4. Make the desired changes to the schedule. Refer to Table 9-1.
Table 9-1: DX9100 Local Time Schedule Modules

Field Description
Time Schedule Displays the time selected for the schedule
Module #
Extension Override Extends the occupancy period for a programmable time. This is active only during
Time the occupancy time. Valid range is 0 to 255 minutes.
Start Time Displays the time the schedule begins
End Time Displays the time the schedule ends
Mon, Tue, Wed, Thu, Checkboxes indicate if a schedule is collected on particular day
Fri, Sat, Sun, Hol,
Weekdays
Events Displays the schedule information
5. Click Save. A message box appears asking you to confirm that

you want to download the new schedules to the DX-9100.
6. Click OK.
Notes: When you download the new schedules to the DX-9100, they
are also saved (archived) in a file on the OWS under the
system in which the DX-9100 is located. The name of the file
is the device name with a .TSD extension.
If you later download a configuration file to the DX-9100,
the download dialog box allows you to choose whether to
download the new schedules (.TSD file), or the schedules
originally defined in the configuration file.
Clearing Schedules
To clear existing schedules:
1. Select the scheduled command, feature, or summary you want to
clear.
2. On the Action menu, click Clear Schedules. A dialog box appears,
asking whether you want to clear the schedules.
3. Click OK. The selected schedules are cleared.
4. On the Item menu, click Save. The changes are entered into the
Printing a Summary of Schedules

To print a summary of schedules:
1. Click on a network, PC group, or system.
2. Click Summary. The Network Map-Summary dialog box appears
(Figure 9-12).

3. Select the Scheduling summary.

4. Click Print. A list of all schedules defined for the selected
network, PC group, or system are printed.
Note: The time it takes to print the summary varies depending on the
size of the network, PC group, or system selected.
Displaying a Summary of Schedules

To display a summary of schedules:
1. Select a System, PC group, or Network.
2. Click Summary. The Network Map-Summary dialog box appears
(Figure 9-12).
3. Select Scheduling.
4. Click Display. A list of all schedules defined for the selected
network, PC group, or system appears.
Note: The time it takes to display the summary varies depending on
the size of the network, PC group, or system selected.
Scheduling a Temporary Calendar Date

To schedule a temporary calendar date:
1. Display the Scheduling window.
2. On the Action menu, click Add Calendar Date. The Schedule
Calendar Date dialog box appears (Figure 9-13).
Figure 9-13: Schedule Calendar Date Dialog Box

3. Specify the month and date.
4. Click OK. The new date appears in the Temporary schedule.
Note: To schedule a command or summary for the new calendar date,
select the date. Use any of the Action menu options described
in this section.
the operational database.
Modifying a Calendar Date

To modify a calendar date:
1. Display the Scheduling window.
2. Select the calendar date.
3. On the Action menu, click Modify Calendar Date. The Schedule
Calendar Date dialog box appears, displaying the scheduled
month and date.
4. Select the field to change and type in corrections.
5. Click OK. The new date appears in the Temporary schedule.
6. To schedule a command or summary for the new calendar date,
select the date. Use any of the Action menu options to add or
modify a scheduled event.
the operational database.
Chapter 10
Using Object Focus Windows
Introduction
Object Focus windows display detailed information about objects.
This section describes how to:
• display an Object Focus window
• display the Control System (CS) Object focus window

Code No. LIT-120174
Key Concepts
Object Focus Windows
Object Focus windows display detailed information about objects.
This information includes values assigned to the object when the
object was originally defined as well as realtime status for dynamic
attributes.
The Object Focus window also allows operators to modify some of the
object’s attributes. In addition, operators can command the object and
access Point History, Scheduling, Totalization, and Trend windows
from Focus windows.
Types of Objects
Table 10-1 describes the three kinds of object.
Table 10-1: Types of Objects

Object Description
Point Objects The software definition for a specific field device such as a
fan control relay or a temperature sensor. Binary Output
objects and Analog Input objects are examples of point
objects.
Control Objects The software definition for a specific process that combines
multiple field devices together to perform a function. A PID
Loop, a GPL process, and a Load Group are examples of
control objects.
Hardware Objects The software definition for a controller. Digital Control
Modules, Expansion Modules, and Intelligent Lighting
Controllers are examples of hardware objects.
Though the objects are different, the process of entering and

modifying attribute values within Object Focus windows is basically
the same.
Note: Operator Workstations, NCMs, and printers are considered
N1 devices.
History and Current Trend Charts

Two charts appear at the top of most Focus windows: a History chart
on the left and a Current Trend chart on the right. The History chart
contains samples of the Current Value in the NCM buffer at the time
the Focus window is displayed (the most recent 48 samples for analog
objects, and the most recent 10 samples for binary objects). The
Current Trend chart contains updating trend samples of the Current
Value.
The sampling starts when you open the window. These samples update
every 20 seconds or whenever there is a change-of-state. Analog
Object Focus windows display the information as a line graph. Binary
Object Focus windows display the information as a textual list of
samples. These differences are described below.
The Focus window for CS objects has no History or Current Trend
charts. To see history or current trend for an attribute of a CS object,
refer to the AD or BD object to which the attribute is mapped.
Analog Object History and Current Trend Charts

Figure 10-1 shows an example of History and Current Trend charts for
an analog object.
Figure 10-1: History and Current Trends in an AI Object

Focus Window
The number in the upper right corner of the chart indicates the value at
the current graph cursor position. You can move the graph cursor to
any position on the chart to display the value at that position. Then
drag the graph cursor to any position on the chart. The number in the
upper right corner updates accordingly. Use the graph cursor in the
same way with the Current Trend chart.
For PID Loop control objects, a Fast Trend chart is displayed at the top
of the Focus window (instead of History and Current Trend charts).
Binary Object History and Current Trend Charts

The History and Trend charts for binary objects display the time and
date of the sample, followed by the current value in the specified
display units (for example, On/Off, Start/Stop). Figure 10-2 is an
example of the History and Current Trend charts that appear in Binary
Object Focus windows.
Figure 10-2: Binary Object History and Current Trend Charts

Modify Attribute
The lower portion of the Object Focus window contains all the
attributes you can view or modify. When the Focus window is first
displayed, most of these attributes cannot be seen. To bring these
attributes into view, use the vertical scroll bar on the right side of the
window. Figure 10-3 is an example of the Analog Input Focus
window.
Figure 10-3: Analog Input Focus Window

Detailed Procedures
Displaying an Object Focus Window
To display an Object Focus window:
1. Double-click a system from the Network Map. The System
summary appears.
2. Double-click the desired object. The Focus window for that object
Displaying the CS Object Focus Window

To display a CS Object Focus window:
1. Double-click the system that contains the CS object. The System
summary appears.
2. Double-click on the CS object you want to see.
Note: Make sure that your windows are set to the Focus option in
the Item-Options window, or double-clicking opens the
Action-Operation window.
3. Select the attribute types (up to two) you want to view first. The
attributes of the selected type appear in the list boxes.
Chapter 11
Using Online Help
Introduction
This section explains how to use the online help features provided with
the OWS. This section describes how to:
• use task help
• access help for Modifiable attributes
• access attribute help for Non-Modifiable attributes
• display and edit operating instructions
• write a new operation instruction

Code No. LIT-120175
Key Concepts
Online Help
Online help is available in Metasys windows. There are several types
of online help: attribute help, operating instructions, descriptive, and
procedural.
Figure 11-1: Metasys Help
Attribute Help
Definition and Focus windows exist for all the hardware and software
objects in your facility. Use the Definition windows to specify
attribute values. Use the Focus windows when viewing or modifying
these values at a later time. While entering or viewing attribute values,
operators might need more information about an attribute.
To access online attribute help in a Definition or Focus window, use
the Help menu. Attribute Help consists of comprehensive information
about every attribute in Focus and Definition windows, including the
format valid ranges to use when entering attribute values.
Using Operating Instructions

Operator and facility engineers write operating instructions that allow
operators to communicate with one another by viewing, writing, and
updating informative notes. The operator and facility engineers can
easily edit these text files to adapt to changing situations.
Operating instructions are numbered. Each object is assigned an
Operating instruction number in its Definition or Focus window. This
associates the instruction with the object. Operating Instruction
numbers can be assigned to more than one object.
The Operating Instruction for an object can appear from any window
or summary that displays the object, except the Critical summary.
Operating Instruction text files are only available at the workstation
where they are written. Therefore, it is possible for two different
workstations to have different instructions for the same object. To
avoid this inconsistency, use the File Transfer function to transfer
Operating Instruction files from one workstation to another.
Operator Help
In most Metasys windows, pressing the F1 key accesses Help for the
window currently in use. Some examples include:
• In the Network Map window, pressing F1 opens the “Using the
Network Map” help topic.
• In the Network Map window with a PC Group highlighted,
pressing F1 opens the “PC Group” help topic.
• In the IP Address Configuration Summary window, pressing F1
opens the “IP Address Configuration Summary” help topic.
Task Help
From the help topics, you can also get step-by-step procedures for
every operator task.
Operating Instructions
Operating instructions are text files written by operators and facility
engineers. Since these instructions can be easily edited via Notepad,
operators can communicate freely with one another about the changing
conditions of the facility.
The operating instruction text files are numbered and each object is
assigned an operating instruction number in the object’s Definition or
Focus window. This associates the instruction with the object.
Feature Help (Metalink™)

On the Network map, selecting Feature Help-Metalink in the Help
menu opens the Metalink User’s Guide (LIT-6295060).
Modifiable and Non-modifiable Fields

In Definition and Focus windows: Modifiable attribute fields are
contained in boxes. These are modifiable attribute fields.
Non-modifiable attribute fields are not contained in boxes. These are
non-modifiable attribute fields.
Detailed Procedures
Using Task Help
To use task help:
1. On the menu bar, click the How Do I button.
2. Minimize the task list window. The procedure help appears in a
smaller window on top of the Metasys window.
Note: Not all of the Metasys windows are context-sensitive. Press
F1 at any time to check if context-sensitive help is available.
If a help topic does not appear after pressing F1, select Help
Topics from the Help menu. Use the Contents or Search
feature to locate help topics.
Accessing Help for Modifiable Attributes

To access help for modifiable attributes:
1. Display the Focus (or Definition) window.
2. Select the desired attribute field.
3. On the Help menu, click Attribute Help. The Help window
appears, displaying information about the selected attribute
(Figure 11-2).
Figure 11-2: Help Window for Operating Instruction-Attribute

Accessing Attribute Help for Non-Modifiable Attributes

To access Attribute Help for non-modifiable attributes:
1. Display the Focus (or Definition) window.
2. On the Help menu, click Attribute Help. A Help Index appears.
3. Click one of the attributes in the Index to display a Help window
with detailed information about the attribute.
Displaying and Editing Operating Instructions

To display or edit the Operating Instruction for an object:
1. Go to any window displaying the object (for example, System
summary, system drawing, Focus window).
2. Select the object.
3. On the Help menu, click Operating Instruction. Notepad appears,
displaying the instruction for the object. Note that the title of the
Notepad file is the number of the instruction (Figure 11-3). In this
case, the number of the instruction is 0.
Note: If a number has not been assigned in the Operating
Instruction # field in the object’s Definition or Focus
window, the Operating Instruction option appears dimmed in
the Help menu.
Figure 11-3: Notepad Editor with Operating Instruction

4. On the Notepad File Menu, click Save.
Writing a New Operating Instruction

To write a new Operating Instruction:
1. Display the object’s Focus window.
2. Enter a new number in the Operating Instruction # field.
4. On the Help menu, click Operating Instruction. The Notepad
Editor appears, displaying a blank screen.
5. Type the instruction.
6. On the Notepad File menu, click Save.
Chapter 12
Using Point History
Introduction
This section tells you how to use the Point History feature. This
chapter describes how to:
• display the point history item window
• display the history item window from a window displaying objects
• display the history item window from a reports destination
summary
• display the point history data window

Code No. LIT-120176
Key Concepts
Point History
The Point History feature samples, displays, and archives attribute data
associated with objects. The attributes sampled are the object’s current
value and status (for example, offline, disabled, overridden).
At the OWS, point history information can be displayed in
three places:
• in graphs at the top of an Object Focus window
• in a Point History Data window accessed from a summary
displaying objects
• in a Point History Data window accessed from a PC file Reports
Destination summary
Note: There is no Point History for CS objects. To get point history
on a CS object’s attributes, refer to the mapped AD objects
and BD objects attributes.
Point History in Object Focus Windows

History and Current Trend graphs appear at the top of Object Focus
windows. These graphs contain point history information for the
displayed object.
Operator Workstation User’s Guide 12-3
Figure 12-1: History and Current Graphs in an AI Object Focus Window

Note: For binary objects, the point history information is in table
rather than graph form.
The History graph displays the samples of the object’s current value in
the NCM buffer at the time the Object Focus window is displayed. The
Current graph displays updating samples of the object’s current value.
The data in the Current graph updates every 20 seconds or whenever
there is a change-of-state.
For an object’s point history information to be collected and displayed,
the object’s Enable Point History attribute must be set to Y (Yes).
Point History Accessed from a Summary Listing Objects

When accessed from a summary, point history data can be displayed
for up to seven objects. This is online information contained in the
NCM buffer at the time the Point History window is displayed.
For AI, ACM, and AD objects, the NCM stores the last 48 samples
and collects data every 30 minutes and whenever there is a
change-of-state. For AOD, AOS, BI, BD, and BO objects, the NCM
stores the last ten events and collects data whenever there is a
change-of-state.
For an object’s point history information to be collected and displayed,
the object’s Enable Point History attribute must be set to Y (Yes).
Point History Accessed from a Reports Destination

Summary
When accessed from a Reports Destination summary (a summary of
reports sent to a PC file), the Point History feature displays archived
point history data for objects that have data sent to the PC file. For
point history information to be archived for an object, the object’s
Save Point History attribute must be set to Y (Yes).
History Item and History Data Windows

The Point History feature uses two windows: the History Item window
and the History Data window. Use the Item window to access the Data
window and to set up point history. Use the Data window to display
the actual point history data in table form.
Detailed Procedures
Displaying the Point History Item Window
To display the Point History Item window:
1. Select a system on the map.
2. On the Go To menu, click History. The History Item dialog box
Figure 12-2 : History Item Dialog Box
Table 12-1: History Item Fields

Field Description
Status Whether Point History is enabled or disabled for the object. When accessed from a
Reports Destination summary, this field does not appear.
Item The name of the object. When accessed from a Reports Destination summary, the
full network\PC group\system\object name is displayed.
Description The object’s expanded ID
Displaying the History Item Window from a Window Displaying

Objects
To display the History Item window from a window displaying
objects:
1. Display the summary (for example, Critical, Follow-Up) or Focus
window.
Note: If you are using an Object Focus window, go to Step 3.
2. Select the system name objects.
3. On the Go To menu, click History. The History Item window
Displaying the History Item Window from a Reports Destination

Summary
To display the History Item window from a Reports Destination
summary:
1. Click the PC file that contains the History report you want to
view. The Reports Destination summary appears.
2. On the Reports Destination Summary, click the History report.
The History Item window appears (Figure 12-1).
Displaying the Point History Data Window

To display the point history data window:
1. Display the History Item window or the Object Focus window.
2. Select the desired objects to display in the History Data window.
3. On Go To menu, click History Data. The History Data window
appears (Figure 12-3). Refer to Table 12-2.
Figure 12-3: History Data Window
Table 12-2: History Data Fields

Field Description
Time/Date Displays the time and date of the sampling. For AI, ACM, and AD objects, the NCM
takes the samples every 30 minutes. For AOS, AOD, BI, and BO objects, the NCM
records changes-of-state whenever one occurs.
ID Displays the system/object name of the object being sampled
Value/ Displays the current value or current commanded value of the object when
Command sampled. If the object is offline or unreliable, ???? appears.
Status/Feature Displays the status (HI-ALRM, LO-ALRM) of the object, or the name of the feature
that commanded the object (for example, DL/LR)
SW Override Displays a Y (Yes) if the object is in software override at the time of sampling. If the
object is not in software override, the column is blank.
HW Override If the object is in hardware override at the time of sampling, a Y (Yes) appears. If
the object is not in hardware override, the column is blank.
Offline Displays, a Y (Yes) if the object is offline at the time of sampling. If the object is not
offline, the column is blank.
Disabled Displays a Y (Yes) if the object is disabled at the time of sampling. If the object is
not disabled, the column is blank. Disabling an object’s communications suspends
the collection of point history data. Therefore, the Point History feature suspends
collection after recording once that an object has been disabled. Data collection
resumes only when the object is enabled again.
Chapter 13
Using Totalization
Introduction
This section tells you how to use the Totalization feature. This section
describes how to:
• display the Totalization item window
• display the Totalization item window from a window displaying
objects
• display the Totalization item window from a reports destination
summary
• add a Totalization entry
• begin Totalization
• end Totalization
• reset a Totalization value
• modify a Totalization entry
• clear a Totalization entry
• clear selected reports
• purge files
• display the Totalization data window
• archive Totalization data
© July 24, 2003 Johnson Controls, Inc. www.johnsoncontrols.com

Code No. LIT-120177
Key Concepts
Totalization
The Totalization feature totals quantities and counts the number of
times events occur. Totalization answers questions such as: How much
steam (or gas, or chilled water) did the facility use last month? or How
many hours was the supply fan for AHU3 in operation last week?
Use Totalization data to save energy, lower energy costs, and provide
effective maintenance.
The Totalization data is collected by the NCM and appears in a graph
or table at the OWS.
There are four types of Totalization: Analog, Pulse, Runtime, and
Event.
Analog Totalization
Analog Totalization totals data recorded at an analog sensor.
It answers the question How much? and is typically used to measure
the consumption of a supply such as chilled water or steam. The input
sensor provides a value corresponding to the current rate of
consumption or flow.
Pulse Totalization
Pulse Totalization, used only with Accumulator (ACM) objects, totals
data recorded at a pulse sensor. It answers the question How much?
and is typically used to measure the consumption of a supply, such as
gas or electricity. The input sensor provides a pulse as each unit of
consumable energy is sensed.
Runtime Totalization
Runtime Totalization accumulates total time only while a particular
condition is satisfied. It answers the question How long? and is
typically used to determine how long equipment is running in order to
schedule maintenance after a certain amount of use. The runtime totals
are recorded in minutes and then converted to hours.
Event Totalization
Event Totalization records a total of the number of times a binary
event occurs. It answers the question How often? and is typically used
to determine the frequency of events.
Runtime or Event Totalization Dialog Box

The Runtime or Event dialog box appears when an integer or binary
attribute is specified in the Add Totalization Entry dialog box.
Figure 13-1: Runtime or Event Totalization Dialog Box
Table 13-1: Runtime or Event Totalization Parameters

Field Description
Report Type Specifies the type of report (Critical 1 through 4 or Follow-Up) that will be
generated if the defined limit is exceeded (optional)
Alarm Message Specifies the number of the alarm message generated if the limit is exceeded
Number (optional)
Limit Specifies the user-defined limit that, when exceeded, generates the report and
alarm message specified in the Report Type and Alarm Message Number fields
(optional). Totalization continues when this limit is exceeded.
Totalization Units Specifies the engineering units for the attribute being totalized. If the Totalization
type is Runtime, this field is not available because the Runtime units are always
Hours.
Period Specifies the period over which Totalization is to occur. The totalized value is
saved as the previous Totalization value, and the current Totalization value is reset
to 0.
State Specifies the value that determines when Totalization occurs
Analog Totalization Dialog Box

The Analog dialog box appears when operators specify an analog
attribute in the Add Totalization Entry dialog box.
Figure 13-2: Analog Totalization Dialog Box
Table 13-2: Analog Totalization Parameters

Field Description
Scale Conversion Specifies the scale conversion, used to convert the base consumption units into
the display consumption units. For Pulse Totalization, the scale conversion must
be a power of 10.
Low Cutoff Specifies the Low Cutoff value. When the analog attribute value being totalized is
less than this Low Cutoff value, a zero value is used to update the current
Totalization value.
Input Rate Specifies the Input Rate by clicking the appropriate option button. If the attribute
has a rate measurement of hours, specify Hours. If the rate is measured in
minutes, specify Minutes. If the rate is measured in seconds, specify Seconds.
Pulse Totalization Dialog Box

The Pulse Totalization dialog box appears when operators specify an
Accumulator (ACM) object attribute in the Add Totalization Entry
dialog box.
Figure 13-3: Pulse Totalization Dialog Box

Note: The fields in the Pulse Totalization dialog box (Figure 13-3)
are the same as those in the Event or Runtime and Analog
dialog boxes described in Table 13-1, with the addition of
the following field:
Table 13-3: Pulse Totalization Parameters

Field Description
Pulse Constant Specify the pulse constant. This floating point number represents the number of
consumption units for each pulse.
Totalization Value
The Totalization value is reset to 0 when the Totalization absolute
limit is exceeded; Totalization then continues from a set value of 0.
The limits are 9,999,999 for Pulse and Analog, 99,999.9 for Runtime,
and 9,999,999 for Event Totalization. Entries used for Totalization
must be whole numbers.
Operators can specify an optional user-defined limit when defining
attributes for Totalization. The user-defined limit does not reset the
value to 0 when exceeded. Even if operators define a limit,
Totalization resets if the absolute limit is reached. When the
user-defined limit is exceeded, operators have the ability to specify
that a report and alarm message be generated.
Totalization Data Table

Clicking the Show as Text on the Edit menu displays the Totalization
data in a table format.
Each column in the table corresponds to one of the attributes listed at
the top of the window and is labeled with the appropriate ID (A to G).
Each attribute column displays the values for the attribute at the
various time samples. When no data is available, ???? appears in the
column. Each row in the table represents a different time sample. The
samples are displayed in chronological order, with the most current
sample in the top row.
The Duration field at the top of the window displays the duration of
Totalization collection for the attributes at the selected time sample.
Totalization Data Graph

Clicking the Show as Drawing option displays the Totalization data in
a graph.
Each bar in the graph corresponds to the totalized value for one
attribute at one sampling. Each bar is labeled with the associated
attribute ID (A to G). When no data is available, no bar appears for the
attribute.
The values displayed at the top of the graph correspond to the
currently selected time sample. To select a time sample, click the time
at the bottom of the graph.
Detailed Procedures
Displaying the Totalization Item Window
To display the Totalization Item window:
1. Select a system.
2. On the Go To menu, click Totalization. The Totalization Item
window appears (Figure 13-4).
Figure 13-4 : Totalization Item Dialog Box
Displaying the Totalization Item Window from a Window

Displaying Objects
To display the Totalization Item window from a window displaying
objects:
1. Display the summary or Focus window.
Note: If you are using an Object Focus window, skip Step 2.
2. Select the system name object.
3. On the Go To menu, click Totalization. The Totalization Item
Displaying the Totalization Item Window from a Reports

Destination Summary
To display the Totalization Item window from a Reports Destination
summary:
1. Click the PC file that contains the desired Totalization. The
2. Click the Totalization report. The Totalization Item window
Note: The fields displayed in the Totalization Item window depend
on the type of Totalization.
Table 13-4: Totalization Item Fields

Field Description
Status Displays the status of Totalization collection for the object attribute: None, Began,
End
Item Displays the name of the object whose attributes are being totalized. If accessed
from a Reports Destination summary, the full network\PC group\system\object
name is displayed.
Attribute Displays the name of the attribute being totalized
Period Displays the period of Totalization: Hourly, Daily, Weekly, Monthly, or None
Limit Displays the defined value that generates an alarm when reached
Report Type Displays the Report Type specified when the attribute is defined for Totalization
Alarm Message Displays the alarm message number specified when the attribute is defined for
Number Totalization
Totalized Units Displays the units used for the totalized quantity
Type Displays the type of Totalization: Analog, Pulse, Runtime, Event
Runtime or Event Displays the condition for which Totalization occurs (Event or Runtime only)
State
Analog Low Cutoff Displays the value at which no Totalization occurs (Analog only)
Analog Input Rate Displays the item scale of the input rate (Analog only)
Analog or Pulse Scale Displays the scale conversion that the totalized value appears (Analog or Pulse
Conversion only)
Pulse Constant Displays the number of consumed units represented by each pulse (Pulse only)
Adding a Totalization Entry

To add a Totalization entry:
1. On the Totalization Item window, click an object.
2. On the Action menu, click Add Totalization The Add Totalization
Entry dialog box appears (Figure 13-5).
Figure 13-5: Add Totalization Entry Dialog Box

3. Select an attribute.
4. Click OK. One of three dialog boxes appears, prompting you to
enter Totalization parameters for the specified attribute.
5. Define Totalization for the attribute.
6. Click OK. The new attribute is added to the Totalization database
and appears in the Totalization Item window.
Beginning Totalization
To begin Totalization for a selected attribute:
1. Select one or more attributes in the Totalization Item window.
2. On the Action menu, click Begin Totalization.
Ending Totalization
To end Totalization for a selected attribute:
1. Select one or more attributes in the Totalization Item window.
2. On the Action menu, click End Totalization. Totalization data
collection ends for the selected attributes.
Resetting a Totalization Value

To reset Totalization value:
1. Select one attribute in the Totalization Item window.
2. On the Action menu, click Reset Totalization Value. The Set
Totalization Value dialog box appears (Figure 13-6).
Figure 13-6: Reset Totalization Value Dialog Box

3. Enter the new value in the text field.
Note: Entries for Totalization must be whole numbers.
4. Click OK. The Totalization value is reset.
Modifying a Totalization Entry

To modify a Totalization entry:
1. Select the desired attribute to modify.
2. On the Action menu, click Modify Totalization Entry.
The Totalization Item dialog box appears (Figure 13-4).
Note: If Totalization is currently running on the attribute, only the
Limit, Report Type, Alarm Message Number, and
Totalization Units can be modified.
3. Modify the values.
4. Click OK.
Clearing a Totalization Entry

To clear an entry from the Totalization database:
1. On the Totalization Item window, click the desired attributes.
2. On the Action menu, click Clear Totalization Entry. The Clear
Totalization Entry dialog box appears (Figure 13-7).
Figure 13-7 : Clear Totalization Entry

3. Click OK.
Clearing Selected Reports

To clear archived Totalization data:
1. Select the Totalization report you want to delete.
2. On the Action menu, click Clear Totalization Entry. The Clear
Totalization dialog box appears (Figure 13-7).
3. Click OK.
Purging the File

To purge all data from a PC file:
1. Click the Reports Destination summary (PC file). The summary
appears.
2. Select Totalization.
3. Click Purge File. A dialog box appears asking you to confirm the
deletion.
4. Click Purge to delete all of the reports in the file.
Displaying the Totalization Data Window

To display the Totalization Data window:
1. Display the Totalization Item window.
2. Select the attributes whose Totalization data you want to display.
Note: If selecting more than one attribute, all selected attributes
must have the same period length to appear in the same
Totalization Data window. Up to seven attributes may be
selected.
3. On the Go To menu, click the Totalization Data option. The
Totalization Data window appears with the selected attributes
(Figure 13-8).
Figure 13-8: Totalization Data Window in Table Form (Default Display)

Table 13-5: Totalization Data Window Parameters

Field Description
ID Displays the ID used to identify the attributes. The ID is a single character from A
to G that references the appropriate bar in the graph or the appropriate column in
the table.
Item Displays the network/PC group/system/object name of the attribute being totalized
Attribute Displays the attribute being totalized
Value Displays when the Totalization data is displayed in a graph, the totalized value for
the sample. If the data is unavailable, ???? appears. When displayed in table form,
this field does not appear because the value is displayed in the table.
Units Displays the units of Totalization
Duration Displays the amount of time that Totalization data has been collected for the
attribute during the defined period. If data is not available, ???? appears in the field
Archiving Totalization Data

To archive Totalization data:
1. Click on the NCM containing the desired Totalization.
2. On the Action menu, click Archive Data. A dialog box appears
asking you to confirm the archive for the NC.
3. Click OK. The archiving process begins.
Note: The archive process may fail if there is not enough memory
to create a Totalization report.
Chapter 14
Using Trend
Introduction
The trend data is collected by the NCM and displayed in a graph or
table at the OWS. This chapter describes how to:
• display the trend item window
• add a trend entry
• begin trend
• end trend
• modify a trend entry
• clear a trend entry
• display a trend data window
• scale trend data
• refresh trend data
• activate fast trend
• archive trend data
• clear archived trend data
© August 1, 2001 Johnson Controls, Inc. www.johnsoncontrols.com

Code No. LIT-120178
Key Concepts
Trend
The Trend feature differs from the Point History feature in that Point
History data collection has a fixed attribute list, fixed sample period,
and fixed number of samples. In contrast, the Trend feature allows
operators to specify the attributes to be trended, the sample interval,
and the number of samples.
The Trend feature monitors changes in object attribute values over
time. The Trend feature answers questions like the following: How
constant is the temperature in a certain area of the building? How often
does the temperature get close to the warning limit?
The Trend feature can be accessed from any window displaying
objects or from a Reports Destination summary. The options are
described below.
Trend Accessed from a Window Displaying Objects

When accessed from a Network Map, an Object Focus window, or a
summary displaying objects, the Trend feature displays online data for
up to seven objects. The trend data is collected by the NCM and stored
in an NCM buffer.
Trend Accessed from a Reports Destination Summary

When accessed from a Reports Destination summary (a summary of
reports sent to a PC file), the Trend feature displays archived data for
objects that have trend data sent to the PC file.
Trend Item Window

Use the Trend Item window (Figure 14-1) to access the Data window
and set up trend.
Figure 14-1: Trend Item Window

Table 14-1 details the information found in the Trend Item window.
When accessed from a Reports Destination summary, Status and Total
NC Samples fields do not appear.
Table 14-1: Fields in the Trend Item Window

Field Description
Status Displays the status of trend collection for the attribute: No Trend, Began, End
Item Displays the name of the object whose attributes are being trended. If accessed
from a Reports Destination summary, the network, PC group, and system names
are also indicated
Attribute Displays the name of the attribute being trended
Display Units Displays the display units for the attribute being trended
Sample Interval Displays the interval at which the data is sampled
Total NC Samples Displays the number of trend samples is collected at the NCM
Trend Data Scales

Use the Trend Data window to display the actual trend data in either
table or graph form.
Trend Data Table

Figure 14-2 shows an example of Trend Data organized in table form.
This is the default format.
Figure 14-2: Trend Data Window in Table Form

Each column in the table corresponds to one of the attributes listed at
the top of the window and is labeled with the appropriate ID (A to G).
The columns display the values for the attribute at the various time
samples. When data is unavailable at sampling, the value field appears
blank. When data is unreliable (for example, if the NCM goes offline),
????? appears. Each row in the table represents one time sample. The
column on the far left displays the time and date of the sample. The
trend samples appear in chronological order, with the most current
samples at the top.
Trend Data Graph

The graph displays each item based on one of three scales: Common,
Individual, or User Defined. Common is the default. You’ll find out
how to change the type of scale later in this section. The scale values
are displayed on the Y-axis.
Each line in a graph corresponds to one of the trended attributes listed
at the top of the window and is labeled with the appropriate
ID (A to G). If data is unavailable, gaps appear in the line. The time is
displayed at the bottom of the chart, with the most current samples on
the far right.
The values displayed in the Value field at the top of the window reflect
the current position of the graph cursor.
Scaling Trend Data

Operators can scale Trend data using one of three scales: Common,
Individual, or User Defined. Common is the default.
Common scale is the only scale that displays values on the Y-axis.
With the Common scale, the high and low values are based on the
overall high value and overall low value for all of the objects being
trended. The middle value displayed on the Common scale graph is the
mid range between the highest and lowest value that any of the objects
have reached.
Individual scale determines the highest and lowest values for each
attribute being trended. The highest value on the graph will be the
same for all objects, even if the high values of each object is different.
User Defined scale is like Individual except it has a user-defined high
and low value for each of the objects being trended, rather than using
the actual high and low values each object has reached.
Fast Trend
The Fast Trend feature provides the higher sample rate required to
check the response of PID Loop objects.
When Fast Trend is activated, a Fast Trend graph appears at the top of
a PID Loop Object Focus window. This graph displays dynamic Fast
Trend information for up to four selected attributes.
The buffer in the NCM can hold up to 180 Fast Trend samples. When
the buffer is full, old samples are removed to make room for new
samples.
Fast Trending takes place only while the PID Loop Object Focus
window is open. When you close the window, the buffer is cleared. In
addition, whenever you change any of the Fast Trend setup
parameters, the buffer is cleared and trending starts over.
Only one PID Loop object from each DCM can display Fast Trend
information at one time.
When more than one request is made for Fast Trend information from
the same DCM, the most recent request overrides the previous request.
Figure 14-3 shows an example of a Fast Trend graph.
Figure 14-3: Fast Trend Graph in PID Focus Window

When data is unreliable, gaps appear in the attribute lines. Table 14-2
describes the trend data information that appears at the top of the Fast
Trend graph.
Table 14-2: Fast Trend Graph Fields

Field Description
Attribute Displays the name of the attribute being trended
Date and Time Displays the date and time of the sample
Value Displays the value of the attribute at the time sample indicated by the current graph
cursor position. When you move the graph cursor to another time sample position,
the value in this field updates.
If the graph cursor is moved to a time sample when the data is unreliable, this field
displays ?????.
Display Low Displays the minimum displayed value. Lesser values appear as the minimum
value.
Display High Displays the maximum displayed value. Greater values appear as the maximum
value.
Default Fast Trend Settings

When operators first activate a Fast Trend graph, it uses a default
setup. The default period length is six seconds, meaning that the
attributes are sampled every six seconds. Table 14-3 shows the default
Fast Trend setup.
Table 14-3: Default Fast Trend Attributes

Attribute Display Low Display High
Setpoint 30.0 80.0
Output 0.0 100.0
Feedback 30.0 80.0
Archiving Trend Data

Operators can archive any current trend data for all of the objects on
an NC. This prevents any data not yet archived from being lost during
an NCM download.
When you initiate the archive, both trend and totalization data for the
NC are archived.
Clearing archived trend data deletes it from the Reports Destination
summary (PC file). This option is only available in a Trend Item
window accessed from a Reports Destination summary.
Detailed Procedures
Displaying the Trend Item Window
Displaying the Trend Item Window from the Network Map
To display the Trend Item window from the Network Map:
1. Click a system on the map.
2. On the Go To menu, click Trend. The Trend Item window appears
(Figure 14-1).
Displaying the Trend Item Window from a Window

Displaying Objects
To display the Trend Item Window from a window displaying objects:
1. Display the summary or Focus window.
Note: If you are using an Object Focus window, skip step 2.
2. Select the system name in the stair-step directory or select an
object.
3. On the Go To menu, click Trend. The Trend Item window
Displaying the Trend Item Window from a Reports

Destination Summary
To display the Trend Item window from a Reports Destination
summary:
1. Click the PC file that contains the desired Trend report. The
2. Click Trend. The Trend Item window appears (Figure 14-1).
Adding a Trend Entry

To add and define trend collection for an object\attribute:
1. Select an object in the Trend Item window.
2. On the Action menu, click Add Trend Entry. The Add Trend
Figure 14-4: Add Trend Dialog Box

3. Fill in the fields. Refer to Table
Table 14-4: Add Trend Parameters

Field Description
Attribute Displays the name of the selected attribute
Number of Samples Displays the number of samples selected for the attribute
1st Display Units st
Displays the number of units for the 1 display attribute
2nd Display Units Displays the number of units for the 2
nd
display attribute
Sample Interval Displays the time between the sample interval
4. Click OK.
Beginning Trend
To begin trend data collection for selected attributes:
1. Select one or more attributes in the Trend Item window.
2. On the Action menu, click Begin Trend.
Ending Trend
To end trend data collection for selected attributes:
1. Select one or more attributes in the Trend Item window.
2. On the Action menu, click End Trend.
IMPORTANT: Trends restart when the NCM is downloaded, even if

you have marked the individual object trend as
Ended.
Modifying a Trend Entry

To modify trend entry:
1. Select an attribute.
2. On the Action menu, click the Modify Trend Entry. The Add
Trend dialog box for the selected attribute appears (Figure 14-4).
3. Modify the Display units and Sample Time Interval.
4. Click OK.
Clearing a Trend Entry

To clear an entry from the Trend database:
1. Select the attribute or attributes you want to clear.
2. On the Action menu, click Clear Trend Entry. A dialog box
appears, asking you to confirm the deletion.
3. Click OK.
Displaying the Trend Data Window

To display the Trend Data window:
1. Display the Trend Item window.
2. Select up to seven attributes to display in the Trend Data window.
3. On the Action menu, click Trend Data. The Trend Data window
Scaling Trend Data

To change the Trend scale:
1. Select an object to trend, and display the Trend Data window. The
Trend Data window appears in table form.
2. On the View menu, click Show as Drawing. The Trend Data
windows display data in graphical form.
3. On the Action menu, click Change Scale. The Change Scale
Figure 14-5: Change Scale Dialog Box

5. Click OK. The Trend Data window appears in the selected scale.
Activating Fast Trend

To activate Fast Trend:
1. Go to any window displaying the PID Loop object whose Fast
Trend information you want to view. For example, go to a System
summary displaying the object.
2. Click the object. The PID Loop Object Focus window appears.
3. On the Action menu, click Start/Modify Fast Trend. The Fast
Trend Setup dialog box appears.
4. Click OK. The Fast Trend graph is displayed at the top of the
Focus window.
Changing Fast Trend Setup

To change the Fast Trend setup:
1. Go to the Focus window of the PID Loop object that contains the
Fast Trend information you want to display.
2. On the Action menu, click Start/Modify Fast Trend option. The
Fast Trend Setup dialog box appears (Figure 14-6).
Figure 14-6: Fast Trend Setup Dialog Box

3. Modify the fields. Refer to Table 14-5.
Table 14-5: Fast Trend

Field Description
Period (secs) Specifies the interval between Fast Trend samples (1 to 32, 767 seconds)
Name Displays the name of the attribute
Min. displayed value Displays the minimum value for the attribute
Max. displayed value Displays the maximum value for the attribute
4. Click OK.
Restarting Fast Trend

To restart Fast Trend collection:
1. On the Action menu, click Start/Modify Fast Trend. The Fast
Trend Setup dialog box appears.
2. Click OK.
Note: Because the most recent request overrides all previous
requests, Fast Trend collection stops for any other PID Loop
object from the same DCM.
Stopping Fast Trend

To stop Fast Trend collection, on the Action menu, click Stop Fast
Trend. Fast Trending stops for the PID Loop object.
Archiving Trend Data

To archive trend data:
1. Go to the Network Map.
2. Click on the NCM containing the archive data you want to
archive.
3. On the Action menu, click Archive Data. A dialog box appears
asking you to confirm the archive for the NC.
4. Click OK.
Note: The archive process may fail if there is not enough memory
to create a Trend report.
Clearing Archived Trend Data

Clearing Selected Reports
To clear selected reports:
1. Select the trend report you want to clear. The selected report
appears highlighted.
2. On the Action menu, click Clear Trend Entry. A dialog box
appears, asking you to confirm the deletion.
3. Click OK.
Purging the File

To purge all data from a PC file:
1. Click the Reports Destination summary. The summary appears.
2. Select Trend.
3. Click Purge File. A dialog box appears asking you to confirm the
deletion.
4. Click Purge. All of the reports in the file are deleted.
Chapter 15
Using Dial-Up with the NCM
Introduction
The Dial-Up Input/Output (I/O) feature (Dial-Up) allows a Metasys
Network to communicate over phone lines (via a modem) to remote
I/O devices such as OWS or printers. Whenever communication to a
remote device is needed, Dial-Up makes the connection.
Communication to a remote device is necessary when a remote device
is defined as a destination for Critical or Follow-Up change-of-state
reports or summaries.
This chapter describes how to:
• initiate a call
• cancel a call
• hang up a call

Code No. LIT-120179
Key Concepts
Dial-Up
Dial-Up is different from other features because you do not access it
by clicking a menu option. Instead, the Dial-Up window appears
automatically whenever remote communication is required.
Communicating with Remote Printers

A Metasys Network can communicate with a remote printer that is
designated as an output device over Plain Old Telephone Service
(POTS) phone lines, via a modem.
This is done by connecting the remote printer (via a modem) to a
NCM. This NCM acts as a gateway to the rest of the network. The
phone connection is initiated by the local NCM. The printer can be
defined as the destination for Critical, Follow-Up, Status, or
Transaction reports.
Communicating with Remote Operator Workstations

A Metasys Network can communicate over phone lines (via a modem
or terminal adapter) with a remote workstation. This is done by
connecting the remote workstation to a NCM. This NCM acts as a
gateway to the rest of the network. The phone connection can be
initiated by the NCM or by the remote workstation. The remote
workstation can be defined as a destination for Critical, Follow-Up,
and other reports.
Dial-Up Window
Figure 15-1 shows the Dial-Up window that appears whenever remote
communication is about to be initiated. This window displays the
name of the network that is about to be called.
Figure 15-1: Dial-Up Window
Connection is Successful
The Dial-Up window displays the source, destination, and duration of
the call. The duration updates every second. The status of the
connection is also displayed, as well as the baud rate of
communication.
The local workstation can handle up to two simultaneous connections
to remote devices. Therefore, there can be up to two Dial-Up windows
(or telephone icons) on the screen at one time.
Detailed Procedures
Initiating a Call
To initiate a call:
1. Logon.
2. Click the Continue button on the Connection dialog box and the
call is attempted immediately.
Note: Conection is automatically attempted after 10 seconds
without user action.
Canceling a Call
To cancel a call:
1. Logon.
2. Click the Cancel button when the Connection Dialog box appears.
Ending a Call
To end a call:
1. Display the Control menu by clicking the Control-menu box in the
upper left corner of the Dial-Up window.
2. Click Hang Up. The connection is canceled; however, any
applications using Dial-Up remain open until closed by the user.
Notes: After hanging up, if the operator initiates any action from the
network map that requires online data, a dial-up connection
occurs, and the connection remains active until the user logs
off or hangs up.
After hanging up, any scheduled operation or incoming call
makes the connection, performs the operation required, and
then terminates the connection after the operation is
complete.
The Hang-Up option is only available in the Control-menu
box accessed from a Dial-Up window.
Chapter 16
Using Dial-Up with the NDM
Introduction
This section describes using the Dial-Up feature to connect to remote
devices via the N2 Dialer Module (NDM).
The N2 Dial feature allows you to communicate over phone lines
through the NDM to remote devices. Using the NDM may eliminate
the need for a second NCM at the remote site.
The N2 Dial feature also allows remote devices to send alarms and
change-of-state messages to the local OWS.
Before you can connect to devices using the N2 Dialer Module, both
the local and remote NDMs must be configured using the N2 Dial
application in the HVAC PRO system.
• display the N2 Dial Network summary
• refresh the N2 Dial Network summary
• close the N2 Dial Network summary
• dial a remote site
• disconnect from a remote site

Code No. LIT-120180
Key Concepts
N2 Dial Network Summary
The N2 Dial Network summary displays the status of all connections
from the OWS to remote sites that are connected via the NDM.
It is also used to dial a remote site or disconnect from a remote site.
Figure 16-1 shows an example of an N2 dial network summary.
Table 16-1 describes the different fields in the summary.
Figure 16-1: N2 Dial Network Summary
Table 16-1: Fields in the N2 Dial Network Summary

Field Description
Dial State Indicates that the local network dialed a remote site (Dial-Out) or a remote site
dialed in to the local network (Dial-In)
Remote Site Name The name of the remote site as it was defined when configuring the local NDM
using the HVAC PRO system. (This is not the System/Object name.)
Telephone # The phone number for the remote site as it was defined when configuring the local
NDM using the HVAC PRO system
Refreshing the N2 Dial Network Summary

Refreshing the N2 Dial Network Summary updates the summary to
show all remote sites in their current state.
When you dial out to a remote site, and then return to the N2 Dial
Network summary, the Dial State field for remote site to which you
dialed is updated (to Dial-Out).
If a remote site dials in to the local network, the N2 Dial Network
summary does not refresh to reflect the current Dial State field
(of Dial-In). You must manually refresh the summary.
Log Off the Metasys System

By default, when the password times out, or when a user logs off the
Metasys system, communications to all remote sites are automatically
disconnected. When operators set the N2DialDisconnectOnLogoff
parameter in the METASYS.INI file to No, all sites remain connected
after logging off.
IMPORTANT: If you set the N2DialDisconnectOnLogoff parameter

to No, the OWS remains connected to the remote site
until you manually disconnect. This is especially
important to remember if you have long distance
remote site connections.
Detailed Procedures
Displaying the N2 Dial Network Summary
To display the N2 Dial Network summary, on the Setup menu, click
N2 Dial. The N2 Dial Network summary appears (Figure 16-1).
Refreshing the N2 Dial Network Summary

To refresh the N2 Dial Network summary manually:
1. Display the N2 Dial Network summary.
2. On the Action menu, click Refresh. The N2 Dial Network
summary is refreshed.
Closing the N2 Dial Network Summary

To close the N2 Dial Network summary, on the Item menu, click
Close.
Notes: The N2 Dial Network summary cannot be closed until you
have disconnected from all remote sites to which you dialed
out from the OWS. If you attempt to close without
disconnecting, a message box appears telling you to
disconnect from all remote sites before closing the summary.
(The summary can be closed while a remote NDM is dialing
in.)
If you log off and the summary is open, you are
automatically disconnected from all dialed out remote sites
and the summary closes before the logoff is initiated.
If you want to close the summary (or log off) without
disconnecting, change the
N2DialDisconnectOnLogoff setting in the
METASYS.INI to No. However, it is important to remember
that all connections, even long distance, will remain intact
after you close the summary (or log off).
Dialing a Remote Site

Note: To dial a remote site, both the local and remote NDMs must
first be configured using the N2 Dial application in the
HVAC PRO system.
To dial a remote site:
1. On the Setup Menu, click N2 Dial. The N2 Dial Network
summary appears.
2. Select the Remote Site Name to which you want to dial.
Note: If the remote site is currently dialed in, the dial-in connection
is automatically broken when dialing out using the same
NDM.
3. On the Action menu, click Dial. The N2 Dial dialog box appears
(Figure 16-2).
Figure 16-2: N2 Dial Dialog Box

4. Select the desired NDM.
Notes: Only those NDMs configured with the Remote Site
selected in Step 2 appear in the NDM list.
If an NDM is currently communicating with a remote
site (either Dial-Out or Dial-In), the Dial State appears
next to the name of the NDM. If you choose to use this
NDM, the current connection is automatically broken.
5. Click Dial.
Note: The Dial Status field is valid only during the Dial process.
Table 16-2 describes the six Dial statuses that may appear in
the Dial Status field during the Dial process.
Table 16-2: Dial Statuses

Status Description
Connected Indicates that the Dial operation was successful and that you are
currently connected to the remote site
Dialing Indicates that the NDM is currently dialing the remote site
Disconnected Indicates that the NDM is currently disconnected from the remote
site
Failed Indicates that the Dial operation failed. The NDM will try to dial
the remote site the number of times specified when the NDM is
configured using the HVAC PRO system. If no connection is
made, the Dial Status is failed. The user must then click Dial to
reinitiate the dial operation.
None Indicates that the Dial operation is currently not being performed.
This is the status that is displayed until the Dial button is clicked
and the Dial process begins.
Retrying Indicates that a connection could not be made and that the NDM
is currently retrying the number. The number of retry attempts is
specified when configuring the local NDM with the HVAC PRO
system.
6. When the Dial operation is complete, the Dial Status appears

either connected or failed.
7. Minimize (or close) the N2 Dial Network summary to view the
Network Map.
Note: You cannot close the N2 Dial Network summary without
disconnecting from all remote sites to which you dialed out
from the OWS.
Disconnecting from a Remote Site

To disconnect from a remote site:
1. On the N2 Dial Network summary, choose the remote site from
which you want to disconnect.
2. On the Action menu, click Disconnect. The phone connection is
disconnected and the status Dial-Out no longer appears in the Dial
Status field.
Chapter 17
Online Generation Overview
Introduction
Online generation is the process performed at the Operator
Workstation (OWS) to set up or modify a database. Setting up a
database means defining the networks, devices, Personal Computer
(PC) groups, systems, and objects that make up the facility.
For example, when defining a network, you specify the type of
connection between the network and the OWS: N1-Direct, NC-Dial, or
NC-Direct. When defining a system, specify the system name, report
group, and host Network Control Module (NCM). When defining
software and hardware objects, specify values for the object attributes.
For example, specify display units for binary objects and alarm limits
for analog objects.
Online generation can be performed at two stages: when the Building
Automation System (BAS) is initially set up and when additions or
changes are made to the facility. During initial setup, use definition
windows and dialog boxes to define new items. Use Focus windows to
view and modify existing definitions.
To define databases offline, use Data Definition Language (DDL) and
Graphic Programming Language (GPL). For detailed information on
DDL and GPL, refer to the DDL Programmer’s Manual and the GPL
Programmer’s Manual.
© April 1, 2002 Johnson Controls, Inc. www.johnsoncontrols.com

Code No. LIT-120143
Key Concepts
Online Generation
The OWS requires the entry of a Level 1 or 2 password to perform
online generation.
As part of the minimum database, the OWS provides a default Level 1
password. Use the default password to log onto the OWS and define a
new password. Give the new password a level of 1 (the system must
always have at least one Level 1 password). Then delete the default
password.
Always define items in the proper order, from highest to lowest level
of organization. For example, define networks before PC groups,
define PC groups before systems, and define systems before objects.
After making changes to the database, perform an upload. Uploading
copies the operational database (the database altered during
Online Generation) to the archive database stored at the OWS.
Because the archive database is the master copy, upload often.
Minimum Database
The OWS provides the following minimum database:
• one PC, N1-Direct
• one NCM
• one network, N1-Direct
• default password database
• one system “SYS”
• 16 report access groups
This minimum database provides a foundation and allows the user to
add as many new items (networks, PC groups, systems, and objects) as
the facility requires, or delete items that are not required by the
facility.
Detailed Procedure
Performing Online Generation
Perform Online Generation steps in the following order:
1. Log on using the default password, define a new Level 1 password,
and delete the default password.
2. Modify the minimum database to meet the specific requirements of
your facility.
3. Define networks. See the Defining Networks chapter (LIT-120144)
in this manual.
4. Define devices (for example, OWS, NCM, Printer, etc.). See the
Defining Devices chapter (LIT-120145) in this manual.
5. Define PC groups. See the Defining PC Groups chapter
(LIT-120146) in this manual.
6. Define the systems within the PC groups. See the Defining Systems
chapter (LIT-120147) in this manual.
7. Define software models. See the Defining Software Models chapter
(LIT-120148) in this manual.
8. Define the hardware objects within the systems. See the Defining
Objects chapter (LIT-120149) in this manual.
9. Define hardware objects before software objects because software
objects must be assigned to an existing hardware system and object
name.
10. Define the software objects.
11. Perform the additional Online Generation tasks in any order
(define passwords, define report/access groups, create alarm
messages, define graphics, etc.).
12. Upload the modified databases (NCM and global) to make sure the
archived versions (master copies) stored at the OWS are kept up to
date.
Chapter 18
Defining Networks
Introduction
A network is a group of related equipment controlled by at least
one NCM and interconnected by an N1 Local Area Network (LAN)
Bus (or, in the case of remote networks, a modem and phone lines). A
facility may consist of one network or of multiple networks. The OWS
monitors and controls these networks.
• define a new network
• modify a network
• delete a network

Code No. LIT-120144
Key Concepts
Network Definition
Each network must be defined. To define a new network, assign it a
name and specify the connection type between the network and the
OWS. The connection types are N1-Direct, NC-Direct, and NC-Dial.
N1-Direct means the network is connected to the OWS via the N1
LAN. NC-Direct means the network is directly connected to the OWS
via a port on the NCM. NC-Dial means the network is remotely
connected to the OWS via a modem, phone lines, and a serial port on
the NCM, or via the Integrated Services Digital Network (ISDN) and a
serial port on the NCM.
The Metasys BAS contains at least one defined N1-Direct network as
part of the minimum database.
Network Summary
The Network Summary lists all the networks defined for an OWS.
Figure 18-1 shows an example of a Network Summary.
Figure 18-1: Network Summary

Table 18-1 describes the fields in the Network Summary.
Table 18-1: Network Summary Fields

Field Description
Status Current network status: online or offline. An asterisk (*) indicates the network is
offline.
Name Network name
Description Network’s expanded ID
Port Port on the OWS used for NC-Dial or NC-Direct connect communication: COM1,
COM2, COM3, or COM4
Type Type of connection: N1-Direct, NC-Dial, or NC-Direct
Network Focus Window

Use the Network Focus window to view and modify the definition
information for an existing network. Figure 18-2 shows an example of
a Network Focus window.
Figure 18-2: Network Focus Window

Network Activation
Use the Activate Network option to switch between networks in a
multiple-network facility. A maximum of five networks can be active
at one time using any combination of the following:
• one to five N1-Direct networks
• up to four NC-Direct networks
• up to two NC-Dial remote networks
The Network Map displays the most recently activated network.
More than one window for an active network can be open at a time.
Complete functionality (for example, commanding, scheduling) is
available in all activated networks.
Note: To deactivate an NC-Dial (modem or ISDN) remote
network, use the Hang Up option in the Dial-Up Window
Control menu.
Detailed Procedures
Defining a New Network
To define a new network:
appears.
2. On the Item menu, select New. The Network-Item New dialog
Figure 18-3: Network-Item New Dialog Box

3. Click the appropriate button next to the network type (N1 direct,
NC direct, or NC dial).
4. Click OK. The Network Definition window appears, with default
values. Figure 18-4 is an example of an NC Dial-up Network
Definition window.
Figure 18-4: Network (NC Dial-up) Definition Window

5. Fill in all of the fields in the Network Definition window.
Table 18-2 describes each of these fields.
Table 18-2: Network Definition Window Fields

Field Description
Network Name Name of the network as it will appear on the network map
Expanded ID Expanded description of the network
PC Name Name the current PC will have on the network
Dial Type* Tone the modem uses when dialing out
Phone Number* Number the PC dials to connect to the network
* NC dial only
Modifying a Network
To modify network definition information:
2. Double-click the network. The Network Focus window appears
(Figure 18-2).
3. Make the desired changes. Only the values contained in boxes
may be modified.
Deleting a Network
To delete a network:
1. Delete all PC groups and systems in the network. See the Defining
PC Groups (LIT-120146) and Defining Systems (LIT-1201147)
chapters later in this manual.
3. Select the network.
4. On the Item menu, click Delete. The Delete dialog box appears.
5. Click OK to delete the network from the operational database.
Troubleshooting
Correcting Invalid Entries
If you enter invalid information into a field, the field appears red when
you attempt to select another field. When this occurs, select the
incorrect value and type in the correct information. In addition, if you
attempt to save a network with invalid information, a dialog box
appears, informing you of the error. Acknowledge the message by
clicking the OK button. Make the necessary corrections and attempt to
save the network again.
An entry might be invalid because it is not in the correct format or
because it exceeds the valid range.
Chapter 19
Defining Devices
Introduction
Devices include NCMs, OWSs (PCs or portable computers), and
printers. Each network has a system called Devices, which contains all
the defined devices in the network.
Note: N2 devices (for example, DCM, XBN, XRL), S2 devices
(for example, FPU, DSC8500), L2 devices (DSC), and
N2E devices (for example, DX91ECH) are considered
hardware objects. Refer to the Defining Objects chapter
(LIT-120149) of this manual.
• define a device
• modify a device definition
• delete a device
• define and modify a default report destination
• delete a default report destination
• set up or modify PC ports
• modify the IP address of a device

Code No. LIT-120145
Key Concepts
Devices Summary
Use the Devices summary to view devices, delete devices, and access
device Focus and Definition windows. Figure 19-1 shows an example
of a Devices summary.
Figure 19-1: Devices Summary

Table 19-1 describes the information that each field in the Devices
summary provides.
Table 19-1: Devices Summary Fields

Field Description
Status Status of the device: online or offline. If the device is offline, an asterisk appears. If
online, no asterisk appears
Item Name of the device
Description Device’s expanded ID
Device Focus Windows

To view or modify the definition information for a selected device, use
the Device Focus window. Figure 19-2 shows the Network Controller
(NC) Focus window.
Figure 19-2: NC Focus Window
Default Report Destination

Device Focus windows are nearly identical to Device Definition
windows. However, the Printer and PC Focus windows have
one additional field: Default Report Destination. This field displays the
currently defined default report destination. Reports are sent to this
default destination if the device is offline and unable to receive reports.
The default destination can be any defined PC, defined printer, or
PC file.
Internet Protocol (IP) Address

Unless a device is defined offline using DDL, its default address is
0.0.0.0. Modify the IP Address using the IP Address Configuration
summary (Figure 19-8).
Unconfigured OWSs
Unconfigured OWSs have the same functionality as defined OWSs,
except that they cannot receive change-of-state reports or archive data.
An unconfigured OWS can be NC-Direct or NC-Dial (not N1-Direct).
Unconfigured OWSs do not appear in the Devices system on the
Network Map or in the Devices summary.
To use an unconfigured OWS, make the NC-Direct or NC-Dial
connection and log on to the desired network using the Logon dialog
box. The unconfigured OWS must have the network in its database. If
the unconfigured OWS does not have the network in its database,
define the network at the undefined OWS.
Detailed Procedures
Defining a Device
To define a device:
1. Double-click Devices. The Devices summary appears
(Figure 19-1).
2. On the Item menu, click New. The Devices-Item New dialog box
Figure 19-3: Devices-Item New Dialog Box

3. Select a type of device to define: PC, NCM, or Printer. To define a
portable computer, select PC.
4. For PC or Printer definition, specify the type of connection
between the device and the network.
5. Click OK. The Definition window for the selected device appears.
Figure 19-4 shows an example of an NC Definition window.
Figure 19-4: NC Definition Window

6. Fill in the fields. Use online help for descriptions of the fields and
the formats and valid ranges for entered values.
Note: To define a printer with a PC-Direct connection, specify
the Object Name, Windows Printer – Driver Name, and
the Windows Printer – Printer Name as suggested in the
Operator Workstation Technical Bulletin (LIT-636013).
Note: Items defined in the device’s Definition window
(connection type, baud rate, subnet address, and port)
may also need to be defined in the NOVRAM
View/Modify dialog box. Refer to the NCSETUP
for Windows Technical Bulletin (LIT-6360251d) for
detailed information.
8. To add the changes to the archive database, perform a global
upload.
9. After PC definitions, compile the NET DDL database on the

newly defined PC.
10. After NCM definition, perform a global upload. Compile the NC
DDL database file, and perform a code and data download to the
NCM.
Shortcut
To copy definition information from one device to another:
1. Select a device in the Devices summary that is similar to the new
device.
2. For example, to define a new N1-Direct Connect PC, select an
existing N1-Direct Connect PC in the Devices summary.
3. On the Item menu, select New. The Copy From field at the bottom
of the Definition dialog box displays the name of the selected
device.
4. Click OK. A Definition window appears with the same
configuration as the selected N1-Direct Connect PC.
5. Specify a unique name, make any necessary changes, and save the
new device.
Modifying a Device Definition

IMPORTANT: Changing the definition information of a PC or printer
while data is being sent to the device can result in the
loss of the data.
To modify device definition:
1. Double-click the name of the device. The Focus window for the
selected device appears.
If you are not familiar with a field, use online help. This help
includes descriptions of the fields and the formats and valid
ranges to use when entering values.
Note: To define a printer with a PC-Direct connection, specify
the printer in the Printer Type field exactly as it is
specified in the Windows Control Panel (under the
Printers icon).
3. On the Item menu, click Save. Close the window after the changes
are saved.
Note: Some of the items modified in the device’s Focus
window (such as connection type, baud rate, and subnet
and port address) may also need to be modified in the
NOVRAM View/Modify dialog box. Refer to the
NCSETUP for Windows Technical Bulletin
(LIT-6360251d) for detailed information.
4. To add the changes to the archive database, perform a global
upload.
After modifying an NC device, perform an NC data download,
following the guidelines described in the Uploading and
Downloading Databases chapter (LIT-120155) of this manual.
Deleting a Device
To delete a device:
1. Double-click Devices. The Devices summary appears
(Figure 19-1).
2. Click the device.
Note: Only one device can be deleted at a time. The delete
option is not available if more than one device is
selected or if no devices are selected.
4. Click the OK button in the Delete dialog box to delete the device
from the operational database. The device no longer appears in the
Devices summary.
To add the changes to the archive database, perform a global
upload.
After deleting a PC (either dial-up or directly connected to an
NCM), perform an NC data download.
Defining or Modifying a Default Report Destination

To define or modify a default report destination:
1. Double-click the name of the PC or printer. The Focus window for
the selected device appears.
2. On the Action menu, click Add Default Destination. The Add
Destination dialog box appears (Figure 19-5).
Figure 19-5: Add Destination Dialog Box

3. Select the default destination type by clicking the Printer or PC
option button or the PC file option button. The Destination list
box displays all defined printers and OWSs in the facility, or all
defined OWSs, depending on the destination type.
4. Specify the destination by clicking the name of the printer, PC, or
PC file.
To select a PC file, first select the OWS where the file resides.
The Files list box displays all existing PC files at that OWS.
Either select an existing file, or type in a new file name in the File
Name text box. Typing a new file name creates the file at the
selected OWS.
5. Click OK. The destination appears in the Default Report
Destination field in the Device Focus window.
To add the changes to the archive global database, perform a
global upload (described in the Uploading and Downloading
Databases chapter [LIT-120155] of this manual).
Deleting a Default Report Destination

To delete a default report destination:
1. Double-click the name of the PC or printer. The Focus window for
the selected device appears.
2. On the Action menu, click Delete Default Destination. The Delete
Default Destination dialog box appears.
3. Click the OK button to delete the default destination from the

operational database. The Default Report Destination field in the
Device Focus window appears blank.
upload (which is described in the Uploading and Downloading
Setting Up or Modifying PC Ports

To set up or modify PC ports:
1. On the SetUp menu, click PC Configuration. The PC
Configuration dialog box appears (Figure 19-6).
Figure 19-6: PC Configuration Dialog Box

Note: If the Device Type is Mouse or Printer, the 19200 baud
rate is not valid.
2. Select a port (for example, COM1, COM2, COM3, or COM4).
3. Click the Device Type that corresponds to the device connected to

the selected port. COM3 and COM4 are limited to direct
connections.
4. Click the Baud Rate that corresponds to the baud rate for the
selected port. A 19200 baud rate is valid only if the Device Type
is NC Direct or NC Dial (POTS or ISDN).
5. Repeat Steps 3 through 5 until all ports are configured.
6. Click OK, and reboot the PC.
Setting Up the Modem for the PC

To set up the modem for the PC:
1. Click Modem Setup button in the PC Configuration dialog box.
The Modem Setup dialog box appears (Figure 19-7).
MODEM SETUP - PC Configuration
Modem Port OK
COM1
COM2 Cancel
Select Modem Type Below

(Brand Names)
Modemset
Figure 19-7: Modem Setup Dialog Box

2. Select the COM port that the modem uses.
3. Use the Select Modem Type Below drop-down menu to select the
brand of the modem.
4. Click OK. This operation sends the correct setup string to the
metasys.ini file.
5. Restart Metasys software to load string into the attached modem.
Modifying the IP Address of a Device

To modify the IP Address of a device:
1. On the SetUp menu, click IP Address Configuration. The
IP Address summary appears (Figure 19-8).
Figure 19-8: IP Address Summary

2. Select the device. The device appears highlighted.
3. On the Action menu, click Modify IP Address. The Item
Address-Modify IP Address dialog box appears (Figure 19-9).
Figure 19-9: Item Address-Modify IP Address Dialog Box

Note: To set the IP Address to zero, select Zero IP Address in
the Action menu rather than Modify IP Address. This
automatically sets the selected device and all other
devices with the same subnet address to 0.0.0.0.
4. Enter the new IP address and click OK. The new address appears
in the IP Address Configuration summary.
5. On the System menu, click Save.
6. Double-click the Control Menu box to close the summary.
Troubleshooting
you attempt to select another field. In this case, select the invalid entry
and correct it. In addition, if you attempt to save invalid information, a
dialog box appears indicating the error. In this case, acknowledge the
message by clicking the OK button. Then make corrections and
attempt to save the information again.
An entry might be invalid because it is in the wrong format or exceeds
the valid range.
Chapter 20
Defining PC Groups
Introduction
A PC group (group) is a set of systems or other PC groups. Group
systems by location, function, or any other convenient association. For
example, if a network facility has two wings, it might be useful to
group the systems within the facility according to the two wings. In
this case, define two PC groups: EAST and WEST. Then, when
defining a system, assign the system to the appropriate PC group.
The PC group level of organization is not global data; it resides only at
the OWS used to define the groups, and Metasys software does not use
it to control objects. However, for the operator’s understanding of the
facility, the group level might be very helpful. In addition, the PC
group name appears on alarm reports, change-of-state reports, and
other summaries to help quickly pinpoint the source of information.
• define a new PC group
• modify the expanded ID of a PC group
• delete a PC group

Code No. LIT-120146
Key Concepts
PC Groups
The PC group names appear as branches on the Network Map. There
can be up to three nested PC group levels.
PC Groups
HDQTRS
EAST
1st Floor
2nd Floor
3rd Floor
4th Floor
AHU1
AHU2
Mechroom
Boiler
West
1st Floor
pcgroups
Figure 20-1: PC Groups on the Network Map

In Figure 20-1, HDQTRS is the name of the network. EAST and
WEST are PC groups. MECHROOM is one of the PC groups within
the EAST group. AHU1 and AHU2 are systems within the 4th Floor
group.
The PC group SYSTEMS (not shown in Figure 20-1) contains all
systems that were not placed in any other particular PC group. If no
such systems exist, this PC group does not appear on the Network
Map.
Defining a new PC group involves naming the group and specifying its
expanded ID. To define a new group, display the PC Group Definition
dialog box from the PC Group summary or from the Network Map.
Define a PC group either as a branch from the network itself, or as a
branch within another PC group.
PC Group Summary
The PC Group Summary lists all the items in the selected PC group.
Figure 20-2 shows an example of a PC Group summary.
Figure 20-2: PC Group Summary

Table 20-1 details the information displayed in the PC Group
Summary.
Table 20-1: PC Group Summary Fields

Field Description
Name Name of the system or group within the PC group
Description Expanded ID of the system or group within the group
Detailed Procedures
Defining a New PC Group
Defining a New PC Group as a Branch within Another PC
Group:
To define a new PC group as a branch within another PC group:
1. Double-click the name of the PC group you wish to add to the
other PC group. The PC Group summary appears (Figure 20-2).
2. On the Item menu, click New. The Item New dialog box appears
(Figure 20-3).
Figure 20-3: Item New Dialog Box

(for PC Groups and Systems)
3. Click the PC Group option button.
4. Click OK. The PC Group Definition dialog box appears
(Figure 20-4).
Figure 20-4: PC Group Definition Dialog Box

5. Type the name of the new PC group (up to eight characters) and
its expanded ID (up to 24 characters).
6. Click OK.
Defining a New PC Group as a Branch from a Network

To define a new PC group as a branch from a network:
1. Double-click the Network name to display a Standard Network
summary (instead of a PC Group summary).
2. On the Item menu, click New.
Modifying the Expanded ID of a PC Group

To modify the expanded ID (description) of a PC group:
1. Select the PC group that contains the group you want to modify.
2. On the GoTo menu, click Selected Item. The PC Group Standard
Summary appears (Figure 20-2).
3. Select the PC group.
4. On the Action menu, click Modify Group/System. The Modify
dialog box appears.
Figure 20-5: Modify Dialog Box

5. Make the necessary changes to the Expanded ID field.
6. Click OK.
Deleting a PC Group
Note: Before deleting a PC group, delete all the groups and
systems within the group.
To delete a PC group:
1. Double-click the network or the PC group that contains the group
you want to delete. The Network or PC Group summary appears.
2. Click the PC group you want to delete.
4. Click OK.
Troubleshooting
If a dialog box field contains invalid information, a message appears
when you attempt to save the new PC group. Acknowledge the
message by clicking the OK button. Then correct the field and try
saving the PC group again.
An entry might be invalid because it is not in the correct format.
Chapter 21
Defining Systems
Introduction
Systems are sets of objects related by function, location, or any other
convenient association. For example, the hardware and software
objects in one air handling unit might comprise the system called
AHU1. The hardware and software objects in another air handling unit
might comprise AHU2.
Define a system at one of two levels: as a branch from the network
name itself or as a branch within a defined PC group. It is more
common to define a system as a branch within a defined PC group.
• define a system
• modify a system
• delete a system
• change the system display order
• move a system to a new PC group

Code No. LIT-120147
Key Concepts
Modifying a System
It is possible to modify a system’s expanded ID (description) or assign
the system to a different report/access group. See Modifying a System
under Detailed Procedures.
System Display Order

Systems are displayed in summaries, in printouts, and at the Network
Terminal in the order in which they are defined. To change this order,
use the System/Object Display Reorder function. Unlike Sort and
Filter functions that change the order for the currently displayed screen
only, this function permanently changes the display order. See
Changing System Display Order under Detailed Procedures.
PC Groups
Most systems are defined as a branch within a PC group. The user can
move a system from one PC group to another with the Modify Group
Assignment function. This is a permanent move and appears on the
Network Map and in summaries. See Modifying a Group Assignment
later in this chapter.
Detailed Procedures
Defining a System
To define a system:
1. Double-click the PC group. The PC Group summary appears.
(Figure 21-1).
Figure 21-1: Item New Dialog Box

(for PC Groups and Systems)
3. Click the System option button. The Item New - System
Definition dialog box appears (Figure 21-2).
Figure 21-2: Item New - System Definition Dialog Box

4. Specify the unique name of the system (up to eight characters).

5. Specify the expanded ID (up to 24 characters).
6. Specify the report/access group that determines destinations for
reports regarding objects in the system (from 1 to 16).
7. Specify the host NCM that contains the system’s object
dictionary. This must be a defined NCM.
8. Click OK.
Shortcut
To copy definition information from one system to another:
1. Select an existing system in the PC Group summary that is similar
to the new system.
2. On the Item menu, click New. The name of the selected system
appears in the Copy From field in the Item New dialog box.
3. Click OK. The System Definition dialog box appears. The values
of the selected system appear in the fields in the dialog box.
4. Enter a unique name, make any necessary changes, and save the
new system.
Modifying a System
To modify a system:
1. Select the PC group that contains the system.
2. On the GoTo menu, click Selected Item. The PC group Standard
Summary appears (Figure 21-3).
Figure 21-3: PC Group Standard Summary

3. Click the system.
4. On the Action menu, click Modify Group/System. The Modify

Figure 21-4: Modify Dialog Box

5. Make the necessary changes to the Expanded ID or Access/Report
Group fields.
6. Click OK.
Deleting a System
Note: Delete all objects from a system before deleting the system
itself.
To delete a system:
1. Double-click the PC group that contains the system. The PC
Group summary appears.
2. Click on the system (or systems).
4. Click OK.
upload (described in the Uploading and Downloading Databases
chapter [LIT-120155] of this manual).
Changing the System Display Order

To change the system display order:
1. Click the name of the network.
2. On the SetUp menu, click System/Object Display Reorder. The
System Reorder window appears, listing all the systems in the
network in their current positions (see Figure 21-5).
Figure 21-5: System Reorder Window

3. Select a system to move to a new position.
4. On the Action menu, click Reorder System. The System Reorder
dialog box appears (Figure 21-6), displaying the name of the
selected system and its current (old) position.
Figure 21-6: System Reorder Dialog Box

5. Type the number of the new position in the New Position text box.
A number equal to or greater than the total number of systems in
the network displays the system in the last position.
6. Click OK.
7. To reposition more systems, repeat Steps 5 through 9.
upload (refer to the Uploading and Downloading Databases
chapter [LIT-120155]).
Moving a System to a New PC Group

To move a System to a New PC Group:
1. Click the name of the system.
Note: Only one system may be moved at a time. If you select
no system or more than one system, the Modify Group
Assignment option is not available in the SetUp menu.
2. On the SetUp menu, click Modify Group Assignment. The
Modify Group Assignment dialog box appears (Figure 21-7),
displaying the name of the selected system and its current group
assignment.
Figure 21-7: Modify Group Assignment Dialog Box

3. In the New Group text box, either type in the name of the new PC
group, or use the scroll bar on the right side of the text box to
scroll through all the groups in the network.
4. Click OK.
Troubleshooting
If a dialog box field contains invalid information, a message appears
when you attempt to save the new system. Acknowledge the message
by clicking the OK button. Then make the necessary corrections and
try saving the new system again.
Chapter 22
Defining Software Models
Introduction
A software model is a predefined set of attributes used as a default for
defining Control System (CS) software objects. OWS uses a specified
model as a reference and assigns its attributes and values to the new
object.
The software model serves three purposes:
• It makes Control System object definition possible.
• It allows for the creation of Control Systems well in advance of
product installation.
• It helps to ensure that Application Specific Controllers (ASCs),
such as the Unitary Controller (UNT), Air Handling Unit (AHU),
Variable Air Volume (VAV), Variable Air Volume Modular
Assembly (VMA), and DX-9100 are used consistently throughout
a facility.
The chapter describes how to:
• define a software model
• view a software model
• modify a software model
• print a software model

Code No. LIT-120148
Key Concepts
Software Model Definition
Software model definition involves adding a new model to a PC
archive database. It can then be used as a reference during database
generation to configure Control System objects for Application
Specific Controllers (ASCs).
When creating a software model, plan your attributes carefully. You
must define every attribute you declare or start the process again. For
example, if you declare five attributes but only define four of them,
you must cancel the define operation and start over.
To create a new software model quickly and easily, find an existing
model that is similar to the new model. Make a copy of the existing
model and edit the copy. See the Detailed Procedures section later in
this chapter.
Notes: New and modified software models exist in the archive of
the OWS used to create them. In order to store a model on a
different OWS, transfer the model using a floppy disk, or use
another method of file transfer. Be sure to transfer all four
files in the directory that “Models” variable in the
METASYS.INI file points to.
If a CS object references the modified software model,
download the NCM containing the CS object. Refer to the
Uploading and Downloading Databases chapter
(LIT-120155) of this guide.
Deleting a Software Model

Due to the kind of database problems that would arise from deleting a
CS software model, a delete option is not available. To correct
deficiencies in models, use the Add or Modify options, or modify the
model using Data Definition Language (DDL).
Print Options
Two types of printing are available from the Software Model
summary: Item Print and Model Print.
Item Print prints a list of all existing software models held in the
archive database. The printed information includes the model names,
types, and associated hardware.
Model Print prints a hard copy of a specified software model. The
printed information includes the object attribute type, the hardware
reference, the override and adjust settings, the object description, and
the engineering units.
Note: Metasys software does not support printing between OWSs
with different operating systems when one of those systems
is a Windows® 2000 Professional system.
Software Model Summary

The Software Model summary lists existing models by name, model
object type (for example, Control System), and by the associated
hardware. Figure 22-1 shows an example of a Software Model
summary.
Figure 22-1: Software Model Summary

Detailed Procedures
Defining a Software Model
To define a software model:
1. On the SetUp menu, click Software Model. The Software Model
2. On the Action menu, click Add Model. The Software Model
Summary-Add dialog box appears (Figure 22-2).
Figure 22-2: Software Model Summary-Add Dialog Box

3. Assign a model name (up to eight characters), associated hardware,

and the quantity and description of attributes for each type listed.
Use the output (.prn file) of the HVAC PRO software after the
completion of controller configuration to find attribute qualities.
Note: Decide the exact quantity of attributes for each group
before proceeding. After clicking OK, you cannot save the
model until you assign all attributes in every group, and
you cannot return to this screen.
4. Click OK. A dialog box that allows the definition of each attribute
type appears (see Figure 22-3).
5. Select an attribute type by clicking one of the attribute type
buttons (for example, Binary Input, Analog, or Output) in the
upper portion of the screen. A box listing the number of attributes
specified for each attribute type (in Step 4) appears in the lower
portion of the screen.
Figure 22-3: Software Model Attribute Definition Box

6. Fill in the fields for each attribute. Then select the next attribute
type using the buttons in the upper portion of the screen. Repeat
this process, defining all of the attributes for each type.
7. Click OK.
Creating a New Software Model Using an Existing Model

To create a software model by copying a model that already exists:
2. Select a model to copy.
3. On the Action menu, click View Model. A box listing all the
attribute names, hardware references, override and adjust
capabilities, descriptions, and engineering units appears
(see Figure 22-4 later in this chapter).
4. Name the new model (up to eight characters), and adjust the
attribute type parameters.
5. Click OK. The Software Model Summary-Add dialog box appears
(Figure 22-3).
6. Make the necessary changes to the attribute fields.
7. Click OK. The Software Model summary appears listing the new
software model.
Viewing a Software Model

To view a Software Model:
2. Select a software model to view.
3. On the Action menu, click View Model, or double-click the model
on the summary. The Software Model Summary-View dialog box
Figure 22-4: View Model Dialog Box
Modifying a Software Model

To modify a software model:
2. Click the model’s name in the window.
3. On the Action menu, click Modify Model. The Software Model
Summary-Modify dialog box appears (Figure 22-5).
Figure 22-5: Software Model Summary-Modify Dialog Box

4. Use the mouse to select attributes and make changes.
5. Click OK.
Printing a Software Model

Item Print
To print a list of all available software models in the archive database:
2. On the Item menu, click Print. A Print message box appears
confirming that the list is printing.
Model Print
To print a hard copy of a software model:
1. On the SetUp menu, click Software Models. The Software Model
2. Select a model to print.
3. To select more than one model, hold down the Ctrl key while
clicking on the desired models.
4. On the Action menu, click Print Model. The Print message box
appears in the Software Summary indicating that the printing is in
progress.
Troubleshooting
If you attempt to save invalid information, a dialog box appears
indicating the error. Acknowledge the message by clicking the OK
button. Make corrections and attempt to save the information again.
An entry might be invalid because it is in the wrong format or exceeds
the valid range.
Chapter 23
Defining Objects
Introduction
Defining an object involves adding a new object to an existing system
and assigning values to the object’s attributes (for example, the
object’s name, expanded ID, and engineering units).
• define an object
• delete an object
• change the system display order of objects

Code No. LIT-120149
Key Concepts
Objects
There are three categories of objects: point objects, hardware objects,
and control objects.
Point Objects
A point object is the software definition for a specific field device such
as a temperature sensor (Analog Input object) or fan control relay
(Binary Output object). The following are point objects:
• Analog Input (AI)
• Accumulator (ACM)
• Analog Output Digital (AOD)
• Binary Input (BI)
• Analog Output Setpoint (AOS)
• Binary Data (BD)
• Analog Data (AD)
• Binary Output (BO)
• Zone
• Card Reader (CR)
• Multistate Data (MSD)
• Multistate Input (MSI)
• Multistate Output (MSO)
• Multi-Command (MC)
Hardware Objects
A hardware object is the software definition for an L2, N2, N2E, S2,
or LONWORKS® compatible device. Table 23-1 lists the hardware
objects for each device type.
Table 23-1: Hardware Objects

Device Type Hardware Objects
L2 C210A C260A
C260X C500X
N2 AHU LCD VND
D600 LCP XBN
DC9100 MDN XRLs
DCM MIG XRMs
DCM140 PHX XT9100
DR9100 TC9100 XTM
DX9100 UNT DX9102
IFC VAV
N2E DX91ECH
S2 DSC8500 FPU
FFPU SFPU
LON LONDXA LONTCU LONVMA
Notes: See the Defining Devices chapter (LIT-120145) of this

manual for a description of N1 devices (Network Control
Modules, OWSs, and printers).
Online S2 device definition does not allow the address 0.
When compiling, the DDL does not check for a device
address 0; therefore, while it is possible to add a device with
address 0, it is not a valid address on the S2 device.
Control Objects
A control object is the software definition for a specific process that
combines multiple field devices and logic to perform a function. The
following are control objects:
• Lighting Control Group (LCG)
• Proportional plus Integral plus Derivative (PID) Loop
• Demand Limiting/Load Rolling Group
• Process (GPL/JCBASIC)
• Control System Object (CS)
Note: Refer to the Using Processes chapter (LIT-120160) of this
manual for descriptions of GPL process objects.
Object Focus Window

Use the Object Focus windows to view and modify object definition.
Display a Focus window from any summary displaying the object by
double-clicking the object name. For information on Focus windows,
refer to the Using Object Focus Windows chapter (LIT-120174) of the
Operator’s Guide.
Object Display Order

Objects are displayed in summaries, in printouts, and at the Network
Terminal in the order in which they are defined. To change the display
order, use the System/Object Display Reorder function. See Changing
the System Display Order of Objects under Detailed Procedures.
Note: Unlike Sort and Filter functions, which change the order for
the currently displayed screen only, the System/Object
Display Reorder function changes the order permanently.
Online Help
The OWS provides online help for all Definition and Focus windows.
This help includes the formats and valid ranges to use when entering
attribute values. To access help, click the Attribute Help option in the
Help menu. Refer to the Using Online Help chapter (LIT-120175) of
the Operator’s Guide for a complete description of online help.
Detailed Procedures
Defining an Object
To define an object:
1. Double-click the system in which the new object will reside.
The System summary appears.
(Figure 23-1).
Figure 23-1: Item New Dialog Box (for Objects)

3. Select the type of object by clicking the appropriate option button.
4. Enter the existing hardware system name and hardware object
name in the text fields. The hardware system and object must
already be defined.
5. Click OK. The appropriate Definition window appears. (For some

object types, another dialog box appears requesting more
information about the object. Make the required selections and
click OK to display the Definition window.) Figure 23-2 shows an
example of an Analog Input Definition window.
Figure 23-2: AI Object Definition Window with Default Values

Notes: During CS object definition, a dialog box listing
available software models appears. Select the model to
copy for the new CS object and click OK. Go to Step 8.
For S2 object (DSC8500 or FPU) definition, Logical
Point Number and Logical Point Type replace the Slot
Number and Input/Output Type, respectively.
The name of AD and BD objects mapped to JC/85/40
points must be separated by an underscore (for example,
LIBR_FAN).
6. Fill in the attribute fields. Most of the fields contain default
values. Either accept these default values or type in different
settings. The new object name must be unique.
7. After specifying the attribute values, click Save on the Item menu
to add the new object to the operational database.
To add the changes to the archive database, perform an NCM
Shortcut
To copy definition information from one object to another:
1. When the System summary is displayed, select an already defined
object that is the same type as the new object.
2. For example, to add a new Binary Output object, select an existing
Binary Output object in the System summary.
3. On the Item menu, click New. The Item New dialog box
(Figure 23-1) appears with the Copy From field filled in with the
selected object’s name.
4. Specify the hardware system and hardware object and click OK. A
Definition window for the selected object type appears. The fields
in this window contain the selected object’s values.
5. Enter a unique object name, make any necessary changes, and
save the new object.
Deleting an Object
Note: Before deleting a hardware object, delete any software
objects that reference the hardware object.
To delete an object:
1. Display the summary of the system that contains the object.
2. Click on the object.
4. Click OK.
5. To add the changes to the archive database, perform an upload
(refer to the Uploading and Downloading Databases chapter
[LIT-120155] of this manual).
Changing the System Display Order of Objects

To change the system display order of objects:
1. Click the name of the system that contains the objects.
2. On the SetUp menu, click System/Object Display Order. The
Object Reorder window appears (Figure 23-3) listing all the
objects in the system in their current positions.
Figure 23-3: Object Reorder Window

3. Select an object to move to a new position.
4. On the Action menu, click Reorder Object. The Object Reorder
dialog box appears (Figure 23-4), displaying the name of the
selected object and its current (old) position.
Figure 23-4: Object Reorder Dialog Box

5. Type the number of the new position in the New Position text
box.
A number equal to or greater than the total number of objects in
the system moves the object to the last position.
6. Click OK.
7. To reorder more objects, repeat Steps 5 through 8.
8. On the Item menu, click Save to save the new positions. The new
order is entered into the operational database.
To save the new order to the archive database, perform an NCM
upload of the system’s NCM host (uploads are described in the
Uploading and Downloading Databases chapter [LIT-120155]of
this manual).
Troubleshooting
you attempt to select another field. If this happens, select and correct
the invalid value. If you attempt to save a new object with invalid
information, an error message appears. Acknowledge the message by
clicking OK. Type in corrections and attempt to save the new object
again.
Chapter 24
Defining Passwords
Introduction
Passwords protect the security of the BAS by allowing different users
different levels of access to the facility. For example, one user can
have complete access to all objects, while another user can have read-
only access to HVAC objects. Each BAS can have up to 100 unique
user passwords. The OWS provides five levels of password protection
and up to 32 report/access groups for each facility. Refer to the
Password Technical Bulletin (LIT-636111) to find out what level of
password is needed for various OWS functions.
The chapter describes how to:
• display the password summary
• add a password
• modify a password
• delete a password

Code No. LIT-120150
Key Concepts
Password Definition
To define a password means to add it to the password database. This
process involves specifying the display language, time out interval,
password level, and Report/Access groups that are in effect when the
password is logged on.
Display Language
The display language determines which language the OWS uses to
display text in windows. For example, if French is specified, all
windows, menus, prompts, and messages are displayed in French.
Time Out Interval

The time out interval determines how long the OWS waits after the
last keyboard or mouse action before automatically logging off the
user. For example, if the time out interval for the current password is
five minutes, the user is automatically logged off if there is no mouse
or keyboard action in a five-minute period.
Password Level
The password level determines which functions are available to the
user. For example, a user with a Level 5 password has read-only
access to summaries. This user cannot command objects or change
attribute values in Object Focus windows. A user with a password
level of two can perform all functions except defining or modifying
passwords. A user with a password Level of 1 can perform all
functions, including the definition of new passwords.
Report/Access Groups
Each system belongs to a particular report/access group. When
defining a user’s password, specify the report/access groups to which
the user has access. This determines which systems the user can
access.
The use of report/access groups provides flexible security protection.
For example, all systems having to do with heating and air
conditioning can be assigned to a report/access group called HVAC.
When defining a password for a user, whose main job is to control
heating and air conditioning equipment, specify that the user be given
access to the HVAC report group only. This means the user only has
access to those systems assigned to the HVAC report group. When this
user is logged on, the Network Map and any summaries only display
the HVAC systems. All other systems are not accessible. If another
password is logged on that allows access to all report/access groups,
the Network Map displays all systems in the network.
For more information on report/access groups, refer to the Defining
Report/Access Groups chapter (LIT-120151) of this manual.
Password Summary
Use the password summary to add new passwords to the database,
modify the settings for existing passwords, and delete passwords. To
perform any of these functions, the user must have a Level 1 password.
Figure 24-1 shows an example of a password summary.
Figure 24-1: Password Summary

Table 24-1 describes the different fields of the password summary.
Table 24-1: Password Summary Fields

Field Description
User Initials Unique user initials specified during password definition. These initials appear on
Operator Transaction summaries to indicate the operator who discarded the
Critical or Follow-Up Alarm reports.
Password Password the user enters when logging on
Language The language the OWS uses when the password is logged on
Time Out Minutes Number of minutes the OWS waits before automatically logging the password off if
there is no mouse or keyboard action
Password Level Level that determines available functionality. The password levels range from
1 to 5, with Level 1 allowing the most functionality.
Report Groups Report group access status. If the password allows access to the report group, an
X appears in the report group column.
Detailed Procedures
Adding a Password
To add a password:
1. On the SetUp menu, click Password. The Password Summary
2. On the Action menu, click Add Password. The Password
Summary-Add dialog box appears (Figure 24-2).
Figure 24-2: Password Summary-Add Dialog Box

3. Fill in the password definition fields.
a. The user initials can be up to three characters long. They must

be unique. If a different user has claimed the initials, a
message error appears. Click OK, and type in different initials.
b. The password level ranges from Level 1 to 5, with Level 1
allowing the most functionality. Choose the desired level from
the combo box. The selected level appears in the Password
Level field.
c. The password can be up to eight characters long. It must be
unique. If a different user has already claimed the selected
password, a message error appears. Click OK, and type in a
different password.
d. The time-out value can be from 1 to 1440 minutes. The
timeout value logs the user off the network after the specified
time if there is no mouse or keyboard action. Choose a limit
that is practical for the user and that protects the network from
unauthorized use.
e. Choose the desired language from the combo box. The
selected language appears in the Language field. The default
languages are English, French, Deutsch (German), Japanese,
Spanish, and Portuguese. For any other language, type in the
name of the language as a default.
f. Select a report/access group by clicking the check box to the
left of the group name. An X appears in the check box. Assign
at least one report/access group to each password.
4. Click OK.
5. Repeat Steps 1 through 4 for each new password.
6. On the Item menu, click Save. The changes to the password
summary are saved to the operational global database. The
password does not become effective until Item > Save is
performed.
To save the changes to the archive global database, perform a
global upload (which is described in the Uploading and
Downloading Databases chapter [LIT-120155] of this manual).
Shortcut
To copy the settings from an existing password to a new password:
1. Select a password in the password summary that has settings
similar to the new password.
2. On the Action menu, click Add Password. The fields in the
Password Summary-Add dialog box (Figure 24-2) contain the
values of the copied password.
3. Make any necessary changes and click OK.
Modifying a Password
To modify a password:
1. On the SetUp menu, click Password. The password summary
2. Select a password to change.
3. On the Action menu, click Modify Password. The Password
Summary-Modify dialog box appears (Figure 24-3).
Figure 24-3: Password Summary-Modify Dialog Box

4. Make the desired changes in the password definition fields.
5. To specify a report/access group, click the check box to the left of
the group name. An X appears in the check box.
6. Click OK.
7. Repeat Steps 1 through 6 to modify another password.
8. On the Item menu, click Save. The changes made to the password
summary are saved to the operational global database. The
password does not become effective until it is added to the
database.
Shortcut
Use the following shortcut to modify a password quickly:
1. In the Password Summary, double-click the password. The
Password Summary-Modify dialog box appears (Figure 24-3).
2. Make the desired changes.
3. Click OK.
Deleting a Password
To delete a password:
1. On the SetUp menu, click Password. The password summary
2. Select a password (or passwords) to delete.
3. On the Action menu, click Password. The Clear Password dialog
box appears.
4. Click OK.
5. Repeat Steps 1 through 4 to delete another password.
6. On the Item menu, click Save. The changes to the password
summary are saved to the operational global database.
Chapter 25
Defining Report/Access Groups
Introduction
Report/access groups (report groups) specify exactly where different
reports are directed. For example, a report group can direct all Critical
reports generated by fire systems to the local OWS, and direct all
Follow-Up reports generated by HVAC systems to a remote printer.
• define a report/access group
• define destinations for a report/access group
• delete a destination

Code No. LIT-120151
Key Concepts
Report/Access Groups
When defining systems, assign each system to one report group.
Define each report group by assigning destinations for the eight report
types. The eight report types are Critical, Follow-Up, Status, History,
Totalization, Trend, Operator Transaction, and Card Reader.
Destinations can be any defined PC, printer, or PC file (only Critical
and Follow-Up reports can have a PC as a destination). There can be
up to eight destinations for each report type, in groups 1-16 and up to
sixteen destinations for each report type in groups 17-32.
For example, when defining Report Group 3, send all Critical reports
to PC3 and Printer4, and all Totalization reports to a PC file called
FILE3. When an object in a system assigned to Report Group 3
generates a Critical report, the system sends the report to PC3 and
Printer4. When an object in this system generates a Totalization report,
the system sends the report to the FILE3 PC file.
Assign report groups to each user password. When logged on, users
only have access to those systems that are in report groups assigned to
their password. The other systems do not appear on the Network Map
or any summaries.
There can be up to 32 defined Report/Access Groups.
Report/Access Group Summary

The Report/Access Group summary displays defined Report
Groups 1-16, and the Enhanced Report/Access Group summary
displays defined Report Groups 17-32. In both summaries, the left
column displays the number of each group and the right column
displays the name of the group.
The default DDL file in the OWS includes 16 defined report groups.
If the DDL file has been altered, the Report Group summary might
display less than 16 report groups.
This chapter describes how to add report/access groups online;
however, to modify or delete a report/access group, use DDL. Refer to
the DDL Programmer’s Manual.
Report Group Focus windows define the destinations for the report
groups, and are accessible from either summary.
Figure 25-1 shows an example of a Report/Access Group summary.
Figure 25-1: Report/Access Group Summary
Default Report Destinations

The purpose of a default report destination is to provide an alternate
destination for reports if the assigned device or PC file is offline or
otherwise not operational. For example, if Printer6 is the default
destination for Printer5 and Printer5 is offline, reports with Printer5 as
their defined destination are sent to Printer6.
Assign default destinations for PCs and printers in their Device Focus
windows. Display the Focus window for a PC by double-clicking the
name of the PC on the Network Map. Refer to the Defining Devices
chapter (LIT-120145) of this manual.
Specify the default destination for a PC file in the PC file’s Reports
Destination summary. On the Network Map, double-click the name of
the PC file to display its Reports Destination summary (this summary
lists all reports sent to the PC file). Refer to the Displaying Archived
Summaries chapter (LIT-120169) of the Operator’s Guide.
Detailed Procedures
Defining Report/Access Groups
To define a report/access group:
1. On the SetUp menu, click Report/Access Group. The
Report/Access Group summary appears (see Figure 25-1).
2. On the Item menu, click New. The Item New box appears
(see Figure 25-2).
Figure 25-2: Item New Box

3. Type the number of the report/access group upon which you want
to base your new group or leave it blank and click OK. The
Report/Access Group Summary box appears (Figure 25-3).
Figure 25-3: Report/Access Group Summary Box

4. Type in a group number and group name in the text fields. The
name can be up to eight characters long. This name appears in the
Password summary.
5. If necessary, define destinations for the report/access group at this
time starting from step 6 in the Defining Destinations for a
Report/Access Group section.
Defining Destinations for a Report/Access Group

To define destinations for a report/access group:
1. On the SetUp menu, click Report/Access Group. The
Report/Access Group summary appears (see Figure 25-1).
2. Double-click the report group. The Report/Access Group Focus
window appears (Figure 25-4), displaying the current destinations
for Report Group 2.
Figure 25-4: Report/Access Group Focus Window

3. To name the group or change the name, type a new name in the
Group Name text box. The name can be up to eight characters
long. This name will appear in the Password summary.
4. To assign destinations, click the Add Destination option on the
Action menu. The Add Destination dialog box appears
(Figure 25-5).
Figure 25-5: Add Destination Dialog Box

5. Select the Destination type by clicking the appropriate option
button.
Clicking the PC or Printer option button lists all the currently
defined OWSs and Printers in the facility in the Destination list
box.
Clicking the PC File button displays the currently defined OWSs
in the Destination list box.
6. Click a PC, printer, or PC file in the list box.
7. Specify the report types that will be sent to the selected
destination by clicking the appropriate check boxes.
8. Click OK.
9. Repeat Steps 4 through 9 until all report types have destinations.
11. To save the changes to the archive database, perform a global
Deleting a Destination
To delete a destination:
1. Display the Report Group summary.
2. Double-click the report group that contains the destination. The
Report Group Focus window appears (see Figure 25-1).
3. Select the destination.
4. On the Action menu, click Delete Destination. The Delete
Destination dialog box appears.
5. Click OK.
7. To save the changes to the archive database, perform a global
Chapter 26
Creating Alarm Messages
Introduction
An alarm message is an ASCII text string associated with a specific
object. When the object goes into an alarm state, the message
associated with the object appears in the Critical Alarm box on the
OWS screen, and in Critical and Follow-Up summaries. The message
might tell the operator what to do in the case of an emergency. For
example, the message “Fire--call 911 and evacuate
building!” might be associated with an object that goes into an
alarm state when fire is detected.
Analog objects may have two messages associated with them: an
alarm message displayed when alarm limits are exceeded, and a
warning message displayed when warning limits are exceeded.
• display the alarm message summary
• add an alarm message
• modify an alarm message
• clear an alarm message

Code No. LIT-120152
Key Concepts
Alarm Messages
Alarm messages can be up to 65 characters long. Each alarm message
is assigned a number from 1 to 255, inclusive. One alarm message can
be assigned to many objects.
Alarm messages are stored in Network Control Modules (NCMs).
Each NCM has a different set of up to 255 messages. A system’s host
NCM must contain the alarm messages for objects in the system. For
example, if NC3 is the host NCM for the AHU1 system, the NC3 must
store all alarm messages for objects in AHU1.
Alarm Message Summary

Use the alarm message summary to view, add, modify, and delete
alarm messages. The alarm message summary lists all alarm messages
associated with an NCM and their numbers. Figure 26-1 shows an
example of an alarm message summary.
Figure 26-1: Alarm Message Summary

Detailed Procedures
Displaying the Alarm Message Summary
To display the alarm message summary:
1. Click on an NCM.
2. On the SetUp menu, click Alarm Message. The alarm message
summary (Figure 26-1) for the selected NCM appears.
Adding an Alarm Message

To add a new alarm message:
1. Click on the NCM.
3. On the Action menu, click Add Message. The Alarm
Messages-Add dialog box appears (Figure 26-2).
Figure 26-2: Alarm Messages-Add Dialog Box

4. Enter a message number in the Message Number field. The
number can be any integer from 1 to 255 that is not already
associated with a different message.
5. Type the message in the Message Text field. The message can be
from 1 to 65 characters long. The message automatically scrolls to
the right if the typed message is longer than the Message Text
field.
6. Click OK.
7. On the Item menu, click Save to enter the message into the NCM
Shortcut
To add a new alarm message that is similar to an existing alarm
message:
1. Select an NCM from the Network Map.
3. Select an existing alarm message.
4. On the Action menu, click Add Message. The Alarm
Messages-Add dialog box appears (see Figure 26-2), displaying
the copied message.
5. Enter a new message number.
6. Make any necessary changes to the message text.
7. Click OK.
Modifying an Alarm Message

To modify an alarm message:
1. Click on the NCM that contains the alarm message.
3. Click the message.
4. On the Action menu, click Modify Message. The Alarm
Messages-Modify dialog box appears (Figure 26-3).
Figure 26-3: Alarm Messages-Modify Dialog Box

5. Type changes to the message in the Message Text field.
Note: You cannot change the message number.

6. Click OK.
Shortcut
To quickly modify an alarm message:
1. Click the NCM that contains the message.
3. Double-click the alarm message. The Modify Message dialog box
appears (see Figure 26-3).
4. Make desired changes to the message text.
5. Click OK.
Databases chapter [LIT-120155] of this guide).
Clearing an Alarm Message

To clear an alarm message:
1. Click the NCM that contains the alarm message.
3. Click the message.
4. To select more than one message, press the Shift or Ctrl key while
holding down the mouse button.
5. On the Action menu, click Clear Message. The Clear Message
dialog box appears.
6. Click OK.
7. On the Item menu, click Save to delete the message from the
NCM operational database.
To save the changes to the archive database, perform an NCM

Chapter 27
Defining Access Cards
Introduction
Access cards are used to enter locked areas or buildings. The access
card definition process defines or limits a card holder’s access to the
facility. For example, one person may be able to enter a building at
any time (unlimited access), while another may only be able to enter
between 6:00 a.m. and 5:00 p.m. (restricted access).
• display the access cards summary
• print the access cards summary
• define an access card
• modify an access card
• delete an access card
• define user data
• modify user data
• modify user definable field titles
• print user data
• quit Superbase 4 software
• display access controllers for an access card

Code No. LIT-120153
Key Concepts
Access Cards Summary
The access cards summary displays data on all access cards defined on
the network, regardless of the NCMs or controllers associated with the
cards. Use the access cards summary to add, modify, or delete access
card files.
Note: If an NC is offline, the cards associated with those devices
do not appear in the summary. When any NCM on the
network is offline, a warning message appears indicating the
offline status before the summary appears.
The access cards summary is organized either by card number or by
last name, depending on the filter selected in the Filter dialog box.
(The summary displays the first 30 cards by number if no filter is
specified.)
Figure 27-1 shows and example of an access cards summary.
Figure 27-1: Access Cards Summary

To find out what access controllers and card readers are defined for
each access card, select Modify Card Data for a selected card.
Table 27-1 details the information provided in each of the access cards
summary fields.
Table 27-1: Access Cards Summary Fields

Field Name Description
Card ID Unique number encoded on the card.
Last Name Last name of the card holder.
First Name First name of the card holder.
Card Issue Level Number of times the same access card has been issued.
See Access Control System Objects Technical Bulletin
(LIT-636077).
Exec Privilege Executive privilege status of the card holder. Executive
privilege allows the user to enter any door controlled by the
IAC-600 system, regardless of the time of day. This privilege
is usually issued to top management and security personnel.
Access Card Definition

Defining an access card involves adding it to the access card database
maintained by the Security NCM. If a card exists that contains similar
data to the new card, copy the card to make the process quicker.
Before attempting to define access cards, read the information below.
• A password level of 3 or higher is required to define access cards,
and the password must give access to the Access Controller
hardware object that will contain the card data.
• Each card defined on the network is unique, and is maintained in
the databases of each of its associated NCMs and Access
Controllers.
• A maximum of 65,535 cards can be defined per network.
• A runtime version of Superbase 4 software can record additional
information about each card holder. The additional data is linked to
the card record during the card definition process.
• Use the same archive PC for all security NCMs on the network.
Otherwise, access card data may not be synchronized at every
OWS. Refer to the Using Diagnostics chapter (LIT-120159) to find
out how to define an Archive PC.
• Define the Access Controller (AC) and Card Reader (CR) objects,
as well as the time zones, before defining any access card.
• To add, modify, or delete an access card the database of the
security NCM, the NCM must be online. If the NCM is offline, its
associated Access Controllers and access cards do not appear. If
any NCM is offline when the access cards summary appears, a
warning message appears indicating that an NCM is offline. (This
NCM may or may not be a security NCM.)
• Verify that the Access Controller is online before adding an access
card to its database. (If an Access Controller is offline, it is still
listed in the Add Card dialog box; however, access card data added
or modified to an offline controller is not saved.) You cannot
delete an access card from an offline Access Controller. If an
Access Controller is offline when Add Card or Modify Card dialog
box appears, a warning message indicating that an Access
Controller is offline appears.
• Define at least one Access Controller and one Card Reader for the
card in the Add Card dialog box before adding a card online.
When defining an access card, begin by entering the global

information: Card ID, First Name, Last Name, Card Issue Level,
Executive Privilege, and Time Zone Used. Table 27-2 describes all of
these fields.
Table 27-2: Global Information Fields

Attribute Description Entry Values
Card ID Describes the unique identification number encoded on the card. 1 to 65535
Card Holder’s Last Self explanatory 10 characters
Name (optional)
Card Holder’s First Self explanatory 8 characters
Name (optional)
Card Issue Level Specifies the number of times a particular card has been issued. 0-7
The first time a card holder receives a card, the issue level is
zero (0). This allows the card to be replaced, should it be lost,
damaged, or stolen, without redefining a new card number. Only
one issue level of a card can be active at a time. A card can have
up to eight issue levels before a new card must be defined.
Process Group Specifies the JC-BASIC/GPL process interlock group in which the Integer 0 to 64
Number card is linked. (optional)
See the GPL Programmer’s Manual or JC-BASIC Programmer’s Zero means
Manual for more information. that the card is
not linked to a
process group.
Executive Privilege Specifies whether the card holder possesses executive privilege. Y = yes
Executive privilege gives a card holder unlimited access to all N = no
operational doors (using that card technology) controlled by the
IAC-600 system. This function is usually enabled for top
management or security personnel.
Time Zone Used Specifies the times of the week a card holder has access to No. of Time
authorized doors. Zone: Integer
1 to 8.
Card Summary-Add Card Dialog Box

There are four types of information defined for an access card in the
Card Summary-Add Card dialog box:
• global
• Access Controller
• card reader
• Superbase 4
Figure 27-2 and Table 27-3 show and explain the Add Card dialog
box.
Card Summary - Add card
Card ID SAVE
Time Zone 0
Last Name
A First Name Process Group 0 QUIT
Card Issue Level 0 In/Out State N/A C
Executive Privilege N Valid Readers
Bldg1.Door1
Bldg1/Door2
Bldg1/Door3
Access Controllers Bldg1/Door4
Bldg1/Security1 Bldg1/Door5
B Bldg1/Security2 Bldg1/LAB
Bldg1/Storage
Bldg1/Security3
Bldg1/Security4
Bldg2/Security1
Bldg2/Security2
Bldg2/Security3
Bldg2/Security4
Bldg2/Security5
Bldg3/Security1
Bldg3/Security2
OK CANCEL
Bldg3/Security3
* Indicates Card in Controller
EXAMPLE
E D
Figure 27-2: Add Card Dialog Box Example
Table 27-3: Add Card Dialog Box Callouts

Callout Description
A* Global card holder information. This Information is the same in all Access Controller databases.
B Access Controllers list box. It appears when you first open the Add Card dialog box; however, no
controller is selected (highlighted).
C User Data button. Click this button to use Superbase 4 software to define additional card holder
data.
D Card Readers list box. Double-click a controller to see this box. Card Readers, Time Zone,
Process Groups, and In/Out State are specific to the controller.
E OK button. Click to save Card Reader information.
* The Global information for an access card is the same in all databases if you define the access card online;
however, access cards can also be defined using DDL. Since access cards are added to each NCM database
separately in DDL, the global information could potentially be different. For detailed information concerning
access card definition in DDL, refer to the DDL Programmer’s Manual.
Superbase 4 Software
The Superbase 4 program is a database management software package
that maintains certain OWS databases. Superbase 4 software displays
and manages:
• access card user data
• Operator Transaction summaries
• Card Reader Transaction summaries
The Superbase 4 package included in Metasys software is a runtime
version and does not have full Superbase 4 capabilites. For instance,
the runtime version of Superbase 4 can not change screen formats. The
only changes that can be made to any Superbase 4 screen within the
OWS are the four User Definable Data fields in the Employee menu.
To change the screen format in any other way, purchase the full
Superbase 4 package.
Note: Superbase 4 software is case-sensitive. Develop a standard
format for data entered in Superbase 4 software.
User Data Windows

Use the User Data menus to record additional access card user data
during the card definition process. The data kept in this database is
informational only. It does not affect the operation of the BAS.
To access the User Data menus, click the User Data button in the Add
Card or Modify Card dialog box. Superbase 4 software opens, and a
User Data menu appears. The format of the menus varies depending on
how they are accessed (that is, from the Card Summary-Add Card or
Card Summary-Modify Card dialog boxes).
The Add Record Entry windows appear when the user clicks the User
Data button in the Add Card dialog box. See Figure 27-16,
Figure 27-17, and Figure 27-18 under Defining User Data later in this
chapter.
To specify additional information about a defined card holder, click
the User Data button in the Modify Card dialog box. The Employee
Menu appears (Figure 27-8).
Move from one User Data menu to another by clicking the appropriate
button on the right side of the dialog box. A total of seven different
menus are available: Main menu, Card Reader menu, Vehicle menu,
Badge menu, Employee menu, Identity menu, and Personal menu.
The Last Name, First Name, and Process Group fields are outlined in
red since Superbase 4 software cannot modify them. You can change
the Card ID and Company ID with Superbase 4 software; however,
this will not change the record created in the Add Card dialog box
(Figure 27-2).
Main Menu
The Main Menu (Figure 27-3) allows access to other user data menus,
the query menu, and the report menu. It also allows modification of the
four User Definable fields.
Figure 27-3: Superbase 4 Main Menu

Card Reader Menu

The Card Reader menu lists access controllers and card readers
defined for an access card. A list of up to 32 controllers appears when
the user presses the Card Reader button (see Figure 27-4). Click the
17-32 button to see the second page. Click on any of the controller
buttons in this list to display a list of the access card’s valid card
readers (Figure 27-5).
Figure 27-4: Card Reader Menu-Controller Page

Figure 27-5: Card Reader Menu-Card Reader Page

Vehicle Menu
Use the Vehicle menu (Figure 27-6) to view and modify information
about an access card holder’s vehicle. This window can record
information for two vehicles per card holder.
Figure 27-6: Vehicle Menu

Badge Menu
Use the Badge menu (Figure 27-7) to view and modify specific
information about the card holder’s access card.
Figure 27-7: Badge Menu

Employee Menu
Use the Employee menu (Figure 27-8) to input specific information
about an employee (this menu has two pages; click P-2 for the second
page). The Employee menu appears when the User Data button is
pushed in the Modify Card dialog box.
Figure 27-8: Employee Menu

Identity Menu
Use the Identity menu (Figure 27-9) to input a card holder’s
photograph and signature.
Figure 27-9: Identity Menu

Personal Menu
Use the Personal menu (Figure 27-10) to input personal information
about the card holder, such as home address, telephone number, and
emergency contact information.
Figure 27-10: Personal Menu

Photo and Signature Files

Superbase 4 software stores photos and signatures for card holders in
their User Data files.
To import files for the Photo and Signature fields, scan the images into
an electronic file using any scanner that can save a photograph in a
.PCX or .GIF format and a signature in a .TIF format. When saving the
file, be sure to place it in the C:\FMS\STATIC directory.
Superbase 4 software can import pictures into the User Data Photo and
Signature fields regardless of their size; however, if the photo or
signature has to be enlarged or reduced to fit the field correctly, it may
appear distorted. For the best results, the recommended photograph
size is approximately 1.75 x 2 inches (177 x 187 pixels). The
recommended signature size is approximately 2.5 x 0.75 inches
(200 x 55 pixels).
IMPORTANT: Keep in mind that picture files consume a large

amount of memory.
Emergency Files
Use the Emergency field to record instructions to be followed in the
event of an emergency for each card holder (for example, the name,
address, and phone number of the person that should be contacted
should an emergency arise).
Creating Emergency files requires the full Superbase 4 package; to use
this feature with only the runtime version, simply copy and modify the
example file provided. To access this example file (BLANKENG.SBT),
access the Personal menu in Superbase 4 Modify mode. The file
automatically appears in the Emergency field of the Personal menu.
Displaying Access Controllers for an Access Card

Both the Metasys program and Superbase 4 software can list which
Access Controllers and Card Readers are associated with an access
card.
The Metasys program displays a list of all Access Controllers and
Card Readers on the network. An asterisk (*) appears to the left of
those Access Controllers that are defined for the selected access card.
However, if a security NCM is offline, associated Access Controllers
and Card Readers do not appear.
Superbase 4 only lists the Access Controllers and Card Readers
defined for the selected card, regardless of whether or not the
associated security NCM, Access Controllers, or Card Readers are
online.
User Definable Fields Titles

Four of the field titles in the access card User Data windows can be
modified. These fields, called User Definable Fields, allow for the
specification of information not mentioned elsewhere in access card
records, such as the card holder’s job title. Modifying one of the four
field titles for an access card affects the field title for all access
cards.
The User Definable fields are located on page 1 (P-1) of the User Data
Add record, and page 2 (P-2) of the User Data Employee Modify
record.
Detailed Procedures
Displaying the Access Cards Summary
To display the access cards summary:
1. Click Summary on the menu bar. The Network Map-Summary

2. Select access cards in the Network Map-Summary list box.
3. Click Display. The access cards summary appears.
Use the vertical scroll bar to view up to 30 access cards in the
summary window. Click Next to view the next set of 30. Click
Previous to view the previous set again.
Changing the Display Order of an Access Cards Summary

To change the order of access card data display:
2. Select access cards in the Network Map-Summary list box and
click Display. The access cards summary appears.
3. On the View menu, click Filter. The Card Summary-Filter Cards
Figure 27-12: Card Summary-Filter Cards Dialog Box

4. Select the information that the summary will include. Card
Number displays the summary with currently defined cards
beginning with the card number entered in the Card Number field.
Last Name displays the summary with currently defined cards
beginning with the last name entered in the Last Name field.
Note: If you are unsure how to spell the last name, type as
much as you know with an asterisk (*) at the end. The
summary lists the cards whose last names begin with the
typed letters. If you are unsure of a character in the
middle of a name, insert a question mark (?) in place of
the unknown letters. Cards are displayed that contain the
specified letters. For example, typing Jo?e* would
retrieve both Joseph and Jones.
5. Click Display. The access cards summary (Figure 27-1) appears
with the data displayed in the specified order.
Printing the Access Cards Summary

Printing the Entire Summary
IMPORTANT: This option prints the information in the access cards

summary for every access card defined on the
network. This can be a very time-consuming
operation.
To print the summary from the Summary dialog box:
1. Click Summary on the menu bar. The Summary dialog box
2. Select access cards in the Summary Name list box.
3. Click Print. A message box appears asking for confirmation.
4. Click OK. A message box appears indicating that the summary is
printing.
To print the entire summary from the access cards summary:

1. On the summary’s Action menu, click Print All Cards Data.
A message box appears asking for confirmation.
2. Click OK. A message box appears indicating that the data is
printing.
Printing the Currently Displayed Page

To print the summary information for the 30 currently displayed
access cards:
3. On the Item menu, click Print. A message box appears indicating
that the summary is printing.
Defining an Access Card

To define an access card:
3. On the Action menu, click Add Card. The Card Summary-Add
Card dialog box appears (Figure 27-2) listing the names of all the
online Access Controllers defined on the network.
4. Enter the Global information: Card ID, First Name, Last Name,
Card Issue Level, and Executive Privilege, and Time Zone Used.
See Table 27-2 for a description of these fields.
5. Double-click the name of an Access Controller to validate it for
the card. The selected controller appears highlighted and a list box
appears containing the Time Zone, Process Group, and all of the
defined Card Readers for the selected controller (Figure 27-13).
Figure 27-13: Add Card Dialog Box After Double-Clicking Controller

6. Click a Card Reader to validate it for the card holder, and enter
the Time Zone and Process Group for the Controller.
Note: The In/Out State applies only to access cards used in In
or Out Card Readers. For example, if the user last used
the access card in an In Card Reader, the In/Out State
would display In. The card does not work in another In
Card Reader until the user inserts the card in an Out
Card Reader. When the card is first defined, the In/Out
State is N/A and works in either an In or Out Card
Reader. To change a card holder’s In/Out State back to
N/A after he or she has used it, click on the card holder’s
name in the access cards summary and click Modify
Card Data on the Action menu. Click Save in the Card
Summary-Modify Card dialog box. The In/Out State is
returned to N/A when the card is saved.
7. Click OK.
To add another controller for the access card, double-click another
controller and repeat Steps 6 and 7.
8. To define user data, click the User Data button, and refer to
Defining User Data later in this document. Always define user
data using the archive PC defined for the security NCMs on the
network. (All security NCMs must have the same archive PC.)
To skip the process of defining user data, click Save. A message
box appears indicating that the data has been saved. Click OK,
and an empty Add Card dialog box appears.
9. Add another card or select Quit to return to the access cards
summary.
Shortcut
To copy information for an existing access card similar to the new
card:
3. Select a card to copy.
Card dialog box appears (Figure 27-2) defined with the same
Access Controller and Card Reader information as the copied
card.
5. Fill in the Global information and make any other necessary
changes in the Add Card dialog box.
6. To copy the Superbase 4 record as well, click User Data.

Superbase 4 software loads, and a message box appears asking if
the entire record should be copied.
7. Click Yes to copy the entire record. Click No to copy a partial
record. The following items are copied in a partial copy:
• Badge Media
• Badge Type
• Building/Floor
• Company ID
• Department
• Expiration Date
• Issue Date
• Mail Station
• User Data Fields 1-4
8. Make the necessary modifications in the three definition screens.
Click Save when finished. The data is saved and the OWS returns
to the Card Summary-Add Card dialog box.
9. Click Save to save the card in the Metasys program. A message
appears indicating that the data has been saved.
10. Click OK. The Add Card dialog box appears blank.
11. Add another card or click Quit to return to the access cards
summary.
Modifying an Access Card

Note: In order to modify an access card, its associated controllers
must be online.
To modify an access card:
3. Click on the access card.
4. On the Action menu, click Modify Card Data. The Card
Summary-Modify Card dialog box appears (Figure 27-14).
Figure 27-14: Modify Card Dialog Box

5. Make any desired changes in the Modify Card dialog box.

To modify Card Reader data, double-click the appropriate Access
Controller. Modify the information that appears in the Card
Reader list box to the right of the Access Controller list box.
Notes: In the Access Summary-Modify Card dialog box, an
asterisk (*) appears to the left of Access Controllers that
contain the selected card in their databases.
An asterisk could appear to the left of an Access
Controller, but when double-clicked, no card readers are
selected. This means that the card was added with an
empty reader list in DDL. Click OK in the Card Reader
list box, without selecting any Card Readers, to deselect
the controller.
6. To modify user data, click the User Data button and refer to
Modifying User Data later in this section.
7. Click Save. A message box appears indicating that the changes
have been saved.
8. Click OK.
Deleting an Access Card

Notes: Always use the archive PC that is associated with the
Security NCMs on the network to delete an access card. (All
Security NCMs should have the same archive PC.) If a card
file contains user data and is not deleted using the archive
PC, the user data records remain in the database. This does
not affect the operation of the BAS; however, the User Data
and access card databases will not be synchronized.
To delete an access card, each of the security NCMs and
Access Controllers associated with the card must be online.
To delete an access card:
3. Click the card.
4. On the Action menu, click Delete Card. The Delete Card message
Figure 27-15: Delete Card Dialog Box

5. Click OK.
Note: When the Security NCM’s archive PC deletes a card with
user data records, Superbase 4 software loads and the user
data is deleted. Superbase 4 software closes, and the screen
returns to the access cards summary.
Defining User Data

To define user data:
click Display. The access cards summary appears (Figure 27-1).
Card dialog box appears (Figure 27-2) listing the names of all the
online Access Controllers defined on the network.
Note: Define the Card ID and Process Group Number fields before
continuing to Step 5. (All fields defined in the Add Card
dialog box carry over to Superbase 4 software when you
click the User Data button.)
4. Click the User Data button. Superbase 4 software loads and the
first page of the Add Record Entry window appears
(Figure 27-16).
Figure 27-16: Add Record Entry Window-Page 1



5. Enter the information for the card into the Add Record Entry
windows. Use the page buttons (P-1, P-2, and P-3) to move
between pages.
Note: Emergency, Photo, or Signature fields use imported data
from external files. For detailed information on
importing data, refer to Importing Photo and Signature
Files and Importing Emergency Files later in this
section.
6. After defining all of the information, click Save.
7. Click Save in the Add Card dialog box. A message appears
indicating that the data has been saved.
8. Click OK. The Add Card dialog box appears blank.
9. Add another card, or click Quit to return to the access cards
summary.
Importing Photo and Signature Files

To import Photo and Signature fields:
1. Place the text cursor in the Photo or Signature field and type in the
name of the file.
2. Fill in any other user data fields as desired.
3. Click Save. The data is saved and the OWS returns to the Card
Summary-Add Card dialog box.
4. Click Save. A message appears indicating that the data has been
saved.
5. Click OK. The fields in the Card Summary-Add Card dialog box
appear blank.
6. Add another card, or click Quit to return to the access cards
summary.
Importing Emergency Files

To copy and modify the emergency file for an access card:
1. Define and save all other fields in the user data record for an
access card as discussed earlier in this section.
2. In the access cards summary, select the card.
Summary-Modify Card dialog box appears (Figure 27-14).
4. Click User Data. Superbase 4 software loads, and the Employee
menu for the selected card appears (Figure 27-8).
5. Click Personal to go to the Personal menu, and click Modify to
place the Personal menu in the Modify mode. A message box
appears asking if you would like to modify the file name.
6. Click No. (This step will be performed later in the definition
procedure.) The Personal menu appears in the Modify mode
(Figure 27-10).
7. Place the cursor inside the Emergency field. The Text window
appears. If no text was previously defined, instructions for adding
text appear.
8. Delete the text in the window and type in up to five lines of new
text.
9. On the File menu, click Save As. The Save As dialog box appears.
10. Type in a file name to save the new text under, and click OK.
11. On the File menu, click Close, or double-click the Control Panel
box in the Text window to close the Text window. (Note that no
text is shown in the Emergency field at this point.)
12. Click Save. A dialog box appears asking if the information is

correct.
13. Click Yes to save the data. The data is saved, and the text that was
originally in the Emergency field appears. (The field only displays
the new text when the external file name is changed.)
14. Click Modify again. A message box appears asking if you would
like to modify the file name.
15. Click Yes. The original file name is displayed in the Emergency
field.
16. Enter the name of the file entered in Step 11.
17. Click Save. A message box appears asking if the entries are
correct.
18. Click Yes to save the entries.
19. Click Exit. The Superbase 4 Main Menu appears (Figure 27-3).
20. Click Quit to return to the Modify Card dialog box.
21. Click Save in the Modify Card dialog box. A message box
22. Click OK.
Modifying User Data

To modify user data:
1. Access the Modify Card dialog box.
2. Click the User Data button. Superbase 4 software loads, and the
Employee Menu for the selected access card appears
(Figure 27-8).
3. Click the button for the window that contains the data you want to
modify (that is, Vehicle, Badge, Employee, Identity, or Personal).
The selected window appears.
4. Click Modify. The database is placed in the Modify mode, and the
text cursor appears in the first definable field.
5. Make the necessary modifications to the fields. (A red border
surrounds fields that cannot be modified.)
6. Click Save. A confirmation message box appears.
7. Click Yes to save the entries in that window and return the
window to its View mode. Click Cancel to modify the entries.
Note: When you click Modify in the Identity menu, the file
names of photo and signature images appear in place of
the images themselves.
8. After making all of the necessary changes in each window, click

Exit. The Superbase 4 Main menu appears (Figure 27-3).
9. Click Quit to return to the Modify Data dialog box.
10. Click Save to save the modified access card. A message box
11. Click OK.
Modifying User Definable Field Titles

To modify user definable field titles:
1. From the Network Map, click the Summary menu option. The
2. Double-click access cards in the Summary Name list box. The
access cards summary appears (Figure 27-1).
3. Select any name from the summary.
Note: This procedure changes the field title of all of the card holder
records in the database, not just the highlighted card.
4. Click Modify Card Data. The Modify Card dialog box appears
(Figure 27-14).
5. Click User Data. Superbase 4 software opens and the User Data
Employee Menu appears (Figure 27-8).
6. Click Exit. The Superbase 4 Main Menu appears (Figure 27-3).
7. Click the Mod User button. The User Definable Fields Modify
Figure 27-19: User Definable Fields Names Window

8. Change the name of the field and click Save. A message box
appears asking for verification.
9. Click Yes. The Superbase 4 Main Menu appears (Figure 27-3).
10. Click Quit to return to the Modify Card dialog box.
11. Click Save. A message appears indicating that the changes are
saved.
12. Click OK.
Printing User Data

Click the Print button in a user data window to print the entire user
data record (Vehicle, Badge, Employee, Identity, and Personal) for a
card holder. A message box appears on the screen indicating that the
record is being printed.
Quitting Superbase 4 Software

Click Quit in the Main Menu to exit Superbase 4 software and return
to the Metasys program.
From user data windows, click Exit to go to the Main Menu. Click
Quit.
From transaction menus, click Cancel to go to the Transaction Main
Menu, and click Quit.
IMPORTANT: Never use the Control Menu box in the upper, left
corner of the screen to exit Superbase 4 software.
Using the Control Menu box to exit could cause the
PC to lock up.
Displaying Access Controllers for an Access Card

Using Metasys Software
Note: All security NCMs must be online to display access
controllers with Metasys.
To display the defined Access Controllers and Card Readers for an
access card:
3. Click the access card.
Summary-Modify Card dialog box for the selected card appears
(Figure 27-14).
Note: The Access Controllers list box lists all Access
Controllers on the network. Each Access Controller
defined for the selected card has an asterisk (*) to the
left of its name. Double-click the controller to see the
Card Readers defined for the selected access card.
(Defined Card Readers appear highlighted.)
Figure 27-20: Modify Card Dialog Box Displaying Access Controllers and
Card Readers
Using Superbase 4 Software

To display the defined Access Controllers and Card Readers for an
access card:
3. Select the access card.
Summary-Modify Card dialog box for the selected card appears
(Figure 27-14).
5. Click the User Data button. Superbase 4 software loads, and the
Employee menu for the selected card appears.
6. Click the Card Reader button. The Card Reader menu appears
listing all of the Access Controllers defined for the selected card
(Figure 27-4). There are two pages, each containing 16 Access
Controller buttons. To go to the second page, click the 17-32
button. Click 1-16 to return to page one. (If less than
16 controllers are defined for the card, the buttons appear
dimmed.)
7. Click each of the Access Controller buttons to see the Card
Readers defined for the access card (Figure 27-5). The number of
Card Readers listed can range from 1 to 16, depending on the
number of card readers defined for the selected access card. If
there are not 16 Card Readers defined, the buttons appear
dimmed.
8. Click Cancel to view the controllers again.
9. Click Exit to return to the User Data Main menu.
10. When finished, click Quit. Superbase 4 software closes and the
screen return to the Card Summary-Modify Card dialog box.
Chapter 28
Defining Time Zones
Introduction
Time zones are database records the Access Controller object
maintains that control certain aspects of access card, Card Reader, and
Binary Input operation. Specify the time zone that controls each
operation when defining the object or item.
• define a time zone
• modify a time zone
• delete a time zone
• print a time zone schedule

Code No. LIT-120154
Key Concepts
Card Reader Time Zones
There are three fields in the Card Reader Definition window that time
zones can control: Reader Active, Override, and Personal
Identification Number (PIN) Suppress. These fields control certain
aspects of Card Reader operation according to the times specified for
each day for the time zone.
For more information on Card Reader definition, refer to the Defining
Objects chapter (LIT-120149).
Reader Active
The time zone number entered in this field specifies the times when a
valid card allows access to that door. Enabled time periods allow entry
with valid cards. Disabled time periods only allow entry with cards
that have Executive Privilege. After defining a time zone, enter the
time zone number in the Reader Active field in the Card Reader
Definition window.
Override
The time zone number entered in this field specifies the times when
the Card Reader is in the Access mode. Effectively, the door will be
unlocked during the enabled time period. After defining a time zone,
enter the time zone number in the Override field in the Card Reader
Definition window.
PIN Suppress
The time zone number entered in this field specifies the time periods
when card readers do not require PIN codes to access a building or
area. The enabled time periods are the periods when the reader does
not require a PIN. After defining a time zone, enter the time zone
number in the PIN Suppress field in the Card Reader Definition
window.
Binary Input Time Zone

The time zone number entered in this field specifies the time periods
when the OWS does not report Binary Input alarms. Disabled time
periods are periods when alarm reporting is suppressed. For example,
use this feature to disable motion detectors during normal business
hours to prevent unnecessary alarms. After defining a time zone, enter
the number in the Time Zone field in the Binary Input Definition
window.
For more information on Binary Input definition, refer to the Defining
Objects chapter (LIT-120149).
Access Card Time Zone

The time zone number entered in this field specifies the time period
when an individual’s access card is valid. Enabled time periods are the
periods in which the individual’s card is valid. After defining the time
zone, enter the time zone number in the Time Zone Used field in the
Add Card dialog box.
For more information on access card definition, refer to the Defining
Access Cards chapter (LIT-120153).
Time Zone Definition

Define up to eight time zones per Access Controller. The time zones
are unique to the controller they are defined for. Each time zone can
have up to eight days (including one holiday) with up to sixteen time
periods defined per day.
Define time zones using the Add/Modify Time Zone dialog box
(Figure 28-1), accessed from the Access Controller Scheduling
window.
Figure 28-1: Add/Modify Time Zone Dialog Box

Table 28-1 describes the fields in the Add/Modify Time Zone dialog
box.
Table 28-1: Add/Modify Time Zone Dialog Box Fields

Field Description
Time Zone Number The identification number for the time zone (1 through 8). Each Access Controller
(No.) can have up to eight time zones. This number appears in the time zone field in the
Card Reader, Access Card, or BI object Definition window.
Days The days of the week affected by the defined time periods of the time zone. Select
Weekdays to add a time period for Monday through Friday. Select Sat/Sun to add
a time period for both Saturday and Sunday. More than one day can be defined at
a time; however, only one day can be modified at a time.
Time Period (list The time period, consisting of an enable time and a disable time. For each day,
boxes) define up to eight Enable Time and eight Disable Time periods for a total of sixteen
periods. Time Period list boxes appear with one predefined Disable time period
starting at 00:00 (midnight). This time period can be modified (that is, changed
from disable to enable); however, the time itself must remain at 00:00.
Enable Time The time of day that a function is enabled. Enter the time in the Enable Time field
in a 24 hour format (hh:mm). Define a disable time period after each Enable time
period before defining another Enable time. For example, if the first Enable time is
00:00, and another Enable time is 05:00, define a Disable time that falls between
00:01 and 05:59.
Disable Time The time of day that a function is disabled. Enter the time in the Disable Time field
in a 24 hour format (hh:mm). When first defining a time zone, each day of the week
has a predefined Disable time period of 00:00. You may change it to an Enable
time; however, the time must remain set at 00:00. Define an Enable time period
after each Disable time period before defining another Disable time. For example, if
the first Disable time is 00:00, and another Disable time is 05:00, define an Enable
time that falls between 00:01 and 04:59.
Detailed Procedures
Defining a Time Zone
To define a time zone:
1. On the GoTo menu in the Access Controller Focus window, click
Schedule. The Access Controller Scheduling window appears.
Figure 28-2: Access Controller Scheduling Window

Note The GoTo menu is also available at the System summary, as
long as an Access Controller is selected.
2. On the Action menu, click Add Access Time Zone. The
Add/Modify Access Time Zone dialog box appears (Figure 28-1).
3. Enter the time zone number in the Time Zone No. field
(1 through 8). It is necessary to define a time zone number before
entering data in any other field.
Note: Make note of the number and what the use of the time zone
will be. The Access Card, Card Reader, and BI object
definition processes require this number to link the time zone
to the correct item.
4. Select the days of the week that the defined time periods affect.
You may select multiple days. The Time Period list box shows a
predefined Disable time period of 00:00. You may change the
command to Enabled; however, leave the time set to 00:00.
Otherwise, an error message appears when you attempt to save the
information.
5. Click inside one of the Time Period list boxes to select one of the
time periods (1-16).
6. Enter an Enable Time or a Disable Time in the appropriate field.
The time appears in the Time Period field selected in Step 5.
Repeat Steps 5 and 6 to define any other time periods for the
selected days.
Notes: Any two enable times on one day must have a disable
time falling between them, or vice versa. This means that,
for each day, you can define up to eight Enable Times
and eight Disable Times, for a total of sixteen time
periods.
For example, if a particular day has an Enable Time
defined for 08:30 and a Disable Time defined as 10:30,
you cannot define another Enable Time between
08:30 and 10:30. The same applies for Disable Time.
7. Click Save. A dialog box appears indicating that the time zone has
been saved, and the Access Controller Scheduling window appears
(Figure 28-2).
Note: Always save the data before defining another day for the
time zone, or the OWS will lose the data.
Modifying a Time Zone

Note: You can modify only one day at a time, even if they were
added as a group (that is, weekdays).
To modify a time zone:
1. On the GoTo menu, click Schedule. The Access Controller
Scheduling window appears (Figure 28-2).
Note: The GoTo menu is also available at the System summary,
as long as an Access Controller is selected.
2. On the Action menu, clickModify Access Time Zone. The
Add/Modify Access Time Zone dialog box appears (Figure 28-1).
3. Enter the time zone number in the Time Zone No. field.
4. Click the day of the week you want to modify. The Time Period
list boxes list the time periods currently defined for the selected
time zone and day.
5. Click the time period that you want to modify (1-16).

6. Make the desired changes in the Enable Time or Disable Time
fields. The modified time and state appears in the list box next to
the time period number.
7. Click Save. A dialog box appears indicating that the modified
time zone has been saved, and the Access Controller Scheduling
window appears.
Note: Always save the data before modifying another time
zone or day within the time zone, or the OWS will lose
the data.
8. Click Cancel to cancel the modifications.
Deleting a Time Zone

To delete a time zone:
2. Click Modify Access Time Zone. The Add/Modify Access Time
Zone dialog box appears (see Figure 28-1).
3. Enter the number of the time zone in the Time Zone No. field.
4. Select the day of the week. All of the defined time periods for that
day appear in the Time Period list boxes.
5. Select the time period you want to delete in the Time Period list
box.
6. Click Delete to delete the time period.
7. Repeat Steps 5 and 6, deleting all of the periods for the selected
day. Click Save. Then select another day, and delete all of its
defined time periods. Repeat this process until all of the time
periods have been deleted.
8. Click Save. The changes are saved and the Access Controller
Printing a Time Zone Schedule

To print a time zone schedule:
2. On the Action menu, click Add or Modify Time Zone. The
Add/Modify Time Zone dialog box appears (see Figure 28-1).
3. Enter the time zone number in the Time Zone No. field.
4. Click Print. The selected Time Zone Schedule is printed, and the
OWS returns to the Access Controller Scheduling window.
Note: If a time zone is being added or modified when a Print
command is issued, the new or modified time zone will
not print unless it was saved before the Print command
was issued.
Chapter 29
Uploading and Downloading

Databases
Introduction
An upload or download is the transfer of data from one device or file
to another. This transfer of data keeps information at different
locations synchronized and up to date.
For example, the archive database should always be an up-to-date
master copy of the database. Therefore, whenever the operational
database changes (for example, after a new object is defined), copy the
operational database to the archive database. This is called an upload.
• perform an NCM upload
• perform an NCM download
• perform a DSC8500 download
• perform a D600 Access Controller download
• perform an N2Open download
• perform a System 91 download
• perform a global upload
• perform a global download
• abort an upload or download
• clear upload and download status lines
© August 1, 2003 Johnson Controls, Inc. www.johnsoncontrols.com

Code No. LIT-120155
Key Concepts
Databases
There are three types of databases: global, NCM, and Controller.
Global and NCM databases are uploaded and downloaded. Controller
databases are only downloaded.
NCM Database
The NCM database contains process code and object/feature data,
including GPL process objects, object definition, and trend data. The
operational NCM database is the database that the NCM is currently
using online. The archive NCM database is the master copy stored at
the OWS designated as the NCM’s archive. An archive device is
designated during NCM setup. The archive workstation can be either
the one you are currently using or another workstation. The archive
database is the version copied to the NCM during a download.
Note: There are different types of NCMs (for example, Standard
and Migration). Keep in mind that these NCMs serve
different purposes, and that some of the information they
download is unique, depending on the way the NCMs are
configured.
Global Database
The global database contains network configuration, the Devices
system, systems, report/access groups, and the password database. The
operational global database is the version currently being used online
by the network. The archive global database is the master copy stored
at the OWS.
Controller Database
The controller database contains object/feature data specific to various
types of controllers. The Download Controller command supports
download to a variety of controllers: DSC8500s, D600s, AHUs,
DX-9100s, DX91ECHs, LCP/DC9100s, PHXs, TC-9100s, UNTs,
VAVs, and XTMs.
NCM Upload
An NCM upload copies the operational NCM database to the archive
NCM database. Whenever the operational database changes (for
example, when a new object is defined), perform an upload to keep the
archive database up to date.
Copy the NCM database either to the workstation performing the
upload (This PC), or to the workstation defined as the NCM archive
database (NC Archive). You can upload from only one NCM at a time
from any one workstation.
An NCM upload uploads all object/feature databases in the NCM. The
OWS cannot upload an individual database (for example, BI object
data). The only exception to this is the uploading of process objects
(which is described in the Using Processes chapter [LIT-120160]).
Note: If the upload fails, the previous version of the archive
database is restored.
Only the supported object/feature data for the NC type is uploaded.
Refer to the Uploading and Downloading Databases Technical
Bulletin (LIT-636115) for more information.
Uploading to the NC-Dial PC

When an NCM communicates over a modem, there are special
circumstances that need to be addressed in order to complete the
upload. These circumstances differ, depending on the PC performing
the upload and the communications route that exists. For specific
details on dial-up communications and the NCM upload, refer to the
Uploading and Downloading Databases Technical Bulletin
(LIT-636115).
NCM Download
An NCM download copies the archive NCM database to the NCM.
Perform a download after installing an NCM or changing the archive
database. The download ensures that the NCM has the correct,
up-to-date database.
If an N1 node (NCM) is moved from an ARCNET® network to an
Ethernet network and the node address changes, recompile and
download the weekly scheduling and GPL process databases.
If both the global and NCM archive databases change, perform the
global download before the NCM download. Do not perform both at
the same time.
An NCM download can copy either the NCM database only, or both
the NCM database and BAS code. BAS code is the set of
Metasys-executable files that allow the NCM to run. A download of
BAS code is necessary for the installation of a new NCM, or the
installation of a new release of OWS software.
If the NCM loses both AC power and battery power, it automatically
initiates a download of BAS code and databases from the workstation
designated as the NCM’s archive when the power returns. The
Upload/Download summary (described later in this section) records
NCM-initiated downloads.
If the system includes an Ethernet Router between the archive OWS
and the NCM, disconnect any unconfigured NC-Direct OWS before
downloading.
Download the archive NCM database either from the OWS performing
the download (This PC), or from the workstation defined as the NCM
archive device (NC Archive).
The workstation performing the NCM download must contain an
operational copy of the global database. Before downloading a newly
defined NCM, perform a global upload. Then compile the NC DDL
database file and perform a code and data download.
Whenever the NCM is downloaded with the NCM database, the online
global database is also downloaded to the NCM. If the downloading
NCM is connected to an N1 network, time and date stamps are
checked with the network global. All online nodes on the network
share the most recent global databases.
An NCM download downloads all object/feature databases. The OWS
does not support the download of individual databases (for example,
BI object data). The only exception to this is the downloading of single
process objects (which is described in the Using Processes chapter
[LIT-120160]).
Only the supported feature/object data for the NC type is downloaded.
Refer to the Uploading and Downloading Databases Technical
Bulletin (LIT-636115) for more information.
Downloading from an NC-Dial PC to the NCM

When an NCM communicates over a modem, there are special
circumstances that need to be addressed in order to successfully
complete the download. These circumstances differ, depending on the
PC performing the download and the communications route that exists.
For specific details on dial-up communications and the NCM
download, refer to the Uploading and Downloading Databases
Global Upload
A global upload copies the operational global database to the archive
global database at the workstation performing the upload. Whenever
the operational global database changes (for example, when a new
password is defined), perform an upload to keep the archive database
up to date.
If the network and workstation are connected through phone lines and
a modem (if the workstation is remote), the Dial-Up feature makes the
connection that allows the global upload to occur.
Only one global upload (or download) may be in progress at a PC at
one time.
Global Download
A global download copies the global archive database to the global
operational database at the workstation performing the download. If
the version copied to the workstation is more recent than the
operational version, the workstation downloads the most recent
database to all online nodes on the network.
If the network and workstation are connected through phone lines and
a modem (if the workstation is remote), the Dial-Up feature makes the
connection that allows the global download to occur.
Only one global download (or upload) may be in progress at a PC at
one time.
If both the global and NCM archive databases change, perform the
global download before the NCM download. Do not perform both at
the same time.
DSC8500 Download
DSC8500 object files are created using the CAL1 programming
language. A download to the DSC8500 controller copies the CAL1
archive database to the operational database of the DSC8500.
After adding to or changing a DSC8500 CAL1 program, perform a
DSC8500 download so that the operational data in the DSC8500 is
up to date.
Download the CAL1 program for a DSC8500 from the OWS
requesting the download (This PC), or from the workstation defined as
the NCM archive device (NC Archive). The PC performing the
download must contain the CAL1 program for the DSC8500. The
CAL1 program can be archived at any PC, not just the archive PC of
the NCM to which the DSC is connected.
A read-only, non-triggerable Download in Progress attribute in the

DSC8500 Focus window indicates whether a download is currently in
progress.
If all three downloads are necessary, perform a Global download, an
NCM download, and download to the DSC8500 in the following
order:
1. Global Download
Note: An NCM download automatically downloads the online
global database. Perform the Global download only if
the archive global database was modified.
2. NCM Download
3. DSC8500 Download
Note: Performing an NCM or Global Download does not
download CAL1 programs to the DSC8500. Download
to all DSCs separately.
When the DSC loses its memory, it automatically requests a
download; therefore, it is important that the object code is stored on
the correct archive directories of the workstations.
Downloading from an NC-Dial PC to the DSC8500

When a DSC8500 communicates over a modem, there are special
circumstances that need to be addressed in order to successfully
complete the download. These circumstances differ, depending on the
PC performing the download, and the communications route that
exists. For specific details on dial-up communications and the
DSC8500 download, refer to the Uploading and Downloading
Databases Technical Bulletin (LIT-636115).
D600 Download
A download to the D600 Access Controller copies Access Controller,
Card Reader, Binary Input, Time Zone, and Access Card databases
from the NCM to the D600. After installing an NCM or downloading
altered access data to the Security NCM, always download to the D600
Access Controller.
Note: When Security objects, Binary objects, access cards, Card
Reader objects, and time zones are added online, they are
automatically downloaded to the D600.
A read-only, non-triggerable attribute in the Focus window indicates
whether a download is currently in progress.
! CAUTION: Downloading to the Access Controller takes the

controller offline until the download is
complete.
A download of a security NCM does not automatically transfer data
dedicated to the Access Controller from the NCM. Instead, this data is
stored at the NCM until the operator commands the download using
the Download Controller option in the Action menu of the Access
Controller Focus window. Only when this command occurs does the
D600 download send access data from the NCM to the operational
database of the D600 Security Controller. Since the controller goes
offline during a data download, this separate download command to
the controller helps to prevent the controller from being taken offline
during a critical time, such as the beginning of a work shift when a
large group of personnel needs to enter a building.
N2Open Download
An N2Open download sends a configuration file from the workstation,
via the NCM, to the specific device. The following devices can be
downloaded:
• Air Handling Unit (AHU)
• Phoenix Fume Hood Controller (PHX)
• Unitary (UNT) Controller
• Variable Air Volume (VAV) Controller
A read-only, non-triggerable attribute in the Access Controller Focus
window indicates whether a download is currently in progress.
The AHU, UNT, VAV, and PHX are configured using HVAC PRO
software. Configure the PHX using HVAC PRO Release 4.00 or later.
The others may be configured using an earlier version.
The file to be downloaded to the AHU is copied to the

AHUTEMPF.TMP temporary file where it is updated with the current
AI offset data from the selected AHU controller. The temporary file
also stores the N2 address data before an N2Open download occurs.
This allows the download to occur without the loss of the current AI
offset and N2 address information.
For HVAC PRO Release 4.00 or later, the file extension for the
configuration file is .ASC, no matter what type of N2 Open device is
downloading. (PHXs always have .ASC extensions, since they must
be configured using HVAC PRO Release 4.00 or later.)
The file extensions of a version of HVAC PRO software earlier than
Release 4.00 vary depending on the controller type. AHUs have .AHO
extensions, VAVs have .VAO extensions, and UNTs have .UNO
extensions.
When downloading to a controller, choose an object file from the list
of files present in the list box. This box contains a list of all object files
located in the HVAC PRO directory (defined in the METASYS.INI
file) for the controller. The default METASYS.INI directory path
name is:
C:\FMS\DATA\HVACPRO
Note: If the program is loaded using the PREP-FOR tool, the
directory path name defaults to:
C:\PROJECT\Contract#\HVACPRO
The firmware version of the controller (AHU, VAV, UNT, or PHX)
and the file to be downloaded must match before the download is
allowed.
The files to be downloaded must be copied into the HVAC PRO
download directory or the directory specified in the OWS.INI as
download directory for that type of controller.
System 91 Download
A System 91 download sends a configuration file from the
workstation, via the NCM, to one of the following devices:
• Extended Digital Controller (DX-9100 and DX91ECH)
• Lab and Central Plant Controller (LCP/DC-9100)
• I/O Extension/Expansion Modules (XTM only; does not include
XT-9100)
• Terminal Controller (TC-9100)
An OWS can download only one System 91 controller at a time.

DX-9100s are configured using the GX-9100 Graphic Programming
Tool. This tool also creates the DX-9100 download. Read in the file
and click Download on the GX-9100 Action menu to reformat the file
and save it with a .DXF extension.
Since each DX-9100 or DX91ECH controller needs a download file,
give the configuration file a name that clearly identifies the controller
to which it belongs.
Note: A DX must be downloaded twice if XT addresses have
changed.
IMPORTANT: Only download a DX-9100 or DX91ECH

configuration file into the controller for which it was
created. The hardware configuration of the DX-9100
(or DX91ECH) and any extension modules (XT-9100)
connected to it, especially their addresses, must match
those defined in the file. XT-9100s must have unique
addresses on the N2 Bus.
LCP/DC9100s are configured using the LCP/GC9100 Commissioning

Tool. To create a download file, simply rename the configuration file
with a .DCF extension. The file format is already correct.
The XTM Configurator program, accessed at the OWS from the
Custom Applications option on the Accessory menu, configures
XTMs. The configuration tool automatically creates the XTM
download file, which has a .DBF extension.
TC-9100s are configured using HVAC PRO Release 6.0 or later.
HVAC PRO software automatically creates the TC-9100 download
file, which has a .TCO extension or .TCD extension.
Note: Download of .TCD files is available at HVAC PRO
Release 9.0.
When downloading to a controller, choose an object file from the list
of files present in the list box. When first opened, the box contains a
list of all object files located in the SYSTEM91 directory (defined in
the OWS.INI file) for the controller. The directory path name for all
System 91 controllers defaults to:
C:\FMS\DATA\SYSTEM91
To make the OWS access a different directory, enter the directory

name in the Download File Path field in the controller’s Download
dialog box.
Note: If the program is loaded using the PREP-FOR tool, the
directory path name defaults to:
C:\PROJECT\Contract#\SYSTEM91
For more detailed information, refer to the following documents:
• GX-9100 Software Configuration Tool User’s Guide
• LCP Commissioning Tool (LIT-636069e)
• HVAC PRO User’s Guide
Upload/Download Summary
The Upload/Download summary contains a record of device uploads
and downloads that have been executed or are currently being
executed at the workstation. The devices whose uploads or downloads
may appear in the summary are:
• NCM
• DSC8500
• D600 Access Controller
• N2Open controller (AHU, VAV, UNT, or PHX)
• System 91 controller (LCP/DC9100, XTM, DX9100, or
DX91ECH)
Note: Global uploads/downloads do not appear in the summary.
The summary displays the status of device uploads and downloads,
and allows the user to abort any uploads or downloads that are in
progress.
The summary automatically appears as an icon (see Figure 29-1) when
a device upload or download begins. The default location is as an
application item on the task bar and the icon can be restored or
maximized to view contents.
FIG60
Figure 29-1: NCM Upload/Download Summary Icon

When the upload or download is complete (or is aborted or fails), and

no other upload/download is in progress, the icon remains on the
screen.
If the summary is in window form (rather than in icon form), the status
lines in the window indicate any status changes.
To display the Upload/Download summary, double-click the icon.
Figure 29-2 shows an example of an Upload/Download summary.
Figure 29-2: Upload/Download Summary

The Upload/Download summary displays a status line regarding each
device involved in an upload or download. The summary displays
uploads and downloads in consecutive order, with the most recent at
the top.
Each device has only one status line. Therefore, if an upload or
download begins, the new In Progress status line replaces any existing
status line. The summary contains dynamic data. Whenever an upload
or download completes, fails, or is aborted, the In Progress status line
changes to reflect the new status.
Table 29-1 details the information that the fields in the summary
provide.
Table 29-1: Upload/Download Summary Fields

Field Description
Network Name of the network containing the device involved in the upload or download.
System Name of the system on which the downloading device resides. For NCMs, this is
blank.
Object Name of the device involved in the upload or download.
Status Status of the upload or download. The upload or download status can be:
• Upload in Progress
• Download in Progress
• Unable to Start
• Complete
• Failed
• Aborted
• Failed - NC Out of Memory
• ???????? - (D600 Access Controller only) Indicates that the workstation is
unable to determine whether the download failed or was completed
successfully. This could be caused by a loss of communication between the
NCM and the workstation after the download began.
Initiator If the NCM initiated the download, NC or DSC8500 appears. If the NCM loses both
AC power and battery backup or is reset for any reason, it initiates a download
when the power returns.
If an Access, N2Open, or System 9100 controller needs a download, the download
must be requested by the operator.
If an operator initiated the upload or download at the workstation, PC appears.
Date and Time The date and time that the upload or download began, if one is in progress. For
any other status, these fields display the date and time of completion.
Detailed Procedures
Performing a NCM Upload
To perform an NCM upload:
1. Click the NCM.
2. On the Action menu, click NC Upload. The NCM Upload dialog
Figure 29-3: NCM Upload Dialog Box

3. Select where the operational NCM database will upload: This PC
or NC Archive. (Refer to the Using Diagnostics chapter
[LIT-120159] for detailed information on Archive PCs.)
To upload the operational NCM database to the workstation
performing the upload, click This PC.
To upload the NCM database to the workstation defined as the
NCM archive, click NC Archive.
4. Click OK. If NCM status is operational, the upload proceeds. The
Upload/Download summary displays the current upload status.
Performing a NCM Download

To perform an NCM download:
1. Click the NCM.
2. On the Action menu, click NC Download. The NCM Download
Figure 29-4: NCM Download Dialog Box

3. To download the NCM object/feature database only, click the NC
Data option button.
To download both the database and BAS code, click the Code and
NC Data option button.
4. To download the archive NCM database from the workstation
performing the download, click This PC. This workstation cannot
be an unconfigured, NC-Dial workstation.
To download the NCM database from the workstation defined as
the NCM archive, click NC Archive.
5. Click OK. If NCM status is operational, the download proceeds.
The Upload/Download summary at the PC performing the
download displays the download status.
If a download initiated at the workstation fails, the NCM attempts
to get a download from the workstation defined as the NCM’s
archive device.
Performing a DSC8500 Download

To perform a DSC8500 download:
1. Double-click the system that contains the DSC8500 Hardware
object.
2. Double click the object. The DSC8500 Hardware Object Focus
window appears.
3. On the Action menu, click Download Controller. A dialog box for
choosing This PC or NC Archive appears. If the current
workstation is the DSC’s archive PC, This PC and NC Archive
are the same.
4. Choose This PC or NC Archive and click OK.
Note: The PC performing the download must contain the
CAL1 object code for the DSC8500.
Performing a D600 Access Controller Download

To perform a D600 Access Controller Download:
1. Double-click the Access Controller Object. The Access Controller
2. On the Action menu, click Download Controller. A dialog box
appears asking for confirmation.
3. Click OK. The Upload/Download summary icon flashes on the
screen, and the Upload/Download summary records the download.
Performing an N2Open Download

To perform an N2Open download:
1. Double-click the system containing the controller.
2. Double-click the hardware object. The AHU, VAV, UNT, or PHX
requesting the selection of an HVAC PRO object file appears
(Figure 29-5).
Figure 29-5: File Selection Box

for N2Open Download
4. Click the relevant object file in the list box.
The object’s Focus window shows a Y in the Download in
Progress field when a download begins.
Performing a System 91 Download

To perform a System 91 download:
1. Double-click the system containing the controller.
2. Double-click the hardware object. The LCP/DC9100, XTM,
DX-9100, DX91ECH, or TC-9100 Focus window appears.
listing System 91 object files appears (Figure 29-6).
Figure 29-6: File Selection Box for System 91 Download

Note: Unless the device is an XTM, the menu item is disabled
if the device is offline or is currently being downloaded.
4. In the list box, click the relevant object file. If the file isn’t in the
default directory (SYSTEM91), enter another directory name.
Enter the directory name in the Download File Path field and
press Tab to display the contents of a new directory.
The Download Controller dialog box displays an additional check
box labeled “Replace time schedules in configuration file with
archived time schedules” for DX-9100 or DX91ECH downloads.
The DX-9100 or DX91ECH Local Time Schedule Modules
Definition dialog box creates the archived time schedules (see the
Scheduling Commands and Summaries chapter [LIT-120173]).
Mark the check box to download the new time schedules instead
of those defined in the configuration file. This option appears
dimmed if there are no archived time schedules for this DX-9100
controller.
Note: During archived time schedule downloads, the
configuration file, including its time schedules, is
downloaded before the archived time schedules (.TSD)
file. If the download fails, check the OWS Error Log to
see which download operation failed.

The object’s Focus window shows a Y in the Download in
Progress field when a download begins.
Performing a Global Upload

To perform a global upload:
1. On the Action menu, click Upload Global Data. A dialog box
2. Click OK. When the upload is complete, a message appears
stating that the global upload either succeeded or failed.
Note: If the upload fails, the previous version of the archive
database is restored.
Performing a Global Download

To perform a global download:
1. On the Action menu, click Download Global Data. A dialog box
2. Click OK. When the download is complete, a message appears
stating that the global download either succeeded or failed.
Aborting an Upload or Download

Note: Only abort the uploads or downloads that have Download in
Progress or Upload in Progress in their status lines.
To abort an upload or download:
1. Double-click the Upload/Download summary icon to display the
Upload/Download summary (Figure 29-2).
2. Select one or more uploads or downloads in the summary. The
selected uploads or downloads must have In Progress in their
status lines.
To select more than one upload or download, hold down the Shift
or Ctrl key while selecting individual status lines, or press the
mouse button and drag the pointer across the lines.
3. On the Action menu, click Abort. The Abort dialog box appears
asking for confirmation.
4. Click OK. After a short delay, the status lines of the aborted
uploads and downloads display Aborted.
Clearing Upload and Download Status Lines

Note: You cannot clear the status lines for uploads or downloads
that display In Progress.
To clear the upload and download status lines:
1. Double-click the Upload/Download summary icon to display the
Upload/Download summary.
2. Select one or more upload or download status lines in the
summary.
To select more than one status line, hold down the Shift or Ctrl
key while selecting individual status lines, or hold down the
mouse button and drag the pointer across the status.
3. On the Action menu, click Clear. The status lines are cleared from
the summary.
Troubleshooting
Table 29-2 explains error messages that may occur during a download
or an upload.
Table 29-2: Error Messages

Error Message Explanation
NC needs code download Indicates the NCM needs a download of BAS code. During an
NCM download, this message indicates that you selected to
download the database only. Repeat the download process,
selecting both the database and the BAS code for download.
Download/Upload already in Indicates the NCM is already involved in an upload or download.
progress
Device Download is already in Download to the requested DSC8500 or D600 is already in
Progress progress.
Command Already Executed The command to download the D600 controller has already been
issued, but the download has not started.
Bad Download Attempt The ASC is already receiving a download, or a download is already
running from this OWS to System 91 controller.
Device is Offline, Command The DSC8500, D600, or ASC is offline.
Not Accepted
Communication Disabled, Communication with the DSC8500, D600, or ASC is disabled.
Command Not Accepted
NC Download Busy An NCM download is in progress. Wait for this download to
complete before starting a new download.
Download Failed NC download fails when using a direct or a dial-up
connection.
Failure to define the archive device baud rate setting can cause the
download to fail after the code download is complete. Verify that
the correct baud rate is defined for the RS-232 direct or dial-up
connection.
NC download fails when using a LAN connection.
The download fails if the Ethernet or ARCNET connection to the
NCM is not maintained during the download. Verify that the LAN
connection is reestablished.
Firmware Version Mismatch The firmware for the downloaded files is a different version of
firmware than the controller of the firmware version not supported
by download.*
Hardware Busy The ASC is performing some other function.
Invalid Path The path name for the HVAC PRO directory is invalid, or the
System 91 directory specifies in the Download Path File test box
does not exist.
File Does Not Exist The file name entered in the Download File Path field does not
exist.
Global Upload Failed Indicates an NC direct or dial-up connection failed.
Global Upload Not Initiated Indicates that an internal failure occurred when the online data was
being transferred to the archive global database.
The file you are trying to Indicates that a file is open. The issue does not affect the global
open is in use by another upload and can be ignored.
program.
GLOBAL DOWNLOAD FAILED The archive was successfully copied to the online global database,
Copy to online successful. but the online database could not be transferred to the network.
Transfer to network failed. This usually indicates an NC direct or dial-up connection failed.
Global Download Not This error message usually indicates that an internal failure
Initiated. occurred when the archive data was being transferred to the online
Copy to online failed. global database.
* The N2Open download feature supports AHUs with Rev. B and C firmware, UNTs, with Rev. A and B
firmware, and VAVs with Rev. A firmware.
Chapter 30
Archiving CAL1
Introduction
This chapter explains how to archive CAL1 files for the DSC8500
hardware object. There are two types of CAL1 files: object and source.
CAL1 object files contain the information necessary for operating the
DSC8500 controller and allowing it to interface with the network via
the S2 Migration NCM. CAL1 source files are files that the DSC
Translator compiles in order to create CAL1 object files.
• archive CAL1 object files
• delete CAL1 object files

Code No. LIT-120156
Key Concepts
Archiving CAL1 Files
The archiving process can be done with either the Disk Operating
System (DOS) or with the Windows operating system. The Archive
CAL1 option in Windows software archives both object and source
files at the same time.
In order to download a DSC8500 controller from the OWS, the archive
PC for the NCM must contain a CAL1 object file for each DSC8500 it
is responsible for. A utility called CAL1ARCH is provided with DDL
software. The CAL1ARCH utility loads CAL1 object files into a PC’s
database.
Keep source files in a separate directory on the hard drive or on
diskettes. The OWS provides the C:\FMS\SAVE directory, which is
automatically created during the installation of OWS software. When
the source files are compiled, the object files are created in the same
directory as the source files, and the Archive Utility can transfer the
object files from the directory to the PC database.
Note: The CAL1 Archive Utility can also archive CAL1 source
files for use with the DSC8500 Snapshot feature.
Nevertheless, keep copies of the source files in a separate
directory on the hard drive or diskette.
Before executing the CAL1 archiving process:
• Install DDL. Which includes the CAL1 archiving utility.
• Compile the Database source files.
For more information, refer to the DDL Programmer’s Manual.
DOS Command Options

Table 30-1 describes some DOS command options used for archiving
CAL1 files.
Table 30-1: DOS Term Explanations

Term Function
CAL1ARCH Commands DOS to archive a CAL1 file
-O Indicates that the CAL1 files is an Object file
-S Indicates that the CAL1 file is a Source file
CAL1Inputfile Indicates the path and file name of the object file. If the file has an extension other than
[.obj] .OBJ (or has no extension), it is given an extension of .OBJ during the archive process.
For example, FILE, FILE.OBJ, and FILE.XYZ will all be archived as FILE.OBJ.
Note: Be sure to include the path for the object file. Otherwise, only the
current directory will be searched.
Networkname Represents the name of the network that the hardware object is located in
(eight characters or less)
Systemname\ Represents the DSC8500 hardware object name, including the system. Each name less
Objectname than nine characters long and the backslash (\) must be included.
Example:
CAL1ARCH a:\DSC1.obj Networka Systemb\DSC1
Modifying CAL1 Object Files

To modify a CAL1 object file, use an ASCII text editor to modify the
CAL1 source file, and recompile. After the compiling, archive the new
object file into the archive database defined for the relevant DSC8500
hardware object. Reload the modified source and object file on any
other PC that contains a copy of the original object file. If the
databases of three different PCs contain a copy of a particular object
file, for example, archive the modified version on all three PCs.
Otherwise, a PC may download the wrong version of the DSC8500’s
object file to the controller. For more information, refer to Archiving
CAL1 Object Files in the Detailed Procedures section of this chapter.
After modifying a DSC8500 object file, download the new information
to the DSC8500. For more information, refer to the Uploading and
Downloading Databases chapter (LIT-120155).
To use the Snapshot feature, the archived source and object files must
match (that is, the object file must have been derived by compiling the
archived source file).
Detailed Procedures
Archiving CAL1 Object Files
Using DOS
To archive a CAL1 object file or source file using the DOS method:
1. Insert a disk copy of the CAL1 file in Drive A, or verify that it is
stored on the PC’s hard drive.
2. For an object file, at the DOS prompt, type:
CAL1ARCH -O CAL1Inputfile[.obj] Networkname
Systemname\Objectname
For a source file, at the DOS prompt, type:
CAL1ARCH -S CAL1Inputfile[.cal]
Networkname Systemname\Objectname
Note: For an example of this format, type CAL1ARCH.
3. Press Return. A message appears asking for confirmation. Press
Return again to continue. If the file is copied correctly, the
following message appears:
The CAL1 file was archived successfully.
Using the Windows Operating System

To archive a CAL1 object file or source file:
1. If the file is not on the workstation’s hard drive, insert a copy of
the CAL1 file in disk Drive A. Object files must have an .OBJ
extension. Source files must have a .CAL extension. To archive
source and object files at the same time, the files must have the
same filename (for example, DSC1.CAL and DSC1.OBJ)
2. Open the Focus window of the relevant DSC8500 object.
3. On the Action menu, click Archive CAL1. The Archive CAL1
Figure 30-1: Archive CAL1 Dialog Box

4. Select Object File (.OBJ), Source File (.CAL), or both.

5. Type in the path and the file name of the CAL1 file.
For an object file, enter an .OBJ extension. For a source file enter
a .CAL extension. To archive both, enter only the filename
without any extension.
6. Click OK. When the process is complete, a message box appears
indicating that the file was archived successfully.
Deleting CAL1 Object Files

To delete CAL1 Object Files:
1. Delete the DSC8500 hardware object at the PC.
Note: To delete the DSC8500 hardware object from the system
using DDL, refer to the Compiler section of the
DDL Programmer’s Manual, and Defining Objects
(LIT-120149) in the Advanced User’s Guide of this
manual.
2. Find the CAL1 source and object files in the archive database. All
source and object files are located under the following path name:
(FMSDATA)\(network name)\CAL1\(system name)\
(object name).obj or .cal.
3. Delete all of the CAL1 source and object files using the DOS Del
command or DFEDIT command, or Windows Explorer.
Troubleshooting
Common Errors
Errors may occur during the archiving process for any of the reasons
described below. Error messages often indicate which specific error
has occurred.
Using DOS
Common errors:
• The Network is not defined.
• The number of parameters for the command is incorrect.
• The parameter is invalid (that is, a space within the name).
Using Windows Software or DOS

• The file is not on the disk.
• The path name for the CAL1 file is incorrect.
• The disk containing the file is not in the disk drive.
Chapter 31
Saving and Restoring Databases
Introduction
The OWS contains archived database files for the entire facility. The
purpose of the save and restore functions is to back up and restore
these files.
The OWS can save and restore either the entire database or a single
network database. The entire database includes the global database and
all network databases archived at the workstation. A single network
database contains all the NCM databases in the network that are
archived at the workstation, and the global database for that network.
• save a database
• restore a database

Code No. LIT-120157
Key Concepts
Saving Databases
Saving databases involves using a workstation to back up (on diskette)
all the NCM databases and the global database of a specified network
that are archived on that workstation.
The process of saving databases varies slightly depending on the
version of Windows® Operating System (OS) that the OWS uses
(Windows 2000 Professional OS or Windows XP Professional OS).
Restoring Databases
The database restoration process copies (to the workstation) the
database on diskettes. For example, if the diskettes contain only
one network database, only that database is restored. The copy from
diskette overwrites the database at the workstation.
Compressed files automatically return to their normal format when
restored; however, the restore process creates a temporary file, called
the CONTRACT.ZIP file, to protect data during the process. The hard
drive should have enough memory to hold a temporary copy of the
compressed file in order to restore it. If the restore process is
successful, the CONTRACT.ZIP file is automatically deleted. If the
process fails, delete it manually, using DOS or the Windows File
Manager.
The restore process returns files to the same directory that they were in
when they were saved. If a directory was empty when it was saved, the
OWS recreates it during the restore process.
Depending on the version of Windows OS the OWS is using (that
is, Windows 2000 Professional OS or Windows XP Professional OS),
the method of restoring a file varies. See the appropriate section in
Detailed Procedures to find out how to restore a database.
LOG Files
During each save or restore attempt, .LOG files are created containing
both error and processing information about the save or restore
process. Refer to the appropriate .LOG file to find what the exact
nature of failed save or restore attempt was, as well as what files
should have been saved or restored. The C:\SAVEREST directory
contains all .LOG files. Each subsequent save or restore overwrites the
.LOG files, so there is never more than one of each of these file types
on the hard drive. A detailed explanation of each of the .LOG files
appears below.
[NETWORK].LOG
The save process creates and names a .LOG file according to the saved
database. For example, the .LOG file for the network JCITOWER
would be named JCITOWER.LOG. This file lists three types of
information:
• all of the files that the save process should have copied, including
each of the global files and all of the network’s directories and
database files
• any global files that the OWS could not find. (The OWS may not
find Global files if a directory or file name has been changed.)
• errors that occur during the save process. Errors may or may not
cause the save process to fail.
DIRFILES.LOG
The DIRFILES.LOG file, located in the \SAVEREST directory, lists
all of the directories to be saved during the save process. The PC uses
this file for internal processing and deletes it automatically when the
save is complete; however, if the save fails, DIRFILES is not deleted.
The next save attempt overwrites this file. However, this file consumes
a small amount of memory; to conserve disk space, delete the file
manually.
RESTDB.LOG
The RESTDB.LOG file contains a list of each of the global and
network database files restored during the restore process. This file
also contains error messages for each error that occurred during the
process. Errors may or may not cause the restore process to fail.
MAKEDIR.LOG
The MAKEDIR.LOG lists all directories created during the restore
process. These directories were empty during the save process, and
would have been created by recompiling the DDL files in past releases
of OWS software.
DOS Backup and Restore Utilities

Back up or restore databases either by choosing the Backup Utility
menu option or by manually running the backup or restore utility. Both
methods use the same DOS backup and restore utility; however, the
Backup Utility menu option uses a set of default options. To customize
options for backing up or restoring databases, exit to DOS and run the
utility manually. Close the Metasys® program before using either
method.
Windows Backup and Restore Utilities

When using Windows, back up or restore databases by choosing the
Backup Utility menu option. This shuts down the Metasys® system
program and loads the Microsoft® Backup and Restore Utility.
Windows 2000 Professional OS and Windows XP Professional OS
support only backup to tape.
Note: Johnson Controls highly recommends performing a back up of
the entire drive using a mass-storage device. This saves hours
of looking for Operating System data, third-party applications,
and operator personal files.
Saving Files to Diskettes

As a precaution, save the databases to diskettes whenever the archive
database changes significantly. The save process overwrites any
previous saves on the diskettes.
Before saving files, be sure to have sufficient diskettes on hand.
Two diskettes per network should be sufficient. An entire database or a
large network with many GPL or JC-BASIC files may require three or
more diskettes. Compress the files before saving them to use fewer
diskettes. More information on compressing files appears later in this
document.
Insert the first diskette in the backup drive before starting the save
process.
The diskettes:
• must not be write protected.
• do not need to be formatted. (The save process formats them if
required.)
• should be labeled with the workstation or network name, the date
and time of the save, and the sequence number of the diskette.
Detailed Procedures
Saving the Database
To save the database using Windows 2000 Professional or
Windows XP Professional OS, use the following instructions:
1. On the Exit menu, click Backup Utility > Backup. A message
appears stating that the PC is about to exit the Metasys system.
The Windows Backup/Restore procedure begins.
2. On the Window drop down menu, click Drives.
3. Select the files to back up by clicking inside the check box next to
each file. (Selecting a directory selects all of the files within the
directory.) Select all files in a directory by placing a check box
next to the directory name. As a minimum, include the following
files and directories:
\CUSTOMAC
\FMS\BIN\GPL\JCIMACS
\FMS\GRFXLIB
\FMS\ERRORLOG
\FMS\SAVE
\FMS\STATIC\*SBQ
\FMS\DATA\N1NET.DBF
\FMS\DATA\PCDEVICE.DBF
\FMS\DATA\Win.ini
\FMS\DATA\NETNAME.NDX
\FMS\DATA\PCCONFIG.DBF
\FMS\DATA\PCPORT.NDX
\FMS\DATA\DDL\*.DDL
\FMS\DATA\MODELS
\FMS\DATA\HVACPRO
\FMS\DATA\SYSTEM91
\FMS\DATA\“NETWORK NAME”
\FMS\DATA\“NETWORK NAME”.DOB
Replace the NETWORK NAME with the actual name of the
network being backed up.
4. Click the Backup button when finished. The Backup Information
dialog box appears.
Figure 31-1: Backup Information Dialog Box

5. Enter Full Metasys backup for the description.
6. Click OK.
7. When the backup is complete, open the Metasys Full Save File
and verify that all selected files are present.
Blank directories are not saved.
Restoring a Database
Use the following procedure to restore the database with
Windows 2000 Professional OS or Windows XP Professional OS:
Note: A database saved using the DOS program SAVEDB.BAT
using Windows 3.1, Windows 95, or Windows 98 OS can be
restored on a Windows 2000 Professional OS or Windows XP
Professional OS machine using the DOS program RESTDB.bat
(DOS program).
1. On the Exit menu, click Backup Utility > Backup. A message
appears indicating that the PC is about to exit the Metasys system.
The Windows Backup/Restore procedure begins.
2. The tape drive activates. Double-click the directory in the right
window. A detail tree of the files that reside on tape appears.
3. Select files to restore by clicking the check box next to the file
name.
4. When the process is complete, check the \winnt\backup.log
to verify that the process restored all of the files and that no error
messages are present.
Metasys® is a registered trademark of Johnson Controls, Inc.

All other marks herein are the marks of their respective owners.
© 2004 Johnson Controls, Inc.
Chapter 32
Using Demand Limit/Load Rolling
Introduction
Demand Limiting/Load Rolling combines two related features, both of
which lower facility energy costs. Demand Limiting lowers the peak
demand of energy usage by temporarily turning off designated
equipment before the usage reaches the defined target limit. Load
Rolling lowers energy usage by constantly turning off enough
equipment to meet the target (for Load Rolling, the target is the
amount of energy to be off at any given time).
• display the Load Group Focus window
• define a load group object
• define a load
• modify a load
• delete a load
• display the Utility Profile

Code No. LIT-120158
Key Concepts
Demand Limiting/Load Rolling Setup
There are two tasks to perform when setting up the Demand
Limiting/Load Rolling feature.
The first task is defining the Load Group object for Demand Limiting,
Load Rolling, or both. For this process, specify the values that the
system will use to determine when loads are turned off (for example,
the limit that energy consumption is not to exceed). Turning off loads
is also called shedding loads.
The second task in the process of setting up DL/LR is to define the
loads that make up the Load Group. Use the Load Definition window
to define these loads as BO, BD, Multistate Object (MSO), or
Multistate Data (MSD) objects.
Load Group Focus Window

Use the Load Group Focus window to display detailed information
about the operation of the Load Group object, modify object attributes,
and access the Associated Loads dialog box. Use the Associated Loads
dialog box to add, delete, or modify loads.
Figure 32-1 shows an example of a Load Group Focus window.
Figure 32-1: Load Group Focus Window

The modifiable fields (such as Expanded ID) in the Load Group Focus
window are contained in boxes.
To access online help on the fields in the Load Group Focus window,
use the Attribute Help option on the Help menu.
Utility Profile
The Utility Profile screen displays detailed information about the
energy consumption of Load Group objects. Information in the utility
profile can not be changed. Figure 32-2 shows an example of a utility
profile.
Figure 32-2: Utility Profile

Table 32-1 details the information that the Utility Profile fields
display.
Table 32-1: Utility Profile Fields

Field Description
Item Name of the load group
Description Extended ID of the load group
Status Load Group’s current status: Normal or Alarm
Current Period Total Consumption, in Measured Peak and Projected Peak for four different tariff
levels. Total Consumption displays the date, time, and the amount of energy that
the object has consumed during the current period for four tariff levels in terms of:
• Measured Peak: The largest demand interval peak detected since the start of
the period, including the time and date of the peak
• Projected Peak: The largest projected demand interval peak for the period,
including the time and date of the projected peak
Use tariff levels to set the demand target at four different levels. Only one level is
active at a time.
Previous Period Total Consumption, in Measured Peak and Projected Peak. Total Consumption
displays the date, time, and the amount of energy that the object consumed during
the previous period in terms of:
• Measured Peak: The largest demand interval peak detected during the last
period, including the time and date of the peak
• Projected Peak: The largest projected demand interval peak for the last
period, including the time and date of the projected peak
Commanding the Load Group Object

Command the Load Group object from any summary displaying the
object or from the Load Group Focus window. Use the Operation and
Communication command options on the Action menu. For the
procedures for commanding objects, refer to the Commanding Objects
chapter (LIT-120172). The Operation and Communications commands
available with DL/LR are described below.
Operation Commands
• Demand Limiting-Monitor Only—Disables the shedding of
loads by the Demand Limiting feature. Demand Limiting continues
to monitor energy consumption and make calculations. Because of
this, the object is ready to shed loads when enabled again. This
command complements the Demand Limiting-Shedding command.
• Demand Limiting – Shedding—Enables the shedding of loads by
the Demand Limiting feature. This command complements the
Demand Limiting-Monitor Only command.
• Load Rolling-Monitor Only—Disables the shedding of loads by
Load Rolling. This command complements the Load
Rolling-Shedding command.
• Load Rolling – Shedding—Enables the shedding of loads by

Load Rolling. This command complements the Load
Rolling-Monitor Only command.
• Reset Period—Moves Load Group information from the current
period to the previous period, and clears the current period
information.
• Lock Load—Locks one specified load. When a load is locked, the
Demand/Limiting Load Rolling feature does not consider it a
candidate for shedding.
• Unlock Load—Unlocks a load that has been locked with the Lock
Load command. When a load is unlocked, Demand/Limiting Load
Rolling considers it a shed candidate.
• Set Demand Limiting Tariff 1 Target—Specifies a new Demand
Limiting target.
Limiting target.
Limiting target.
Limiting target.
• Set Load Rolling Tariff 1 Target—Specifies a new Load Rolling
target.
target.
target.
target.
Communication Commands
The Lock/Unlock Triggers and Lock/Unlock Reports commands
operate for the Load Group object as they do for other objects. The
Enable and Disable commands differ for the Load Group object as
follows:
• Enable—Enables the DL/LR feature. This command complements
the Disable command. DL/LR begins monitoring and calculating
data.
• Disable—Disables the DL/LR feature. When the feature is
disabled, it does not monitor data or make DL/LR calculations.
Therefore, when the feature is enabled after a Disable command, it
must start its calculations from the beginning.
Scheduling Demand Limit/Load Rolling Commands

For more information on scheduling Demand Limit/Load Rolling
commands, refer to the Scheduling Commands and Summaries chapter
(LIT-120173).
Online Help
Use the online help (provided for all Definition and Focus windows) to
explain any unfamiliar fields during the definition process. Online help
describes the fields and gives the formats and valid ranges to use when
entering values.
To access online help, use the Attribute Help option on the Help menu.
For a complete description of online help, refer to the Using
Online Help chapter (LIT-120175).
Detailed Procedures
Displaying the Load Group Focus Window
To display the Load Group Focus window:
1. Double-click the system that contains the Load Group Object. The
System summary appears.
2. Double-click the Load Group object. The Load Group Focus
Defining a Load Group Object

To define a Load Group object:
1. Double-click the system that will contain the new object. The
System summary appears.
2. On the Item menu, click New. The following Item New dialog
Figure 32-3: Item New Dialog Box (for Objects)

3. Click the DL/LR Group option button.
4. Click OK. The Load Group Definition window appears
(Figure 32-4).
Figure 32-4: Load Group Definition Window

5. Enter the required information in the Load Group Definition
fields.
6. After defining the Load Group object, click Save on the Item
menu. The new Load Group object is added to the operational
NCM database.
Databases chapter [LIT-120155]).
Defining a Load
To define loads:
1. Double-click the system that contains the most recently defined
Load Group object. The system summary appears.
2. Double-click the Load Group object. The Load Group Focus
3. Double-click the Associated Loads button in the upper right
corner of the Load Group Focus window. The Associated Loads
dialog box appears (Figure 32-5). This box lists the loads in the
Load Group.
Figure 32-5: Associated Loads Dialog Box

4. Select the priority level by clicking one of the priority level option
buttons (1-4).
Note: Shed candidates for Load Rolling must be priority
Level 3. Shed candidates for Demand Limiting can be
any priority level.
5. Click the Add option button. The Load Definition window

Figure 32-6: Load Definition Window

6. Enter the required information in the Load Definition window
fields.
7. After defining the load, click Save on the Item menu. The new
load is added to the operational database. The Load Definition
window remains active.
8. Repeat Steps 6 through 8 until all the loads are defined for the
Load Group.
Shortcut
To add a load that is similar to one already defined:
1. Select a load that is similar to the new load in the Associated
Loads dialog box.
2. Click Add. The Load Definition window appears (Figure 32-6),
displaying the settings of the selected load.
3. Specify the system\object name of the new load, change the other
settings as needed, and save the load.
Modifying a Load
To modify a load:
1. Display the Load Group Focus window by double-clicking the
Load Group object in any summary displaying the object.
2. Click the Associated Loads option button in the upper right corner
of the window. The Associated Loads dialog box appears
(Figure 32-5).
3. Select the priority level. The list box displays all loads at the
selected priority level. If necessary, use the scroll bar to scroll
through the list of loads.
4. Double-click the load. The Load Focus window for the selected
load appears (Figure 32-7).
Figure 32-7: Load Focus Window

5. Modify the settings.
6. On the Item menu, click Save. The changes are saved and added
to the operational NCM database.
To save the changes to the archived database, perform an NCM
Deleting a Load
To delete a load:
1. Display the Load Group Focus window by double-clicking the
Load Group object in any summary displaying the object.
2. Click the Associated Loads option button in the upper right corner
of the window. The Associated Loads dialog box appears
(Figure 32-5).
3. Select the priority level. The list box displays all loads at the
selected priority level.
4. Click the load.
5. Click the Delete option button. The Delete dialog box appears,
6. Click OK. The selected load is deleted from the Load Group.
To save the changes to the archived database, perform an NCM
Displaying the Utility Profile

To display the Utility Profile:
1. Click the PC group or system with the relevant Load Group object
or objects in the Utility Profile.
2. Click the Summary option in the Network Map menu bar. The

3. Use the scroll bar in the Summary dialog box to display the Utility
Profile option.
4. Double-click the Utility Profile option. The Utility Profile appears
(Figure 32-2).
Troubleshooting
If a field contains invalid information, it appears red when cursor
moves to a new field. If this happens, select and correct the
information. If you attempt to save the window with invalid
information, a message appears indicating the error. Acknowledge the
message by clicking OK, correct the information, and attempt the save
again.
Chapter 33
Using Diagnostics
Introduction
Use Metasys Diagnostics to troubleshoot the hardware components of
the BAS and to check how efficiently the devices are communicating.
Perform diagnostics on the network, on an N1 device (OWS or NCM),
or on an N2, L2, S2, N2E, or LONWORKS compatible device (that is,
DCM, XRL, DSC8500, or FPU).
Activate Diagnostics from any OWS (PC or portable) remotely or
directly connected to an online Network Control Module (NCM).
• print network diagnostics
• display PC diagnostics
• display NC diagnostics
• perform N2/L2/S2 diagnostics
• update statistics
• clear statistics
• print diagnostics

Code No. LIT-120159
Key Concepts
Network Diagnostics
The Network Diagnostics option prints detailed information about the
hardware configuration and addressing of the entire network. The PC
can only print Network Diagnostic information; it cannot display this
information on the screen.
The printout of Network Diagnostics includes listings of all connected
OWSs, NCMs, N2/L2/S2/N2E/LONWORKS compatible devices, and all
software objects connected to each N2/L2/S2/N2E/LONWORKS
compatible device.
PC Diagnostics
The PC Diagnostics option displays N1 statistics collected at the
selected OWS (not all N1 traffic). This information appears in the
Diagnostics-N1 Statistics window. Figure 33-1 shows an example of
this window.
Figure 33-1: Diagnostics-N1 Statistics

Table 33-1 details the type of information found in each of the fields
of the Diagnostics-N1 Statistics window.
Table 33-1: Diagnostics-N1 Statistics Window Fields

Field Description
XMIT The number of communications transmitted over the N1 Direct and RS-232
communication ports (COM1, COM2, COM3, and COM4) since the last time
statistics were cleared. These statistics are collected when a PC or portable
terminal uses these ports for a dial-up connection to an NCM. If a printer or mouse
is connected to the COM1 port, the COM1 transmits are not included.
RECV The number of communications received since the last time statistics were cleared
ERRORS The number of abnormal conditions received over the N1 Direct and RS-232
communication ports (COM1, COM2, COM3, and COM4) since the last time
statistics were cleared.
RECONS The total number of reconfigurations since the last time the statistics were cleared.
A reconfiguration automatically occurs whenever a node is added to or deleted
from the N1 LAN, or changes from offline to online.
NC Diagnostics
There are eight NC Diagnostics options, all described below.
Reset NC
If the NCM has already been downloaded, this option warm starts the
NCM. If the NCM has not been downloaded, this option cold starts the
NCM. The cold start induces a download of BAS code and databases.
BAS code consists of Metasys executable files. The databases include
system\object records, control processes, and feature information. Both
warm and cold resets activate a series of internal self-tests, and the
NCM goes offline until the self-tests are complete.
Reload NC
Cold starts the NCM. The cold start induces a download of BAS code
and databases.
NOVRAM View
When you choose this option, a dialog box appears indicating that the
function has been moved to WNCSETUP.EXE. Use WNCSETUP to
see or modify NOVRAM information for the selected NCM. See the
NCSETUP for Windows Technical Bulletin (LIT-6360251d) for more
information.
N1 Statistics
The N1 Statistics window that appears for NC diagnostics is identical
the PC Diagnostics window (Figure 33-1). See Table 33-1 for a
description of the fields in this window.
N2/L2/S2 Statistics
If more than one trunk is defined, NC/L2/S2 Statistics displays a
second dialog box for selecting N2/L2/S2 Trunk 1, Trunk 2, or both.
Select a trunk and click OK. The N2 Statistics window appears
(Figure 33-2).
Figure 33-2: N2/L2/S2 Statistics Window

Table 33-2 describes the information presented in the N2 Statistics
window fields. The first line displays trunk totals rather than data
specific to one device. For example, the Polls column in the first line
displays the total number of polls from the NCM to all devices on the
trunk.
Table 33-2: N2 Statistics Window Fields

Field Description
System\ Object Name System\object name of the device connected to the trunk. For the trunk totals line
(the first line), this field is blank
N2 Address Address of the device on the trunk. For the trunk totals line, only the trunk number
appears
Clear Date Date and time that N2 statistics were last cleared for the device
Polls Number of polls from the NCM to the hardware device since the last time statistics
were cleared
Commands Number of requests from the NCM to the device since the last time statistics were
cleared
Off Polls Total number of offline polls from the NCM to the hardware device since the last
time statistics were cleared
Retries Total number of times the NCM retried communications since the last time
statistics were cleared
Err Response Total number of errors received
LONWORKS Statistics
Figure 33-3 shows the Diagnostics-LON Statistics window, which
displays diagnostics information for LONWORKS devices connected to
the selected NCM.
Figure 33-3: Diagnostics-LON Statistics Window

Table 33-3 describes the fields in the Diagnostics-LON Statistics

window.
Table 33-3: LON Statistics Window Fields

Field Name Description
System\ System\object name of the device
Object Name
LON Addr, Address of the device on the trunk. For the trunk totals line, only
Subnet:Node the trunk number appears.
Clear Date Date and time that LONWORKS statistics were last cleared for the
device
Polls Number of polls from the NCM to the hardware device since the
last time statistics were cleared
Cmds Number of requests from the NCM to the device since the last
time statistics were cleared
Offl. Polls Total number of offline polls from the NCM to the hardware
device since the last time statistics were cleared
Prog. ID 8 bytes of information identifying the device’s firmware version.
May be either an ASCII string or a special format containing
manufacturer and device information as defined by the LONMARK
interoperability guidelines
Neuron® ID Unique 48-bit address embedded in the device’s Neuron chip
Cache Hits Number of times the NCM has found a Network Variable (NV)
value in the poll image cache
Cache Misses Number of times the NCM has polled a device to find an NV
value
Netw. Var. Number of permanent NVs (mapped BI or MSI software objects,
Permanent or AI objects with Alarm limits) in the poll image
Netw. Var. Number of temporary NVs in the poll image (AI’s without Alarm
Temporary limits defined). These are deleted when their time-to-live is up.
See the NCSetup for Windows Technical Bulletin
(LIT-6360251d) for details on how to define the time-to-live.
Poll Cycle Amount of time it took to poll the NVs of each priority. Multiply
Time (*50 ms) the displayed value by 50 milliseconds.
Prio 1, 2,
and 3
Task/Error Log
The Diagnostics-NC Task Error Log window (Figure 33-4) contains
the contents of the NCM’s detected runtime errors.
Figure 33-4: NC Task Error Log Window

This window displays the date and time of the error, the error number,
error data, and the text associated with the error. For more information
on the NC Task Error Log window, see the Troubleshooting Guide
NCM Miscellaneous Data

The Diagnostics-NCM Miscellaneous Data window (Figure 33-5)
displays information for the selected NC, including:
• NCM type and NIM (if the NCM is an NCM200)
• EPROM and DRAM release
• NC current state
• NCM runtime in days (This is the number of days since the NCM
was first powered up, not reloaded.)
• current NCM allocable and acquired memory usage. (The NCM
uses allocable memory to hold the database. Acquired memory is
the memory that the features temporarily use.)
• startup diagnostic results
Figure 33-5: NCM Miscellaneous Data Window

N2/L2/S2 Device Diagnostics Options

There are two N2/L2/S2 diagnostics options: Reset and Statistics.
These options function differently for each type of device: DCM, XM,
LC (ILC), FPU, or DSC.
Table 33-4 describes how the two options function for each device.
Table 33-4: N2/L2/S2 Diagnostics Options

Type of Description
Diagnostics
DCM Diagnostics Reset: If the NCM reads a changed version number from the DCM, the DCM is
downloaded. The DCM sanity test is performed. The DCM goes offline during the test,
but returns online after the test is complete.
N2 Statistics: Displays the following N2 Statistics window for the trunk and device
number of the selected DCM. This summary is the same as the N2/L2/S2 Diagnostic
window shown previously, except that it displays N2 statistics for the selected DCM
only (rather than for all devices on the trunk).*
XM Diagnostics Reset: No download occurs. The XM sanity test is performed. The XM goes offline
during the test, but returns online when the test is complete.
N2 Statistics: Displays the N2 statistics for the trunk and device number of the
selected XM. This summary is the same as the one displayed N2 Statistics window,
except that it displays N2 statistics for the selected XM only.*
ILC Diagnostics Reset: The ILC goes offline, comes back online, and is downloaded. The current status
of the outputs is frozen until the download is complete.
selected ILC. This summary is the same as the one displayed in N2 Statistics window,
except that it displays N2 statistics for the selected ILC only.*
DSC Diagnostics Reset: The C210A or C260A goes offline and returns online after a few seconds. The
CS forces a download to the C210A or C260A when it returns online. The adjust value
for Priority 2 and override value are downloaded. No internal test occurs.
L2 Statistics: Displays the L2 statistics for the trunk and device number of the selected
C210A or C260A. This summary is the same as the one displayed in the N2/L2/S2
Statistics window, except that it displays L2 statistics for the selected DSC only.*
DSC8500 and FPU Reset: DSC8500 and FPU devices do not have reset capabilities.
Diagnostics S2 Statistics: Displays the S2 statistics for the trunk and device number of the selected
DSC8500 or FPU. This summary is the same as the one displayed in the N2 Statistics
window on the previous page, except that it displays S2 statistics for the selected S2
device only.*
ASC Diagnostics Reset: The AHU, UNT, or VAV goes offline, comes back online, and is downloaded.
The current status of the outputs is frozen until the download is complete. DC/DR and
LCPs do not have reset capabilities.
selected ASC. This summary is the same as the one displayed in the N2 Statistics
window, except that it displays N2 statistics for the selected ASC only.*
D600 Diagnostics Reset: D600 devices have no reset capabilities.
selected D600 Access Controller. This summary is the same as the one displayed in
the N2 Statistics window, except that it displays N2 statistics for the selected D600
only.*
* For a description of the fields in the Statistics window, see Diagnostics- N1 Statistics Window Fields
earlier in this chapter.
Detailed Procedures
Printing Network Diagnostics
To print network diagnostics:
1. Select the name of the network on the map.
2. On the Action menu, click Diagnostic. The Network Diagnostics
Figure 33-6: Network Diagnostics Dialog Box

3. Click OK to send the diagnostics to the currently active printer.
(Specify the active printer with the Change Printer option on the
Item menu.)
Displaying PC Diagnostics
To display PC diagnostics:
1. From the Network Map, select an OWS to use to perform
diagnostics.
2. On the Action menu, select Diagnostic. The following PC
Diagnostics dialog box appears (Figure 33-7).
Figure 33-7: PC Diagnostics Dialog Box

3. Click OK. The Diagnostics-N1 Statistics window appears.
Displaying NC Diagnostics
To display NC diagnostics:
1. Double-click on the Devices PC group to display the Devices
Focus window. The Devices Focus window appears.
2. Select an NCM. (The NCM must be online.)
3. On the Action menu, click Diagnostics. The NC Diagnostics
Figure 33-8: Network Map-Diagnostics Dialog Box

4. Select one of the options and click OK.
Performing N2/L2/S2 Diagnostics

To perform N2, L2, or S2 diagnostics:
1. Display any summary (for example, System, Offline, Critical)
containing the device.
2. Select the N2, L2, or S2 hardware device.
3. On the Action menu, click Diagnostics. The Diagnostics dialog
box appears. The heading of the box varies according to the type
of device selected in Step 2. The dialog box shown in Figure 33-9
appears for a DCM.
Figure 33-9: N2/L2/S2 Device Diagnostics Dialog Box

4. Select the type of diagnostics (Reset or N2/L2/S2 Statistics) to
perform by clicking the option button. Refer to Table 33-4 for a
list of available diagnostics options.
5. Click OK.
Updating Statistics
To update the statistics displayed on the current screen, click Reread
Statistics on the Action menu. (The NC Task/Error Log Action menu
displays Reread Log.)
Clearing Statistics
To clear the statistics to 0, click Clear Statistics on the Action menu.
The Diagnostics feature continues to collect data starting from 0. (The
NC Task/Error Log Action menu displays Clear Log.)
Printing Diagnostics
To print diagnostics information:
1. Display the diagnostics on the screen as described in this chapter.
2. On the Item menu, click Print to send the current screen to the
active printer. (Specify the active printer with the Change Printer
option on the Item menu.)
Chapter 34
Using Processes
Introduction
Processes are programs that determine how equipment operates based
on actual field conditions and internal logic. For example, a process
can specify that when the outside temperature reaches freezing, an
additional heating system is activated.
• display the process window
• display a process focus window
• add a new process
• import an existing process
• delete a process
• edit a process
• print source and list files
• disable a process
• enable a process
• compile a process
• download a process
• upload a process
• trigger a process

Code No. LIT-120160
Key Concepts
Process Programming Languages
There are two process programming languages: Graphic Programming
Language (GPL) and JC-BASIC. GPL draws BAS control strategies
using a mouse, symbols, and icons. JC-BASIC, a modification of the
BASIC programming language, writes BAS processes as textual lines
of code. After using GPL or JC-BASIC to create processes, download
the processes into the NCM using the OWS.
Process Window
Use the Process window to perform process functions, such as adding
and deleting processes or downloading them into the NCM.
The Process window is accessible from any window that displays a
system containing processes (for example, System summary, Critical
summary).
Figure 34-1 shows an example of a Process window.
Figure 34-1: Process Window

The Process window is composed of two separate windows: the

Process Disk window and the Process Field window. You can
maximize and minimize these windows independently of one another.
When the Process Window first appears, only portions of the Disk and
Field windows are visible. To bring additional information into view,
either use the scroll bars or maximize a window.
You cannot directly modify the information in these windows.
However, use the Item and Action menus to add or delete processes.
Process Disk Window

Figure 34-2 shows an example of a maximized Process Disk window.
Figure 34-2: Process Disk Window

The Process Disk window lists all the source (.BAS), list (.LST), and
object (.OBJ) files on disk for processes in the selected system. An
asterisk appears to the left of disabled object files. For object files, the
date and time the file was compiled appear, along with the size in
bytes and the name of the NCM to which the OWS downloads the
process. For source and list files, the date and time of the last update
appear, along with the size of the file in bytes.
Add, delete, edit, compile, download, and upload processes from the
Process Disk window. A download copies the process from the disk to
the NCM. An upload copies the process in the NCM to the process
(.OBJ file) on disk.
Process Field Window

Figure 34-3 shows an example of a maximized Process Field window.
Figure 34-3: Process Field Window

The Process Field window lists the processes from the selected system
that the OWS has downloaded into the NCM. An asterisk appears to
the left of processes that are in any of the following states: Disabled,
Error, not fully downloaded, or unreliable. The date and time the
process file was compiled appears, along with the size of the file in
bytes. The name of the NCM to which the OWS downloads the
process also appears.
Process Focus Window

The Process Focus window is available from either the Process Disk or
Process Field windows. Process Focus windows display detailed
information on the selected process (see Figure 34-4 for an example).
The information in the Process Focus window cannot be modified.
Figure 34-4: Process Focus Window

Table 34-1 describes the fields of the Process Focus window.
Table 34-1: Process Focus Window Fields

Field Description
System Name Name of the system containing the process and its expanded ID
Process Name Name of the selected .OBJ file or process and its expanded ID
NC Name/Address Name and node address of the NCM containing the process
Status Status of the process: Disabled, Enabled, Ready, Trigger, Waiting, Error,
Time-sliced, Not Fully Downloaded, Held, or Executing
Period How often the process runs according to the last executed period statement
Priority Priority level that determines whether a process supersedes another process
Size in Bytes Size of the .OBJ file in bytes
Execution Count Number of times the process has executed since being downloaded
Generated By Program that generated the process: GPL or JC-BASIC
User Initials Initials of the user who compiled the process
Source Date and time the source file was compiled
Compile Date and time the source and list files were compiled
Enabling and Disabling Processes

Enable or disable a process from the Process Disk or Process Field
windows. To enable a process on disk means that when the process is
downloaded into the NCM, it is able to execute.
A disabled process does not execute in the NCM for any reason
(for example, download, trigger, or manual command). To disable a
process on disk means that when the OWS downloads the process into
the NCM, it does not execute until it is enabled.
Triggering Processes
Use the Process Field window to trigger (execute) a process. A process
must be in one of the following states to be triggered: Ready, Waiting,
Executing, or Time-sliced.
For information on scheduling a specific time for the process to be
triggered, see the Scheduling Commands and Summaries chapter
(LIT-120173).
Detailed Procedures
Displaying the Process Window
To display the Process window:
1. Click a system.
2. On the GoTo menu, click Process. The Process window appears,
displaying the processes in the selected system (Figure 34-1).
Displaying a Process Focus Window

To display a Process Focus window:
1. Display the Process Disk or Process Field window.
2. Double-click a .OBJ file or process. The Process Focus window
Focusing on Source and List Files

Note: Source and list files do not have separate Focus windows.
To focus on the contents of a source (.BAS) or list (.LST) file:
1. Display the Process Disk window.
2. Double-click the source or list file. The selected file appears.
Adding a New Process

To add a new process:
1. Display the Process Disk window (Figure 34-2).
2. On the Item menu, click New. The Process-New dialog box
Figure 34-5: Process-New Dialog Box

3. Enter the name of the new process file in the File Name text box.
4. Click OK. Microsoft Wordpad (or another text editor) opens.

5. Create the source file in Notepad according to JC-BASIC
guidelines. For more information, refer to the JC-BASIC
Programmer’s Manual.
6. Save the file and exit. The new process appears in the Process
Disk window.
Importing an Existing Process

To import an existing process:
2. On the Item menu, click New. The Process-New dialog box
3. In the Import DOS Path and File Name text box, enter the
complete path and file name of the existing process file.
4. In the File Name text box, enter the name for this process file.
5. Click OK. The imported file is listed in the Process Disk window.
Deleting Processes
To delete processes:
Note: To delete processes from the Process Field window, the
processes must be disabled or Error Locked.
2. Select the processes.
3. Click the Item and select Delete. The Delete dialog box appears,
4. Click OK.
Editing a Process
Note: Only one file can be edited at a time.
To edit a process:
2. Select the process.
3. On the Action menu, click Edit. Microsoft Wordpad (or another
text editor) opens.
4. Edit the file according to JC-BASIC guidelines. For more
information, refer to the JC-BASIC Programmer’s Manual.
5. Save the edited file and exit.
Printing Source and List Files

To print source (.BAS) and list (.LST) files:
2. Select the file or files.
3. On the Action menu, click List. The contents of the selected files
are sent to the active printer.
Disabling a Process
To disable a process:
2. Select the .OBJ files or processes.
3. On the Action menu, click Disable. The Disable dialog box
appears .
4. Click OK. An asterisk appears to the left of the disabled
processes.
Enabling a Process
To enable a process:
2. Select the disabled .OBJ files or processes.
3. On the Action menu, click Enable. The Enable dialog box
appears.
4. Click OK.
Compiling a Process
Note: Do not move the mouse or windows on the PC screen more
than necessary after this process begins. Excess mouse or
window movement during a compile process could cause the
process to terminate.
To compile a process:
2. Select the relevant .BAS file.
3. On the Action menu, click Compile. The Compile dialog box
Figure 34-6: Compile Dialog Box

4. Select the processes to compile: all processes in the selected .BAS
file or only a subset of processes.
5. Use the appropriate check boxes to create a list file during the
compile or include decompile information, if desired.
6. Click the appropriate option button for verification against either
the disk or the field.
7. Click OK. A dialog box appears indicating of the status of the
compile.
Note: When a process is compiled, and before it is downloaded
and run on the NC, it shows 0:00 for the period. Once
you download and run the process, the period begins and
the Field Process Focus window displays the updated
period.
Downloading a Process
To download a process:
2. Select the relevant .OBJ file or files.
Note: After compiling a GPL source file, always download all
processes in the file.
3. On the Action menu, click Download. The Download dialog box
appears.
4. Click OK. Once the download begins, it cannot be cancelled. No
other actions can be performed on the NCM during a download.
If the process download fails, perform an NCM data only
download to insure that the NCM contains the accurate database.
For information on NCM downloads, refer to the Uploading and
Downloading Databases chapter (LIT-120155).
Uploading a Process
To upload a process:
1. Display the Process Field window (Figure 34-3).
3. On the Action menu, click Upload. The Upload dialog box
appears.
4. Click OK. Once started, the upload cannot be canceled. The
workstation cannot perform other actions during an upload.
Triggering a Process
To trigger a process:
1. Display the Process Field window (Figure 34-3).
3. On the Action menu, click Trigger. The Trigger dialog box
appears.
4. Click OK.
Chapter 35
Editing Graphics
Introduction
The OWS can provide information on the entire facility in both textual
and graphical formats. A System summary displays an air handling
unit as a textual list of objects. A system drawing displays the same
system with graphical symbols representing the objects.
This section discusses system drawings and provides some examples
of drawings created with Micrografx Designer™ software. The chapter
assumes the reader knows how to use Designer or DRAW software to
create system drawings. While drawing procedures in Micrografx
Designer and Micrografx® DRAW are similar, refer to the appropriate
manual for detailed instructions.
Designer and DRAW are no longer supported at Metasys
Release 11.00. Thus, you cannot create new graphics for the OWS
with these programs. This chapter only describes how to modify
drawings that already exist.
• access Designer/DRAW
• unbind objects and symbols
• bind symbols and objects
• set colors for a symbol
• modify a bound symbol
• delete a bound symbol
• modify slide show settings

Code No. LIT-120161
Key Concepts
Graphic Binding
All graphics symbols are bound, or associated, to certain objects in the
system. The graphic symbol indicates dynamic data about its
associated object.
Each symbol can also display certain information, such as the object’s
Focus window, when the user double-clicks the symbol.
Designer can modify a bound symbol without destroying its binding if
it is given the same Symbol ID. If the symbol is a combination of
drawing elements, use Designer to break it apart, modify it, and
recombine it. You can also use this process to change the location of
Metasys text associated with an object.
Change the binding associations of symbols and objects in the
displayed graphics by unbinding the symbol from an object and
rebinding it to a new one. See Detailed Procedures for further
instructions.
Alarm Flashing
An object symbol can be made to flash when it goes into certain alarm
states. The color of the object alternates between its static and alarm
state colors. This feature is turned on by setting three parameters in the
METASYS.INI file. Refer to the Initialization Parameters Technical
Bulletin (LIT-636345) for details.
Note: If the flashing interval is set too low and there are many
flashing objects within the drawing, the operation of the
system may slow down. A flashing interval of less than
0.5 second is not recommended.
Setting Colors
The OWS indicates changes-of-state in an object by changing the color
of the object and its associated text within the dynamic drawing.
The OWS provides default colors for each state that an object can
experience. To change the color settings, click Set Colors/Test on the
Binding Editor Action menu.
Default colors are described in the Graphics Technical Bulletin
(LIT-636108).
Slide Show
IMPORTANT: The Metasys PMI slide show does not work if
M5 Workstation is loaded. Use the M5 Workstation
slide show instead. See Appendix D: Screen Manager
Slide Show of the M5 Workstation User’s Guide,
LIT-1153896.
The slide show is a series of images that appears on the OWS screen
when no one is logged on. The images can include a company logo,
floor plans, or the dynamic drawings that represent the PC groups and
systems within the facility. Each image remains on the screen for a
defined time period before the slide show cycles to the next image.
FIG102
Figure 35-1: Example Slide Show Image

Slide show images can be pictures drawn with Micrografx Designer
(including the same drawings that represent the actual PC groups and
systems in the facility software), or the default drawings provided with
the OWS. If the facility software drawings are dynamic drawings, the
slide show displays the current values and changes-of-state for the
objects in the drawings.
Specify the slide show parameters in the SLIDES.TXT file. To add or
delete drawings, or to change the number of seconds that a drawing
remains on the screen, simply edit the SLIDES.TXT file in any text
editor.
Figure 35-2 is an example of a SLIDES.TXT file displayed in

Notepad.
Figure 35-2: Example of SLIDES.TXT File in Notepad

Detailed Procedures
Accessing Designer or DRAW
Program Manager Method
To access Designer or DRAW:
1. On the Exit menu, click Program Manager. A dialog box appears
asking if the BAS should continue to run.
2. Click Yes or No.
3. Double-click the Designer/Draw icon.
4. When finished, exit and double-click the Metasys icon to return to
the Metasys program.
Designer Method
Note: To access Designer using the Exit Menu described below, set
Designer = Yes in the Metasys section of the METASYS.INI
file. (This is the default, if Designer was installed before
Metasys.)
To access Designer:
1. On the Exit menu, click Designer. A dialog box appears asking if
the BAS should continue to run.
2. Click Yes. The Network Map becomes an icon in the lower portion
of the screen and Designer opens.
3. When finished, close Designer. Click on the Network Map icon.
The Network Map appears.
Unbinding Objects and Symbols

To unbind an object and a symbol:
1. Display the system with the object.
2. On the Action menu, click Graphic Binding. The Binding Editor
appears.
3. Select the object. Handles appear around the selected object.
4. On the Action menu, click Unbind. The binding between the object
and the object symbol is deleted. The object symbol remains in the
drawing as a static element.
5. After unbinding the object, click Save on the item menu.
Binding Symbols and Objects

To bind a symbol to an object:
1. From the Stair Step in the PC Group summary (see Figure 35-3),
select the system that contains the objects.
Stair-Step
AHU2
HDQTRS
WEST
AHU2
Status Item Description Value Units
SFSST Supply Fan Start/Stop OFF

RFSST Return Fan Start/Stop OFF
SFSTAT Supply Fan Status OFF
RATEMP Return Air Temperature 71 Deg F
Stairstep
Figure 35-3: Stair Steps in a Summary

2. On the Action menu, click Graphic Binding. The Binding Editor
Figure 35-4: Binding Editor Dialog Box

3. Choose the options in the Binding Editor dialog box.

Use default symbols: This selection is the default if no drawing
exists in the selected system’s directory. It imports all of the
symbols that have been defined in object Definition or Focus
windows. Once the symbols are imported, they will need
editing.
Verify with archive: To bind symbols offline rather than online,
select this option. (CS objects must be bound online.) When
selected, an X appears in the box. To use this option, the PC must
have a copy of the archive database on its hard drive.
Import drawing: This option is only available if there is no
drawing in the selected system’s directory. If a drawing exists,
delete it before selecting this option, or use DOS copy command
or the Windows File Manager to copy over the existing drawing.
4. Click OK. The program is now in Binding Editor mode and the
system drawing appears.
5. Select a symbol to bind to an object. Handles appear around the
selected symbol.
6. Either double-click the object, or click Bind on the Action menu.
The Bind dialog box appears (Figure 35-5).
Figure 35-5: Bind Dialog Box

7. Type the object name of the object in the Item text box (the
Group\System name is already entered).
The Available Selections list box lists the names of all items
available for the PC group/system in the next sublevel. For
example, if there is no valid item specified in the Item text box or
this box is empty, a list of all PC groups and systems defined
under the network appears. Click on an item. The selected item is
added to the text in the Item text box, and the next sublevel of
names appears. If the selected name specifies a system, the list
contains names of all of the objects in the system. After selecting
an object, the Available Item list box disappears. To leave the
Available Item list box after selecting a group or system, either
click another area of the dialog box, click OK or Cancel, or press
Tab.
When binding an attribute, type the name of the attribute after the
object name, separating the two with a colon ( : ). For example,
the Object AHU2 and the attribute Display would appear in the
Item Name field like this:
West\2ndFloor\AHU2:DISPLAY.
To see a list of available types of attributes, type a question mark
(?) after the colon. The Attribute Class box appears in the Bind
dialog box. Click on a class to select it, and the Available
Selections list box lists the available attributes. Click the desired
attribute. It appears in the Item field.
Note: Fire Object input and output devices can also be
specified; however, the devices do not appear in the
Available Items box. The names of these devices are
available from the Input and Output Device summaries.
When indicating a device, precede it with a pound
sign (#). For example, an entry might look like this:
GRP1\FIRESYS\ZONE:#7BF1.
8. Specify the text to display in place of the dummy string for the
object or attribute by clicking any, all, or none of the check boxes.
For example, click the Description check box to display the
object’s 24-character expanded ID next to the symbol of the
object. Click Value/Units to display the object’s current value. (If
analog, the engineering units are also displayed.) The Text options
vary depending on the type of object.
9. Specify what the workstation should display when the object’s

symbol is double-clicked.
Select Item’s Standard Display to display the object’s Focus
window.
Note: The PC User Option on the SetUp menu should be set to
the To Focus Window option. For more information,
refer to the Using Object Focus Windows chapter
(LIT-120174).
To return to the Network Map after double-clicking the symbol,
select Item’s Standard Display, and leave the Item text box blank.
To access another drawing after double-clicking the symbol, click
the Other button. Enter the complete path and file name of the
drawing in the text field. For a list of available drawings, click on
the File button. Select the drawing from this list. The path name of
the selected drawing appears in the Drawing Name text box.
Select Neither if nothing should happen when the user
double-clicks the object symbol.
10. Click OK.
11. Repeat Steps 8 through 13 until all objects are bound to their
object symbols.
12. When finished working with the drawing (including setting
colors), save the drawing. On the Item menu, click Save.
13. Close the Binding Editor by double-clicking the Control menu
box, or clicking it once and selecting the Close option. The
Binding Editor closes.
Setting Colors for a Symbol

To set colors for an object symbol:
1. In the Binding Editor, select the bound object symbol. Handles
appear around the selected object symbol.
Note: The program allows the selection multiple symbols at
once. However, doing so means all of the symbols will
use the same color for a particular state (for example, all
disabled symbols will change to red).
2. On the Action menu, click Set Colors/Test. The Binding
Editor-Colors dialog box appears (Figure 35-6).
Figure 35-6: Set Colors Dialog Box

3. In the Graphical Display State box, select a state (for example,
Offline, Communication Disabled) to assign colors to by clicking
the option button.
Note: Items in the Graphical Display State box vary depending
on the type of object.
4. In the Color Scheme box, click the Line/Border/Text radio button
and select a color from the Standard Color list box for the lines,
border, and text to have in the selected state. For example, click
Green. When the object reaches the selected state, the border and
text in the object symbol changes to green. Customize the color by
changing the color intensity with the R, G, and B settings. For
more detailed information, refer to the Graphics Technical
Bulletin (LIT-636108).
5. Click the Pattern radio button in the Color Scheme box, and
assign a color for the symbol’s pattern when the object reaches the
selected state. For best results, set the pattern color to As In Static
Drawing.
6. Click the Background radio button in the Color Scheme box, and
assign a color for the symbol’s background when the object
reaches the selected state.
7. After specifying the colors for the Lines/Border/Text, Pattern, and
Background of the object symbol, click the next state and repeat
Step 4 to set its colors. Repeat this process to define colors for all
states.
8. Test the colors by selecting a state in the Graphical Display State
list box and clicking the Test button. The colors of the symbol
appear as they would in the selected state.
9. When finished with the drawing, click Save on the Item menu.
Modifying a Bound Symbol

To modify a bound symbol:
1. In Designer, select the symbol.
2. On the menu, click edit > Symbol ID. The Edit-Symbol ID dialog
box appears with the symbol’s current name in it. Make note of
the symbol name. Click Cancel. The dialog box closes.
3. On the Arrange menu, click Break Apart.
4. Make the necessary changes to the symbol.
5. Recombine the symbol or symbol elements. To do this, refer to
Creating Symbols earlier in this section.
6. On the Edit menu, click Symbol ID. The Symbol ID dialog box
appears.
7. Assign the original Symbol ID to the symbol. Click OK.
Note: When working with the default symbols in Designer, click
the Symbol ID option on the Edit menu to find out the name
of the object to which the symbol is bound. The Symbol ID
is usually the object name. This is true only for default
symbols that have been added and saved via the Binding
Editor in the Metasys program.
Deleting a Bound Symbol

To delete a bound symbol:
1. Unbind the symbol from the object.
2. If the object has a graphic symbol number, delete the number. Be
sure to change the graphic symbol # in the Focus window to 0.
Note: This is only necessary if the bound object belongs to this
system. If the bound object belongs to another system,
this step is not necessary.
3. Access Designer and delete the symbol from the drawing by
selecting the symbol and pressing the Delete key.
Modifying the Slide Show Settings

To modify the slide show settings:
1. Select drawings to use in the slide show. These drawings must
have been created in Micrografx Designer and have a .DRW
extension. The slide show can use the same drawings used to
represent the PC groups and systems within the facility. If these
drawings are bound to objects through the Graphic Binding
process, the slide show displays the dynamic object data.
2. Display the SLIDES.TXT file in any text editor.
The SLIDES.TXT file is kept in the directory assigned to the
GRAPHICSLIBPATH parameter in the METASYS.INI file. The
default setting for this parameter is C:\FMS\GRFXLIB. Unless
this default setting has changed, the SLIDES.TXT file is in the
C:\FMS\GRFXLIB directory.
For more information on the METASYS.INI file, refer to the
Initialization Parameters Technical Bulletin (LIT-636345).
3. Specify the full network\PC group\system name of each drawing
in the order in which the drawings should cycle. Start each .DRW
file on a separate line.
For the slide show to display dynamic object data, the system
drawing must be in the same directory and have the same name as
the system it represents.
For example, to have the slide show display dynamic data about
the AHU1 system in the WEST PC group, specify the full
directory path and name of the system drawing.
The full network name is the name assigned to the FMSDATA
parameter in the METASYS.INI file combined with the name of
the network. The default setting for the FMSDATA parameter is
C:\FMS\DATA. If the default has not been changed, and the
network name is HDQTRS, the name of the AHU1 system
drawing would be as follows:
C:\FMS\DATA\HDQTRS\WEST\AHU1\AHU1.DRW
4. Specify the number of seconds each drawing should remain on the

screen before the slide show cycles to the next drawing. Insert a
space between the drawing name and the number of seconds.
The recommended settings are 5 seconds for drawings without
dynamic data, and 31 seconds for drawings with dynamic data.
The data in a dynamic drawing set for less than 31 seconds is
current when the drawing appears on screen; however, it does not
refresh.
To have the slide show to display a particular drawing indefinitely
(or until someone attempts to log on), enter 0 for the number of
seconds.
The format of each line, including the full network\PC
group\system\drawing name and number of seconds, should be as
follows:
C:\FMS\DATA\HDQTRS\WEST\AHU1\AHU1.DRW 40
5. Save the edited SLIDES.TXT file in the text editor.
Chapter 36
Defining Queries
Introduction
The Query is a Superbase 4 tool for collecting and analyzing database
information concerning specific parts of the BAS. Use the query to
analyze data from three different databases: the Access Card summary,
the Operator Transaction summary, and the Card Reader summary.
For example, define a query from the Card Reader summary to find
out how often a particular door is used during certain times of the day.
Or define a query from the Operator Transaction summary to find out
how many times a particular operator has discarded Follow-Up reports
over a specific period of time.
• define a query
• modify a query
• delete a query
• display a query
• print a query
• save a query to a file
• exit a query

Code No. LIT-120162
Key Concepts
Superbase 4 Software
Superbase 4 program is a database management software package that
maintains certain OWS databases. The Superbase 4 package included
in Metasys software is a runtime version and does not have full
Superbase 4 software capabilities.
The runtime version of Superbase 4 software that comes with Metasys
Release 4.0 or higher can define the title and output sections of a
query. To define the destination section, purchase the full Superbase 4
package.
Query Definition
To define a query that draws data from the Operator Transaction
summary, display the summary. Superbase 4 software loads when the
summary appears. This allows access to the OPTRANS file that
contains all of the Operator Transaction data. To find out how to
display the Operator Transaction summary, refer to the Displaying
Archived Summaries chapter (LIT-120169).
To define a query that draws data from the Card Reader summary,
start Superbase 4 software by displaying the summary. This allows
access to the CARDRDR file which contains all of the Card Reader
transaction data. To find out how to display the Card Reader summary,
refer to the Displaying Archive Summaries chapter (LIT-120169).
To define a query that draws data from the Access Card summary,
start Superbase 4 software by clicking the User Data button in the
Modify Card dialog box for an access card. This allows access to the
PERSON file, which contains all of the Access Card data. To find out
how to display the Modify Card dialog box, refer to Defining Access
Cards (LIT-120153) in the Advanced User’s Guide of this manual.
Figure 36-1 shows an example of a query defined using data from the
Access Cards summary.
Figure 36-1: Example Query
Displaying a Query
Use the Query menu (Figure 36-2) to display a query. The Query
menu is accessible from three different Superbase 4 screens: the Main
menu, the Operator Transaction menu, or the Card Reader menu.
Figure 36-2: Query Menu

For best results and up-to-date data, display the query from the
function for which the query was created. For example, to display a
query that gathers Operator Transaction data, display the query from
the Operator Transaction Main menu.
Query Title
The title section of a query can display the title, date, and page number
of the query on each page. The upper portion of the Query Definition
dialog box (see Figure 36-4) defines this section. Defining the title
section is optional. If no title, date, or page numbers are defined, the
query data appears on the first line of the printed page or PC screen.
If the query has a title, it appears centered on each page. The date
appears in the upper left corner of each page, and the page number
appears in the upper right.
Query Output
The query output section of the Query Definition dialog box defines
the type of information that the query collects, as well as how the
information is ordered. The output section specifies data collection in
four categories: Fields, Report, Filter, and Order.
To define a query, the Fields output must be specified; Report, Filter,
and Order output are optional.
Fields Output
Clicking the Fields button displays the Fields Output dialog box
(Figure 36-6). This dialog box specifies the fields from which the
query draws data, as well as the page format. Individual fields can be
up to 70 columns (character spaces) long across the page.
Before defining the Fields Output, determine how the query is going to
be organized, including:
• which fields from which the query draws
• where each column should appear on the query, in character spaces
(for example, a position of 20 means the column begins at
20 character spaces from the left side of the page)
• the limit to the number of characters that can appear in each field
• whether any of the fields should have a heading different from the
field title that appears in the Fields dialog box (Figure 36-6)
• whether the query appears in the standard table format (as in
Figure 36-1) or use the NEWLINE function (Figure 36-3). The
NEWLINE format is useful for queries in which the columns
would exceed the 70-character space maximum across the page.
Figure 36-3: Example Query Using the NEWLINE Function

Table 36-1 lists the fields available for a query of Access Card User
Data.
Table 36-1: Access Card User Data Fields

Field Description Ranges
Card_ID Unique Card ID number as defined in Numeric, up to 5 characters between
Metasys software 0 and 65535
Last_Name Last name of the card holder as defined in Text, up to 10 characters
Metasys software
First_Name First name of the card holder as defined in Text, up to 8 characters
Metasys software
Middle_Initial Middle initial of the card holder Text, 1 character (automatically
converted to upper case)
Company_ID Unique ID number assigned to each card Numeric, from 0 to 65535
holder
Mail_Station Mail station of the card holder Alphanumeric, up to 10 characters
(automatically converted to upper case)
Department Department of the card holder Alphanumeric, up to 20 characters
Bld_Floor Building and floor of the card holder’s office Alphanumeric, up to 20 characters
Work_Phone Office phone number of the card holder Text, up to 20 characters (automatically
converted to upper case)
Car1_License License plate number of the card holder’s Alphanumeric, up to 10 characters
primary vehicle (automatically converted to upper case)
Car1_Year Year of the card holder’s primary vehicle Numeric, 4 characters
Car1_Make Make (for example, Chevrolet, Ford) of the Alphanumeric, up to 20 characters
card holder’s primary vehicle
Car1_Model Model (for example, Chevette, LTD) of the Alphanumeric, up to 20 characters
card holder’s primary vehicle
Car1_Color Color of the card holder’s primary vehicle Alphanumeric, up to 20 characters
Car2_License License plate number of the card holder’s Alphanumeric, up to 10 characters
secondary vehicle (automatically converted to upper case)
Car2_Year Year of the card holder’s secondary vehicle Numeric, 4 characters
Car2_Make Make (for example, Chevrolet, Ford) of the Alphanumeric, up to 20 characters
card holder’s secondary vehicle
Car2_Model Model (for example, Chevette, LTD) of the Alphanumeric, up to 20 characters
card holder’s secondary vehicle
Car2_Color Color of the card holder’s secondary Alphanumeric, up to 20 characters
vehicle
Parking Lot Name of the parking lot assigned to the Alphanumeric, up to 20 characters
card holder
PIN 5-digit unique Personal Identification Numeric, 1 through 65,535
Number of the card holder
Badge_Type Type of card the card holder is issued (that Alphabetic, up to 20 characters
is, permanent, temporary, visitor)
Badge_Media Type of badge the card holder is using (that Alphabetic, up to 20 characters
is, WIEGAND, N-CRYPT, MAGSTRIP,
B/F NPAR, B/F PAR)
Field (Cont.) Description Ranges

Issue_Date Date the access card was issued Alphanumeric, automatically converted
to the mmm, dd, yyyy format
Expiration Date Date the access card expires Alphanumeric, automatically converted
to the mmm, dd, yyyy format
Door_Access Doors for which the card can be used to Alphanumeric, up to 20 characters
enter or exit. (For Metasys Release 6.0,
this field does not exist, although it still
appears in the query list.)
Access_Days Days of the week that the access card is Alphabetic, up to 20 characters
valid. (For Metasys Release 6.0, this field
does not exist, although it still appears in
the query list.)
Access_Times Times of day that the access card is valid. Alphanumeric, up to 20 characters
(For Metasys Release 6.0, this field does
not exist, although it still appears in the
query list.)
Social_Security Card holder’s social security number Numeric, up to 11 characters
Full_Name Card holder’s first name, middle initial, and Alphabetic, up to 24 characters--first
last name as defined in Superbase 4 name, middle initial, last name (read
software only)
Photo Full path name (including the file extension) Alphanumeric, up to 60 characters
of the file containing a photograph of the (automatically converted to upper case)
card holder
Signature The full path name (including the file Alphanumeric, up to 60 characters
extension) of the file containing a signature (automatically converted to upper case)
of the card holder
Home_Phone Card holder’s home phone number Alphanumeric, up to 20 characters
Home_Address Card holder's home address Alphanumeric, up to 30 characters
Home_City City in which the card holder lives Alphanumeric, up to 20 characters
Home_Zip Zip code for the residence of the card Numeric, up to 5 characters
holder
Emergency Info Full path name (including the file extension) Alphanumeric, up to 60 characters
for the file containing emergency (automatically converted to upper case)
information for the card holder
User1 Information stored in the operator defined Alphanumeric, up to 40 characters
field User Data 1
field User Data 2
field User Data 3
field User Data 4
Home_State State in which the card holder lives Alphanumeric, 2 characters
ID_Card Unique card ID number for the access card Numeric, up to 5 characters between
defined in Metasys software 0 and 65535 (read only)
ID_Company Card holder’s unique company ID (defined Numeric, from 0 to 65535 (read only)
in Superbase 4 software)
Field (Cont.) Description Ranges

Interlock_Grp Interlock group that represents the GPL Numeric, from 0 to 64
interlock in which the AC object triggers
other Metasys process to run (for example,
turn lights on)
FAX_Number Card holder’s facsimile phone number Alphanumeric, up to 20 characters
U1_Header Field title for the User 1 field, as defined in Alphanumeric, up to 14 characters
Superbase 4 software (automatically converted to upper case)
Card_Issue_Lev Number of times a card has been issued to Numeric, from 0 to 7
a card holder (as defined in Metasys
software)
Exec_Privilege Executive privileges status of the card holder Boolean, 0 or 1 (0=No, 1=Yes)
(as defined in Metasys software)
SysObjName_1* Name of the system and Access Control Alphanumeric, up to 17 characters
object for each controller to which the card
holder is assigned (as defined in Metasys
software)
Proc_Grp_1* JC-BASIC/GPL process interlock group in Numeric, from 0 to 99
which the card is linked (as defined in
Metasys software)
TimeZone_1* Times of the week a card holder may Numeric, from 0 to 9
access authorized doors (as defined in
Metasys software)
Reader_1 through Card readers for a specific controller valid Alphanumeric, up to 17 characters
Reader_16** for a card holder (as defined in Metasys
software)
Curr_SystObj Name of the system and Access Control Alphanumeric, up to 17 characters
object that was last viewed through
Superbase 4 software
Curr_Int_Grp Interlock group for the last AC object Numeric, from 0 to 64
viewed in Superbase 4 software. The
interlock group represents the GPL
interlock in which the AC object triggers
other Metasys process to run (for example,
turn lights on)
Curr_TimeZone Times of the week a card holder may Numeric, from 0 to 9
access authorized doors (as defined in
Metasys) for the last AC object viewed in
Superbase 4 software
Curr_Read1-16 Card readers for a specific controller valid Alphanumeric, up to 17 characters
for a card holder (as defined in Metasys) for
the last AC object viewed in Metasys
software
* This field repeats for each controller (up to 32). The end number indicates the number of the controller
shown on the Superbase 4 screen.
** Card Readers are numbered consecutively, 1 through 512. For example, the Card Readers for controller
number one are numbered 1 through 16. The second controller’s Card Readers are numbered
17 through 32, and the third controller’s Card Readers are numbered 33 through 46, etc.
Table 36-2 lists the fields available for an Operator Transaction

summary query.
Table 36-2: Operator Transaction Query Fields

TRANTYPE Type of operator transaction that initiated a Numeric, 1 character, from 0 to 3
report (that is, Report, Object, Logon, or
Feature)
LOCATION Name of the PC file destination in which Alphanumeric, up to 8 characters
the transaction occurred
GROUP_ PC group in which the transaction occurred Alphanumeric, up to 26 characters
SYSTEM Name of the system in which the Alphanumeric, up to 8 characters
transaction was generated
OBJECT Name of the object for which the Alphanumeric, up to 8 characters
transaction occurred
ATTRIB Name of the attribute for which the Alphanumeric, up to 8 characters
transaction occurred
ACCSLEVL Password level of the user that logs on, or Numeric, 1 character, from 0 through 7
the password level required to perform a
transaction
DEVICE Name of the device where the transaction Alphanumeric, up to 8 characters
occurred
FEATURE Either the name of the feature for which the Alphanumeric, up to 8 characters
transaction occurred, or the status of the
object.
VALUE Value of the affected object or attribute Alphanumeric, up to 8 characters
UNITS Units used to measure the value of the Alphanumeric, up to 6 characters
affected object (if the object is analog)
DATE_Y Year that the report was generated Numeric, 2 characters, from 00 to 99
DATE_M Month that the report was generated Numeric, 2 characters, from 01 to 12
DATE_D Day that the report was generated Numeric, 2 characters, from 01 to 31
TIME_H Hour of the day the report was generated Numeric, 2 characters, from 00 to 23
TIME_M Minute of the day the report was generated Numeric, 2 characters, from 00 to 59
TIME_S Second of the day the report was Numeric, 2 characters, from 00 to 59
generated
OPERATOR Initials of the operator who performed the Text, up to 3 characters
transaction
ODATE_Y Year that the original transaction occurred Numeric, 2 characters, from 00 to 99
ODATE_M Month that the original transaction occurred Numeric, 2 characters, from 01 to 12
ODATE_D Day that the original transaction occurred Numeric, 2 characters, from 01 to 31
OTIME_H Hour of the day original transaction Numeric, 2 characters, from 00 to 23
occurred
OTIME_M Minute of the day original transaction Numeric, 2 characters, from 00 to 59
occurred
OTIME_S Second of the day original transaction Numeric, 2 characters, from 00 to 59
occurred
TEXT_ Description of the exact nature of the Alphanumeric, up to 89 characters
transaction (for example, object disabled)
Table 36-3lists the fields available for a query of data from the Card
Reader summary:
Table 36-3: Card Reader Query Fields

SYSTEM Name of the system containing the Access Alphanumeric, up to 8 characters
Controller whose card reader was used
OBJECT Name of the Access Controller defined for Alphanumeric, up to 8 characters
the card reader that was used
CARDNUM Card ID defined for the access card used Numeric, up to 5 characters,
from 0 to 65,535
L_NAME Last name defined for the access card Text, up to 11 characters
used
F_NAME First name defined for the access card Text, up to 9 characters
used
STATUS_ Status of the card reader that generated Status, up to 8 characters
the report (either Normal or Abnormal)
TIME_H Hour of the day that the report was Numeric, 2 characters, from 00 to 23
generated
TIME_M Minute of the day that the report was Numeric, 2 characters, from 00 to 59
generated
TIME_S Second of the day that the report was Numeric, 2 characters, from 00 to 59
generated
DATE_Y Year the report was generated Numeric, 2 characters, from 00 to 99
DATE_M Month that the report was generated Numeric, 2 characters, from 01 to 12
DATE_D Day that the report was generated Numeric, 2 characters, from 01 to 31
TEXT_ Description of the transaction (for example, Alphanumeric, up to 60 characters
CARD ID 25: Access Granted)
A number of keywords are not shown as selection buttons in the Fields

dialog box (Figure 36-6), but can still specify the format for Query
output. Type these keywords directly into the fields text box with
spaces or semicolons separating them from other words in the line.
Table 36-4 lists the key words and their functions. Place these
keywords before the text they are formatting.
Table 36-4: Keywords and Functions of Query Output

Keyword Function
ALL Includes all fields in the query output. You can add derived columns to this output.
FIELD Suppresses column headings. To suppress all headings, place the keyword at the
beginning of the line. Otherwise, only those headings followed by the keyword are
suppressed.
DOWN Outputs data for each field on a separate line. Place the keyword at the beginning of the line
before the field names. DOWN can also be used in conjunction with the Field keyword to
hide headings. For example, FIELD DOWN Last_Name.person, Department.person would
look like this:
Jones
1237
UL Underlines all text
IT Italicizes all text
OFF Turns off the text style it follows (that is, UL OFF turns off underlining. UL ON turns it on
again.) This is useful for formatting certain portions of the query using a certain style.
ATTR OFF Turns off all text style for styles that it precedes in the command line
EJECT Ensures that all data for a single record is output on the same page. The number following
EJECT should be the number of lines occupied by the record data. For example, if two lines
output the data from each record, the command line might look like this:
Last_Name.person, NEWLINE Department.person, Card_ID.person EJECT 2
Report Output
Click the Report button to analyze data collected by the query. For
example, a report can count the total number of records in a query
Filter Output
Click the Filter button to limit the types of information the query
collects. For example, the query could collect data from records where
the Department field is defined as Research. The Filter works the same
way as the filter option in the browsing control panel.
Order Output
Click the Order button to select the order in which the query data
appears. The default order for the data is the order in which it is found
on the disk.
Detailed Procedures
Defining a Query
To define a query:
1. Start Superbase 4 software by displaying either the Operator
Transaction summary or the Card Reader summary, or by clicking
the User Data button in the Modify Card dialog box.
Note: Make sure to start Superbase 4 software from the correct
file in order to gain access to the appropriate database.
2. If you started Superbase 4 software from the access card Modify
Card dialog box, click Exit to return to the Main menu.
If you started Superbase 4 software by displaying the Operator
Transaction or Card Reader summary, click Cancel to exit to the
Operator Transaction or Card Reader menu.
3. Click the Query > Add. The Query Definition dialog box appears
(Figure 36-4).
Title
Query Definition NETWORK MAP - Summary

Title Date Page
Fields
Report
Output
Filter
Order
Destination Screen Disk File

Printer SB File OK Clear Cancel
QUERYDEF
Figure 36-4: Query Definition Dialog Box

4. Define the title section to make a title, page number, or date to

appear on each page of the query. Detailed information about
defining the query title appears later in this chapter.
Define the output section to specify what information should be in
the query. Always define the Fields section. The Report, Filter, and
Order sections are optional. Detailed information about defining
query output appears later in this chapter.
Notes: The destination section is set to the Screen destination.
Full Superbase 4 capabilities are necessary to change the
destination.
Superbase 4 software is case sensitive. To do a search
for an exact match (that is, using the = option rather than
Like), make sure to match the upper and lower case
letters as they have been entered in the database.
5. When finished defining the query, click OK in the Query
Definition dialog box. The Save Query dialog box appears
(Figure 36-5).
Figure 36-5: Save Query Dialog Box

6. Type a name to give the query in the text box and click OK
Defining the Query Title

To define the title section of a query:
1. Click the Query button from the Superbase 4 menu of the database
to which the query belongs (the Operator Transaction menu, Card
Reader menu, or Main menu). The Query menu appears
(Figure 36-2).
2. Click Add. The Query Definition dialog box appears
(Figure 36-4).
3. To have the date to appear on the query, click the date box. An X
appears in the box, and the date appears in the upper left corner of
each page of the query.
4. Type the title in the text box, located between the Date and Page
boxes. The title appears centered at the top of each page of the
query.
5. Click the Page box to number the pages. An X appears in the box.
The page number appears in the upper right corner of each page of
the query.
Defining Query Output

To define the query output for queries in the standard table format:
1. Click the Fields button in the Query Definition dialog box. The
Query Fields dialog box appears (Figure 36-6).
Figure 36-6: Fields Dialog Box

Table 36-5 describes the Fields dialog box selection buttons and their
function.
Table 36-5: Fields Dialog Box Buttons

Button Function
Click this button to specify where each field should appear on the query. Use it to
organize the fields in the query, or to specify a certain amount of space between fields.
Position
Click this button to limit the number of characters that can appear in a field, and to
& specify the number of digits that can appear before and after a decimal point. For
Length example: if only the first few characters of a lengthy field are important, limit the field
length so that the query only displays the relevant information.
AS Click this button to specify a heading name other than the field name.
Heading
ON Use this button to extract data from more than one database for a query. This query is
called a Multi-File query and is not recommended for querying Metasys BAS data, since
File current data can be accessed from only one database at a time.
+-*/() Use the mathematics keys on the right side of the dialog box to perform mathematic
Derived Column computations on two or more numeric fields. For example, use the addition button (+) to
Expressions add the values of two fields to form another entry in a query.
Click this button to start a column heading on a new line. If a new line is not specified,
LINE the query outputs the data in a tabular format. To specify a new line, click the Line button
Line and select the field that should begin on a new line. Click the Line button once for each
blank line between field headings.
2. Click the @ Position button and type the column number where the
first column in the query should begin in the Value text box. Click
Value or press Enter.
One column equals one character space wide, beginning at the left
margin. For example, @20 means that the column will be
positioned 20 character spaces from the left of the page. The first
column is usually positioned @1.
3. To limit the width of the column, click & Limit. Type the
maximum number of characters that the column should contain in
the Value text box. Click Value or press Enter.
Notes: This step is optional. However, make sure that the
query’s columns do not overlap on each other.
To specify the number of digits that can appear before
and after a decimal point, type the number of digits to
appear before the decimal, the decimal point, and the
number of digits to appear after the decimal. For
example, if no more than two digits should appear both
before and after the decimal point, type 2.2 in the Value
text box.
4. Click on a field name in the list box. The values selected in the
previous two steps now apply to this field.
To create a query field that is a mathematical computation of
two or more numeric fields, use the Derived Column Expression
buttons, and enclose the equation in parentheses.
5. To give the field a heading in the query that is different from its
field name, click AS Heading and type the new heading into the
value text box. Click Value or press Enter.
6. Repeat Steps 2 through 5 for each field that appears in the query.
When finished, click OK. The query definition dialog box (Figure
36-4) reappears with the field output definition displayed in the
Fields text box.
7. Click another option and continue defining the query, or click OK
to save the query.
To define queries using the NEWLINE format (Figure 36-3):
1. Click the Fields button in the Query Definition dialog box. The
Query Fields dialog box appears (Figure 36-6).
2. Click the Line button. NEWLINE appears in the Field text box.
3. Click the Field name that should appear first in the query. The
name appears to the right of NEWLINE in the Field text box.
4. To give the field a heading in the query that is different from its
field name, click AS Heading and type the new heading into the
Value text box. Click Value or press Enter.
5. Repeat steps 2 through 4 for all remaining fields that appears in
the query.
6. When finished, click OK. The query definition dialog box
(Figure 36-4) appears with the field output definition displayed in
the Fields text box.
to save the query.
Report Output
To define a report function:
1. Click the Report button on the Query Definition dialog box. The
Report dialog box appears (Figure 36-7).
Figure 36-7: Report Dialog Box

Table 36-6 details the functions of the buttons in the Report dialog
box.
Table 36-6: Report Dialog Box Buttons

Button Function
Report Click this button to analyze information drawn from all of the records in a file.
Group Click this button to display information drawn from a subgroup of records within a file.
The way the query is ordered (using the Order button) determines which subgroups are
available for use in the Report section. Define the order before using the Group function
in the Report dialog box. For example, if the query is ordered by Department, count the
number of records in each department by clicking Group > Count > Department.
Summarize Click this button before clicking OK in the Report dialog box to display a summary of the
query data specified in the Reports line without displaying the fields specified in the
Fields line. This is useful for displaying file Report calculations without going through the
individual records.
Note: The functions of the Sum, Mean, and Count buttons

vary depending on whether the report function is
analyzing all records in a file or a subgroup of records in
a file.
2. Click the fields that the report functions will affect.

3. To analyze information drawn from all of the records in a file,
click the Report button. Report is displayed in the Report text box.
a. Click Count to count the number of records in the file.
b. For the sum of a numeric field, click Sum and select the
numeric field from the Report list box.
c. For the mean of a numeric field, click Mean and select the
numeric field from the Report list box.
4. To display information about a subgroup of records in a file, click
the Group button. Group is displayed in the Report text box.
a. To count the number of records in a subgroup of a file, click
Count and select the subgroup (field).
b. To view the sum of a numeric subgroup, click Sum and select
the subgroup (numeric field).
c. To view the mean of a numeric subgroup, click Mean and
select the subgroup (numeric field).
5. To view a summary of the query data specified in the Reports line
without displaying the fields specified in the Fields line, click
Summarize.
6. Click OK. The Query Definition dialog box (Figure 36-4) appears
with Report selections displayed in the text box located to the
right of the Report button.
to save the query.
Filter Output
To filter a query:
1. Click the Filter button in the Query Definition dialog box. The
Filter dialog box appears (Figure 36-8).

2. Click on the fields in the list box that the filter should limit (that
is, Card_ID).
3. Specify how the filter function should limit each field by clicking
the selection buttons located on the right side of the list box and
filling in the value for each limitation. An explanation of each of
the buttons is listed Table 36-7.
Table 36-7: Filter Dialog Box Buttons

= Displays a record with an exact value (for example, Card ID = 27 displays the record with a
Card ID number of 27)
Note: Superbase 4 software is case sensitive. The upper and lower case letters used with the
= function should match those in the database. If you are unsure of the case, use the
LIKE function.
<> Displays records excluding a specific value (for example, Department <> “Research” displays
all records except those with the Department field defined as Research)
< Displays values less than a specific amount (for example, Card ID < 100 displays all records
with Card IDs defined as 99 or less)
> Displays records with a value greater than a certain amount (for example, Card ID > 100
displays all records with Card IDs defined as 101 or more)
<= Displays records with a value less than or equal to a specific amount (for example, Card ID <=
100 displays all records with Card IDs defined as 100 or less)
>= Displays records with a value greater than or equal to a specific amount (for example, Card ID
>= 100 displays all records with Card IDs defined as 100 or more)
Displays records according to two expressions where one expression has higher priority than the
( AND ) other (for example, NOT (Department LIKE “Research” AND Card ID < 17) displays only
records with Department defined as anything other than Research, and Card IDs defined as less
than 17)
AND Displays records where two conditions are true (for example, Card ID < 1000 AND Card ID > 100
displays records with Card IDs defined between 101 and 999)
OR Displays records that meet one of two conditions (for example, Department LIKE “Research”
OR Department LIKE “Marketing” displays only those records with Department defined as
Research or Marketing)
NOT Displays records with values that negate an expression (for example, NOT (Department LIKE
“Research” AND Card ID < 17) displays only those records with Department defined as
anything other than Research, and Card IDs defined as less than 17)
LIKE Displays a record with an exact value (for example, Last Name LIKE “Jones” displays only
those records with the Last Name defined as Jones)
Type an asterisk in place of any unknown letters (for example, Last Name LIKE “Joh*” lists all
records with the first three characters defined as Joh).
Type an asterisk before and after the character to find any field containing a certain character
(for example, Last Name LIKE “*R*” displays all records with an R anywhere in the Last Name
field).
Type a question mark to denote the number of unknown characters (for example, Last Name LIKE
“???r*” displays all records with an R as the fourth letter of the Last Name).
+ - Mathematically compute two or more numeric fields
* /
with the Filter selections displayed in the text box located to the
right of the Filter button.
to save the query.
Ordering the Output

Note: Define the Fields output before defining the order. Refer to
Defining Query Output earlier in this section.
To display query data in a specific order:
1. Click the Order button on the Query Definition dialog box. The
Order dialog box appears (Figure 36-9).
Figure 36-9: Order Dialog Box

2. To limit the number of characters the query should consider when
ordering the field, click the & Length button. Type the number of
characters in the Value text box and press Enter or click Value.
The default value is 15.
3. Click a field in the list box to use to order the file (for
example, Last_Name).
Note: This field must be one that the query summarizes (that
is one that was selected in the Fields dialog box during
query definition).
4. Click Ascending or Descending. An ascending order begins with
the lowest number or first alphabetical character. A descending
order begins with the highest number or the last alphabetical
character.
with the Order selections displayed in the text box next to the
Order button.
6. Click another option and continue defining the query.

7. When finished defining the query, click OK in the Query
Definition dialog box. The Save Query dialog box appears
(Figure 36-5).
8. Type a name for the query in the text box and click OK.
Modifying a Query
To modify a query:
1. Click the Query button on either the Main menu, Operator
Transaction menu, or Card Reader menu. The Query menu
2. Click Modify. The Query Selection dialog box appears
(Figure 36-10).
Figure 36-10: Query Selection Dialog Box

3. Select the query from the list box. The query name appears in the
text box.
4. Click OK. The Query Definition dialog box appears
(Figure 36-4).
5. Make the changes in the definition box, and click OK.
Deleting a Query
To delete a query:
2. Click Delete. The Query Selection dialog box appears
(Figure 36-10).
text box.
4. Click Delete. The query is deleted, and the OWS returns to the
Query menu.
Displaying a Query
To display a query:
To display the Operator Transaction summary or Card Reader
Transaction menu, click Cancel in the Operator Transaction or
Card Reader summary. The summary closes and its Transaction
Menu appears.
To display the Card Reader Main menu, display the Access Cards
summary, select a card, and click Modify Card Data from the
Action menu to display the Modify Card dialog box. Start
Superbase 4 software by clicking User Data, and click Exit in the
Employee menu to go to the Card Reader Main menu.
2. Click Display in the current menu.
text box.
4. Click OK. The query appears. (See Figure 36-1 for an example.)
5. Click Clear to clear the selection or click Cancel to cancel the
query request.
Press the space bar to page down in a query. To return to the
beginning of a query, exit the query and display it again. To exit
the query, page down to the end of the query and press the space
bar again.
Printing a Query
To print a query:
1. On the Query menu, click Print. The Query Selection dialog box
text box.
3. Click OK. A message box appears indicating that the query is
being printed.
Saving a Query to a File

Note: Click the File button on the Query menu to save the query to
an ASCII file rather than print it or display it on the PC.
To save the query to a file:
1. Click the Query button on the Main Menu, Operator Transaction
Menu, or Card Reader Menu. The Query Menu appears
(Figure 36-2).
2. Click File. The Query Selection dialog box appears
(Figure 36-10).
3. Select a query to save to an ASCII file. The selected query name
appears in the text box.
4. Click OK. The query is saved in the same directory as the selected
query in the ASCII format.
Note: The ASCII file has an .ASC extension.
Exiting a Query
To exit a query:
1. Page down to the end of the query by pressing the space bar. Press
the space bar again. The query closes, and the Query menu
appears.
Note: If the query is only one page long, press the space bar
once to return to the Query menu.
2. Click the Exit button, or click Exit on the Query Command menu.
The Query menu closes and the Main menu appears.
Note: If the query was accessed from the Operator Transaction
or Card Reader summary, the OWS returns to the
summary rather than the Main menu.
Chapter 37
Defining Custom Applications
Introduction
The Custom Applications feature allows the user to access other
software applications, such as Microsoft Excel, from the OWS without
closing Metasys software.
• set up access to the Custom Applications menu
• add an application to the Custom Applications menu
• modify the Custom Applications menu
• delete an application from the Custom Applications menu
• start a custom application

Code No. LIT-120163
Key Concepts
Adding Custom Applications
In order to run via the Custom Applications option, the application
must be a Windows application or a Windows PIF file. The hard drive
of the OWS must contain the application, and the application must be
added to the Custom Applications menu (see Adding an Application to
the Custom Applications Menu later in this chapter).
Up to 19 applications can be added to the Custom Applications menu.
Before adding an item, determine:
• the name that should appear on the menu
• the password level for exiting to the software
• the DOS command line that prompts the program to run
CUSTMENU.INI
To add an application to the Custom Applications menu, you must edit
the CUSTMENU.INI file. Before editing this file, define the path for
accessing the CUSTMENU.INI file so that the file is accessible from
the Accessory menu on the Network Map. See Setting Up Access to
the Custom Menu under Detailed Procedures.
Figure 37-1 shows the CUSTMENU.INI files displayed in Notepad.
Figure 37-1: CUSTMENU.INI File

The following line of text is an example of a line added to the

CUSTMENU.INI file to create a new Custom Applications menu item.
Table 37-1 lists and describes the different parameters to use when
editing the CUSTMENU.INI file, using this line as an example:
1=2, &Add A Custom Menu Item...,notepad
c:\windows\custmenu.ini
Table 37-1: CUSTMENU.INI Parameters

Parameter Description
1 Number that represents the number of the menu item. Type the number
followed by an equals (=) sign. Assign each new application to the number
that follows the last menu item in sequential order. The first application is
menu item 1.
2 Number that represents the password level assigned to the menu item.
Password levels can be 1, 2, 3, 4, or 5. The password level should be
followed by a comma and a space.
& Symbol that designates which letter of the menu item will be used to select
the item using the keyboard rather than the mouse. Place this symbol directly
before the letter in the line of text.
Add A Custom Menu Item... Line of text that represents the text that will appear on the menu. Type it
exactly as it should appear, followed by a comma.
notepad DOS command used to run the software, Notepad. Enter the DOS command
for the software package you are adding to the Custom Applications menu.
c:\windows\ Entire path name of a specific file that the Custom Application opens upon
custmenu.ini initialization. Leave one space between the DOS command and the file name
(that is, notepad c:\windows\custmenu.ini).
This step is optional. If this step is skipped, the Custom Application program
appears without opening a specific file.
Detailed Procedures
Setting Up Access to the Custom Applications Menu
To set up access to the Custom Applications menu:
1. Run Notepad or any other text editor.
2. Open the CUSTMENU.INI file. This file is located in the
Windows directory by default.
3. Change Line 1 so it contains the complete path name under which
the notepad.exe file is stored (see Figure 37-2).
Was
1=2, &Add a Custom Menu Item...,notepad custmenu.ini
this
Change
1=2, &Add a Custom Menu Item...,notepad c:\windows\custmenu.ini
to this
Where the drive

and directory matches
the drive and directory in
which your custmenu.ini
is stored.
direct
Figure 37-2: Changing the CUSTMENU.INI File
Adding an Application to the Custom Applications Menu

To add an application to the Custom Applications menu:
1. On the Accessory menu, click Custom Applications > Add a
Custom Menu. The CUSTMENU.INI file opens in Notepad
(Figure 37-1).
2. Use the arrow key to arrow down to the line directly beneath the
following line:
2=1, &XTM Configurator Tool,xtmcfg Metasys
3. Type all of the necessary parameters for the new menu item. The
example below is a duplicate of the first menu item in the
CUSTMENU.INI file. Use the same punctuation and spacing that
is shown in this example. Table 37-1 describes each of the
parameters.
1=2, &Add A Custom Menu Item...,notepad
c:\windows\custmenu.ini
Note: The entire command line may not exceed
255 characters.
4. On the File menu, click Save. This saves the additions to the
CUSTMENU.INI file. Close Notepad.
5. Log off of the OWS and log on again to see the changes in the
Custom Applications menu.
Modifying the Custom Applications Menu

To modify the Custom Applications menu:
Custom menu Item. The CUSTMENU.INI file opens in Notepad
(Figure 37-1).
2. Modify the appropriate lines.
3. On the File menu, click Save.
4. Close Notepad to return to the Metasys program. Log off of the
Metasys system and Log on again to see changed menu.
Deleting an Application from the Custom Applications Menu

To delete an application from the Custom Applications menu:
Custom menu. The CUSTMENU.INI file opens in Notepad
(Figure 37-1).
2. Delete the line that defines the menu item.
3. On the File menu, click Save. Close Notepad to return to the
Metasys program.
4. Log off of the OWS and log on again to see the changed menu.
The deleted item no longer appears on the menu.
Starting a Custom Application

Note: Make sure that the Application software is installed in the
OWS before attempting to start the application from the
Network Map.
To start a custom application:
1. On the Accessory menu, click Custom Applications. On the
submenu, click the name of the application. The software program
starts.
2. When finished using the software, exit the program. The PC
automatically returns to the Network Map.
Chapter 38
Defining Custom Summaries
Introduction
The OWS uses summaries to monitor specific aspects of a facility’s
operation. For further monitoring options, create a custom summary.
For example, create a summary to display all of the fans in the facility
that have a current status of On, or to display all of the temperature
sensors that have a value of greater than or equal to 72.0 degrees.
• define a custom summary
• copy a custom summary
• display a custom summary
• refresh a custom summary
• print a custom summary
• modify a custom summary
• delete a custom summary

Code No. LIT-120164
Key Concepts
Custom Summaries
Custom summaries can be either permanent or temporary. Permanent
summaries are saved and accessed through the Summary option on the
Network Map. Temporary summaries are one-time summaries that are
not saved for future use. In order to designate a summary as
temporary, leave the Summary Name field blank.
To make the definition process quicker and easier, find an existing
custom summary that is similar to the new summary. Copy the existing
custom summary and edit the copy.
Here are a few general rules that apply to custom summaries:
• Always give a custom summary a unique name.
• To designate as summary as a temporary summary, leave the
Summary Name field blank in the Custom Summary-New dialog
box (Figure 38-3). The OWS does not save temporary summaries
for future use.
• To have a custom summary appear on multiple workstations,
define the summary at each workstation separately. Custom
summaries only appear on the workstation at which they where
created.
• To command an object from the custom summary, select the object
and click Operation or Communication on the Action menu.
• Access an object’s Focus window from the custom summary by
double-clicking on the object name in the summary.
• Program custom summaries to print on a schedule (if desired) in
the same manner as you would other online summaries. (For more
information, refer to Scheduling Commands and Summaries
chapter [LIT-120173].)
• Make sure to enter the correct criteria type (that is, Value, Status,
or Unit) for the object type, or no objects appear in the summary.
Figure 38-1 shows an example of a custom summary. The summary’s
PC group is stated at the top of the window. In this example, the
summary is from the Union Fans PC group.
The Date and Time stamps indicate the time that the summary was
opened or last updated (refreshed).
Figure 38-1: Custom Summary Example

Table 38-1 details the information provided by custom summary
fields.
Table 38-1: Custom Summary Fields

Field Description
Status State of the object (for example, offline)
Item Name of the PC group/system/object
Value Value of the object when the summary was opened or last refreshed
Units Engineering units of the object (if analog)
Description Expanded ID of the object
Detailed Procedures
Defining a Custom Summary
To define a custom summary:
1. Select the network, PC groups, or systems for the summary to
describe.
2. Click the Summary menu. The Network Map-Summary dialog

3. Click New. The Custom Summary-New dialog box appears
(Figure 38-3).
Figure 38-3: Custom Summary-New Dialog Box

The New button appears dimmed if a summary other than a
custom summary is highlighted. To deselect the summary, either
select a custom summary, or click Cancel to close the Network
Map-Summary dialog box, and reopen it following Steps 1
through 3.
4. Fill in each of the fields in the Custom Summary-New dialog box.
The fields are described in Table 38-2.
Note: The data entered in these fields is not case sensitive.
Table 38-2: Custom Summary-New Dialog Box Fields

Field Description
Summary Name Name of the new custom summary (maximum of 24 alphanumeric characters). For
a temporary summary, leave this field blank. Each summary must have a unique
name, unless the new summary is replacing an old one with the same name.
Characters entered here are displayed in upper case only.
Object Name Filter Name of objects to include in the summary. Use DOS wildcard characters (* and ?)
for filtering. Maximum of eight alphanumeric characters allowed
Filter On: Status, Type of filter used to distinguish what information appears in the summary. Select
Value, Units, or None Status, Value, Unit, or None by clicking the radio button to the left of the selection.
For Status, select a status from the list box to the right of Status.
For Value, select the relational operator from the list box to the right of Value and
enter a numeric value in the field to the right of the list box (decimals are
acceptable). Relational operators include:
• Less Than (<) • Greater than or Equal (> =)
• Greater than (>) • Equal (=)
• Less than or Equal (<=) • Not Equal (≠)
For Units, type the engineering units in the field (up to six alphanumeric ASCII
characters).
None indicates that data for all objects is collected based on the Object Name
Filter.
5. Click Display to see the summary, or click Save to save the

summary.
Copying a Custom Summary

To copy a custom summary:
1. Select the network, PC group, or system for the summary to
describe.
2. On the Main menu, click Summary. The Network Map-Summary
3. From the list box, select a custom summary to copy.
IMPORTANT: The selected summary must be a custom summary.

Other online summaries listed in the box cannot be
copied.
4. Click New. The Custom Summary—New dialog box appears
(Figure 38-3).
5. Modify the Summary Name field and any other fields necessary
for the new summary.
Displaying a Custom Summary

To display a custom summary:
2. Click the summary.
3. Click Display. The selected summary appears.
While summary data is being collected (before the summary
appears on the screen), a message box appears indicating how
many records the summary has found. Click Cancel on this
message box to end the query. The summary appears displaying
only the records found up until the search was cancelled.
Refreshing a Custom Summary

To refresh a custom summary:
1. Display the summary as described in Displaying a Custom
Summary, earlier in this chapter.
2. On the Action menu, click Refresh Summary Data. The summary
data is updated.
Printing a Custom Summary

To print a custom summary:
2. Click the custom summary.
3. Click Print. The summary is sent to the workstation’s designated
printer.
Modifying a Custom Summary

To modify a custom summary:
2. Select the custom summary.
3. Click Edit. The Custom Summary-Edit dialog box appears
(Figure 38-4).
Figure 38-4: Custom Summary-Edit Dialog Box

4. Modify the summary.
5. Click Display to see the summary, or click Save to save the
summary.
Deleting a Custom Summary

To delete a custom summary:
2. Select the custom summary.
3. Click Delete. A message box appears asking for confirmation.
4. To delete the summary, click Yes.

PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PDF

Uploaded by

Copyright:

Available Formats

Table of Contents

Operator Workstation User’s

Chapter 1 Getting Started ...........................................................1-1

Key Concepts................................................................................................... 1-2

Detailed Procedures...................................................................................... 1-12

© June 18, 2004 Johnson Controls, Inc.

Chapter 2 Using the Network Map ......................................................2-1

Key Concepts................................................................................................... 2-2

Detailed Procedures........................................................................................ 2-5

Chapter 3 Setting the Calendar ...........................................................3-1

Key Concepts................................................................................................... 3-2

Detailed Procedures........................................................................................ 3-4

Troubleshooting .............................................................................................. 3-9

Chapter 4 Displaying Online Summaries ...........................................4-1

Key Concepts................................................................................................... 4-2

Online Summary Types..................................................................................................4-2

Detailed Procedures...................................................................................... 4-25

Chapter 5 Displaying Archived Summaries .......................................5-1

Key Concepts................................................................................................... 5-2

Operator Transaction Summary .....................................................................................5-3

Detailed Procedures...................................................................................... 5-11

Chapter 6 Displaying Drawings...........................................................6-1

Key Concepts................................................................................................... 6-2

Detailed Procedures........................................................................................ 6-4

Chapter 7 Managing Alarms and Change-of-State Reports .............7-1

Key Concepts................................................................................................... 7-2

Critical Alarm Warning Box ............................................................................................7-3

Detailed Procedures...................................................................................... 7-13

Chapter 8 Commanding Objects .........................................................8-1

Key Concepts................................................................................................... 8-2

Detailed Procedures........................................................................................ 8-5

Chapter 9 Scheduling Commands and Summaries ..........................9-1

Key Concepts................................................................................................... 9-2

Detailed Procedures........................................................................................ 9-3

Chapter 10 Using Object Focus Windows.......................................10-1

Key Concepts................................................................................................. 10-2

Detailed Procedures...................................................................................... 10-6

Chapter 11 Using Online Help ..........................................................11-1

Key Concepts................................................................................................. 11-2

Detailed Procedures...................................................................................... 11-5

Chapter 12 Using Point History........................................................12-1

Key Concepts................................................................................................. 12-2

Detailed Procedures...................................................................................... 12-5

Chapter 13 Using Totalization ..........................................................13-1

Key Concepts................................................................................................. 13-2

Runtime or Event Totalization Dialog Box....................................................................13-3

Detailed Procedures...................................................................................... 13-7

Chapter 14 Using Trend ....................................................................14-1

Key Concepts................................................................................................. 14-2

Detailed Procedures...................................................................................... 14-8

Modifying a Trend Entry .............................................................................................14-10

Chapter 15 Using Dial-Up with the NCM..........................................15-1

Key Concepts................................................................................................. 15-2

Detailed Procedures...................................................................................... 15-4

Chapter 16 Using Dial-Up with the NDM..........................................16-1

Key Concepts................................................................................................. 16-2

Detailed Procedures...................................................................................... 16-4

Chapter 17 Online Generation Overview .........................................17-1

Key Concepts................................................................................................. 17-2

Online Generation ........................................................................................................17-2

Detailed Procedure........................................................................................ 17-3

Chapter 18 Defining Networks .........................................................18-1

Key Concepts................................................................................................. 18-2