41731326 configuration
2 likes1,990 views
- This document is a reference guide for configuring the Andover Continuum CyberStation building automation software. - It assumes CyberStation has already been installed and covers topics like configuring menu pages, security, users, networks, controllers, I/O modules, alarms, reports and more. - Each chapter follows the typical sequence involved in configuring different aspects of the CyberStation software and Andover Continuum's building automation system.
![Andover Continuum CyberStation Configurator’s Guide 253
• Extended-log settings 7, 8, 9, and 10, in the General Preferences dialog. (For more
information on these settings, see Extended Logging, later in this section.)
Automatic Logs and Manual Logs
For Infinity Input, Output, Numeric, String, and DateTime points, you can set up one of
two basic types of short-term logs:
• Logs that the system updates automatically
• Logs that you update manually
Automatic Logs — Automatic logs are generated by CyberStation at specific intervals
that you define via the attribute settings on this tab, as well as the preference settings in
the General Preferences dialog. (See Extended Logs, later in this section, for General
Preference settings.)
For example, the following picture depicts an automatically updated log for a point named
SupplyAir:
CyberStation updates automatic logs by inserting new values into the first log entry.
Every interval, a new value is stored in the first log entry, pushing existing values down to
the remaining entries. When the specified number of entries is full of values, the bottom
value "drops off” when a new value is inserted.
When working with logs, you won’t actually see structures like the one shown above.
Instead, you use point names and index numbers to retrieve values stored in logs. To do
this, simply enclose the index number in square brackets [ ] directly after the point name.
For example, to print the sixth entry (72) of the log for SupplyAir, use the following
command:
PRINT SupplyAir[6]](https://image.slidesharecdn.com/41731326-configuration-150930164937-lva1-app6892/85/41731326-configuration-265-320.jpg)
![TAC254
Manual Logs — Unlike automatic logs, CyberStation cannot set manual logs. Manual
logs are set either from the Command Line editor or a Plain English program. To update
a manual log, simply enclose the index number in square brackets [ ] directly after the
point name. The example below sets the third log entry of an array named MyNum:
SET MyNum[3] TO 12
Note: To perform calculations on logs, see the following Plain English keywords:
SUM
AVERAGE
MINIMUM
MAXIMUM
Logs
The following table describes the attributes in the Logs section of this tab. These
settings affect extended logs, when extended logging is activated.
Number of
Entries
Enter an integer representing the number of entries.
The maximum number of entries allowed in a log depends on the memory
available on your controller, but cannot exceed 32,767 entries per log.
When this number is exceeded, and you have activated extended logging,
then the first-in-first-out log entries are transferred (uploaded) to a
workstation's CyberStation database. If extended logging is not activated,
then the first-in-first-out log entries are deleted from the controller.
Type In the Type field, use the down arrow to show a list of available log types
and select one:
Manual Not set by CyberStation. Can be set only from
the command line, a report, or a Plain English
program
LogInstantaneous CyberStation stores the current value of this
point at the beginning of every interval
LogAverage CyberStation calculates the average point
value over every interval, using a weighted
average algorithm. Average values are stored
at the end of every interval.
LogMinimum CyberStation compares all values over an
interval, finds the minimum and stores it at the
end of every interval
LogMaximum CyberStation compares all values over an
interval, finds the maximum and stores it at
the end of every interval](https://image.slidesharecdn.com/41731326-configuration-150930164937-lva1-app6892/85/41731326-configuration-266-320.jpg)
![TAC474
About Sending Condition Level Values to Individual
Controllers
Using the Global Condition Level dialog enables you to change the value for
ConditionLevel at multiple controllers with one command. You can also change the value
for individual controllers:
• You can edit the ConditionLevel variable in the InfinitySystemVariable editor.
• You can enter a command to change the value from the command line.
• You can use a Plain English (PE) program to change the value.
• You can use PE script attached to a Pinpoint control to change the value.
When you use the command line or a PE program to send a value for this variable, you
must use the numeric value that corresponds to the condition level that you want to set.
Do not use a text string.
For example, if you want to use the SET command to change the value for
ConditionLevel to Level 5, use the following syntax:
SET [pathname]ConditionLevel = 5](https://image.slidesharecdn.com/41731326-configuration-150930164937-lva1-app6892/85/41731326-configuration-486-320.jpg)
41731326 configuration
- 1. Andover Continuum CyberStation Configurator’s Guide for Version 1.8
- 2. TACii © 2006, TAC All Rights Reserved No part of this publication may be reproduced, read or stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior written permission of TAC. This document is produced in the United States of America. Infinity is a trademark of TAC. All other trademarks are the property of their respective owners. Andover Continuum CyberStation Configurator’s Guide for Version 1.8 December, 2006 TAC part number: 30-3001-781 The information in this document is furnished for informational purposes only, is subject to change without notice, and should not be construed as a commitment by TAC. TAC assumes no liability for any errors or inaccuracies that may appear in this document. TAC, Inc. One High Street North Andover, MA 01845 (978) 470-0555 Fax: (978) 975-9782 http://www.tac.com
- 3. Andover Continuum CyberStation Configurator’s Guide iii Contents 1 Introduction ................................................................................................................ 1 About this Guide........................................................................................................... 1 Key Concepts ............................................................................................................... 3 Andover Continuum Product Description..................................................................... 5 CyberStation............................................................................................................... 12 Starting CyberStation ................................................................................................. 14 Closing CyberStation.................................................................................................. 15 2 Menu Pages .............................................................................................................. 17 The CyberStation Main Menu .................................................................................... 17 Accessing the Online Help System ............................................................................ 22 Menu Page Selections ............................................................................................... 23 Configuring New Menu Pages ................................................................................... 32 Button Wizard............................................................................................................. 36 3 Continuum Explorer................................................................................................. 39 Objects in Continuum Explorer .................................................................................. 39 Starting Continuum Explorer ...................................................................................... 45 Dropdown Menus ....................................................................................................... 46 Quick Picks Toolbar ................................................................................................... 54 Popup Menus ............................................................................................................. 55 Continuum Explorer Window...................................................................................... 55 Explorer Views ........................................................................................................... 58 Creating Objects......................................................................................................... 62 Importing from ASCII Dump Files .............................................................................. 65 Importing from CSV Files ........................................................................................... 66 Creating CSV Files for CyberStation.......................................................................... 67 Updating or Creating Personnel Objects from CSV Files .......................................... 68 CyberStation Object Editors....................................................................................... 70 Access Security Rules in Continuum Explorer........................................................... 70 4 Security ..................................................................................................................... 73 Security Groups.......................................................................................................... 73 Configuring Object-Level Security.............................................................................. 80
- 4. TACiv Folder and Device Level Security............................................................................... 85 5 Configuring Users .................................................................................................... 89 What Are Users? ........................................................................................................ 89 Customizing the User Environment............................................................................ 89 Before Configuring Users........................................................................................... 90 Creating a User Object............................................................................................... 90 Groups Tab – User Editor .......................................................................................... 93 SecurityLevel Tab – User Editor................................................................................. 93 Setting up the General and CFR Preferences ........................................................... 94 Creating a ControllerUser Object ............................................................................. 100 6 Configuring a Network........................................................................................... 103 Creating a Network Object ....................................................................................... 104 Assigning a Network Object to a Default Folder ..................................................... 105 7 Configuring Controllers......................................................................................... 107 Commissioning a Controller ..................................................................................... 108 Creating an InfinityController Object ........................................................................ 109 Creating a bCX1 (40x0) or b4920 Controller............................................................ 122 Sending Controller Data to the CyberStation Database .......................................... 123 Working With Infinet Controllers .............................................................................. 124 Creating an Infinity Infinet Controller Object ............................................................ 125 Creating an Infinet Controller Offline........................................................................ 126 Editing an Infinet Controller Object .......................................................................... 126 8 Configuring Comm Ports....................................................................................... 131 Supported Device Types.......................................................................................... 131 Configuring a Comm Port for a Terminal ................................................................. 132 Configuring a Comm Port for a Printer..................................................................... 133 Configuring a Comm Port for a LBus ....................................................................... 133 Configuring a Comm Port for a TankNet.................................................................. 134 Configuring a Comm Port for XDrviers..................................................................... 134 Configuring a Comm Port for Infinet, MS/TP, or Wireless ....................................... 135 Configuring a Comm Port......................................................................................... 137
- 5. Andover Continuum CyberStation Configurator’s Guide v 9 Creating IOU Module Objects ............................................................................... 147 Creating an IOU Module Object ............................................................................... 148 Commissioning an IOU Module ............................................................................... 149 Replacing an IOU Module ........................................................................................ 150 10 Configuring Alarms................................................................................................ 151 Considering the Alarm System................................................................................. 151 Alarms and BACnet.................................................................................................. 151 Considering the Alarm System................................................................................. 151 Basic Steps for Setting Up Alarms .......................................................................... 152 About EventNotification Objects .............................................................................. 152 About Configuring Alarm System Components ....................................................... 152 Using the EventNotification Editor............................................................................ 154 Distributing Tasks to Several Workstations.............................................................. 163 About AlarmEnrollment ............................................................................................ 168 Using the AlarmEnrollment Editor ............................................................................ 169 Writing Alarm Messages .......................................................................................... 175 Attaching Alarms to a Point...................................................................................... 176 Active Alarm View .................................................................................................... 180 Infinet Intrinsic Alarms.............................................................................................. 196 Database Fault Detection Alarm .............................................................................. 199 11 Configuring Reports .............................................................................................. 201 Overview................................................................................................................... 201 Source Tab............................................................................................................... 204 Configuring Columns for a Report............................................................................ 212 Filter Tab .................................................................................................................. 215 Output Tab ............................................................................................................... 219 Scheduling Automatic Reports................................................................................. 224 What Are Extended Logs? ....................................................................................... 230 The ReportViewer .................................................................................................... 230 12 Templates................................................................................................................ 237 About CyberStation Templates ................................................................................ 237
- 6. TACvi Creating a Template Object ..................................................................................... 239 Creating an Object from a Template ........................................................................ 241 Editing an Object Created from a Template............................................................. 240 13 Points, Logs, and Triggers.................................................................................... 243 What is a Point? ....................................................................................................... 243 About InfinityInput and InfinityOutput Points ............................................................ 244 Before You Start....................................................................................................... 245 Creating an InfinityInput Object................................................................................ 245 InfinityOutput Points ................................................................................................. 261 Creating an InfinityOutput Object ............................................................................. 261 About Infinity Software Points .................................................................................. 267 Creating Infinity Software Points .............................................................................. 267 About BACnet Points................................................................................................ 273 14 BACnet .................................................................................................................... 275 What is BACnet? ...................................................................................................... 275 Andover Continuum’s BACnet Product Line ............................................................ 277 BACnet-Related Documentation .............................................................................. 277 Post Installation System Integration......................................................................... 278 The Device Editor..................................................................................................... 288 Configuring BACnet Alarms ..................................................................................... 311 BACnet Defined Objects .......................................................................................... 330 Infinity and BACnet Object Editors........................................................................... 333 15 Configuring Schedules and Calendars................................................................ 371 Schedule Views – Finding Your Way Around .......................................................... 372 Configuration Tab..................................................................................................... 376 Working with Exception Schedules .......................................................................... 383 Working with Standard Days and User-defined Days.............................................. 391 Current State Tab..................................................................................................... 399 Proprietary Schedule Properties for Programs ........................................................ 400 Mass Create – Populating Devices with a Schedule ............................................... 401 Mass Change – Updating Multiple Schedules ......................................................... 404 Calendars and the Calendar Editor.......................................................................... 406
- 7. Andover Continuum CyberStation Configurator’s Guide vii 16 Configuring Loops ................................................................................................. 411 Overview................................................................................................................... 411 General Tab ............................................................................................................. 412 Tuning Tab ............................................................................................................... 416 What Is PID? ............................................................................................................ 419 Tuning the PID Loop ................................................................................................ 421 Customizing the PID Graph...................................................................................... 422 Basic Alarms Tab and Advanced Alarms Tab.......................................................... 429 17 Configuring Trend Loops ...................................................................................... 433 Overview................................................................................................................... 433 General Tab ............................................................................................................. 434 Data Tab................................................................................................................... 437 Extended Logging Tab ............................................................................................. 440 Basic Alarms Tab ..................................................................................................... 441 18 Configuring Areas and Doors ............................................................................... 447 Configuring Andover Continuum for Security and Access Control .......................... 447 Key Terms for Access Control ................................................................................. 447 About Areas, Doors, and Personnel......................................................................... 449 Sequence for Creating Access Control Objects....................................................... 451 Creating an Area Object........................................................................................... 452 Creating a Door Object............................................................................................. 452 Data that Defines a Door Object .............................................................................. 452 General Tab – Door Editor ....................................................................................... 453 Card Formats Tab – Door Editor.............................................................................. 454 Channels Tab – Door Editor..................................................................................... 455 Options Tab – Door Editor........................................................................................ 460 XDriver Tab – Door Editor........................................................................................ 461 Entry Reader Tab – Door Editor............................................................................... 462 Entry Options Tab – Door Editor .............................................................................. 464 Entry Status Tab – Door Editor ................................................................................ 465 Exit Reader Tab – Door Editor ................................................................................. 466 Exit Options Tab – Door Editor ................................................................................ 468
- 8. TACviii Exit Status Tab – Door Editor................................................................................... 469 Alarms Tab – Door Editor......................................................................................... 469 Access Events Tab – Door Editor ............................................................................ 469 Using Area Lockdown .............................................................................................. 470 More About Area Lockdown..................................................................................... 470 What Happens During Lockdown............................................................................. 471 Locking down an Area.............................................................................................. 471 Locking down Individual Doors................................................................................. 472 Controlling Access with Condition Levels ................................................................ 472 Sending a Condition Level Message to Controllers ................................................. 473 Restoring Controller Condition Levels to Previous Levels ....................................... 473 About Sending Condition Level Values to Individual Controllers............................. 474 19 Personnel ................................................................................................................ 475 Personnel Manager .................................................................................................. 475 Enabling the Personnel Manager............................................................................. 477 Adding New Personnel Objects................................................................................ 477 Editing a Personnel Object....................................................................................... 480 Making/Editing a Badge ........................................................................................... 485 Reading Card Information ........................................................................................ 491 Replacing Card Information...................................................................................... 492 Issuing or Restoring a Temporary Card ................................................................... 492 Marking a Card as Lost ............................................................................................ 493 Deleting Personnel Objects...................................................................................... 493 Working with Personnel Clearance Levels and Controller Condition Levels ........... 494 Configuring the Personnel Manager ........................................................................ 498 Creating a Personnel Profile .................................................................................... 500 Customizing Personnel Attributes ............................................................................ 506 Selecting Configuration Settings for the Personnel Manager .................................. 508 Personnel Import Utility ............................................................................................ 510 What Can I do with the Personnel Import Utility?..................................................... 511 Configuration Tab..................................................................................................... 515 Mapping Data Source Attributes to CyberStation Personnel Attributes................... 520
- 9. Andover Continuum CyberStation Configurator’s Guide ix Previewing Data ....................................................................................................... 522 Data Source Data Tab.............................................................................................. 523 Transforming Data Using the XSLT File .................................................................. 524 Saving a Configuration and Importing Data into CyberStation ................................ 526 20 Managing Personnel Distribution......................................................................... 529 Access Distribution View.......................................................................................... 529 Launching and Populating the Access Distribution View......................................... 531 Filtering Distribution Events in Access Distribution View ......................................... 532 Using Columns in the Access Distribution View....................................................... 535 Using Toolbar Buttons in Access Distribution View ................................................. 540 Distributing Personnel Immediately — Distribute Now ............................................ 540 21 Managing Configuration Files............................................................................... 543 Overview................................................................................................................... 543 General Tab ............................................................................................................. 544 Backing Up a Device’s Configuration....................................................................... 545 Restoring a Device’s Configuration.......................................................................... 547 22 Creating Groups..................................................................................................... 549 What is a Group? ..................................................................................................... 549 What is a Graph? ..................................................................................................... 550 Using the Group Editor............................................................................................. 551 Opening a Log Viewer.............................................................................................. 559 Editing a Group from the Log Viewer....................................................................... 559 23 Creating ListViews ................................................................................................. 561 What is a ListView?.................................................................................................. 561 About Creating a New ListView................................................................................ 561 Using the ListView Editor ......................................................................................... 561 Test and Save .......................................................................................................... 573 Creating a History or Graph of a ListView................................................................ 574 24 Creating EventViews.............................................................................................. 577 Overview................................................................................................................... 577 Before Creating an EventView ................................................................................. 578 Creating an EventView............................................................................................. 579
- 10. TACx The Active Event View ............................................................................................. 583 25 Configuring and Viewing Video ............................................................................ 593 Overview of Video Integration and Configuration..................................................... 593 Using the VideoServer Editor................................................................................... 596 Using the VideoLayout Editor................................................................................... 597 26 Graphics Panels ..................................................................................................... 605 Introduction............................................................................................................... 605 Pinpoint Environment ............................................................................................... 613 Configuring a Pinpoint Panel.................................................................................... 615 Selecting Default Properties for Components.......................................................... 618 Creating an Active Text Component ........................................................................ 619 Inserting Images....................................................................................................... 621 Creating an Active Switch Control............................................................................ 621 Creating an Active Rotation Control......................................................................... 622 Creating a Personnel Picture Switch Control........................................................... 623 Creating an Active Bar Control................................................................................. 624 Creating an Active Button Control............................................................................ 625 Creating an Active n-Stage Animation Control......................................................... 628 Creating an Active Animated Button Control............................................................ 632 Inserting a Scale....................................................................................................... 636 Inserting a Gauge..................................................................................................... 637 Importing a Pinpoint Panel ....................................................................................... 639 Creating Windows Controls...................................................................................... 639 Controlling a Door .................................................................................................... 664 A Using the Personnel Editor ................................................................................... 671 General Tab – Personnel Editor............................................................................... 672 Area List Tab – Personnel Editor ............................................................................. 674 Privileges Tab – Personnel Editor............................................................................ 678 Employee Info Tab – Personnel Editor .................................................................... 678 Personnel Info Tab – Personnel Editor .................................................................... 679 Current Status Tab – Personnel Editor .................................................................... 680 Access Events Tab – Personnel Editor.................................................................... 681
- 11. Andover Continuum CyberStation Configurator’s Guide xi Templates Tab – Personnel Editor........................................................................... 681 Custom Attributes Tab – Personnel Editor............................................................... 682 Security Tab – Personnel Editor .............................................................................. 682 B EpiBuilder Installation ........................................................................................... 685 Installing EPIBuilder ................................................................................................. 686 C Personnel Import Utility Tables and Sample XSLT File ..................................... 687 Active Directory Attributes Table.............................................................................. 688 Continuum Personnel Attributes Table .................................................................... 691 Card Type Table....................................................................................................... 695 Active Directory ........................................................................................................ 696 LDAP Protocol.......................................................................................................... 701 Sample XSLT File .................................................................................................... 704 D Scheduling Automatic Personnel Object Updates ............................................. 711 Working with Scheduled Tasks ................................................................................ 717 Selecting Global Options.......................................................................................... 718 E Custom Card Formats............................................................................................ 719 Configuring CyberStation for Custom ABA Card Access......................................... 720 Multiple Custom Card Formats ................................................................................ 728 F Points – Electrical Types....................................................................................... 731 Infinity Electrical Types and BACnet Objects........................................................... 732 InfinityInput Types .................................................................................................... 732 InfinityOutput Types ................................................................................................. 735
- 12. TACxii
- 13. Andover Continuum CyberStation Configurator’s Guide 1 Introduction The chapter is an introduction to the Andover Continuum CyberStation Configurator’s Guide. This chapter also presents Andover Continuum’s hardware and software, key concepts that are important for a configurator to understand, an overview of CyberStation, and instructions on how to start and stop CyberStation. About this Guide This guide is designed to help you configure your building automation control system with Andover Continuum CyberStation software. This guide is based on the assumption that CyberStation has already been successfully installed on your system in accordance with the instructions contained in the Andover Continuum CyberStation Installation Guide, 30- 3001-720. Once the installation has occurred, the system is ready to configure as described in this guide. Document Scope This guide is a reference document for configuring the CyberStation software on your building control system. Chapters follow the typical sequence that is involved in configuring CyberStation on your Infinity or BACnet system. How this Guide Is Organized This guide is organized as follows: Chapter/Appendix Description Chapter 1 Introduction ⎯ Presents an introduction to this guide, brief descriptions of Andover Continuum’s product line, and overview of CyberStation, key concepts, and instructions for starting and stopping CyberStation. Chapter 2 Menu Pages ⎯ Describes all the features available from CyberStation’s main menu, how to create new menu pages and hot spots, and how to use the Button Wizard. 1
- 14. TAC2 Chapter/Appendix Description Chapter 3 Continuum Explorer⎯ Explains how the Explorer is laid out, its four views, describes objects and how they are represented on the Explorer and how viewer access to it is determined by security rules. Chapter 4 Security Chapter 5 Configuring Users Chapter 6 Configuring a Network Chapter 7 Configuring Controllers Chapter 8 Configuring Comm Ports Chapter 9 Creating I/O Module Objects Chapter 10 Configuring Alarms Chapter 11 Configuring Reports Chapter 12 Templates Chapter 13 Points, Logs, and Triggers Chapter 14 BACnet Chapter 15 Configuring Schedules and Calendars Chapter 16 Configuring Loops Chapter 17 Configuring TrendLogs Chapter 18 Configuring Areas and Doors Chapter 19 Configuring Personnel Chapter 20 Managing Personnel Distribution Chapter 21 Managing Configuration Files Chapter 22 Creating Groups Chapter 23 Creating ListViews Chapter 24 Creating EventViews Chapter 25 Configuring and Viewing Video Chapter 26 Graphics Panels Appendix A Using the Personnel Editor Appendix B EpiBuilder Installation Appendix C Personnel Import Utility Tables and Sample XSLT File Appendix D Scheduling Automatic Personnel Object Updates
- 15. Andover Continuum CyberStation Configurator’s Guide 3 Chapter/Appendix Description Appendix E Custom Card Formats Appendix F Points – Electrical Types Related Documentation The following documents are related to this configurator’s guide: Title Part Number Andover Continuum CyberStation Installation Guide for Version 1.8 30-3001-720 Remote Communication Configuration Guide 30-3001-814 Command Terminal Configuration Guide 30-3001-843 RoamIO2 (BACnet service tool) User’s Guide 30-3001-910 RoamIO2 (Infinet service tool) User’s Guide 30-3001-989 SNMP Configuration Guide 30-3001-855 Introducing BACnet – A Guide for CyberStation Users 30-3001-863 Plain English Language Reference 30-3001-872 bCX1 Series Controller Technical Reference 30-3001-890 CyberStation includes an extensive online help system. This help system is described in more detail in Chapter 2. Intended Readers of this Guide This guide is written for anyone at your site who is responsible for configuring the CyberStation software that controls the operation of your building control system. This person is the configurator. Network administrators and operators may also need this guide. Key Concepts The design of the CyberStation system is based on several key concepts that are involved in the makeup of the software and hardware components of a building control system. These key concepts are outlined below. More thorough descriptions may be found in subsequent chapters. Site Your building complex, or whatever you are controlling with the Andover Continuum system, is referred to as a site. In complex operations, you may have control of multiple sites.
- 16. TAC4 Points The control of equipment requires monitoring individual inputs and actuating individual outputs. In Infinity and CyberStation systems, these discrete entities are referred to as points. You’ll see references to “output point” or “input point” often. Internal places within a controller or workstation’s memory are also referred to as points. These software-based points may be temporary storage locations for setpoints or the memory location where the current date and time are stored. Events During operation, things happen as a result of actions taken by users, by the controllers, or as the result of no action. These occurrences can include the triggering of an over- temperature warning or the discovery of a forced door entry. In Andover Continuum systems, they are classified as events. There are several types of events. Each type can be monitored and acted upon through automatic and programmed control. All events are stored by the system. Alarms Alarms are events that signal the controller of an unusual occurrence. Typical alarms might include temperature variations and intrusion attempts. Schedules Schedules allow the operation of the system to be regulated according to a particular day, week, month, year, or time of day. User The user or operator is the person or persons who manually acknowledge alarms, monitor system activity, and interact with the system on a daily basis. Users are also individuals who have access to the CyberStation software. Configurator The configurator is the person who sets up (configures) the CyberStation software to match the physical devices of the site. Programmer The programmer is the person who determines the operational flow of the system. The programmer writes programs in a BASIC-like language called Plain English. Network The network is a medium through which electronic hardware communicates. Andover Continuum products use several types of networks: • Network controllers communicate with a user workstation and with each other via an Ethernet TCP/IP network. Our products support physical wire and fiber versions of the Ethernet as well as wide-area wireless Ethernet. • Andover Continuum controllers communicate with external input and output modules through a variety of commercial and proprietary network products.
- 17. Andover Continuum CyberStation Configurator’s Guide 5 Controller Controllers are small, dedicated computers that perform the logic necessary to read external inputs and operate external outputs. User-created programs that are loaded into the controller define the controller’s personality. There are two types of controllers: • Network controllers communicate through an Ethernet network. • Infinet controllers communicate through either the Andover Continuum proprietary Infinet network or the Master-Slave/Token Passing (MS/TP) network for BACnet devices. Workstation The user interacts with the Andover Continuum system through a personal computer called the workstation, which runs the CyberStation software. CyberStation is used to configure, program, monitor and operate the system. All workstations on the Andover Continuum system are BACnet-compliant BACnet Operator Workstations (B-OWS). Enterprise The entire Andover Continuum system configuration of workstations, servers and networks with attached controllers and I/Os is called an enterprise. An enterprise can consist of an unlimited number of networks containing a total of up to 4 million controllers and workstations. Andover Continuum Product Description Andover Continuum is a mixture of hardware and software that is designed to monitor and control the various functions of a building. These functions include, but are not limited to, security, access control, lighting, heating, ventilation, and cooling. The hardware consists of equipment controllers, network communication controllers, input and output interfaces. The CyberStation software is a computer program that allows you to communicate with, monitor and control the operation of the entire Andover Continuum system. CyberStation Software A key component of the Andover Continuum system is a Windows-based application program called CyberStation that runs on a PC workstation and interacts with the control system. Andover Continuum’s second key software component is the database that stores all the vital information pertaining to the building automation control system. CyberStation CyberStation provides a graphic user interface that can display and manipulate data that allows the entire site management of adjusting schedules and setpoints, acknowledging alarms, controlling doors, tracking personnel, and so on. Andover Continuum allows you to connect several CyberStation workstations simultaneously to provide for the most flexible configuration/control and monitoring operation available.
- 18. TAC6 Database The information that describes the structure and operation of your building is stored in the CyberStation database. The values of each point in the system, the settings for limits, the configuration of the hardware, the personal data of the personnel granted access to your building, and more, are contained in the database. The database engine that CyberStation uses is either Microsoft SQL server or MSDE 2000. Objects The components associated with your site (networks, workstations, actuators, sensors, and so on) are created, monitored, and controlled as objects in CyberStation. For example, for every controller you have in a building, CyberStation stores a controller object. When you have created an object for a piece of hardware, you can monitor, disable, change the settings for, and enable that equipment using that object in CyberStation. Objects represent every aspect of Andover Continuum’s building control system, whether it is building security, lighting, or HVAC control. Refer to Chapter 3 for more information about objects and how they are represented in CyberStation. Attributes An attribute is a characteristic of an object. All objects have attributes associated with them. In most cases, there are several attributes that describe an object. (Attributes are known as properties in BACnet objects.) Andover Continuum Hardware Products The Andover Continuum product line encompasses a wide variety of TAC components including Infinity CX 9XXX series controllers, NetControllers and NetController II network controllers, 9702 Site controllers, bCX1 series controllers, Infinet and Infinet II controllers, BACnet controllers, local and expansion input/output IOU modules, display modules and smart sensors. These components are networked to create a total building automation system. Andover Continuum System Architecture Depending upon the complexity of the site architecture, a system can range from a single-user configuration with one workstation to a large, multi-user configuration with a network of multiple workstations, a file server, and numerous controllers.
- 19. Andover Continuum CyberStation Configurator’s Guide 7 Single-User Configuration In single user configurations (shown below) the Andover Continuum product line consists of a network controller (NetController or NetController II with optional input/output modules), a bCX1 or a 9702 Site Controller and a CyberStation workstation. The MSDE database also resides on the workstation. The NetController/bCX1/9702 use Ethernet TCP/IP protocol to communicate with the workstation. Field bus communication between the network controller and the I/O modules is conducted over a special ACC I/O bus. There are two versions of the bCX1. One uses Infinet protocol and the other communicates over standard MS/TP BACnet.
- 20. TAC8 Multi-User Configuration The Andover Continuum system design is based on scalability, so expansion to a multi- user, larger network configuration is easily accomplished. The following figure below shows such a configuration. In this configuration, the Ethernet LAN is expanded to include another workstation and an SQL database server. Network Controllers There are several types of Andover Continuum network controllers: • Infinity CX 9000 series • NetController II 96xx series • NetController CX 94xx series • 9702 Site Controller • BACnet b4920 Gateway/Controller • bCX1 series All are Ethernet TCP/IP compatible. The first four contain at least one Infinet port to allow communication with Infinet application controllers. The b4920 includes one MS/TP network for communicating with b3xxx BACnet controllers.
- 21. Andover Continuum CyberStation Configurator’s Guide 9 The Infinity CX9XXX series are connected to individual IOU modules via an RS-485 cabling arrangement referred to as "LBUS". The NetController, NetController II, and 9702 Site Controller are powerful CPUs with flash EPROM providing the central network management functions for Andover Continuum building automation system. These network controllers can be connected to individual IOU modules via a different RE-485 protocol called ACC-LON. The 9702 Site Controller includes the equivalent of a NetController, a power supply, and an AC-1 access controller in one small package. The bCX1 is a series of Infinet and Native BACnet routers and controller/ routers. The Infinet devices (96xx) function as Ethernet-to-Infinet field bus routers. The BACnet devices (40x0) function as BACnet/IP-to-MS/TP field bus routers Infinet Controllers These controllers include combinations of inputs and outputs for the monitoring and control of local sensors and devices. There is a wide variety of Infinet controllers; each device is designed for a specific purpose. Infinet controllers are connected to network controllers via the Infinet network. BACnet Controllers These controllers include combinations of inputs and outputs for the monitoring and control of local sensors and devices. They are equivalent in function to the Infinet i2 series controllers mentioned above. BACnet controllers are connected to a bCX1 or b4920 controller/gateway via the Master- Slave/Token Passing (MS/TP) network. Workstations A personal computer (PC) connected to the Continuum Ethernet network runs the CyberStation software and database. The system can contain a single workstation or multiple workstations, depending on the site configuration. Networks The Infinet is Andover Continuum’s high-performance, token-passing LAN that allows Infinet application controllers to communicate with each other and to a single network controller. With repeaters, it is possible to have 127 Infinet controllers on one Infinet network The LBUS is the cable that connects IOU modules to a CX network controller or via the LA-1 (see Table 1-1) to a NetController or NetController II. Only one LBUS can be connected to a CX network controller. Each LBUS can handle up to 16 IOUs. The BACnet MS/TP network is an RS-485 based industry standard LAN that allows BACnet b3 controllers to communicate with each other and to a single b4920 or bCX1. It is possible to have 127 Infinet controllers on one MS/TP network. NetController I/O Modules NetController I/O modules are specialized units that receive sensor inputs and activate equipment (valves, fans, door locks, and so on) and perform access control functions.
- 22. TAC10 The I/O modules, available in several configurations including input, output, mixed I/O, and display are listed in the following table. Type Module Function UI-8-10 and UI- 10-10V Universal Input Module DI-6 AC and DI-6 AC HV AC Digital Input Module DI-8 Digital Input Module DM-20 Digital Input/Output Module (for DIO-20) Input MI-6 MilliAmp Input Module AO-4-8 Analog Output Module AO-4-8-O Analog Output Module with override DO-4-R Relay Output Module DO-4-R-O Relay Output Module with override DO-6-TR Triac Output Module LO-2 Lighting Output Module Output LO-2-O Lighting Output Module with override AC-1 Door, Access Control AC-1A Door, Access Control AC-1 Plus Door, Access Control Access Control VS-8-4 Video Switch Module LB-8 8-Channel LED Bar Display/w 8 Push buttons LS-8 8-Channel, 3-Digit 7-Segment LED Display/w 16 Buttons LC-1 2-Line LCD Display/w 12 Push Buttons Display VM-1 Voice Record and Playback Module (requires LC-1 Module) VT-1 Voice module for use with touch-tone telephonesMiscellaneous LA-1 Allows use of LBUS IOUs with a NetController or NetController II
- 23. Andover Continuum CyberStation Configurator’s Guide 11 Controller Expansion Modules Expansion modules extend the I/O capability of certain i2, BACnet, and bCX1 controllers. Type Expansion Module Function xPUI4 4-Channel Universal Input Module xPBD4 * 4-Channel Universal Input and 4-Channel Digital Output Module Universal xPBA4 * 4-Channel Universal Input and 4-Channel Analog Output Module Input xPDI8 8-Channel Digital Input Module xPAO2 2-Channel Analog Output Module xPAO4 4-Channel Analog Output Module xPDO2 2-Channel Relay Output Module Output xPD04 4-Channel Relay Output Module xP Display Internal Mounted Keypad/Display Module (920 only) Display xP Remote Display Externally Mounted Keypad/Display Module *These modules expand the I/O of bCX1 series controllers only.
- 24. TAC12 CyberStation You use CyberStation software to configure, monitor and control the Andover Continuum and Infinity hardware. CyberStation has a collection of tools and applications that work together to help you create and interface with all the objects in the system. The figure below illustrates some of them.
- 25. Andover Continuum CyberStation Configurator’s Guide 13 Creation Tools Editors Every type of object has its own editor. An editor is a software tool that allows you to create an object of a specific type. Each object type is known as an object class. You can also use editors to change object settings, such as the value of an output object. Templates Templates are objects that are used to create other objects. Templates look like editors that have been pre-configured with most or all of the information required to rapidly create multiple instances of the same object class. To create a new object, copy the template, and change or add information as needed. Configuration Wizard The Configuration Wizard allows you to create and edit CyberStation templates. It presents a tab for each template subfolder contained in the template folder. Clicking on a tab displays a listing of all the templates available in the subfolder. CyberStation Online Help Online help topics cover all CyberStation object class editors (including BACnet object class editors) and all major CyberStation features. Reference information on the Plain English IDE programming environment, including a Plain English keyword reference, is also provided. Help buttons, located in the CyberStation user interface — editors, dialogs, live views, and so on — open help topics related to the CyberStation editor or feature in which you are working. You can also press the F1 key to bring up related help. For more information about online help, please see: Accessing the Online Help System, Chapter 2. Programming Tools Plain English Plain English is the programming language you or your programmer will use to write functions and programs that can automatically initiate and respond to activity in your building control system. You can also use the Plain English program to automate routine tasks, such as generating reports. The language is easy to use because its keywords are common, easy to understand words. The Plain English Editor also makes programming easy by reducing most of the typing to mouse clicks. Command Line The command line is a simple text field interface that allows you to directly enter, via the keyboard, Plain English commands. The command is executed immediately after entry. This tool is handy for trying commands before committing them to your program. You can also review and use a running history of the commands you entered. Message Window The Message Window allows you to view the results of your Plain English programs as CyberStation processes them.
- 26. TAC14 Monitoring Tools Continuum Explorer The Continuum Explorer is your main access window into CyberStation. It is similar to the standard Windows explorer, and displays all the objects on your system in a hierarchical view. This allows you to see the relationship between objects. The Continuum Explorer also provides access to all the object editors. Menu Pages Menu pages are the graphic screens you will see after logging into CyberStation. Menu pages help you navigate to, as well as monitor, certain objects. These screens contain "hot spots" that you can click to move to another screen or to open an application. Menu pages also display a status bar that shows the most recent alarm. The status bar includes an icon that provides access to the Active Alarm View. Graphic Panels Using a sophisticated Graphic Panel editor, you can create colorful screen-based graphics that simulate control panels, floor plans, and automated warnings or alerts. These panels can then become primary interfaces for your end users. Active Event Views, Groups, and ListViews These are all objects that you create for the purpose of monitoring other objects. Starting CyberStation Use the following procedure to start CyberStation: 1. Click the Start button in your task bar. 2. Select Programs. 3. Select Continuum in the list of programs, and then click Continuum in the program list. The CyberStation splash screen and the main menu appear along with the following dialog: 4. Enter your User Name and password. 5. Click OK.
- 27. Andover Continuum CyberStation Configurator’s Guide 15 Your administrator usually assigns authorizations to access the CyberStation software. For unassigned users there is a default user name and password. Note: Once you start CyberStation, you can create a Windows shortcut to open CyberStation from your desktop by clicking on the Continuum icon: Closing CyberStation Use the following procedure to shut down CyberStation: 1. Right-click the Continuum icon in the taskbar at the lower right-hand corner of your screen. 2. Select Exit from the popup menu: 3. When prompted to confirm that you want to close the application, click Yes. 4. If prompted to add a comment, enter a comment in the Comment field, and then enter your user name and password.
- 28. TAC16 5. Click the OK button, and wait for all CyberStation processes to terminate. If you do not wait for all processes to finish you risk losing system information.
- 29. Andover Continuum CyberStation Configurator’s Guide 17 Menu Pages This chapter describes the features of the CyberStation user interface and explains how to use screen elements, such as “hot spots” and popup menus, to access information in CyberStation. This chapter also describes how to customize CyberStation menu pages to meet your requirements. The CyberStation Main Menu The CyberStation Main Menu, shown on the next page, contains the following features: • Title Bar - Shows the title for the current menu page. • Menu Area - Covers the entire region in between the title bar and status line. • Main Menu Links or “Hot Spots” – Displays menu selections for major features (Graphics, Schedules, Groups, and so on) along the left side of the window. • Status Line - Displays information including user name, workstation name, current date and time, error messages, and prompts. • Alarm Bar - Displays text that describes an active alarm condition. 2
- 30. TAC18 All CyberStation menu pages share the same basic features as the Main Menu described above. Selecting Items on the Main Menu There are two ways to select items from the CyberStation Main Menu: • Hot spots • Popup menus Hot Spot Links Hot spots are selectable areas of a menu page. Clicking on the hot spot: • Moves you to another menu page. • Launches a CyberStation application, such as Schedules or Listviews. • Runs a program. • Creates new objects. Hot spots may look like buttons clearly marked by text or icons, or they may simply be objects, such as doors, boilers, or controllers, that are part of the overall graphic. You will always know that a hot spot exists if the cursor arrow changes to the hand symbol. Shortcut Popup Menu You can also select certain items from the Main Menu using a popup menu: Title Bar Alarm Bar Status Line Menu Area Continuum Tooltray and Icons “Hotspot” Menu Links
- 31. Andover Continuum CyberStation Configurator’s Guide 19 1. Move the cursor to any part of the menu area that is not a hotspot. 2. Right click to display the popup menu. 3. Select Change Page and then the item you want to open from the dropdown list. For example: Tool Tray Items CyberStation-related icons appear in the lower right-hand corner of the Windows task bar, known as the tool tray: Placing the cursor over each of these icons displays a message indicating the status of the item represented by the icon. Right click the icon to bring up a popup menu for each item. The SQL Server Icon The SQL server icon appears only on a machine that is also functioning as the MSDE Server. Right click the icon to display a menu that allows you to start and stop the SQL server from CyberStation and determine whether it starts automatically with the OS Note: The SQL Server Service Manager menu is usually restricted, and used only by the system administrator. Do not stop the SQL server without first consulting your administrator. Distribution Server Icon When you make changes to CyberStation objects, CyberStation immediately sends the new configuration information to the controllers. This process is referred to as distribution and is performed by the CyberStation distribution server. The CyberStation distribution server handles moves, copies, deletes, creating objects from templates and any other actions occurring between a workstation and a controller. The distribution server icon in the tool tray provides feedback about the current status of the distribution server.
- 32. TAC20 When the distribution server is active, the icon animates to indicate the activity. Connecting lines appear between the document and the controller, and a red dot animates along the connecting lines. For more detailed information, double click the icon (or right click) and select Properties from the icon’s popup menu to display a Distribution Properties dialog. This dialog provides detailed information about the status of the server and the currently running operation. Note: The Distribution View button in the Distribution Properties dialog launches a powerful tool, the Access Distribution View, which allows you to monitor distribution-event transactions and perform an immediate distribution of a personnel record. (See Chapter 20, Managing Personnel Distribution.) Workstation Status Icon The Workstation Status Icon indicates whether the CyberStation workstation is online or offline: • When the workstation is online, CyberStation is communicating with controllers and other devices in the network. The workstation is typically online when CyberStation is running. • When the workstation is offline, CyberStation does not send or receive messages form the network. Changes that you make to CyberStation objects while the workstation is offline are not sent to the controllers until you change the workstation status to online. Double click or right click the icon to change the workstation status. Continuum Icon Right click the Continuum icon to display a popup menu with several options: • Advanced CyberStation functions • Access to online help and software version numbers • Logoff and Logon options • Exit option to close CyberStation Alarm Icon You can double click the Alarm icon to bring up the Active Alarm View:
- 33. Andover Continuum CyberStation Configurator’s Guide 21 You can also access the Active Alarm View from the popup menu for this icon. Alarm Bar Selectable Items When an alarm condition occurs, and the Active Alarm View is in the status line mode, text describing the alarm appears in the white status box in the alarm bar. To respond to the alarm, you click the appropriate icon in the bar for the action you wish to perform: • Acknowledge • View a graphic panel • View report • Silence (mute) an audio alarm • Execute a user-defined Plain English function for the alarm. • Bring up the surveillance video monitor (the VideoLayout editor) when a point goes into an alarm. This is the VideoLayout object attached to the point for this alarm. (See Chapter 25, Configuring and Viewing Video.) • Display the AlarmEnrollment or EventEnrollment editor associated with the selected alarm. See the section, Active Alarm View, in Chapter 10 for complete details on the Active Alarm View modes: view mode and status line mode.
- 34. TAC22 Accessing the Online Help System Within CyberStation, an extensive online help system is readily accessible. From the CyberStation Main Menu, you may access the Help system in two ways: • Press the F1 key as instructed in the status line. • Right-click the Continuum icon in the tool tray, and select How Do I from the popup menu. Either method opens the online help and displays the home screen: The CyberStation editors, live views, and other major dialogs have a Help button. Click the Help button (or press the F1 key) to display help topics related to the feature in which you are working. To learn how to use all the features of the online help system, click the Contents tab in the Help navigation pane, and then click the topic, How to Use this Online Help, as shown below:
- 35. Andover Continuum CyberStation Configurator’s Guide 23 When you access the online help system for the first time, please read the topic entitled, How to Use this Online Help. The help system has a navigation pane and a viewing pane. The navigation pane has a Contents tab, as well as an Index tab with a text search engine. Though the CyberStation online help system contains some task-oriented “how to” information, the help topics, by design, are closely aligned with the user-interface attributes of CyberStation editors, dialogs, and other features that display Help buttons. Menu Page Selections The CyberStation main menu is a list of hotspots that you can select to display another menu page. Each page provides specific capabilities for annotating and controlling your building automation system. Graphics Click the hot spot to display a listview of all graphics files on the system. These graphics files contain Pinpoint panels, which are described in detail in Chapter 26.
- 36. TAC24 Each entry lists the name of the graphic object, its alias, and the ownership of the object, as indicated by file path. Double click an entry to open the selected object in the Graphics editor. Schedules Click the hot spot to display a listview of all schedules system. Click an entry to open the selected schedule in the Schedule editor. Refer to Chapter 15 for a detailed discussion of Schedules. Groups Click the hot spot to display a listview of all groups on the system. Click an entry to open the selected group in the Group editor. Refer to Chapter 22 for a detailed discussion of Groups. Listviews Click the hot spot to display the Listviews menu page:
- 37. Andover Continuum CyberStation Configurator’s Guide 25 Within this menu page many hot spots are arranged in five categories. Clicking on a hot button produces a listview of the selected object. Under Alarms you can request a list of all alarms on the system, as well as the alarm activity for various time intervals. You can also create a list of all unacknowledged alarms and view alarm acknowledgements. The User Activity hot buttons each produce a listview of user activity on the system for a particular time frame. The User Logons hot buttons provide selections for the day, week, or month that create a listview of all user logons to CyberStation. Each entry indicates the time of logon, where the logon occurred (NodeName) and the name used (UserName) to logon with.
- 38. TAC26 The Access Events hot buttons display listviews of access event activity on the system for a particular time frame. Valid and Invalid Access can also be reported by day, week, or month. The Invalid Access Listview provides a time stamp, event type, door, a person ID, card number, and message for each invalid event occurring on the system. See also Chapter 23, Creating Listviews and Chapter 11, Configuring Reports.
- 39. Andover Continuum CyberStation Configurator’s Guide 27 Personnel Click the hot spot to display the Personnel menu page. An example of the listview associated with the All Personnel hot spot is shown below. The hot spots under the Prompted Lists heading let you search for a Personnel object by entering a card number, a department number, a last name, a driver's license, or a Social Security number. Explorer Click the hot spot to open Continuum Explorer.
- 40. TAC28 Continuum Explorer is where you work with all the objects on your CyberStation system. From Continuum Explorer, you can open object editors, create new objects, open Listviews and schedules, launch graphics panels and view the properties of objects. See Chapter 3 for detailed information about working in Continuum Explorer. System & Status Click the hot spot to display the System & Status menu page.
- 41. Andover Continuum CyberStation Configurator’s Guide 29 Command Line Click the hot spot to display the Command Line. The Command Line is where you enter Plain English statements for carrying out CyberStation system tasks. For example, you can run a report, print the values of system variables, or change input setpoints by typing the appropriate keywords for these actions at the Command Line. The Command Line consists of a title bar, a button to expand the Command Line, a button to open the explorer, an area in which to type commands, and a message window in which messages and printed values display. This is where you type Plain English Statements. This title bar displays the current path to the controller you are working on This button opens the Continuum Explorer navigation tree. This is where print requests and messages display. This button expands the Command Line to a scrollable window The title bar contains the path to the controller or device the Command Line is connected to. To hide or display the title bar, right click it, and select Title Bar from the popup menu. To view messages that are too long for the Command Line window, you can either resize the command line, or place your cursor anywhere in the message text to display a pop up view of the entire message. Plain English Editor Click the hot spot to open the Plain English editor. You use the Plain English editor to write, edit, and debug your Plain English programs. Refer to the online help for more information about Plain English and the Plain English editor. You can also refer to the Plain English Language Reference Guide, 30-3001-872 Message Window Click the hot spot to display brings up the Continuum Message Window.
- 42. TAC30 The Continuum Message Window displays system messages and the results of print requests generated from within programs. Graphics Editor Click the hot spot to display the Pinpoint graphics editor. Pinpoint, the CyberStation graphics application program, allows you to produce dynamic virtual control panels on your workstation. Refer to Chapter 26 for complete details on the use of Pinpoint. Configuration Editor Click the hot spot to display the Configuration Wizard. The Configuration Wizard is a tool for using CyberStation templates. Templates are predefined objects that you can drag and drop into container objects to create new objects with the same attributes. The Configuration Wizard displays the templates that are stored in the template folder. Each subfolder in the template folder creates a tab in the Wizard. The Miscellaneous tab is created by the template folder itself. Refer to Chapter 12 for a full discussion on templates.
- 43. Andover Continuum CyberStation Configurator’s Guide 31 Communication Status, Point Status and System Messages The hot spots appearing along the bottom half of the System and Status page display listviews that report the status of system components and objects as well as all error messages. Communication Status The hot spots listed under Communication Status open listviews that indicate the communication status (on-line or off-line) of the system controllers and IOU modules. An example of the listview of IOU Modules is shown below. Point Status Under the Point Status heading, listviews are available for points. An example of the listview for Doors is shown below. System Messages Under System Messages, hot spots link to error message listviews for the day, week and month.
- 44. TAC32 Windows Applications The Windows Applications hot spot provides direct access to Windows applications. Click a hot spot to open the corresponding Windows program. Configuring New Menu Pages As you configure your CyberStation system, you may want to create new menu pages and add hot spots to them. For example, you may want to create a menu page of all the building control objects that you need to access and create hot spots for each of them. Creating a New Menu Page 1. In the CyberStation Main Menu page, place your cursor anywhere that is not a hot spot. 2. Right click to display the popup menu, and click Edit. On the Main Menu page, dashed lines appear around the existing hot spots, like the one shown below: The Edit toolbar of options also appears.
- 45. Andover Continuum CyberStation Configurator’s Guide 33 3. Click the icon in the Edit toolbar. The current menu page changes to a blank page and the Page Edit dialog appears: Page Information Enter a Name and a Description for the page. Users see the name you entered when they click Change Page in the shortcut menu and is the name that Change Page hot spots refer to. Name can be up to 132 characters (including spaces). Select the Main Page checkbox if you want the page you are creating to be the first page the user sees. Create a New Page Save Run Help
- 46. TAC34 Background File The typical graphic file for a menu page has some sort of background or theme that represents the purpose of the menu page and objects or text that can serve as hot spots. A Main Page graphic might also include the corporate image of your company. Insert the name of a graphic file for the menu page into the Background File field: Use the button to browse for a .bmp file. The default path for menu page files is wherever CyberStation was installed, in the UserProfile folder. Select the file you want to use, and click the Open button. Audio To add audio to the new menu page, proceed as follows: 1. In the File to Play field, click the button to browse for an audio file that plays whenever users move to this page. 2. Locate and select the audio (.wav) file that you want to use, and then click the Open button. 3. Select the Enable checkbox to enable the audio file. 4. Select the Use MS MPlayer checkbox to use Microsoft’s Media Player. If your workstations use another type of media player, clear this checkbox. If you check the Use MS MPlayer box, a second checkbox appears, Show MPlayer. Check this box if you want the Microsoft Media Player to display on the screen: Video To add video to the new menu page, proceed as follows: 1. In the File to Play field, click the button to browse for a video file that plays whenever users move to this page. 2. Locate and select the video (.avi) file name, and click the Open button. 3. Check the Enable checkbox to enable the video file. 4. Check the Full Screen checkbox if you want the video to be the size of the monitor screen. To have the video display in a window, clear this checkbox. Save and Run 1. Click OK to close the Page Edit dialog. 2. Save your changes by clicking the icon in the Edit toolbar. 3. Click the icon in the Edit toolbar, or display the shortcut menu and click Run. You are now ready to add hot spots to the page you created.
- 47. Andover Continuum CyberStation Configurator’s Guide 35 Creating a Hot Spot to Run a Windows Program To create a hot spot on the new menu page, perform the following steps. 1. Place your cursor anywhere that is not a hot spot, right click, and select Edit from the popup menu. 2. Use your cursor to draw a rectangle around the area of the graphic or text that you want to be the hot spot. Define a big enough hot spot so users can easily click it. 3. Place the cursor anywhere inside the dashed lines surrounding the hot spot just created. 4. Right click, and then select Properties to display the Edit HotSpot dialog: 5. Select the Execute radio button. 6. Click the browse button in the Open field. 7. Locate and select an executable program file. For example, to open Excel you need to locate and select the executable file for Microsoft Excel on your workstation. 8. Click the Open button. 9. Check the Make hotspot look like a window button checkbox. 10. Enter a title for the button (for example “Excel”) in the Button field. Creating a Change Page Hot Spot You can create a hot spot that will send you to another menu page. For example, if you create a new menu page, you might like to have a hot spot on the main menu that takes you to it. 1. Place your curser anywhere that is not a hot spot, right click, and select Edit from the popup menu.
- 48. TAC36 2. Use your curser to draw a rectangle around the area of the graphic or text that you want to be the hot spot. Define a big enough hot spot so users can easily click it. 3. Place the curser anywhere inside the dashed lines surrounding the hot spot just created. 4. Right click, and then select Properties to display the Edit HotSpot dialog: 5. Select the Change Page radio button. 6. From the dropdown menu for the Open field, select the name of the new menu page. 7. Check the Make hotspot look like a window button checkbox. 8. Enter a title for the button in the Button field. 9. Click OK. 10. Click the Save icon in the Edit toolbar. 11. Click the Run icon in the Edit toolbar The button should now appear on the menu page. Selecting it takes you to new menu page. Button Wizard The Button Wizard is another method for creating buttons on menu pages. You can create buttons to: • Edit an existing object • Create a new object • Open an existing object • Create a new object from an existing template object The following procedure described how to use the Button Wizard to create a button that opens a CyberStation object in the appropriate object editor. 1. Create a hot spot as previously described under Creating a Hotspot as a Windows Button. 2. Right click inside the Hot Spot rectangle and select Button Wizard from the popup menu. You are presented with the following menu.
- 49. Andover Continuum CyberStation Configurator’s Guide 37 3. Select Open an existing object, and click Next. 4. Select I would like to select an object to open, and click Next.
- 50. TAC38 5. From the dropdown menu, select the class of object to attach to the new button, and click Next. 6. Using the browse button, select a location for the object, select whether users can browse to other locations to locate the objects, and click Next. 7. Enter a HotSpot name and description. 8. To display the hotspot as a button, check the checkbox and enter the text you want displayed on the button. 9. Click the Finish button. The button should now appear on the menu page and selecting it will open the selected object (in the above example, a listview).
- 51. Andover Continuum CyberStation Configurator’s Guide 39 Continuum Explorer Continuum Explorer is a tool that allows you to work with all the objects in your Andover Continuum system. It displays the controllers, inputs, outputs, and workstations and is the main environment in which you configure your system. From Explorer, you can open object editors, create new objects, open listviews and schedules, launch graphics panels, and view the properties of objects. Objects in Continuum Explorer Andover Continuum control system software is based on object-oriented programming principles. Objects and classes are the basic building blocks of the Continuum system. All the items that make up the system, both the hardware and the software, are identified as objects. Each item appearing in a Continuum Explorer screen represents an object. Objects are organized in classes. For example, devices, points, personnel records, areas, graphics, doors, schedules, and programs are all examples of object classes. Some object classes, known as containers, can “own” other objects. Container Objects and Object Ownership Container objects and object ownership are terms that describe the relationships between objects in the Andover Continuum system. Container Objects Objects in CyberStation are arranged in a hierarchy. The Root object is always the prime object at the top of the hierarchy. Objects at the top of the hierarchy contain, or own the objects beneath them. Networks, Devices, InfinityControllers, InfinityInfinetControllers, BACnet Controllers and Folders are examples of Continuum container objects. Objects that are not container objects cannot own any other objects. Object Ownership Object ownership refers to the physical network connection between devices and to where the objects are stored within the network. 3
- 52. TAC40 For example, if an input point called Rm Temp 1 was attached to a CX 9XXX controller named CX1 which is connected to the Ethernet network called Building 1, you have the following object hierarchy: the network object (Bldg1) owns the attached device object (controller CX1) which owns the input point object (Rm Temp1). These relationships are shown below. Class Icons Each class has a default icon associated with it so that you can easily identify the object class. Icons can represent a hardware object (for example, a controller or a workstation) or a software object, such as a schedule. The following table shows all the default object- class icons. Note: In the following table, an asterisk (*) denotes an object class that may include or be limited to BACnet objects. Refer to Chapter 14 for more information on BACnet and BACnet icons. Icon Object Class AlarmEnrollment AnalogInput * AnalogOutput * AnalogValue * Network Bldg1 Root Input Point Rm Temp1 Controller CX1
- 53. Andover Continuum CyberStation Configurator’s Guide 41 Icon Object Class Area BinaryInput * BinaryOutput * BinaryValue * Calendar * ControllerUser CommPort DateTime Device (Andover Continuum b4/b3 controller) * Device (third-party BACnet controller) * Device (Andover Continuum workstation) * Device (third-party workstation) * Door EventEnrollment * EventView EventNotification * (equivalent to BACnet NotificationClass object) File * Filter
- 54. TAC42 Icon Object Class Folder (Continuum/Infinity) Folder (BACnet) Folder (Continuum/Infinity default class) Folder (BACnet default class) Function Graphics Group InfinityController InfinityInfinetCtlr InfinityInfinetCtlr (Infinity 2 only) InfinityDateTime InfinityFunction InfinityInput InfinityOutput InfinityNumeric InfinityProgram InfinityString
- 55. Andover Continuum CyberStation Configurator’s Guide 43 Icon Object Class InfinitySystemVariable IOUModule Listview Loop * MultistateInput * MultistateOutput * MultistateValue * Network (Continuum/Infinity) Network (BACnet) * NetworkDialup Personnel Program * Report Schedule * SecurityLevel String TrendLog *
- 56. TAC44 Icon Object Class User VideoLayout VideoServer Object Names and Object Aliases Each object in CyberStation has two identifiers, a name and an alias. An object name can be lengthy and descriptive. Although an object name and alias can be the same, an object alias must conform to stricter naming conventions. Object Names Descriptive object names help other users identify what the object is. For example, if you are creating an output point for operating fans, you might want to enter a name like Fan Start/Stop. The name can be up to 128 characters long, and can include spaces, underscores, dashes, slashes, and periods. An object name is stored in the CyberStation database, but not at the controller. Object Aliases The alias is the name of the object used in programs and functions. CyberStation creates the alias version of an object name for you as you type the object name when creating a new object. The alias is saved to the controller. The alias is also saved in the CyberStation database. Alias Naming Conventions An object alias can be up to 16 characters, and can use only alphanumeric (letters and numbers) characters, periods, and underscores. Aliases must start with a letter, and have no spaces. They also cannot be reserved words, or keywords, which are words that have a designated use in CyberStation or in the Plain English programming language.
- 57. Andover Continuum CyberStation Configurator’s Guide 45 Starting Continuum Explorer On left-hand side of the Main Menu (Chapter 2) click the hot spot. The Explorer includes the following elements: • Title bar - indicates the path of the selected object, or the name of the selected device or folder. • Dropdown Menus – contains menus for Explorer tasks. • Quick Picks toolbar • Popup menus • Command scroll box - always shows the path of the last selected object or the name of the selected device or folder. Clicking the down arrow of the scroll bar presents a history of all previous selections of objects, devices and folders. • Explorer Window – divided into the two main viewing areas: navigation pane and viewing pane. • Status bar - indicates Explorer’s activity, either in the idle state (Ready) or displaying an active state. In the right-hand corner, indicates the number of objects appearing in the viewing pane, and the number selected. Title Bar Dropdown Menus Quick Picks Status Bar Navigation Pane Viewing Pane Command Scroll Box Explorer Window
- 58. TAC46 Dropdown Menus Object Menu The following table describes the selections in the Object dropdown menu, shown below. The number of selections that appears in the dropdown menu varies according to the object selected. Object menu options are also available from popup menus when you right click an object. Selection Purpose Open Opens the editor dialog corresponding to the first object that appears in the viewing pane by default. If you select another object, the dialog that corresponds to that object appears. Edit Opens the editor dialog corresponding to the first object that appears in the viewing pane by default. If you select another object, the dialog that corresponds to that object appears. Explore Opens another session of Continuum Explorer. View Depending on what item is selected – a controller, default object class folder, object, and so on – clicking View may do one of two things: • Open a listview. • Display submenu selections: History, Graph, and Report. The History and Graph submenus provide a LogView history. In these cases, you may chose a time range for the history log by specifying the range in the Time Range for History dialog that appears. Selecting Report brings up the Report editor, from which you may create, configure, and view a graphical or text report in the ReportViewer. (See Chapter 11, Reports and the Report Editor.) Import Into Causes the Open dialog to appear. You can select an ASCII dump file from which to import object settings Find New BACnet Devices Searches the network for BACnet devices that have not been declared. The new devices then appear automatically on the Explorer. Backup to Infinet2 Flash Saves the Infinet 2 controller's RAM configuration to its flash memory, in accordance with the attribute value that is set for the ACCRestartMode system variable. When you click this button, a Confirm Operation dialog appears.
- 59. Andover Continuum CyberStation Configurator’s Guide 47 Selection Purpose Backup BACnet Device Backs up configuration information (stored in a special File object called ACCConfiguration) for a single BACnet controller, or multiple controllers, and saves it to your CyberStation database, for BACnet devices that support Backup/Restore (See Chapter 21, Managing Configuration Files.) Restore BACnet Device Restores configuration information from your database to one or more BACnet controllers, for BACnet devices that support Backup/Restore. (See Chapter 21, Managing Configuration Files.) Distribute Personnel Sends all Personnel objects to a selected controller. Send To When you click this menu item the following submenu items appear: Text File: Opens the Save As dialog. Use the Save As dialog to save Continuum Explorer data in the desired location. Printer: This option is disabled in this version of Continuum Explorer. Controller: Appears whenever a controller icon is highlighted in the Explorer. Used in conjunction with the Send to Controller Options selection in the Options menu to reload the controller. Database: Used in conjunction with the Send to Database Options selection in the Options menu to reload the database. New Displays a submenu of object classes. Use this menu selection to create new objects. Delete Deletes the selected object and all its container objects including all references and links to the database. It is a nonrecoverable operation. A Confirm Operation dialog appears as a warning. Click OK or Cancel. Rename Opens the Rename dialog so that you can rename the selected object. Page Setup Sets up paper size and margins for the print commands. Print Prints the viewing pane of Continuum Explorer on the default printer. The printout dimensions depend on the default printer settings. Properties Displays the Properties dialog for the currently selected object. Exit Closes Continuum Explorer.
- 60. TAC48 Edit Menu Selection Purpose Select All Selects all the objects currently displayed in the viewing pane. Select None Clears the selection of all objects in the viewing pane. Inverse Selection Reverses whatever the last selection was. For example, if you selected A, B, and C, but left D unselected, inverse selection causes D to be the only selection. View Menu Selection Purpose Toolbar Displays or hides the Quick Picks toolbar. Status Bar Displays or hides the Status Bar. Explorer Bar Provides four different ways to view the Andover Continuum system. (See Explorer Views, later in this chapter.) Class Folders Displays class folders in the viewing pane. Show TAC BACnet Device As Provides three different ways to view an Andover Continuum BACnet device. (See “Viewing Options” in Chapter 14.) Objects Displays objects in the viewing pane. Hide Out Of Services Devices Allows you to hide out-of-service BACnet device objects on the Explorer tree. (Refer to “Hiding Out of Service Devices” in Chapter 14.) Icon Displays graphic images that represent a file, folder, subfolder, command, or object. Small Icons Displays small icons in the viewing pane. List Alphabetizes objects vertically rather than horizontally in the viewing pane. Details Displays attributes in columns in the viewing pane – that is, name, alias, owner, and so on. Up One Level Moves the cursor one level higher in the tree hierarchy in the left pane. Stop Halts user-initiated list building in the viewing pane. Refresh Updates the content in the Explorer window to display newly added, deleted, or modified objects. Refresh All Updates the content in the Explorer window to display all the latest data.
- 61. Andover Continuum CyberStation Configurator’s Guide 49 Selection Purpose Configuration Wizard Opens the Configuration Wizard dialog. You use the Configuration Wizard to create objects from templates. Options Menu Selection Purpose Copy Options Opens the General tab of the Copy Options dialog. Import Into Options Opens the Import Into Options dialog. Send to Text File Options Opens the Send To Text File Options dialog. Send To Controller Options Opens the Send To Controller Options dialog. Send To Database Options Opens the Send To Database Options dialog. Copy Options Dialog Continuum Explorer makes it easy to copy objects among containers. You can use copy and paste from the Edit menu, or you can drag objects from one container to another. The Copy Options dialog helps you control how and when objects can be copied in Continuum Explorer. Note: After copying an object, ensure that the name and alias have changed. If the name or alias has not changed, manually change the name or alias, as required. The Copy Options dialog has the tabs described in the following table. Tab Name Description General Allows you to select Source Container and Source Object options. For more information about container and child objects, see Container Objects and Object Ownership earlier in this chapter. Name Conflicts Allows you to decided what CyberStation does when it detects objects that have the same name in the source and target containers. Class Filter Allows you to select how to copy source objects. You can copy all, include only certain classes, or exclude certain classes selected from a scroll-down list. Import Into Options Dialog Continuum Explorer allows you to set various skip, merge, replace, and area link options, when you import CyberStation object data from ASCII dump files and importing from CSV files. The Import Into Options dialog is displayed when you select the Import Into option from a menu in Continuum Explorer. The following table describes selections on the Import Into Options dialog.
- 62. TAC50 Skip, Merge, and Replace Options Skip source objects with name conflicts. Click this radio button to stop the import operation for an object when the name of the source file object and the name of the target object are the same. Merge target objects with name conflicts if the source object is of the same class, otherwise skip the source object. Click this radio button to merge the source file object with the target object, if the source and target objects are of the same object class. If the source and target objects are of different classes, stop the import operation for the object. Merge target objects with name conflicts if the source object is of the same class, otherwise replace the source object. Click this radio button to merge the source file object with the target object, if the source and target objects are of the same object class. If the source and target objects are of different classes, overwrite the source object with the target object. Replace target objects with name conflicts. Click this radio button to replace the target object with the source file object, when the names of the source object and target object are the same. Area Link Options Overwrite existing area links Click this radio button to overwrite the area links (Assigned areas) in the personnel target object with the area links in the personnel source file object. Append imported area links to existing area links. Click this radio button to add the personnel source file object's area links to the area links of the personnel target object. Replace the area links from the personnel’s parent template, but leave all other area links unchanged. Click this radio button to replace the area links in the parent template of a personnel objec with the source file area links, and append (or "import") these template links to the target object, leaving all the other target- object links unchanged. The target object then has its own links plus the links from the updated template. All personnel objects that were created from this parent template are also refreshed to represent the changed parent template.
- 63. Andover Continuum CyberStation Configurator’s Guide 51 Checkbox Distribute personnel during an ASCII import. Check this checkbox to ensure the information that is newly imported into the CyberStation database is distributed to all the controllers that are affected by the modified Personnel objects. Send to Text File Options Continuum Explorer allows you to set various source-object options and text-file options when you when you export CyberStation object data to ASCII dump files. The Send to Text File Options dialog is displayed when you select the Export to option from a Continuum Explorer menu. The following table describes selections on the Send to Text File Options dialog. Source Object Options Do not dump child objects. Click this radio button to export the data for the selected object, but not the child objects -- that is, not the objects contained within the controllers belonging to the parent object in the device hierarchy. Dump child objects, but do not dump the children's children. Click this radio button to export the data for the selected object, as well as all child objects – that is, all objects contained within the controllers belonging to the parent object in the device hierarchy, but do not export the child objects within the controllers contained beneath those "child controllers" in the device hierarchy. Dump child objects and the children's children. Click this radio button to export a parent object and everything beneath it. That is, this operation exports the parent object, all objects contained within controllers belonging to the parent object, plus all objects within the controllers contained beneath those "child controllers" in the device hierarchy. Text File Options Overwrite the file if it already exists. Click this radio button to overwrite the data in the target text file with the data from the parent source object. Append to file if it already exists. Click this radio button to add the data from the parent source object to the data in the target text file.
- 64. TAC52 Checkbox Dump pictures to separate files. Check this checkbox to export the graphics in the source object into separate bitmap graphics files. This operation results in one text file for object data, plus individual graphics files for the pictures. Send To Controller Options Continuum Explorer allows you to set source-object options when you perform "send-to- controller" operations – that is, when you update an object in the CyberStation database and need to distribute or "reload" the updated data to controllers that need to know about the updates. You can initiate send-to-controller operations from the Send To Controller selection in the popup menu displayed when you right click a container object. The following table describes selections in the Send To Controller Options dialog: Source Object Options Do not reload attached objects. Click this radio button to reload the controller, but not to reload the data from the attached objects. If this is used on a CX series Infinity controller, only the import/export table is reloaded. Reload attached objects, but not attached controllers. Click this radio button to reload the newly updated object data in the affected controllers, but not to reload the child objects belonging to the controllers contained within this parent (attached) object in the device hierarchy. Reload attached objects and controllers. Click this radio button to reload the newly updated object data in the affected controllers, and also reload the data objects belonging to the controllers contained within this parent (attached) object in the device hierarchy.
- 65. Andover Continuum CyberStation Configurator’s Guide 53 Send To Database Options Continuum Explorer allows you to set source-object options when you perform "send-to- database" operations. A send-to-database operation is needed if you have directly updated an object in a controller from a command terminal and need to notify system administrators that these updates must be synchronized with the CyberStation database. You initiate Send-to-database operations from the Send To Database selection in the popup menu displayed when you right click a container object. The following table describes selections in the Send To Database Options dialog: Source Object Options Do not save attached objects. Click this radio button to save the controller data to the CyberStation database, not to save data from attached objects. Save attached objects, but not attached controllers. Click this radio button to save the data in the object that you have just directly updated in a controller from the command terminal, but not to save the child objects belonging to the controllers contained in this parent (attached) object in the device hierarchy. Save attached objects and controllers. Click this radio button to save, the data in the object that you have just directly updated in a controller from the command terminal, and also to save the child objects belonging to the controllers contained in this parent (attached) object in the device hierarchy. CAUTION: Complete the following steps to ensure that the Send to Database operation is successful for controllers residing on a bCX1 40x0 controller for a field bus network. "Learn" a bCX1 40x0 Controller before Sending to Database — Before performing a routine Send to Database operation on a bCX1 40x0 series controller, you must first perform a "learn" operation by clicking the Learn button on the Settings tab of the Comm Port editor. (See Chapter 8.) This ensures that the bCX1 40x0 first knows about the existence of its BACnet field bus controllers (b3 and third-party controllers). After the learn, the Send to Database fetches object information from all controllers residing on the field bus subnetwork and saves it to the CyberStation database. Before performing the Send to Database operation, make sure you have also selected the Save attached objects and controllers radio button.
- 66. TAC54 Help Menu Selection Purpose Contents Opens help topics for Continuum Explorer. (You may also press the F1 key.) About Continuum Explorer Displays the CyberStation software version and copyright information. Quick Picks Toolbar Button Description Explorer bar. When you click the downward arrow to the right of the Explorer bar, a dropdown menu lists the Explorer bar viewing options. See “Using the Explorer Bars.” View Class Folders. For additional information, see “Understanding Object Classes.” View Objects. For additional information, see “Understanding Object Classes.” Stops current process. Refreshes, or updates, both panes with newly added, deleted, or modified objects. Moves the cursor one level higher in the tree hierarchy in the left pane. Changes the views you see in the Continuum Explorer viewing pane. For additional information, see “Working with the Viewing Pane.” Opens the Configuration Wizard. Prints the viewing (right) pane of the Continuum Explorer on the default printer. The dimensions depend on the default printer settings. Command Scroll Box The Command scroll box always shows the path of the last selected object. Clicking the scroll bar lists paths of all previously selected objects.
- 67. Andover Continuum CyberStation Configurator’s Guide 55 Popup Menus Throughout CyberStation, in the Continuum Explorer and in almost all CyberStation applications, right clicking displays a popup menu a popup menu. Popup menus may interchangeably be referred to as shortcut menus. The selection appearing in bold text in a popup menu is called the default verb for that object. When you double click an object in the Continuum Explorer or in a browse field, the action that takes place depends on the default verb for that object. Continuum Explorer Window The Continuum Explorer window is divided into two panes where objects appear: • The navigation pane on the left • The viewing pane on the right. Navigation Pane The navigation pane is a tree structure hierarchical representation of the root object and the objects connected to it. The first icon (the infinity symbol) that appears in the list is the root object. Below the root object are device and folder objects. A plus sign (+) indicates that the object contains sub objects. Click the plus sign and the object icon opens, displaying its contents. In the above figure, the Network folder object is expanded, indicated by the fact that the + sign has been replaced by a minus sign (-). The Infinity 1 controller icon is displayed. When the + sign for the controller was clicked, the folder objects below it appeared. Click the minus sign (-) to collapse a list of objects or folders.
- 68. TAC56 Viewing Pane Use the viewing pane to view the contents of objects selected in the navigation pane and to find details about the objects you are viewing. Selecting How Objects Will Be Displayed You can use the viewing pane to display objects in four different ways by making selections from the Views drop down menu, or by clicking the Views icon in the Quick Picks toolbar until the desired view appears. Option Description Example Icon Displays large icons in the viewing pane Small Icon Displays small icons in the viewing pane List Displays objects in a list in the viewing pane Details Displays details of objects in the viewing pane
- 69. Andover Continuum CyberStation Configurator’s Guide 57 Details Options The Details option provides the following information about CyberStation objects: Column Description Name Name of the object. DeviceID or Owner Identification of the attached folder or device. Alias The name used to identify the object in programs and functions. When referring to an object, whether in a path or a program, always use the object alias. Type The object class or type. Last Change The date and time the object was last modified. Changing the Width of Details View Columns Place the cursor on a vertical line that separates two columns at the top of the Details View window: When the cursor changes to look like this ,drag column boundaries to the left or right. Class Folders or Objects Use the class folder and object buttons in the Quick Picks toolbar to select how the viewing pane displays objects. You can display the class folders or the objects in the class folders. The picture on the left represents the class folder image of the objects pictured on the right.
- 70. TAC58 Explorer Views Continuum Explorer allows you to view your system in five different ways: All Paths, Networks, Folders, Templates, and BACnet View. To change views, click the down arrow attached to the Explorer quick picks icon . All Paths View This is the default view for Continuum Explorer. It displays all elements in the Andover Continuum system, including all devices, networks, folders, and templates. The Root appears at the top of the navigation panel with all linked objects below it. The contents of any object selected in the navigation pane appear in the viewing pane.
- 71. Andover Continuum CyberStation Configurator’s Guide 59 Networks View The Networks view shows the objects in your system in the viewing pane in relation to physical hardware (workstations, controllers, and connected peripheral devices) that contains them in the navigation pane. Folders View The Folders view shows folders, subfolders and class folders in the navigation pane. Folders, class folders, and objects are shown in the viewing pane. The Folders view organizes objects in your system independent of their physical connection to each other. For example, suppose you have an Infinity Input point named Room Temperature 1 attached to a controller named CX1 and you want to create a folder named Chiller Plant that contains all the objects having to do with cooling systems in a building. In Folder view, you place the CX1 controller in the Chiller Plant folder. (See the following figure.)
- 72. TAC60 In contrast to the Folders view, the Network view shows the objects in relation to their physical arrangement in the network. The figure below shows the comparison between the two views back to the root object. This arrangement is possible because CyberStation allows every object to have two owners, an attached network device and a folder owner. In the figure, the input point Room Temperature 1 has two owners: Chiller Plant Folder and Attached Device CX1. The folder owner is optional. Root Root Network Building 1 Folder Owner Chiller Plant Attached Device CX1 Infinity Input Room Temperature 1 Folder View Network View
- 73. Andover Continuum CyberStation Configurator’s Guide 61 Class Folders CyberStation keeps track of the objects you create by storing them in class folders. Every time you create a new object on a device, CyberStation either stores it in an existing class folder, or, if the object is the first instance of a class, CyberStation creates the appropriate class folder for you. The picture below shows a device and all the class folders that it owns: Templates View The Templates view displays the templates that are available in the CyberStation system. The templates (Chapter 12) appear as folders and subfolders in the navigation pane. In the viewing pane the templates are represented as folders and object icons. BACnet View In the BACnet view, only BACnet objects and devices are displayed. (Refer to Chapter 14.) For example:
- 74. TAC62 Creating Objects Here are some points to keep in mind before you create your first object: • CyberStation automatically creates the appropriate class folders as you create your objects and stores the objects in the applicable views. • You can store objects in more than one view at the same time. • You may use either the navigation pane of Continuum Explorer or the New dialog to navigate to the device that you want to attach. Most objects must be attached to (stored in) a device such as a controller or workstation. The exceptions are: Areas Folders Personnel AlarmEnrollments Graphics Security Levels Event Views Groups Templates EventNotifications List Views Users Creating a New Object Perform the following steps to create a new object: 1. In the Continuum Explorer, select the Network or All Paths view. 2. Select the object to which you want to attach the new object. See the table on the following page for a container object listing. 3. Right click the object or select New in the Object menu to display a pop up list of object classes. 4. Select the object class of the object you want to create. For example, select InfinityNumeric to create an InfinityNumeric point object. 5. The New dialog appears, with the object type you selected displayed in the Objects of type field. The following figure shows an InfinityNumeric object. 6. In the New dialog, enter the Object name field.
- 75. Andover Continuum CyberStation Configurator’s Guide 63 CyberStation fills in the Alias field, but you can change it. 7. Click Create to enter the editor of the object you are creating. The following table lists the CyberStation objects that can be owned by container objects. … Can Be Owned by this Container This Object… Network Infinity Controller Infinity Infinet Controller Andover Continuum Workstation Infinity Folder BACnet Device * BACnet (Network) Folder ** AlarmEnrollment No No No Yes Yes No No AnalogInput No No No Yes No Yes No AnalogOutput No No No Yes No Yes No AnalogValue No No No Yes No Yes No Area No No No Yes Yes No No BinaryInput No No No Yes Yes Yes No BinaryOutput No No No Yes Yes Yes No BinaryValue No No No Yes Yes Yes No Calendar No No No No No Yes No CommPort Yes Yes No No No No No ControllerUser No Yes No No Yes No No DateTime No No No Yes Yes No No Device * No No No No No Yes Yes Door No Yes Yes Yes Yes No No EventEnrollment No Yes (b4/b3 only) No No No Yes No EventNotification No Yes (b4/b3 only) No Yes Yes Yes No EventView No No No No Yes No No File No Yes Yes No No Yes No Filter No No No No Yes No No Folder No No No No Yes No No Function No No No Yes Yes No No Graphics No Yes Yes Yes Yes Yes No Group No Yes Yes Yes Yes Yes No InfinityController Yes No No No Yes No No InfinityDateTime No Yes Yes No Yes No No InfinityFunction No Yes Yes No Yes No No InfinityInfinetCtlr No Yes No No Yes No No InfinityInput No Yes Yes No Yes No No
- 76. TAC64 … Can Be Owned by this Container This Object… Network Infinity Controller Infinity Infinet Controller Andover Continuum Workstation Infinity Folder BACnet Device * BACnet (Network) Folder ** InfinityNumeric No Yes Yes No Yes No No InfinityOutput No Yes Yes No Yes No No InfinityProgram No Yes Yes No Yes No No InfinityString No Yes Yes No Yes No No InfinitySystem Variable No Yes Yes No Yes No No IOUModule No Yes No No* Yes No No Listview No Yes Yes Yes Yes Yes No Loop No Yes Yes No Yes No No MultistateInput No No No Yes Yes Yes No MultistateOutput No No No Yes Yes Yes No MultistateValue No No No Yes Yes Yes No Network No No No No Yes No No NetworkDialup No No No Yes Yes No No Personnel No No No No Yes No No Program No Yes Yes Yes Yes Yes No Report No Yes Yes Yes Yes No No Schedule * No Yes Yes Yes Yes Yes No SecurityLevel No No No No Yes No No String No No No Yes Yes No No TrendLog No Yes Yes No Yes Yes No User No No No No Yes No No VideoLayout No No No No Yes No No VideoServer No No No No Yes No No *Note: A Device is a BACnet object, viewed in the BACnet Devices portion of the Continuum Explorer. A BACnet Device object can be one of the following: Andover Continuum b4 or b3 controller device, third-party device, third-party workstation. Although Andover Continuum workstations are BACnet devices, they appear at the Root, not in the BACnet Devices network. Also, a Schedule object may or may not be owned by a third-party device, depending on whether the device supports Schedule. **Note: A BACnet folder is a folder designated as a “network,” viewed in the BACnet Devices portion of the Continuum Explorer.
- 77. Andover Continuum CyberStation Configurator’s Guide 65 Importing from ASCII Dump Files Importing from ASCII dump files is a process you can use to: • Update or reload CyberStation objects with previously backed-up data. • Create new objects. You can update or create one CyberStation object from each ASCII file. You may also set options for performing operations. See, Import Into Options Dialog earlier in this chapter. Updating and Reloading Objects from ASCII Files To update and reload data from ASCII files into existing CyberStation objects: 1. Right click the object that you want to update or reload. 2. From the popup menu, or from the Object dropdown menu, select Import Into. 3. In the Open dialog, locate and select the .DMP file that contains the back-up data for the object you want to reload, and 4. Click Open. If your workstation is set up to confirm reloads, you'll see a confirmation dialog. 5. Click OK to start reloading the object. If your workstation has been set up to monitor object loads, you will see a dialog that will show you the load progress, as well as any errors that occur. Creating Objects from ASCII Files To create a CyberStation object from an ASCII file: 1. In the ASCII file, ensure that you specified the appropriate attribute values, such as Name, Alias, Owner, Device ID, and Description for the object you want to create, and then save and close the file. 2. Right click the container where you want to store the new object, and select Import Into... from the popup menu. 3. In the Open dialog, select the DMP files (*.DMP) you want to use and click Open. If your workstation is set up to confirm load operations, you see a confirmation dialog. 4. Click OK to start loading the object. If your workstation is set up to monitor object loads, you see a dialog that will show you the load progress, as well as any errors that occur.
- 78. TAC66 Exporting Object Data to ASCII Dump Files Exporting data to ASCII dump files is a process by which all the information about an object is sent to a text file. To export data to an ASCII dump file for a CyberStation object: 1. From the Continuum Explorer, right click the object that you would like to export, and select Send to... and then select Text File. Note: If you right click an object that contains other objects, you will be exporting data for all the contained objects as well as the object on which you clicked. See also Send To Text File Options Dialog, earlier in this chapter, for export options involving an object's children and children's children. 2. In the Save As dialog, navigate to the folder that will store the file, and enter the name of the dump file, including a .DMP extension, in the File name field. 3. Click Save. If your workstation is set up to confirm for ASCII dumps, a confirmation dialog appears. 4. Click OK. If your workstation is set up to monitor ASCII dumps, you will see a dialog that will show you how the dump is progressing, as well as any errors that might occur. Importing from CSV Files Importing from CSV files is a process you can use to: • Update or reload objects. • Update existing objects. This feature allows the creation or update of one or more objects from a text file containing an object class name and a list of object attributes, one row per object. All attributes and attribute values are separated by commas. CSV files are especially useful for creating and loading Personnel objects for access control applications. A single CSV file may include a list of Personnel records, each row containing, for example, Last Name, First Name, Middle Initial, a template object name, photo file name, card number, and so on. You may also set options for performing import operations. See: Import Into Options Dialog earlier in this chapter.
- 79. Andover Continuum CyberStation Configurator’s Guide 67 Creating CSV Files for CyberStation To create CyberStation objects from a CSV file, the file must contain an object class name, a list of object attributes, and one row for each object. The first line specifies the class name of the objects to be imported. The second line, called the Attribute Definition Line (ADL), defines the attributes to be imported by name. The third and successive rows contain the objects themselves, called Attribute Value Lines (AVL), using the ADL as a template for what order the attributes are in. You can create and edit CSV files in a text editor or a spreadsheet program. An example of a CSV import file viewed through a text editor is as follows: If you create or edit a CSV file with Microsoft Excel, you must open the CSV file with a text editor and remove all of the extra commas in the object class lines and at the end of any lines throughout the file that have extra commas at the end. Object Class Attribute Definition Line Attribute Value Lines Extra commas
- 80. TAC68 Updating and Reloading Objects from CSV Files To update and reload existing CyberStation objects from CSV files: 1. Right click the object that you want to update or reload, and select Import Into… from the popup menu. 2. In the Open dialog, select CSV Files (*.CSV) from the Files of type dropdown menu. 3. Locate and select the CSV file that you want to use, and then click Open. If your workstation is set up to confirm load operations, you see a confirmation dialog. 4. Click OK to start reloading the object. If your workstation is set up to monitor object loads, you'll see a dialog that will show you the load progress, as well as any errors that occur. Creating Objects from CSV Files To create CyberStation objects from a CSV file: 1. Open the container object (root, folder, device or controller) that will contain the object you are going to create, and right click the opened container object. 2. Select Import Into... from the popup menu. 3. In the Open dialog, select CSV Files (*.CSV) from the Files of type dropdown menu. 4. Locate and select the CSV file that you want to use, and then click Open. If your workstation is set up to confirm load operations, you see a confirmation dialog. 5. Click OK to start loading the object. If your workstation is set up to monitor object loads, you see a monitor dialog that will show you the load progress, as well as any errors that occur. Updating or Creating Personnel Objects from CSV Files The CSV import of personnel objects follows the same format as that of other objects, except that there are three optional lines that can be added. The format includes the following additional CSV keyword lines: AutoNumber – This optional line automatically assigns CardType, SiteCode(for Non- ABA) and CardNumber for every personnel object imported. You can overwrite this auto- assignment for particular personnel by including CardType, SiteCode(For Non-ABA), and CardNumber in the attribute definition line and put non-empty values in the attribute value line. If no value is specified in a line, auto-assignment will take place. This overwrite feature is useful when you want to change a personnel’s cardnumber with the Key line presented and set to non-CardNumber. Key – This optional line tries to resolve each attribute value line (personnel or user) by using the unique key or keys specified in the key line. With this line, you can specify the attribute list that uniquely identifies personnel. Examples of Key lines are as follows:
- 81. Andover Continuum CyberStation Configurator’s Guide 69 • Key,firstname,lastname • Key,socsecno • Key,name • Key,alias • Key,cardnumber,sitecode,cardtype • Key,name,socsecno Note: Key must not be an attribute in any class. All attributes in the Key Definition Line (KDL) must also be in the Attribute Definition Line (ADL). Option – This line has two options available, as follows: • NoPhotoUpdate – This option does not update the personnel photo file. • NoCardNumberCheck – This option does not check CardNumber duplication. This will speed up personnel CSV import. Without this option, CSV import always check CardNumber duplication. The CSV import file format for personnel objects is as follows: • ClassName • AutoNumber,CardType,SiteCode,BeginCardNumber • Key,attribute1,attribute2,… • Option,NoPhotoUpdate • Attribute Definition Line • Attribute Value Lines
- 82. TAC70 CyberStation Object Editors CyberStation object editors are dialogs you use for creating or modifying objects. Each class of CyberStation object has its own editor. Each editor shows the class name, object name, and path in the title bar. Opening an Object Editor When you create an new object (described on the previous page) the object editor automatically appears on the CyberStation screen. Use one of the following methods to open an editor for an object that already exists in Continuum Explorer. • Double click the object in Continuum Explorer. • Right click the object, and select Edit from the popup menu that appears. Using CyberStation Object Editors Each editor has a series of tabs containing text fields, buttons, and dropdown menus that you use to define or modify an object. You enter text in the fields, make choices by clicking buttons, and select from lists of possibilities. The bottom of the dialog consists of five buttons: OK, Cancel, Apply, Refresh and Help: Button Purpose OK Save changes and exit the editor. Cancel Exit the editor without saving changes. Apply Apply and save changes without exiting the editor. Refresh Update to current values. Help Open online help topics for the object editor. Access Security Rules in Continuum Explorer The objects that appear in both the navigation and viewing panes of Continuum Explorer are determined by the user's security level settings for view access, as described below. The navigation and viewing panes do not display objects to which the user does not have view access. If users do not have view access to all the objects within a class folder, the folder does not appear in the navigation path. For example, if a controller appears in the navigation pane, and the user does not have view access to the InfinityNumeric objects for that controller, no InfinityNumeric class folder appears in the tree path beneath the controller. Note: You cannot browse to individual objects for which you have view access if the objects are contained within a class folder that you cannot access. Multiple Path Lists The security action "Multiple path lists" is included in the ListView class of the Security menu. (Refer to Chapter 4.)
- 83. Andover Continuum CyberStation Configurator’s Guide 71 Use this menu to determine whether or not a user has the ability to create listview objects with a path type that shows objects for more than one path. This action should be used with the view access (above) to restrict users from seeing objects to which they do not have access.
- 84. TAC72
- 85. Andover Continuum CyberStation Configurator’s Guide 73 Security Security groups and SecurityLevel objects are two CyberStation tools that you use to determine the access privileges of CyberStation users. • Security groups enable you to define the access privileges needed by different types of CyberStation users. You can then assign users to appropriate security groups. Access privileges that you define for object classes in the Security editor apply to all objects in that class (for example, all doors, all personnel). • SecurityLevel objects are CyberStation objects that you attach to other CyberStation objects or to containers. You use SecurityLevel objects if you want to further restrict security group access to individual objects, or to actions, such as deleting or editing, that may be taken with the individual objects. You attach a SecurityLevel object to each CyberStation container or object that you want to be controlled by those privileges. Access privileges that you define in the SecurityLevel editor for SecurityLevel objects apply only to the individual objects or containers that you attach them to. They do not apply to other objects in the same object class. For more information, see SecurityLevel Editor. Security Groups A security group is a category of CyberStation privileges for using editors and applications. Typically, a system administrator sets up security groups defined by certain access privileges and then assigns users to security groups in accordance with their needs. The security groups are configured to allow or deny the user access to Continuum objects. Security groups might include the following examples: • Administrator ⎯ allowed access to all Continuum applications • Security Guard ⎯ allowed full access to doors, areas, and personnel data but limited to view only access to everything else. • HVAC Technician ⎯ allowed access to all HVAC related objects, but denied access to everything else. 4
- 86. TAC74 Setting up CyberStation security groups has three major steps: 1. Configure security groups that allow or deny access to CyberStation object classes and actions. 2. Create a user object for each person who will be allowed access to a CyberStation workstation. 3. Assign users to the appropriate security groups for the access each user requires. This chapter explains the process of configuring the security groups. This chapter also describes how to create SecurityLevel objects and use them with security groups to further customize CyberStation security. See Chapter 5 to create user objects and assign them to security groups. Configuring User Security Groups You use the Security editor to configure security groups. To access the Security editor, proceed as follows: 1. Right click the Continuum icon in your tooltray. 2. Select Security from the popup menu. This displays the Security editor. Displaying Security Groups CyberStation provides 1024 security groups for which you can assign access privileges. By default, the first 128 groups are displayed. You can display the additional groups as needed in multiples of 128 (256, 384, 512, and so on) up to 1024. Note: If you reduce the number of displayed security groups, users assigned to groups that are no longer displayed lose all access to CyberStation. Be sure to assign all users to security groups that are currently displayed. Security groups that are not displayed retain their settings and user assignments. If you later display these security groups, the settings in these groups will apply to any users assigned to them. 1. In the Group Names tab, select a value from the dropdown list for Number of Security Groups. 2. Click the Change button. If you select a smaller number of groups, you are prompted to confirm the change. Click Yes to continue. 3. Click Apply or OK. Renaming Security Groups By default, the security group names are Group 01 through Group 1024. You can rename the groups that you use, if you wish. 1. In the Group Names tab, use the vertical scroll bar to locate the security group name that you want to change. 2. Double click the group name, enter a new name, and press the Enter key.
- 87. Andover Continuum CyberStation Configurator’s Guide 75 3. Repeat steps 1 and 2 to rename other security groups as needed. 4. Click Apply or OK. Displaying Access Privileges in the Actions Tab 1. Select the Actions tab. 2. Expand a folder to display the object classes or tasks (actions) within that folder. Expand an object class to display the actions and editor tabs for that object class. For example, expand the Area class to display the actions for Area objects and the list of tabs in the Area editor. Security groups are displayed to the right of the action or the tab name. The icon used to identify each group indicates whether the group has access privileges for it: • The Lock icon indicates that the users in the security group do not have access privileges; that is, the action or tab is locked for this security group. • The Key icon indicates that the users in the security group have access privileges; that is, the action or tab is unlocked for this security group. Position your cursor over an icon to display the name of the security group and the action or editor tab it represents. Group names are defined in the Group Names tab. You can edit the names as needed, and also select the number of security groups that are displayed. Assigning Access Privileges for Security Groups Use this procedure to assign or remove access privileges for security groups.
- 88. TAC76 You can also assign and remove privileges by copying access settings to other security groups and by importing security groups. For more information, see Copying Security Groups and Importing and Exporting Security Groups later in this chapter. Note: When you remove access privileges to view an object class for a security group, users in that group do not see that object in Continuum Explorer. If the objects are contained within a class folder, the class folder is not displayed when any of these users are logged into CyberStation. For example, if a user belongs to a security group that does not have access privileges to view Personnel objects, Personnel objects and the Personnel class folder are not displayed in Continuum Explorer when this user is logged into CyberStation. 1. Expand a view or folder. To assign access privileges to object classes, expand the Classes folder, and then expand an object class. A list of actions is displayed. If you expanded an object class, a list of the tab names in that object editor is displayed after the actions. Use the vertical scroll bar to locate the action for which you would like to assign access privileges. In addition to actions specific to that object class, if any, the following actions are listed for most object classes: Change Out of Service — Users belonging to security groups with this privilege can enable and disable objects of this class. Create —Users belonging to security groups with this privilege can create objects of this class. Delete —Users belonging to security groups with this privilege can delete objects of this class. Edit —Users belonging to security groups with this privilege can open the editors of objects of this class, and modify object values in the editor. View — Users belonging to security groups with this privilege can open the editors of objects of this class, but cannot modify any values unless they also have Edit privileges. These users will also be able to view the class folder for any objects for which they have view access (provided the users also have access to Continuum Explorer). Send To Text File — Users belonging to security groups with this privilege can import and export object data to text files. 2. Assign or remove access privileges. If you want to . . . Then . . . assign an access privilege for an action or an editor tab to a security group In the row that contains the action or tab name, click the Lock icon for the security group that you want to have the privileges. The Key icon is now displayed for this security group, indicating that the group has access to the action or tab.
- 89. Andover Continuum CyberStation Configurator’s Guide 77 If you want to . . . Then . . . remove an access privilege for an action or an editor tab from a security group In the row that contains the action or tab name, click the Key icon for the security group where you want to remove the privileges. The Lock icon is now displayed for this security group, indicating that the group does not have access to the action or tab. assign access privileges to all actions within a view, object class, or folder Right click the view, object class, or folder, and select Unlock Actions from the popup menu. In the Unlock Actions for Groups dialog, select the checkbox next to each security group that you want to have access, and click OK. The Key icon is now displayed for the selected security groups, indicating that the groups have access to all the actions (and editor tabs) in the view, object class, or folder. remove access privileges to all actions within a view, object class, or folder Right click the view, object class, or folder, and select Lock Actions from the popup menu. In the Lock Actions for Groups dialog, select the checkbox next to each security group that you do not want to have access, and click OK. The Lock icon is now displayed for the selected security groups, indicating that the groups do not have access to any of the actions (and editor tabs) in the view, object class, or folder. 3. Click OK. Copying Access Privileges Between Security Groups Use this procedure to copy the access privileges assigned to one security group to another security group. This is useful when you want to define privileges for a security group that are only slightly different from another security group. When you paste the copied access privileges to the destination security group, the privileges for all actions in all folders are replaced with the new privileges. You can then assign or remove privileges as needed. 1. In the Actions tab, expand a view or folder. 2. If needed, use the horizontal scroll bar to display the icon for the security group whose access privileges you want to copy. 3. Right click the security group, and select Copy Group from the popup menu.
- 90. TAC78 4. If needed, use the horizontal scroll bar to display the icon for the security group where you want to paste the access privileges. 5. Right click the security group where you want to paste the privileges, and select Paste Group from the popup menu. 6. Assign or remove privileges as needed for the security group where you copied the access privileges. 7. Click Apply or OK. Exporting and Importing Security Groups CyberStation provides backup and restore capabilities for the security group settings with its export and import features. These features export and import security group settings using dump files with the security dump file extension (.SDF). The export feature exports the access privileges for all security groups. The import feature imports the access privileges from a security dump file that you select. You can import access privileges for all security groups or for a selected security group. Exporting Security Groups Use the following procedure to export access privileges for all security groups. 1. In the Actions tab, right click anywhere under Action or Locks, and select Export All from the popup menu.
- 91. Andover Continuum CyberStation Configurator’s Guide 79 2. In the Save As dialog, enter a filename, and click the Save button to create the .SDF file. Importing One Security Group Use this procedure to import the access privileges for a selected security group from a security dump file (.SDF). 1. In the Actions tab, expand a view or folder, and right click the security group for which you want to import access privileges. 2. Select Import Group from the popup menu. 3. In the Open dialog, select the file containing the security group settings you want to import, and click the Open button. Note: Importing access privileges overwrites the previous access privileges for the security group. Ensure that you have imported the access privileges that you want to use before clicking Apply to save them in the Security editor. 4. Click Apply or OK to save the access privileges for the selected security group. Importing All Security Groups Use this procedure to import the access privileges for all security groups from a security dump file (.SDF). 1. In the Actions tab, right click anywhere under Action or any white space, and select Import All from the popup menu. 2. In the Open dialog, select the SDF file that contains the security group privileges that you want to import, and click the Open button.
- 92. TAC80 Note: Importing all security group privileges overwrites the previous access privileges for the security groups. Ensure that you have imported the access privileges that you want to use before clicking Apply to save them in the Security editor. 3. Click Apply or OK save the security groups settings. Configuring Object-Level Security Use the SecurityLevel editor to define the security group access privileges in a SecurityLevel object. You can create multiple SecurityLevel objects, each with customized access privileges. You then attach a SecurityLevel object to individual CyberStation objects or containers. Each of these is then accessible to users only as defined in the SecurityLevel object attached to it. If you attach a SecurityLevel object to a container, such as a folder, all objects stored in the folder are accessible as defined in the SecurityLevel object. This customized security is known as object-level security, and it works with the access privileges defined in security groups. In the Security editor, you set up security groups and assign access privileges to those groups. These access privileges are defined for object classes rather than individual containers or objects. Object-level security further refines those access privileges by controlling access to individual containers or objects to which SecurityLevel objects are attached. Note: Object-level security can be more restricted than the access privileges defined in the Security editor for security groups; it cannot be less restricted. For example, if users in a security group can edit Personnel objects, a SecurityLevel object attached to selected Personnel objects can prevent the users from editing those objects. However, the reverse is not permitted in CyberStation: if users in a security group are prevented from editing Personnel objects, a SecurityLevel object with editing of Personnel objects unlocked does not allow the users to edit Personnel objects to which the SecurityLevel object is attached. When user-level and object- level privileges differ for the same object class and action, CyberStation uses the more restricted setting. Creating a SecurityLevel Object Note: You cannot delete or move SecurityLevel objects. In Continuum Explorer, they must reside in Root. 1. In Continuum Explorer, right click Root. 2. Select New, and then select SecurityLevel from the popup menu. 3. Enter a name for the object, and click Open. 4. The SecurityLevel editor is displayed. You define access privileges for the SecurityLevel object in the Security tab of this editor. Displaying Access Privileges in the Security Tab Expand Classes to display the object classes. Expand an object class to display the actions and editor tabs for that object class. For example, expand the Area class to display the actions for Area objects and the list of tabs in the Area editor.
- 93. Andover Continuum CyberStation Configurator’s Guide 81 Security groups are displayed to the right of the action or the tab name. The icon used to identify each group indicates whether the group has access privileges for it: • The Lock icon indicates that the users in the security group do not have access privileges; that is, the action or tab is locked for this security group. • The Key icon indicates that the users in the security group have access privileges; that is, the action or tab is unlocked for this security group. Position your cursor over an icon to display the name of the security group and the action or editor tab it represents. Group names are defined in the Group Names tab of the Security editor. Universal Unlock Folder Using the Universal Unlock folder, you can deny one or more user groups universal access and viewing privileges to all features of all objects to which the SecurityLevel object is attached. When you deny a security group access privileges (place a lock) in this folder, it overrides any other key (unlock) on any features throughout the system for that security group. It is a quick way to prevent access to every object to which the SecurityLevel object is attached for users in the security group. (Users are assigned to security groups in the Groups tab of the User editor.) When the universal lock is unlocked, all objects owned by a parent (folder or device) inherit the security level of the parent; security levels of each class are applied. To deny all access to any security group, lock the universal lock for that group. This simplifies the task of locking all access for a security group from a folder or a device. Assigning Access Privileges in a SecurityLevel Object Use this procedure to assign access privileges to security groups in a SecurityLevel object. 1. In the Security tab, expand the Classes folder, and then expand an object class. A list of actions is displayed, followed by a list of the tab names in that object editor. Use the vertical scroll bar to locate the action for which you would like to assign access privileges. In addition to actions specific to that object class, if any, the following actions are listed for most object classes: Change Out of Service — Users belonging to security groups with this privilege can enable and disable objects of this class. Create —Users belonging to security groups with this privilege can create objects of this class. Delete —Users belonging to security groups with this privilege can delete objects of this class. Edit —Users belonging to security groups with this privilege can open the editors of objects of this class, and modify object values in the editor.
- 94. TAC82 View — Users belonging to security groups with this privilege can open the editors of objects of this class, but cannot modify any values unless they also have Edit privileges. These users will also be able to view the class folder for any objects for which they have view access (provided the users also have access to Continuum Explorer). Send To Text File — Users belonging to security groups with this privilege can import and export object data to text files. 2. Assign or remove access privileges. If you want to . . . Then . . . assign an access privilege for an action or an editor tab to a security group In the row that contains the action or tab name, click the Lock icon for the security group that you want to have the privileges. The Key icon is now displayed for this security group, indicating that the group has access to the action or tab. remove an access privilege for an action or an editor tab from a security group In the row that contains the action or tab name, click the Key icon for the security group where you want to remove the privileges. The Lock icon is now displayed for this security group, indicating that the group does not have access to the action or tab. assign access privileges to all actions within a view, object class, or folder Right click the view, object class, or folder, and select Unlock Actions from the popup menu. In the Unlock Actions for Groups dialog, select the checkbox next to each security group that you want to have access, and click OK. The Key icon is now displayed for the selected security groups, indicating that the groups have access to all the actions (and editor tabs) in the view, object class, or folder. remove access privileges to all actions within a view, object class, or folder Right click the view, object class, or folder, and select Lock Actions from the popup menu. In the Lock Actions for Groups dialog, select the checkbox next to each security group that you do not want to have access, and click OK. The Lock icon is now displayed for the selected security groups, indicating that the groups do not have access to any of the actions (and editor tabs) in the view, object class, or folder.
- 95. Andover Continuum CyberStation Configurator’s Guide 83 3. Click OK. You attach a SecurityLevel object to individual CyberStation objects in the SecurityLevel tab in their respective object editors. For more information, see the help topics for SecurityLevel tabs in the editors. Copying Access Privileges from a Single Security Group to Another Group Use this procedure to copy the access privileges assigned to one security group to another security group. This is useful when you want to define privileges for a security group that are only slightly different from another security group. When you paste the copied access privileges to the destination security group, the privileges for all actions in all folders are replaced with the new privileges. You can then assign or remove privileges as needed. 1. In the Security tab, expand an object class. 2. If needed, use the horizontal scroll bar to display the icon for the security group whose access privileges you want to copy. 3. Right click the security group, and select Copy Group from the popup menu. 4. If needed, use the horizontal scroll bar to display the icon for the security group where you want to paste the access privileges. 5. Right click the security group where you want to paste the privileges, and select Paste Group from the popup menu. 6. Assign or remove privileges as needed for the security group where you copied the access privileges. 7. Click Apply or OK.
- 96. TAC84 Copying Access Privileges from the Security Editor Use this procedure to copy the access privileges for all security groups from the Security editor to a SecurityLevel object. You can paste the access privileges into a SecurityLevel object in the SecurityLevel editor and then edit the access privileges as needed for the object. Note: You can also copy access privileges from another SecurityLevel object and paste them into a different SecurityLevel object. 1. In the tool tray, right click the Continuum icon, and select Security from the popup menu. 2. In the Actions tab, right click any white space (not over text or icons), and select Copy All from the popup menu. 3. Click OK. 4. In Continuum Explorer, create or edit the SecurityLevel object where you want to paste the access privileges. 5. In the SecurityLevel editor, select the Security tab. 6. Right click any white space, and select Paste All from the popup menu. 7. Edit the access privileges as needed, and click Apply or OK. Viewing Objects Controlled by a SecurityLevel Object Use this procedure to view a list of the CyberStation objects to which a specific SecurityLevel object is assigned. 1. In Continuum Explorer, expand the SecurityLevel folder, and double click the SecurityLevel object you want to view. 2. In the SecurityLevel editor, select the Attached Objects tab. The list of objects to which this SecurityLevel object is attached is displayed.
- 97. Andover Continuum CyberStation Configurator’s Guide 85 Attaching a SecurityLevel Object to a Container or Object Only one SecurityLevel object can be attached to an object or container. You can also remove a SecurityLevel object from an object. 1. Open the object to which you want to attach a SecurityLevel object in its editor. 2. Select the SecurityLevel tab. 3. Select the SecurityLevel object you want to attach to this object. If you want to remove an attached SecurityLevel object without attaching another one, right click in the list of SecurityLevel objects, and select Clear Selection. 4. Click OK. Folder and Device Level Security Folder and device level (FDL) security allows you to apply a security level to a collection of child objects by placing them in a folder or device object (the parent) so that the child objects inherit the parent’s security level. Note: FDL security does not apply to Root, since Root is not treated as a folder by FDL. Attaching SecurityLevel Objects to Parent Objects and Folders Your CyberStation system can include thousands of objects that you want to be accessible only to the appropriate users. One efficient way to define access to these objects is to attach SecurityLevel objects to containers: parent objects and folders that can contain other objects. Child objects in the container inherit the access privileges defined in the SecurityLevel object attached to the container. Implementing security in this way is referred to as folder and device-level (FDL) security. For example, you can create a folder and place personnel, areas, doors, points, and programs into it and then attach a security level object to the folder that gives view access to one group of users, edit access to another group of users, and no access to a third group of users. You an also apply the same process to a network controller, an Infinet controller or a CyberStation workstation.
- 98. TAC86 Guidelines for Using FDL Security When you configure security at your site using FDL, consider the following factors: • Roles ⎯ categories to which a user can be assigned (Administration, Guard, Maintenance, and so on) • Partitions ⎯ division of site into physical areas (Building A, Building B, and so on) • Security Groups ⎯ the combination of roles and partitions (BldgAAdmin, BldgAGuard, BldgAMaint, and so on) The number of groups can be determined by the following formula: Number of groups = Number of roles X Number of partitions The use of these guidelines is illustrated in the following example. Example of Using FDL Security Consider the situation where you want to partition the security in a site that is located in two separate buildings. Using the above guidelines, proceed as follows: 1. Determine the roles of the users. This example uses three categories: • Administrators • Guards • Maintenance 2. Determine the partitions. This example uses two partitions: • BuildingA • BuildingB 3. Determine the number of security groups to configure: Number of roles x Number of partitions = Number of groups For example: 3 x 2 = 6 Security groups 4. Assign names to security groups in the Group Names tab of the Security editor: BldgAAdmin BldgBAdmin BldgAGuard BldgBGuard BldgAMain BldgBMain 5. In the Actions tab, select security privileges for each group. This should be role based. That is, all guards should have the same lock and key settings. The same should be true for the maintenance personnel. Administrators usually have keys to all objects and actions. 6. Create users, and assign each user to the appropriate group in the User editor. (See Chapter 5.) 7. In Continuum Explorer, create two folders named BuildingA and BuildingB.
- 99. Andover Continuum CyberStation Configurator’s Guide 87 8. Create a SecurityLevel object for each folder named BldgAAccess and BldgBAccess, and define access as shown in the following table. You can use the Universal Lock/Unlock feature in the SecurityLevel editor to quickly assign access privileges to the security groups. Folder Security Level Object Groups Allowed Access Groups Denied Access BuildingA BldgAAccess BldgAAdmin BldgAGuard BldgAMain BldgBAdmin BldgBGuard BldgBMain BuildingB BldgBAccess BldgBAdmin BldgBGuard BldgBMain BldgAAdmin BldgAGuard BldgAMain 9. Attach the SecurityLevel objects to the appropriate folders. 10. Place the objects associated with each building in the appropriate folders. User Limitations Users that do not have access privileges to certain folders/devices will not be able to access any objects contained in them. Pinpoint is the exception to this. Pinpoint will not hide controls based on FDL security. However, Pinpoint does prevent users from editing objects that they have no access to. The following table summarizes the effect of user access privileges with FDL security. Function User Limitations List Views The user will be able to see objects they don’t have access to, but will not be able to access them. Group Views The user will be able to see objects they don’t have access to, but will not be able to access them. Active Alarm View The user will be able to see objects they don’t have access to, but will not be able to access them. Event View The user will be able to see objects they don’t have access to, but will not be able to access them. Continuum Explorer The user will not see any object that the user doesn’t have view access to when using the Universal Lock. If the Universal Lock is unlocked, for a group and the view access of a device class or folder is locked, then the corresponding device/folder will not be viewable from explorer. If a security level object is set up to allow viewing the folder but not viewing any child class under it, attaching this security level object to a folder would not prevent child class objects from showing under that folder in Continuum Explorer. When users click a child class object however, an “access denied error” will show up. The use case of viewing a folder/device but not viewing children under that folder/device in Explorer is not supported in current FDL implementation.
- 100. TAC88 Function User Limitations Command Line The user cannot change the value of any object or attribute if they do not have change value level. Editors The user cannot edit any object that they do not have edit access to. This applies to all editors independently of where they are launched. web.Client All applications in web.Client will mirror the corresponding CyberStation security functionality. Pinpoint Pinpoint will not apply view FDL security to controls. All controls will always display. If the user does not have change value level, then they cannot modify values using in line controls. If they do not have edit access, then they are denied from launching object editors. If they do not have access to other graphics that are linked using buttons, then they will be denied access to the graphics when clicking the button.
- 101. Andover Continuum CyberStation Configurator’s Guide 89 18Configuring Users What Are Users? A user is a person who logs onto a CyberStation workstation on a command terminal to monitor and manage their building control system. Users have passwords that allow them access to CyberStation, and they have security levels that restrict the kinds of changes they can make, and actions they can take. User Object For every user in your company who is allowed access to your building control system, you must create a User object in CyberStation. User objects contain each user’s password and security group assignment. If you choose to you can also record personal information, such as the Social Security number and address, about each user. User objects are always created under the Root object. ControllerUser objects are created under the applicable NetController. ControllerUser cannot exist under Root. ControllerUser Object For every user in your company who is allowed access to a command terminal remotely connected to a NetController you must create a ControllerUser object in CyberStation. (See Creating a ControllerUser Object, later in this chapter.) Controller users are separate from CyberStation users. Controller objects have a direct relationship with the NetController they are connected to. Customizing the User Environment In CyberStation, you can customize each user’s environment by specifying the following: • Programs that start when the user logs in or out • A graphic panel to display when the user logs in • A menu-pages file to display when the user logs in • A report program to run when the user logs in Procedures for customizing the user’s environment begin below. 5
- 102. TAC90 Additionally, the CyberStation can be configured to implement the features that assist in satisfying the requirements of Part 11 of Title 21 of the Code of Federal Regulations entitled Electronic Records; Electronic Signatures (better known as 21 CFR 11). Procedures for setting features on the General Preferences and CFR Preferences dialogs to implement these features are presented later in this chapter. Before Configuring Users You’ll use the User editor to configure each user of your system. Before using the editor, you need to know the following information about the person to whom you are giving access to the system: • The user’s name. There are two name considerations: the name that is assigned to the User object that is created for the user and the Full Name that is entered in the User editor. The object name is the one that system recognizes. • The password this user will use when logging on to CyberStation. (It must be between 0 and 16 alphanumeric characters as determined by the General Preferences setting.) • What programs, reports, menu pages, or graphics panels you want to run when this User logs on. • The CyberStation User Security Group(s) that this user will be assigned to. In order to use the User editor, you must first create a User object. Creating a User Object Create a user object for each person who requires access to the CyberStation software. At a minimum, you specify the following information: • Object name, which is also the username the user enters to log on to CyberStation • Password, which is also required to log on • Security group or groups to which the user is assigned (See Chapter 4 for more information about security groups.) You can also enter personal information for the user. Perform the following steps to create a User object: 1. In Continuum Explorer, right click the Root. 2. Select New, and then select User from the popup menu. 3. In the New dialog, enter the username in the Object name field. CyberStation fills in the Alias field, but you can change it if needed. 4. Click the Create button. General Tab – User Editor In the General tab, you enter the user password. You can also enter personal information, such as the user’s full name and phone number.
- 103. Andover Continuum CyberStation Configurator’s Guide 91 Full Name Enter the user’s full name. You may use up to 32 characters, including spaces. The order of the first and last names is not important, but you should use the same format for all your users. Full Name is optional. Users must enter their user name, to log into CyberStation. For example, if you create a user object named jbrown for Jim Brown, Jim must enter jbrown and his password to log in. Password Enter the user’s password. The password must be between 0 and 16 alphanumeric characters, including underscores and periods. The password must start with a letter. For security, the characters you type are displayed as asterisk marks (*). A password is optional, but highly recommended. Social Security Enter the user’s Social Security number. You can use up to 11 characters, including dashes. This is optional. Address Enter up to 48 characters, including spaces, for the user’s address. This is optional. Office Phone # Enter the user’s office phone number. You can use any characters you need, such as dashes and parenthesis. This is optional. Home Phone # Enter the user’s home phone number. You can use any characters you need, such as dashes and parenthesis. This is optional. Employee # Enter the user’s employee number. You can use up to 32 characters, including spaces and dashes. The employee number can contain letters as well as numbers. This is optional. Title Enter the user’s job title. You can use up to 32 characters, including spaces. This is optional. Security Tab – User Editor In the Security tab, you can set up programs, reports, menu files, and graphic panels to run or display when this user logs on. These settings, in addition to access privileges defined in the security group(s) to which you assign each user, allow you to control the information users can view and change in CyberStation. Personnel Record Not implemented in this release. State Select either enabled or disabled from the dropdown menu. When a user object is disabled, the user will not be able to log in. If you disable a user while he/she is logged on, that user is automatically logged off. When a user object is enabled, the user will be able to log in.
- 104. TAC92 LogOn Program If you have a program that you would like to run every time the user logs on, click the browse button to locate and select it. This displays a Browse dialog to help you find the right file. When you have located the file you want, select it and click the Select button. This inserts the correct path and filename into the Logon Program text field. LogOff Program If you have a program that you would like to run every time the user logs off, click the browse button to locate and select it. This displays a Browse dialog to help you find the right file. When you have located the file you want, select it and click the Select button. This inserts the correct path and filename into the LogOff Program text field. Report If you have a report that you would like to run every time the user logs on, click the browse button to locate and select it. This displays a Browse dialog to help you find the right file. When you have located the file you want, select it and click the Select button. This inserts the correct path and filename into the Report text field. Menu File If you have a file containing customized CyberStation menu options that you would like to run every time the user logs on, click the browse button to locate and select it. This displays a Browse dialog to help you find the right file. When you have located the file you want, select it and click the Select button. This inserts the correct path and filename into the Menu File text field. Graphic If you have a graphic panel that you would like to display every time the user logs on, click the browse button to locate and select it. This displays a Browse dialog to help you find the right file. When you have located the file you want, select it and click the Select button. This inserts the correct path and filename into the Graphic text field. Inactivity Timer In this field, you enter the amount of time (in minutes) that no user activity occurs in CyberStation before the user is automatically logged off. All applications, such as the Continuum Explorer, the Plain English IDE, Pinpoint, and any object editor will be closed after the number of minutes. Note: Keyboard entry and mouse clicks are considered user activity. Hovering the mouse over any CyberStation application is not considered user activity. Enable Operator Text Prompt for changes When checked, a comment dialog appears whenever this user modified any objects, persistent settings, etc. This option is enabled by default when a user object is created.
- 105. Andover Continuum CyberStation Configurator’s Guide 93 Enable Operator Text Prompt for Alarm Acknowledgement When checked, a comment dialog appears whenever this user acknowledges an alarm.. This option is enabled by default when a user object is created. Groups Tab – User Editor In the Groups tab, you select the security groups that you want to assign the user. Security groups determine the objects this user can work with and the actions the user can perform with those objects. Users can belong to more than one security group. Click the checkbox for each security group to which this user will belong. To remove the user from a specific security group, click the checkbox to remove the check mark. CyberStation provides you with 1024 security groups. By default, these security groups are named Group 1 through Group 1024. You can rename security groups and specify object actions for each in the Security dialog. SecurityLevel Tab – User Editor For details in attaching or detaching SecurityLevel objects to CyberStation objects , see Chapter 4, Security.
- 106. TAC94 Setting up the General and CFR Preferences There are two separate preference menus that allow you to set up the user activity that satisfies the 21 CFR 11 requirements. Preferences for most requirements are included in the main release of CyberStation and are covered under the General Preferences section (below). The remaining CFR features, which the customer may choose to purchase, are covered under the CFR Preferences section, later in this chapter. General Preferences This section presents password management requirements and configuration of 21 CFR 11. In order to implement the password management features of CyberStation, the following requirements must be met: • A General Preference setting for a password age of between 7 and 180 days must exist for all users of the system. • A General Preference setting for a password length of between 0 and 16 alphanumeric characters must exist for all users of the system. • A General Preference setting for the consecutive number of invalid login attempts of between 0 and 255 before an alarm is triggered must exist for all users of the system. • A General Preference setting that tells CyberStation how far back in time to check a user’s password history – the number of previous passwords to check – in search of duplicate passwords. When a user changes the password, or the password expires, and a duplicate password is found in his/her password history, the user receives an error message. • A General Preference setting to force a password change after the password of a user account has been modified must exist for all users of the system. • An EventNotification object called LogonStatus must exist to trigger an Invalid Attempt Alarm. • A means to allow any user of the system to change their own password at any time. • A means to allow the system administrator to immediately disable the account of any user of the system.
- 107. Andover Continuum CyberStation Configurator’s Guide 95 Setting up Password Management Features Perform the following steps to set up the password management features in CyberStation. 1. Right click the Continuum symbol located in the tool tray area of the Windows task bar, and select General Preferences. The General Preferences dialog appears. The first six preference attributes in the list apply to CyberStation password management. 2. In the Value column, enter or select your preference for each attribute. Preference Value Maximum password age Enter a value between 7 and 180 days. The default value is 0, which means it never expires. Minimum password age Enter a value between 1 and 16 alphanumeric characters. The default value is 0. Maximum consecutive invalid attempts before alarm in triggered Enter a numeric value. The default value is 5. Note: Setting this column to zero (0) will prevent the alarm from being triggered for invalid logins with a valid User account.
- 108. TAC96 Preference Value Password History Depth Enter a value between 1 and 10. The default value is 1. When a user changes his/her password, or when a password expires, CyberStation used this number to look for previous duplicate passwords in this users password history. This number tells CyberStation how far back in time to check a password history (the number of previous passwords to check). A value of 1 means the new password cannot be the same as the old password. A value of 2 means the old password cannot be the same as either of the two previous passwords, and son on. CyberStation always stores every user’s last 10 passwords. This mean that you, the administrator can use this feature and enforce passwords immediately, rather than waiting for password histories to accumulate. Enable Operator Text Prompt for Alarm Acknowledgement Select True. The default value is False. Force password change after User account password modification Select True. The default value is True. 3. Click the Close button. 4. In Continuum Explorer, under Root in the All Paths view, double click the Templates folder, and select EventNotification. 5. Double click LogonStatus EventNotification object in the Explorer’s viewing pane. 6. In the EventNotification editor, enter the appropriate settings for the LogonStatus object as described in Using the EventNotification Editor in Chapter 10. Make sure that the applicable workstations are included in the Delivery tab as recipients of the LogonStatus object. The CyberStation is now configured to implement password management. General Preferences Settings for Extended-Log Reports Your CyberStation administrator configures settings 7 through 10 in the General Preferences dialog as part of the process of configuring extended logs. For more information on setting up extended logs and descriptions of these General Preference settings, please see the subsection, Extended Logs, in the description of the point-editor Logs tab in Chapter 13. See also What Are Extended Logs? in Chapter 11.
- 109. Andover Continuum CyberStation Configurator’s Guide 97 CFR Preferences The additional 21 CFR 11 features affects two separate areas of the CyberStation system: • Audit Trail • Alarm Log Both of these areas are configured from CyberStation’s CFR Preferences dialog. Setting Up Audit Trail Features In order to implement the Audit Trail features of CyberStation, the following requirements must be met: • The 21 CFR 11 bit of the Security hardware Key (supplied with the CyberStation installation kit) must be enabled in order for the CFR Preferences features of CyberStation to be available. • An entry to the Activity Log when CyberStation starts up. The entry will not include user information since no user is logged on at that time. • An entry to the Activity Log when CyberStation shuts down. The entry will include user information. • A setting to enable an Operator Text Prompt for changes at both the CFR Preferences and user levels of the system. • A CFR Preferences setting that provides the user with the option to enable logging of all attribute values that are set when an object is created. Perform the following steps to set up the Audit Trail features in CyberStation. 1. Right click the Continuum icon in the tool tray, and select CFR Preferences form the Continuum popup menu to access the CyberStation CFR Preferences dialog. 2. Verify that the value of item 2, Enable Operator Text Prompt for changes, is set to True. 3. For item 3, Log attribute values set at object time select either: True to log the attributes that are set when an object is created. False to not log the attributes that are set when an object is created. 4. Click Close. 5. For each CyberStation user, verify that the Enable Operator Text Prompt for Changes checkbox is checked in the Security tab of the User editor. This is the default setting. The CyberStation is now configured to implement the 21 CFR 11 Audit Trail features.
- 110. TAC98 Setting up Alarm Log Features In order to implement the Alarm Log features of CyberStation, the following requirements must be met: • The CFR 11 bit of the Security hardware key (supplied with the CyberStation installation kit) must be enabled in order for the CFR Preferences features of CyberStation to be available. • The user is forced to enter text comments along with user name and password to the Alarm log whenever alarms are acknowledged; this is covered under the General Preferences dialog. The user name and password must match the logged on user ⎯ this only applies when the “Allow different user to sign off operator text” value is set to False in the CFR Preferences dialog. • A CFR Preference setting that provides the option of allowing a user other than the original user to sign off operator text dialogs. Perform the following steps to set up the Alarm Log features in Continuum CyberStation. 1. Right click the Continuum icon in the tool tray, and select CFR Preferences from the Continuum popup menu to access the CyberStation CFR Preferences dialog. 2. For item 1, Allow different user to sign off operator text, select one of the following settings: True if you want operator text dialogs to accept any valid and enabled CyberStation user name and password. False if you want operator text dialogs to accept only the user name and password of the user that is logged on. 3. For each CyberStation user, verify that the Enable Operator Text Prompt for Alarm Acknowledgement checkbox is checked in the Security tab or the User editor. This is the default setting. The CyberStation is now configured to implement the 21 CFR 11 Alarm Log features.
- 111. Andover Continuum CyberStation Configurator’s Guide 99 Results of General and CFR Preference Settings Once the features that affect the Password Management, Audit Trail and Activity Logging activities (previously described) have been implemented, the events discussed below will occur. Invalid Login Attempts When an invalid login attempt occurs at login, the following error message will appear. When the maximum number of invalid logins (set in the General Preferences dialog) is exceeded, the following error message appears: If the workstation is added to the list of recipients in the Delivery tab of the EventNotification editor (for the LogonStatus EventNotifcation object), this alarm is reported in the Active Alarm View. The user name and the workstation that was used for the logon attempts are displayed. Also, any attempt to login at any workstation with a disabled account will fail and be recorded on the Activity log. This situation is shown in the second entry of the Active Alarm View log shown above. Maximum Password Age Exceeded Whenever the Maximum password age setting in the General Preferences dialog is exceeded for a user, the user is prompted to create a new password when the user next attempts to log in. Password Change and/or Password Length Exceeded When either of these events occur: • The password is changed in the General tab of the User editor, and the Force password change after User account password modification in the General Preferences dialog is set to True. • The Minimum password length setting in the General Preferences dialog is exceeded. The user is not allowed to access the system until he/she successfully creates a new password. The new password must be different than the old one.
- 112. TAC100 Duplicate Password Found in Password History Whenever a user changes his/her password, or it expires, and CyberStation finds a duplicate password in a user’s password history (the depth of which is specified in the Password History Depth setting of the General Preferences dialog) the user is prompted to create a different password. Enabling Operator Text Prompts for Changes Each time a modification is made to an object, or the user makes some other type of persistent change, and the Enable Operator Text Prompt for changes setting on the CFR Preferences dialog is set to True, the user is prompted to enter a comment. The user must enter explanatory text in the Comment field and then enter a valid user name and password in the appropriate text fields. If the user tries to cancel comment entry, an entry is recorded in the log indicating the canceled action. Also, the action indicated by the text entry will be canceled. Enabling Operator Text Prompt for Alarm Acknowledgement Whenever an alarm is acknowledged, or an audio alarm is silenced and the Enable Operator Text Prompt for Alarm Acknowledgement setting on the General Preferences dialog is set to True, the user is prompted to add a comment as well as their user name and password. The comments and the user name appear in the Operator Text column of the Active Alarm View. Disabling a User Account The CyberStation administrator can log any user out of all workstations by either of the following methods: • Right click the User object, and select Disable from the popup menu: • In the User editor, select Disabled in the State dropdown menu on the Security tab. Creating a ControllerUser Object The ControllerUser object allows you to assign the security level permissions for users who need access to a command terminal interface to a network controller. You can track all changes in the CyberStation activity log. ControllerUser objects can be owned only by a network controller. To create a ControllerUser object: 1. In Continuum Explorer, right click the network controller where you want to create a ControllerUser, and select New and ControllerUser from the popup menu. 2. In the New dialog, enter the name of the ControllerUser in the Object name field, and click the Create button. 3. In the General tab, enter information about the ControllerUser object as described below. Full Name Enter the full name of the controller user. Password Enter the password of the controller user.
- 113. Andover Continuum CyberStation Configurator’s Guide 101 Login Program Use the browse button to search for the name of the CyberStation program that will run when the ControllerUser logs in. This program must be owned by the same controller that owns the UserController object. Logout Program Use the browse button to search for the name of the CyberStation program that will run when the ControllerUser logs out. Controller Security Level Select a security level from the drop down list Refer to Object Level Security in Chapter 4 for details on how to attach a SecurityLevel object to a ControllerUser object. 4. Click OK. You can use Continuum Explorer’s Copy and Paste features to place the same ControllerUser on other network controllers.
- 114. TAC102
- 115. Andover Continuum CyberStation Configurator’s Guide 103 Configuring a Network A network is a system of one or many controllers and their connected peripheral devices that are linked together on an Ethernet communications network to share information. In CyberStation, a network object represents a network configuration of up to 190 controllers that know about and exchange information with each other. This chapter describes the process of creating a network object. 6
- 116. TAC104 Creating a Network Object Create a Network object, as follows: 1. In the Continuum Explorer, right-click the Root object, select New, and then select Network. 2. In the New dialog, enter a name for your network object in the Object Name field. 3. Click the Create button. 4. In the General of the Network editor, enter information about the network object. Description Enter a description of the Network object, up to 32 characters (including spaces). Time Zone Difference Enter the Universal Time Coordinate (UTC) offset in minutes. This is the difference in minutes between your local time and Greenwich Mean Time. • 300 means you are 300 minutes (5 hours) ahead of Greenwich Mean Time. • -300 means you are 300 minutes (5 hours) behind Greenwich Mean Time. The following are UTC offsets for the Continental United States: • Eastern Standard Time (EST) -300 • Central Standard Time (CST) -360 • Rocky Mountain Standard Time (RMT) -420 • Pacific Standard Time (PST) -480 Default Folder All child objects of this network will be stored in the folder you select. Note: If you do not designate a default folder for a new Network object, and you select Put object in folder when you created the Network object, all its child objects will default to their respective class folders under the Root. Click the browse button to display the Browse dialog. Select the folder that you want to hold the child objects for this network object, and, click the Select button. Controller to CyberStation DBsync Check this checkbox if you want changes made to the controller outside of CyberStation, such as through a command terminal connection to the controller, to be synchronized with the CyberStation database. If a reload of the controller occurs, a flag appears on the controller icon in Continuum Explorer, indicating that a save to database must be performed. 5. Click the Alarms tab.
- 117. Andover Continuum CyberStation Configurator’s Guide 105 6. You can attach up to eight alarms to the network object. You may also attach a graphic panel and a report or other program to the object. 7. Click the corresponding browse button to select the AlarmEnrollment object, graphic, or program you want to attach. 8. If you selected AlarmEnrollment objects, click the Enabled checkbox next to the field to enable the alarm. 9. If you want to attach a SecurityLevel object to this network object, select the SecurityLevel tab and select a SecurityLevel object. 10. For details in attaching or detaching Security Levels, refer to Chapter 4. 11. Click OK. Assigning a Network Object to a Default Folder After you create a Network object, you need to create a link between that Network object and its owner (folder). When you copy objects in Folder View, they are stored on the designated default device in Network View. When you create objects from a template in Virtual View (Folder or Template) and drop them on a parent folder, the objects are created in Network View (Network or Controller) on the assigned default device of that folder. 1. Select the default folder of the Network object, right-click the folder, and then select Edit from the popup menu. 2. In the editor for the default folder, browse for the Default Device, the Network object you just created. 3. Select the Network object, and click the Select button. Click OK.
- 118. TAC106
- 119. Andover Continuum CyberStation Configurator’s Guide 107 Configuring Controllers CyberStation allows you to create and configure controllers from a CyberStation workstation. You do this by creating a new controller object and then using a controller editor to configure the controller. There is a separate editor for each type of controller: • InfinityController (for CXxxxx, NetController, NetController II, bCX1 96xx, bCX1 40x0, or b4920) • InfinityInfinet controller (for TCXxxx, i2xxx, or b3xxx) Refer to Chapter 1 for a description of these controllers. Network Secure Communication TAC has a local network security policy that secures communication between certain Andover Continuum controllers and workstation. This secure communication ensures authentication, integrity, and encryption of IP data packets, using the Internet Protocol Security (IPS) and the Internet Key Exchange (IKE). Network security is a separately purchased option that is supported on the NetController II model 9680 and in the ACX controller models 5720 and 5740. For more information, please see Establishing Network Security for a Controller later in this chapter, and the Network Security Configuration Guide, 30-3001-996. Andover Continuum’s Wireless Controllers Certain models of the Infinity controller series can also become parent wireless controller for an Active Continuum wireless mesh network. • NetController II (model CX9680 or CX9681) configured with its wireless Infinet field controllers • bCX1 9640 controller configured with its wireless Infinet field controllers • bCX1 40x0 controller configured with its wireless BACnet b3 MS/TP field controllers. Note: As a future enhancement, ACX 57xx series controllers will support Wireless communication, much like the NetController II models 9680/9681. See also the Andover Continuum Wireless Mesh Network Concepts and Best Practices Guide, 30-3001-912, the NetController II Operation and Technical Reference Guide, 30- 7
- 120. TAC108 3001-995, the ACK 57xx Series Controller Operation and Technical Reference Guide, 30-3001-999, and the bCX1 Series Controller Technical Reference Guide, 30-3001-890. Note: In order to make one of these controllers a wireless controller, you must designate one of its comm ports as Wireless to establish wireless communication with the wireless mesh network. Note: Andover Continuum BACnet-compliant controllers are included in the Andover Continuum product line. These are the bCX1 (40x0), b4920 and the b3xxx series controllers. The b4 is created as an InfinityController object, and the b3 is created as an InfinityInfinetCtlr object. Depending on which Continuum Explorer view you select, b4 and b3 controllers may also be viewed as BACnet Device objects in the BACnet Devices portion of Explorer’s navigation pane, while also being viewed as InfinityController and InfinityInfinetCtlr objects in the Infinity portion of the navigation pane. (Please refer to Chapter 14 for more information on BACnet and BACnet devices.) Andover Continuum also supports third-party BACnet devices that are integrated into the Andover Continuum system. By default, communication with Andover Continuum BACnet controllers is enabled on your system. If you have no BACnet devices, or if you do not want exposure to BACnet class objects, you may want to disable system communication with BACnet, whereby CyberStation no longer sends or responds to BACnet communication requests. In this case, only Infinity and InfinityInfinetCtlr controller objects are visible in Continuum Explorer. For more information, please see Chapter 14. All InfinityControllers, including b4 controllers, must be commissioned before they can communicate with CyberStation. bCX1 device commissioning is described in the bCX1 Controller Technical Reference, 30-3001-890. Once an InfinityController has been commissioned, a network controller object can be created to represent it on the network. Commissioning a Controller In order for CyberStation to communicate with an Ethernet-level controller, you or your administrator must connect to the controller and enter its network address and other identification information. This process is called controller commissioning. You can commission most Andover Continuum controllers by accessing and entering information on their embedded web pages. Some older controllers, such as the previous-generation NetController, require you to connect to the controller using a command terminal emulator, such as HyperTerminal. For more information, please see the manual for your controller: • NetController II (968x series) – NetController II Operation and Technical Reference Guide, 30-3001-995, and its embedded web page online help. • NetController (older generation – 990x, 994x, 920x series) – NetController Technical Reference Guide, 30-3001-703 • ACX 57xx series – ACX 57xx Series Controller Operation and Technical Reference Guide, 30-3001-999
- 121. Andover Continuum CyberStation Configurator’s Guide 109 • bCX1 series (9640, 40xx) – bCX1 Series Controller Technical Reference Guide, 30- 3001-890 • BACnet b4920 – b3 and b4920 Controller Technical Reference Guide, 30-3001-862 • CX 9702 – Commissioning information is detailed on the controller’s faceplate. (A 9702 manual will be released as a future enhancement.) Creating an InfinityController Object Note: Before performing this procedure, you must commission the controller as described in its product documentation. To create an InfinityController object: 1. In Continuum Explorer, right click the Network object that will contain the new controller, select New, and then select InfinityController. 2. In the New dialog, enter a name for the controller in the Object name field, and click the Create button. 3. Refer to the following pages to enter information about this controller in the tabs of the InfintyControler editor, and click Apply to save your entries. 4. After you save the controller information, refer to “Teaching Network Controller” later in this chapter to exchange information about this controller in the network. General Tab – InfinityController Editor Note: In CyberStation 1.8 or higher, you may be replacing your NetController (models 990x, 994x, 920x) with a newer NetController II model (model 9680 or 9681). If so, please so Guidelines for Converting a NetController to a NetController II later in this chapter. You begin configuring the InfinityController by entering information on the InfinityController’s General tab. Note: Depending on the controller type, some editor attributes are not selectable. If an attribute is gray and is not selectable, it is not relevant to the type of controller you are creating. Note: The InfintyController editor does not have a Backup to Flash button, which is used for NetController II controllers, ACX 57xx controllers, and bCX1 controllers. Instead, in Continuum Explorer, you can right click on the controller and select Backup to Flash from the container popup menu. Description Enter up to 32 characters of text to describe the physical characteristics or functionality of the controller. ACCNet ID Identifies each controller by a unique number between 1 and 190 for the network. This number is set at the controller during commissioning.
- 122. TAC110 Controller Type Select the controller model number from the dropdown menu. Andover Continuum BACnet-compliant controllers are designated as bCX1 (40x0) or b4920. (See also the subsection, Creating an Andover Continuum bCX1 (b40x0) or b4920 Controller, later in this chapter.) NetController II controllers are designated as 9680 and 9681. Older NetControllers are designated as 990x, 994x, and 920x. Selections for 572x and 574x are ACX series controllers. Comm Status CyberStation sets the comm status to OnLine or OffLine depending on whether the workstation is in communication with the controller. Out of Service Check this checkbox if you need to place the controller in an out-of- service (disabled) state. This creates a return-to-normal failure alarm on all CyberStations with the associated AlarmEnrollment editor’s Alarmed Attribute value set to OutOfService (see Using the AlarmEnrollment Editor in Chapter 10). It also allows the user to clear unwanted failure alarms from the alarm viewer and prevents any further failure alarms being reported from the controller. Also, personnel distribution cannot occur on the controller or its associated Infinet controllers. Daylight Savings Check this checkbox if daylight savings time is in effect. Network Security Check this checkbox to activate the TAC network security policy for this controller. Note: Network security is supported only in the NetController II model 9680 and in the ACX controller models 5720 and 5740. The TAC network security policy is a local security policy, established and enabled through CyberStation, through the Network Security Configuration web page and other web pages embedded in the controller, and through your Windows Administrative Tools. Network security secures communication between the controller and a workstation using the Internet Security Protocol (IPS) and the Internet Key Exchange (IKE). It ensures authentication, integrity, and encryptions of IP data packets. For more information on how to implement network security in CyberStation, please see Establishing Network Security for a Controller later in this chapter. For complete instructions on configuring network security on the controller and in Windows, please see the Andover Continuum Network Security Configuration Guide, 30-3001-996.
- 123. Andover Continuum CyberStation Configurator’s Guide 111 Probe Time Enter the interval in seconds by which the Infinity controller checks the comm status of its other connected CX series controllers and CyberStations. When the Infinity controller does not receive a response from another CX controller or CyberStation within the probe time, it changes their comm status to Offline. IOU Models Displays a list of IOU module connected to a CX9400 Controller. Not applicable to any other controllers. UTC Offset Enter the Universal Time Coordinate (UTC) offset in minutes. This is the difference in minutes between your local time and Greenwich Mean Time (GMT): • 300 means you are 300 minutes, or 5 hours ahead of GMT. • -300 means you are 300 minutes or 5 hours behind GMT. BACnet Device Id Identifies the bCX1 (40x0) or b4920 BACnet controller by a unique integer. Each controller must have a unique ID. BacMaxMaster The Max Master property, which is of type Unsigned, is present if the device is a master node on a BACnet MSTP network. Enter an integer in this field that equals the exact number of b3 and third- party BACnet controllers connected to this device. It must be less than or equal to 127 (the default). Location Enter the location of the controller (optional). Serial Number CyberStation retrieves the controller’s serial number from the hardware. Network ID - UPD This integer displays the ID number of the BACnet/IP and Ethernet TCP/IP network on which the controller resides. Version CyberStation retrieves the controller’s version number from the hardware. Network ID – Comm2 This integer displays the ID number of the BACnet Master- Slave/Token Passing (MS/TP) or Wireless network on which the bCX1 (40x0) or b4920 controller resides. Default Folder Browse to select the folder where the child objects of this controller will be stored (optional). Update OS You can upgrade the Infinity controller’s operating system by clicking the Update OS button. You can then locate and select an update (.upd) file and click OK to load the new operating system to the controller.
- 124. TAC112 Update IOUs If you have loaded IOU module firmware updates received from TAC, use the Update IOUs button to update the modules. Click the Update IOUs button. You can then locate and select an (.IOU) file and click OK to update the IOU modules currently connected to this controller. Note: Make sure you select the .IOU file for the type of controller you want to update. Each .IOU file updates a single model of IOU module. Update BACnet b3 OS Click the Update BACnet b3 OS button to upgrade the operating system of the Infinity Infinet BACnet b3 controllers currently connected to this Infinity controller. When you click this button, an Open dialog appears. This dialog helps you locate the update file (shipped with CyberStation) to send to the b3 controllers. Search for and select the file, and then click OK. The new operating system is automatically downloaded to the controllers. There’s no need to replace the microchip. If you are creating or modifying an Infinity 9xxx controller, this button changes to: Update Infinet 2 OS. (See below.)
- 125. Andover Continuum CyberStation Configurator’s Guide 113 Update Infinet 2 OS Click the Update Infinet 2 OS button to upgrade the operating system of the Infinity Infinet 2 controllers currently connected to this Infinity controller. The upgrade procedure is identical to that for a b3 controller (described above). When you click this button, an Open dialog appears. This dialog helps you locate the update file (shipped with CyberStation) to send to the Infinet 2 controllers. Search for and select the file, and then click OK. The new operating system is automatically loaded to the controller. There’s no need to replace the microchip. Note: If this parent controller is a NetController II (model CX9680/CX9681) and one comm port is configured for Infinet while another is configured for Wireless, be sure your update file matches the active medium (in this case, Infinet) of the comm port to which the i2 controllers are attached. If it does not match, a warning message appears, telling you there is a mismatch and asking you if you want to continue. If you continue with this mismatch, another message appears: Upon successful update, all controllers that participated in the update will now be operating in Wireless mode. These controllers will be offline until the selected comm port mode is changed, the controller is connected by proper medium, and the parent controller is reloaded…Continue with update? See also the description for the Wireless Update I2 OS button, below. Wireless on ACX 57xx Series Controllers – As a future enhancement, ACX 57xx series controllers will support Wireless communication much like the NetController II 9680/9681. When you are creating or modifying a BACnet bCX1 40x0 or b4920 controller, this button changes to: Update BACnet b3 OS. (See above.)
- 126. TAC114 Update Wireless I2 OS Click the Update Wireless i2 OS button to upgrade the operating system of Infinity Infinet 2 (i2) controllers affixed with Wireless Adapters in a wireless mesh network and connected to this parent wireless Infinity controller. Wireless on ACX 57xx Series Controllers – As a future enhancement, ACX 57xx series controllers will support Wireless communication much like the NetController II 9680/9681. Note: The Update Wireless I2 OS button appears only when this Infinet controller is a NetController II (CX9680/CX9681) and when its comm ports are configured in one of these ways: • Comm1 is configured as Infinet and Comm2 is configured as Wireless OR • Comm1 is configured as Wireless and Comm2 is configured as Infinet. When you click this button, an Open dialog appears. This dialog helps you locate the wireless-controller update file (shipped with CyberStation) to send to the wireless Infinet 2 controllers. Search for and select the file, then click OK. The new operating system is automatically loaded to the controllers. There’s no need to replace the microchip. Note: Be sure your update file matches the active medium (in this case, Wireless) of the comm port to which the i2 controllers are attached. If it does not match, a warning message appears, telling you there is a mismatch and asking you if you want to continue. If you continue with this mismatch, another message appears: Upon successful update, all controllers that participated in the update will now be operating in Infinet mode. These controllers will be offline until the selected comm port mode is changed, the controller is connected by proper medium, and the parent controller is reloaded…Continue with update? Reset Click the Reset button when you need to delete all programs and points stored on the controller. Use the Reset button with caution, and only after you have saved the programs and points to the CyberStation database. When you click the Reset button, a dialog appears and asks you if you want to continue. If you click OK, you will not be able to retrieve the deleted programs and points except by reloading them from the CyberStation database. Teach See “Teaching Network Controllers” later in this chapter for information about this button.
- 127. Andover Continuum CyberStation Configurator’s Guide 115 Network Tab - InfinityController Editor Enter the following information on the InfinityController Network tab. Note: Depending on the controller type, some editor attributes are not selectable. If an attribute is gray and is not selectable, it is not relevant to the type of controller you are creating. Transport Type From the dropdown menu, select the type of network protocol through which the controller communicates with workstations and other Ethernet-level controllers. Selections are TCP, UPD, or TCP and UPD. TCP stands for Transmission Control Protocol. TCP uses a connection- oriented byte stream and guarantees data delivery. TCP is used by network applications that require guaranteed delivery and that cannot be hampered by time-outs and retransmissions. TCP requires more CPU and network bandwidth than UDP. UDP stands for User Datagram Protocol. Many application protocols use UDP: for example, Network File System (NFS), Simple Network Management Protocol (SNMP), and BACnet. UDP, which is a connectionless datagram delivery service, does not maintain an end-to- end connection with the remote UDP module. UDP does not guarantee delivery, whereas TCP does. Ethernet ID The Ethernet ID number for the controller is assigned to the controller at the factory. This number is retrieved from the controller. IP Address, Subnet Mask, PPP IP Address, and Default Router Enter the IP address, Subnet Mask, PPP IP address if using remote access communications, and Default Router numbers provided by your network administrator. If you are operating a standalone system, be sure that the Subnet Mask numbers on the workstation and controller match. Max Response Time This number is the number of seconds the controller will wait before resending a packet of information. In most situations, the default value of 5 seconds is sufficient. You may want to increase the number of seconds in the following situations: • If your network nodes are far apart • If the connection between nodes exhibits a slow transmission rate. It is recommended that only your network administrator change the number of seconds. Home Page This is the Plain English function path of this controller’s web page. This path is used by the web.Client application. When a user clicks a controller, via the web.Client Web Pages feature, web.Client accesses this path, and displays the appropriate web page in the browser. For example: http://Andover/PE/WebSetSampl
- 128. TAC116 Controller to CyberStation DBsync Check this checkbox if you want changes made to the controller outside of CyberStation, such as through a command terminal connection to the controller, to be synchronized with the CyberStation database. If a reload of the controller occurs, a flag appears on the controller icon in Continuum Explorer, indicating that a save to database must be preformed. Options Tab – InfinityController Editor In Options tab of the InfinityController editor. you can review the hardware options installed in the controller. This tab also lists the XDriver settings for each comm port, as well as whether or not the TAC network security policy is enabled for a NetController II 9680 or an ACX 57x0 controller. This tab displays read-only information. X Driver X drivers can be enabled or disabled on each comm port. A value of 0000 means disabled. A value of 0001 means enabled. All other values in the 4-digit hex number shown for each comm port are X Driver- specific bits set at the factory. Max Infinet Controllers The total number of controllers that can be attached to this controller. LAN Indicates whether or not the LAN card is installed.
- 129. Andover Continuum CyberStation Configurator’s Guide 117 LON Indicates whether or not a 9900, 9400 or 9410 controller has a LON X Driver card installed. Modem Indicates whether or not the controller has an installed modem. PCB Revision The revision number of the controller's printed circuit board. This information may be requested by TAC Technical Services Department if you are calling in with a problem related to this controller. Web Server Indicates whether or not the Web Server feature of the controller is turned on. SNMP Indicates whether the advanced Simple Network Management Protocol is enabled. For more detailed information about SNMP, refer to Continuum SNMP Alarming MiniGuide (30-3001-855). ACC_LON I/O Indicates whether the ACC_LON I/O has been selected. L-BUS I/O In this example, indicates that ACC_LON I/O is disabled and L-BUS I/O is enabled. HCR Hardware Configuration Resource. Displays the current revision level of the hardware. Area Lockdown Displays whether or not the Area Lockdown feature is Enabled or Disabled. Condition Level Displays whether or not the Condition Level feature is Enabled or disabled. Bootloader Version Displays the version of the controller’s bootloader, represented by its bootloader UPD file that you received from TAC. Network Security Indicates whether or not this controller may be configured for network security, which is a separately purchased option from TAC. If the entry says Enabled, it means your site has purchased this option. If it says Disabled, it means your site has not purchased this option. Note: Only the NetController II model 9860, as well as the ACX controller models 5720 and 5740, can support Network Security. For more information on network security, please see Establishing Network Security for a Controller later in this chapter. SecurityLevel Tab – InfinityController Editor For details in attaching or detaching Security Levels, see Chapter 4, Security.
- 130. TAC118 Teaching Network Controllers After you finish configuring the network controller, click Apply to save the information you have entered into the fields of the InfinityController editor. Network controllers need CyberStation information in order to send alarms and events to those CyberStation workstations. They must also have network controller information if they reference points in other network controllers (for example, in Plain English programs). Network controllers are organized into networks. The network controllers in each network should know about each other, but they should not know about any network controllers outside their network. To exchange this information, you use the Teach button in the InfinityController editor. You click the Teach button when you add new network controllers or CyberStation workstations to the system. It is automatically invoked when a network controller or CyberStation is deleted, and when a network controller is modified. Note: During a teach, a controller queries through the system Ethernet network asking for and receiving the IP addresses of up to 64 CyberStation workstations. The controller can only be taught about workstations with a network ID number in the range of 191-254. Workstations with network IDs outside this range cannot be taught. When you click the Teach button, a Select Teach Mode dialog appears containing the following teach mode selections. Click the appropriate Teach Mode radio button and then click OK. Mode Description Infinity Controller Teach Teaches other network controllers in this network about this network controller. It also teaches the network controller about all other network controllers on its Network and all the CyberStation workstations in the system. Network Teach Teaches all network controllers in a Network about all other net controllers is the same Network. It also teaches the network controllers about all CyberStation workstations in the system. Global Teach When there are multiple networks, choosing this teach mode has the same effect as executing a Network Teach on each Network. Establishing Network Security for a Controller TAC’s network security policy is a local security policy that secures communication between the controller and a workstation. You establish network security on an Andover Continuum system through CyberStation, through the Network Security Configuration web page embedded in the controller, and through you Windows Administrative Tools. Note: Network security is supported only the NetController II model 9680 and in the ACX controller models 5720 and 5740. On Andover Continuum controller, network security is not enabled by default, your site must purchase it as a separately sold option from TAC.
- 131. Andover Continuum CyberStation Configurator’s Guide 119 For communication in an Andover Continuum system, network security ensures authentication, integrity, and encryption of IP data packets, using the Internet Protocol System (IPS) and the Internet Key Exchange (IKE). Main Configuration Tasks Establishing network security involved the following four major configuration tasks. Task Description Where It Is Configured 1: Determine if network security is enabled for this controller. Determines whether or not your site has purchased the network security option for this NetController II 9860 or ACX 57x0. CyberStation – InfinityController editor, Options tab 2: Configure network security on the controller Configured network security settings inside the controller. Web-page dialogs embedded in the NetController II 9860 or the ACX 57x0 3: Configure network security on the workstation Imports, edits, assigns, and exports the local TAC network security policy on the workstation. Windows Control Panel – Administrative Tools – Local Security Settings 4: Activate network security for the controller Sets the Network Security attributes for an existing controller or a new controller. CyberStation – InfinityController editor, General tab Configuring Network Security Perform the following procedure to establish network security. For complete, in-depth instructions on configuring network security, please see the Andover Continuum Network Security Configuration Guide, 30-3001-996, the NetController II Operation and Technical Reference Guide, 30-3001-995, and the ACX 57xx Series Controller Operation and Technical Reference Guide, 30-3001-999. 1. Edit the online controller (bring up the InfinityController object editor) on which you want to enable network security. 2. Select the Options tab of the InfinityController editor. If the Network Security entry says Enabled, it means your site has purchased the network security option for your 9680 or 57x0 controller. Go to step 6. If the entry says Disabled, it means your site has not purchased the network security option for your 9680 or 57x0 controller. In this case, go to the next step. 3. Purchase the network security option from TAC for this controller. In turn, TAC sends your site a UPD file. 4. On the General tab, click the Update OS button and load the appropriate UPD file to enable the network security option for this controller. 5. When the update is complete, verify that the controller has returned online. Go back to Option tab, and verify that the Network Security entry now says Enabled.
- 132. TAC120 6. Access and configure the controller for your preferred security. To do so, you must access and log in to the controller’s main embedded web configuration page, then navigate to the Network Security Configuration embedded web page. Note: For complete instructions on configuring network security, please see the Andover Continuum Network Security Configuration Guide, 30-3001-996, the NetController II Operation and Technical Reference Guide, 30-3001-995, and the ACX 57xx Series Controller Operation and Technical Reference Guide, 30- 3001-999. 7. If you have not imported the IPSec security policy, do so now. if you already have, go to the next step. From the Windows Control Panel, open Administrative Tools, then Local Security Policy, which launches the Local Security Policy dialog. Note: For complete instructions, see the Andover Continuum Network Security Configuration Guide, 30-3001-996. 8. Edit the imported security policy. You do this via the Control Panel and the TAC Encrypt and Authenticate dialog. Note: For complete instructions, see the Andover Continuum Network Security Configuration Guide, 30-3001-996. 9. If necessary export the edited security policy to other workstation. This allows the use of the modified policy on other workstations without having to edit it on each workstation. You do this from the Launch Security Settings dialog. Note: For complete instructions, see the Andover Continuum Network Security Configuration Guide, 30-3001-996. 10. Activate network security in an existing controller or on a new controller that you are creating. For an existing controller, enter CyberStation offline editing mode. On the General tab of the InfinityController editor, check the Network Security checkbox. 11. Click Apply. 12. Enter online editing mode. 13. Verify that the controller is online. 14. From the General tab, click the Teach button to update the network. Guidelines for Converting NetController to NetController II CyberStation supports the conversion of a previous-general NetController (CX9680 and CX9681). A procedure over viewing this conversion follows. 1. Back up your SQL Server database. See the Andover Continuum CyberStation Installation Guide, 30-3001-720, and Microsoft’s SQL Server documentation.
- 133. Andover Continuum CyberStation Configurator’s Guide 121 2. From Continuum Explorer, right click the controller, and select Send To Text Files. This dumps the controller object’s data into a text file. 3. Update your workstation with a version of CyberStation that supports the newer NetController models. (These models are supported in CyberStation Version 1.8 and higher.) See the Andover Continuum CyberStation Installation Guide, 30-3001-720. 4. Physically remove the old NetController, and mount/connect your NetController II. When you configure and commission the NetController II, use the same controller name, network IP address, and neting ID. This is performed via the controller’s embedded web commissioning pages, via the General tab, and via the Network tab. See the Andover Continuum NetController II Operation and Technical Reference Guide, 30-3001-995, and the Andover Continuum NetController II Installation Instructions, 30-3001-994. 5. Switch to CyberStation offline editing mode (if you are not already there) in the InfinityController editor. 6. On the General tab, from the Controller Type dropdown menu, change the model number to 9680 or 9681, depending on which NetController II you are installing. 7. Make sure you actually want to replace the NetController. When you attempt to change the controller model, CyberStation displays a few warning messages: • CyberStation warns that a model change is irreversible. • CyberStation warns that, if an XDriver is used with this controller, not all XDrivers are supported by the new model. This warning only occurs if an XDriver is loaded and enabled. If you proceed, the XDriver links are left in place regardless of the availability of a replacement XDriver. XDrivers on NetController II – In general, XDrivers that are available on the bCX1 model 9640 are also supported on the NetController II. For example, supported NetController II XDrivers include, but are not limited to, the following: • Filter • XdTest • Modbus TCP • Modbus RTU Note: XDrivers built for the previous-generation NetController will not run on the NetController II What is an XDriver? An XDriver is special, customized software that your site purchases separately from TAC. This XDriver software allows your controller to connect to and communicate with a special piece of third-party equipment needed at your site. In the CommPort editor, you must configure a controller comm port for this special device that the XDriver software enables.
- 134. TAC122 When you leave the InfinityController editor, go back to online editing mode. 8. If necessary, provide an updated XDriver file compatible with your NetController II. CyberStation prompts you to do this. Note: You can specify an XDriver on the General tab of the CommPort editor. Specify XDriver for the Default Mode, and use the browse button in the XDriver File Name field to search for and specifiy the path of the XDriver. See, Configuring Settings for an XDriver, later in this chapter. 9. Determine whether this NetController II has network security. If so, configure network security for this controller. See, Establishing Network Security for a Controller, earlier in this chapter. Note: Network Security is supported online in NetController II model 9680, as well as ACX controllers 5720 and 5740. 10. Restore (reload) data from your database into the new controller. From Continuum Explorer, use the Object dropdown menu, or right click the controller and select Sent to Controller. 11. Back up to flash. In Continuum Explorer, right click the controller, and from the container popup menu, select Backup to Flash. This saves the controller’s RAM configuration to its flash memory. Creating a bCX1 (40x0) or b4920 Controller Create a BACnet-compliant controller as an InfinityController, as follows: 1. In Continuum Explorer, right click a Network object, and select New from the popup menu, and then select InfinityController. 2. In the New dialog, enter the name and alias of the new controller, and click the Create button. 3. In the General tab, select b40x0 or b4920 from the Controller Type dropdown menu. 4. Configure the BACnet attributes and other configuration attributes using the tabs of InfinityController editor. See “Creating an InfinetController Object” earlier in this chapter for a description of each attribute and lock tab. See also Chapter 14 for more information on BACnet device operations.
- 135. Andover Continuum CyberStation Configurator’s Guide 123 Sending Controller Data to the CyberStation Database If controller settings or data are changed outside of CyberStation (for example, through a command terminal), you need to update the database with these changes. You do this using the send to database feature in Continuum Explorer. 1. Click the Options dropdown menu, and select Send To Database Options. 2. Select the appropriate radio button, and click OK. (See Chapter 3.) 3. In Continuum Explorer, right click the controller that was edited, select Send To, and then select Database. 4. When prompted to confirm the operation, click OK to initiate the operation. When the send to database is accomplished, you can click the Refresh icon to remove the exclamation flag next to the controller icon in Continuum Explorer. Reloading a Controller from CyberStation If a controller object is modified in CyberStation in the offline-editing mode, CyberStation creates an event in the Activity Log and marks (with a flag) the object icon in the Explorer. The flag presents a tool tip when the cursor is placed over it that indicates that the controller must be reloaded. You can reload the controller with the Send To Controller operation. 1. In Continuum Explorer, open the Options dropdown menu, and select Send to Controller Options.
- 136. TAC124 2. Select the appropriate radio button, and click OK. 3. In Continuum Explorer, right click the controller you want to update, select Send To, and then select Controller. 4. When prompted to confirm the operation, click OK to initiate the operation. When the send to controller is accomplished, you can click the Refresh icon to remove the exclamation flag next to the controller icon. Turning Off DB Sync Note: Disabling these attributes should be restricted to the facility's system administrator. Setting the value of the NetController and network Database Synchronization attributes to FALSE will disable the db sync message and prevent the warning flags from appearing in Continuum Explorer. An event is created in the Activity Log each time CyberStation receives a db sync message as a result of a controller change. Working With Infinet Controllers Infinet controllers communicate with Infinity controllers through the Infinet network. These subcontrollers, attached to Infinet networks, contain the various input and output points needed to control building systems such as fans, boilers, chillers, and other electro- mechanical units. Note: Andover Continuum provides a b3 series of BACnet controllers. Refer to Chapter 14 for a description of these controllers. About Infinet 2 Controllers Infinet 2 (i2) controllers store all user-created objects (points, programs, and so on) in non-volatile flash memory. All Infinet 2 controllers contain EPROM flash memory that can be upgraded electronically. The Infinet 2 flash memory has two separate areas:
- 137. Andover Continuum CyberStation Configurator’s Guide 125 • A user backup area • A warm start area The user backup area is used to store a copy of the controller's original RAM database. The warm start area is used as a temporary storage region that stores the configuration of the controller's database at the time a reset or power failure occurred. How the data in flash memory is used depends on the mode in which the Controller restarts after a power failure reset: • Cold Start: The Infinet 2 controller comes up, from a reset, with no user objects or configuration in place. • Cool Start: The Infinet 2 controller comes up, from a reset, and restores a user configuration from flash memory (the user backup area) that was initially saved by the user. Cool start can be thought of as a “self reload.” • Warm Start: The Infinet 2 controller comes up, from a reset, and restores the configuration that was present in the controller when it was reset and/or power was lost (restored from the warm start area of flash memory). For each Infinet 2 controller, you can specify which restart mode to use as described in “Setting the ACCRestartMode Attribute” later in this chapter. Flash Backup Notification Andover Continuum provides a safeguard to ensure that you are aware of the need to backup an Infinet 2 controller. This is true for the WarmToCool and CoolStartOnly modes. It does not apply to the WarmStartOnly mode. When an Infinet 2 controller needs a backup, a flag in the form of an exclamation point will appear over the controller's icon in Continuum Explorer. The flag presents a tool tip when you place the cursor over it. To backup the controller you edit the controller and click the Backup to Flash button on the InfinityInfinetCtlr General tab. (See next page for details.) Creating an Infinity Infinet Controller Object The usual method for configuring Infinet controllers into the system is known as “learning” them into the system. The “learning” procedure is as follows: 1. In Continuum Explorer, click the Explorer bar icon , and select the Networks view. 2. Select the InfinityController to which the Infinet controller is attached. 3. Click the + in the navigation pane to expand the icons beneath the InfinityController. 4. Open the CommPort object that corresponds to the communication port attached to the Infinet controller.
- 138. TAC126 The CommPort editor appears. 5. In the CommPort editor Settings tab, click the Learn button. This sends information to the InfinityController about the Infinet controllers on the network connected to this communication port. When the learn process completes, you can see the controllers on the Field Bus Controllers tab of the editor. (For more information, see Chapter 8.) 6. Click OK. 7. Refresh the Explorer by selecting Refresh from the View dropdown menu or the Explorer’s refresh button. The new Infinet controller is now shown. You can now open the controller if you want to view or edit its attributes. See “Editing an Infinet Controller Object” later in this chapter. Creating an Infinet Controller Offline It is possible (but not recommended) for you to create Infinet controllers offline, using the following procedure: 1. In Continuum Explorer, click the Explorer bar icon and select the Networks view. 2. In the Networks view, right click the InfinityController object under which you are adding the Infinet controller, select New, and then InfinityInfinetCtlr. 3. Name your controller in the Object name field. 4. Remove the check from the Put object in folder checkbox. 5. Click the Create button. Enter the controller attributes, and click OK to save the controller object. Editing an Infinet Controller Object 1. In Continuum Explorer, right click the controller you want to edit, and select Edit. 2. Refer to the following pages to enter information in the tabs of the InfinityInfinetController editor. General Tab – InfintyInfinet Editor In the General tab, you view and enter information that describes the controller and its location, and to which Infinity comm port it is connected. Description Enter up to 32 characters of text that describes the physical characteristics or functionality of the device. Location Enter up to 32 characters of text that describes the location of the device.
- 139. Andover Continuum CyberStation Configurator’s Guide 127 Model Select the Infinet controller's model number from the dropdown menu. Note: When you select a BACnet-compliant b36xx, b38xx, or b39xx controller, you are creating an Andover Continuum BACnet- compliant Device object, in addition to an InfinityInfinetCtlr object. To configure BACnet analog, binary, and multistate inputs, outputs, and values for this new BACnet device, you must first create them as Infinity Input, Infinity Output, and Infinity Numeric points. A b3 controller must be reside on a b4 controller. Otherwise the b3 controller selections will not be available in the Model dropdown menu. (See also the subsection, Creating an Andover Continuum b3 Controller, later in this chapter.) CommPort Browse to locate the comm port to which this Infinet controller is connected. Infinet Id Enter an ID number for this controller if you are creating this controller offline. Normally, you let CyberStation assign one for you by clicking the Learn button from the Comm Port editor (Chapter 8). This is known as an “Infinet Learn.” An Infinet Learn checks for new Infinet controllers. If it finds one without an ID number, it assigns a number. If it finds an Infinet controller with an ID number that has been manually entered, it learns that number. You need to perform an Infinet Learn only if your are adding a new Infinet controller. Do not do an Infinet Learn if you are replacing an existing controller. BACnet Device Id Identifies the b3 BACnet controller by a unique integer. Each controller must have a unique ID. Default Folder (Optional) Click the browse button to select the default folder for this controller. Status CyberStation displays either Online or Offline, depending on whether or not the Infinet controller is in communication with its attached Infinity controller. Backup to Flash Click this button to save the configuration to its flash memory in accordance with the attribute value that is set for the ACCRestartMode system variable. Update INfinet2 OS Click this button to upgrade the Infinet 2 controller’s operating system. You need to locate and select an update (.upd) file to sent o the Infinet 2 controller to update its operating system. Update b3 OS (replaces above button for BACnet controllers) Click the button to upgrade the BACnet b3 controller’s operating system. (See Chapter 14.) You need to locate and select an update (.upd) file to send to the BACnet b3 controller to update its operation system.
- 140. TAC128 Runtime Tab – InfinityInfinetCtlr Editor In the Runtime tab, you can: • View information about the controller during runtime. • Find the controller’s serial and version numbers, as well as information about any errors that may have occurred. With the exception of Serial #, all of the information on this tab is read-only. In the case of the Serial #, if for some reason the controller had to be replaced, you would enter the new number in the Serial # field. Serial # Displays the serial number that is filled in when you click the Learn button from the CommPort editor. Version # Displays the version number that is filled in when you click the Learn button from the CommPort editor. Error # Displays the last error to occur on the controller. Error Time Displays the time and date that the last error occurred on the controller. Error Count Displays the number of errors that have occurred on the controllers since it was last set to zero. Totals up to 255 errors and remains set at 255 until it is reset to zero. Use a Plain English program to reset this attribute.
- 141. Andover Continuum CyberStation Configurator’s Guide 129 Reconfigs Displays the number of times the network has been reconfigured. The network automatically reconfigures itself when it detects a communication error. If a high number of errors and a high number of reconfigs occur, your network may have a loose connection somewhere that is causing the communication error. Reset The Reset button clears the controller’s memory. Security Level Tab – InfinityInfinetCtlr Editor For details in attaching or detaching Security Levels, see Chapter 4, Security. Setting the ACCRestartMode Attribute To specify the restart mode to use, you must set the value of the Infinet 2 system variable ACCRestartMode. 1. In the InfinitySystemVariable folder of the Infinet 2 controller, double click ACCRestartMode. 2. In the InfinitySystemVariable editor, enter the value that corresponds to the restart mode you want to use: Enter this value… To use… ACCWarmStartOnly The warm start area of the controller flash memory. The system attempts automatically to restore the Infinet 2 controller’s RAM to the state it was in at the time of the reset or power failure. With this setting, the ACCStatusBackup is set to ACCBackupInactive. ACCCoolStartOnly The user backup area of the controller flash memory. The flash backup notification flag (see next page) appears in the Explorer tree when a change or reload occurs to RAM and you must initiate the action by activating the Backup to Flash button which causes the controller’s RAN to be restored from the user backup flash area. ACCWarmtoCool The flash notification flag, which appears in the Explorer tree when a change or reload occurs to RAM. You must initiate the action by editing the controller and clicking the Backup to Flash button. The controller will first attempt a warm start, and if that fails it will attempt a cool start. This is the system default setting. 3. Enter a description (optional.) 4. Select Enabled in the State dropdown menu. 5. Click the Apply and OK buttons. Creating an Andover Continuum b3 Controller The most common and suggested method for creating a BACnet-compliant b3 controller is to open the comm port on the b4 device and perform a learn. Another way to create a b3 controller is:
- 142. TAC130 1. In Continuum Explorer, right click an Infinity controller. 2. Select New and then select InfinityInfinetCtlr.. 3. In the New dialog, enter the name and alias of the new controller, and click the Create button. 4. In the General tab, from the Model dropdown menu, select a b36xx, b38xx, or b39xx controller. When you select a b3 model, notice that the BACnet field, BACnet Device Id, becomes selectable. Note: You must create a b3 controller residing on a b4 controller. Otherwise, the b3 model selections are not available. 5. Configure the BACnet fields and other configuration attributes, using the InfinityInfinetCtlr editor. For more information on these configuration attributes, see the attribute descriptions in “Editing an Infinet Controller Object” earlier in this chapter. See also Chapter 14 for more information on BACnet operations.
- 143. Andover Continuum CyberStation Configurator’s Guide 131 Configuring Comm Ports After a controller is defined its communication ports need to be configured for the devices connect to them. Each Andover Continuum network controller includes provisions for adding other devices. The network controllers include up to four programmable communications interfaces called comm ports and a dedicated interface for the Continuum IOU modules. A comm port is an electrical interface used to connect the controller to an external device such as a printer or a terminal. When you create a controller object, CyberStation automatically creates appropriate comm port objects for each of the comm ports of that controller. You use the CommPort editor to provide settings that enable the comm port to work with the device attached to it. Supported Device Types CyberStation supports the following types of devices. Not all comm ports support all of these devices. Make sure that the port you are configuring includes support for the device you select. Printers Printers are typically used to produce hard copy of lists and logs. These devices interface with controllers via an RS-232 serial connection. Infinet, MS/TP, Wireless Andover Continuum controllers and other equipment that communicates over a proprietary version of an RS-485 network called Infinet, a standard BACnet version called the Master- Slave/Token-Passing (MS/TP) network, or a wireless network with a Wireless Adapter affixed to a bCX1 90xx (Infinet) controller or bCX1 40x0 (BACnet) controller. XDriver XDrivers are custom interfaces that have been designed to provide an interface between the controller and another device generally manufactured by another company. 8
- 144. TAC132 TankNet TankNet is another version of RS-485 developed for communication between controllers and certain tank-mounted liquid level sensors. L-BUS LBUS is the cable that connects IOU modules to a CX network controller. Only one LBUS can be connected to a CX controller. Each LBUS can have up to 16 IOU modules on it. Configuring a Comm Port for a Terminal Terminals can be connected to controllers two ways: • Directly to the controller using up to 50 feet of RS-232 cable • Remotely to the controller using a modem The table below shows the comm port settings to use for each controller when you connect a command terminal. Setting Description Comm Port Number and Default Mode You can use the settings indicated for each of the following controller models: • 9200/9300: Use AutoSet or Window on COMM1, COMM2, COMM#, and COMM4. On 9300 models, you can also use Command on these ports. AutoSet is the default on COMM3. • 9400: Use AutoSet, Window, or Command on COMM1, COMM2, COMM3, or COMM4. AutoSet is the default mode on COMM3. • 9924: Use AutoSet, Window, or Command on COMM1 and COMM2. AutoSet is the default mode on COMM2. • NetController: Use AutoSet, Window, or Command on COMM1, COMM2, COMM3, or COMM4. AutoSet is the default mode on COMM3. Baud Rate The default baud rate setting is 9600. All baud rates are valid, however if you are experiencing communication problems, check the baud rate requirement for your equipment and choose the matching baud rate. Flow Control CyberStation automatically uses XonXoff for terminals, regardless of which flow control type you select. Terminal Type Click the terminal type that you are using. If you are running a terminal emulation program on a computer, select VT100. TrackCXD This attribute is automatically selected. Deselect it only if your terminal is connected directly to the controller (not through a modem). Direct Connect Select this attribute only if your terminal is not connected to the controller over a modem. This is required.
- 145. Andover Continuum CyberStation Configurator’s Guide 133 Configuring a Comm Port for a Printer The table below shows the comm port settings to use for each controller when you connect to a printer. Setting Description Comm Port Number and Default Mode You can use the settings indicated for each of the following controller models: • 9200: Use COMM1, COMM2, COMM3, or COMM4. Select Printer for Default Mode. • 9400: Use COMM1, COMM2, COMM3, or COMM4. Select Printer for Default Mode. • 9924: Use COMM1 or COMM2. Select Printer for Default Mode. • NetController: Use COMM1, COMM2, COMM3, or COMM4. Select Printer for Default Mode. • bcx1 Series: Use COMM1 or COMM2. Baud Rate Set the baud rate to match the baud rate of the serial printer you are using. If you are unsure of the printer’s baud rate, set the comm port baud rate at the lowest setting, then try to print. If the baud rate is set too low, something will usually print, but it may be unintelligible. Change the comm port’s baud rate to next higher settings and print again. Continue this process until the printer works properly. Flow Control Depending on the flow control type required by your printer, select either NoFlowControl, XonXoff, CtsRts, or XonXoffCtsRts. TrackCXD This attribute does not apply to printers. Configuring a CommPort for an LBus You can set up a comm port for an Lbus to communicate with one or more IOU modules. Once you set a comm port’s default mode to LBus, you can’t change it without resetting the controller, so be sure to plan ahead. The table below shows which comm port you should use: Setting Description Comm Port Number and Default Mode You can use the settings indicated for each of the following controller models: • 9200: Use COMM4. Select LBus for Default Printer. • 9400: There are no LBus comm ports on the 9400 series. • 9924: There are no LBus comm ports on the 9924 series. • NetController: Use COMM1. Select LBus for Default Printer.
- 146. TAC134 Baud Rate The default baud rate is 19.2K. All baud rates are valid. If you are having communication problems, check the baud rate requirements for your equipment, and then make the appropriate selection here. Set to a lower baud rate if you require greater noise immunity. Flow Control Flow control does not apply to LBus connections. TrackCXD This attributes does not apply to LBus connections. Configuring a Comm Port for a TankNet You can configure a TankNet port to use for communicating with a network of Infinity RS- 485 level-sensing probe through this port. There is a maximum of one TankNet per controller. You can use the RS-485 connectors on the following ports for TankNet: Setting Description Comm Port Number and Default Mode You can use the settings indicated for each of the following controller models: • 9200: You COMM1, COMM2, COMM3, or COMM4. Select TankNet for Default Mode. • 9400: Use COMM1, COMM2, COMM3, or COMM4. Select TankNet for Default Mode. • 9924: Use CustomPort. TankNet is the default mode.. • NetController: Use COMM1, COMM2, COMM3, or COMM4. Select TankNet for Default Mode. Baud Rate The default baud rate, 4800, is the only setting allowed for TankNet. Flow Control Flow control does not apply to TankNet connections. TrackCXD This attribute does not apply to TankNet probes. Configuring a Comm Port for XDrivers You can configure a comm port to connect to special equipment. To do this, you will need to purchase Andover Continuum customized software called an XDriver. The table below shows which comm ports are available for XDrivers for each controller. Setting Description Comm Port Number and Default Mode You can use the settings indicated for each of the following controller models: • 9200: Use COMM1, COMM2, COMM3, or COMM4. Select XDriver for Default Mode. • 9400: Use COMM1, COMM2, COMM3, or COMM4. Select XDriver for Default Mode. • 9924: Use COMM1 or COMM2. Select XDriver for Default Mode. • NetController: Use COMM1, COMM2, COMM3, or COMM4.
- 147. Andover Continuum CyberStation Configurator’s Guide 135 Select XDriver for Default Mode. • NetController II: Use COMM1, COMM2, COMM3, or COMM4. Select XDriver for Default Mode. • bxc1 Series: Use COMM1 or COMM2. • ACX 57xx series: Use COMM1. (The ACX57xx controller has only one configurable RS-485 comm port). Select XDriver for Default Mode. Baud Rate The appropriate baud rate may vary depending on the XDriver software. Refer to the instructions provided with the software. Flow Control Flow control does not apply to XDrivers. TrackCXD In most cases, TrackCXD should be selected. However, this may vary depending on the device. Check the documentation that came with the XDriver to be sure. What Additional Settings Do I Need to Make? When the default mode is set to XDriver, the Settings tab contains the attributes shown below: Baud Rate Refer to the documentation provided with the XDriver to select the appropriate setting. Data Length Refer to the documentation provided with the XDriver to select the appropriate setting. Parity Refer to the documentation provided with the XDriver to select the appropriate setting. Stop Bits Refer to the documentation provided with the XDriver to select the appropriate setting. Configuring a Comm Port for Infinet, MS/TP, or Wireless You can configure a comm port to communicate with an Infinet controller, a BACnet MS/TP controller, or a bCX1 series controller equipped with a wireless adapter, communicating with a wireless subnetwork. Note: The Wireless choice is available for the following parent controllers: Infinet bCX1 Model 9640, BACnet bCX1 model 40x0, and NetController II models 9680 and 9681. See the tables below. Note: As a future enhancement, ACX 57xx series controllers will support Wireless, much like the NetController II models 9680 and 9680. A bCX1 series controller can be either an Infinet controller (90x0 model) or a BACnet controller (40x0 model). The Wireless choice is available both the Infinet bCX1 and the BACnet bCX1. For more information, please see the bCX1 Series Controller Technical Reference, 30-3001-890, and the Wireless Adapter Installation Sheet, 30-3001-887. For each controller, the table below lists comm ports to use for Infinet or Infinet Wireless.
- 148. TAC136 Note: Once you select Infinet and save for the default mode, you cannot change it. 9000 and 9200 Use COMM1 or COMM2. Select Infinet for Default Mode. 9400 Use COMM1 or COMM2. Select Infinet for Default Mode. 9924 Use the Infinet port. The default mode for this port is Infinet. NetController (99xx) Use COMM1 or COMM2. Select Infinet for Default Mode. NetController II (9680 and 9681) For both Infinet and Wireless, use COMM1 or COMM2. When COMM1 is configured for Infinet and COMM2 is configured for Wireless (or vice versa) there are some special considerations for updating the operating system of the Infinet or Wireless field controllers. (See the descriptions for the buttons on the General tab of the InfinityController editor.) ACX 57xx series Use COMM1. the ACX 57xx controller has only one configurable RS- 485 comm port. The default mode for this port is AutoSet. 9702 Use COMM1. The default mode for this port is Infinet. bCX1 9640 Use COMM2. Select Infinet or Wireless for Default Mode. Which Comm Ports Should I Use for MS/TP or BACnet Wireless b4920 Use COMM1. You must use MSTP for Default Mode. bCX1 40x0 Use COMM2. You can select MS/TP or Wireless for Default Mode. Baud Rate The default baud rate is 19.2K baud. Valid baud rates for Infinet also include 1200, 2400, 4800, and 9600. (MSTP also permits 9600 baud. Wireless also permits 19.2K.) Set the baud to a lower rate if you require greater noise immunity. If you are using an Infilink on the Infinet, be sure that their baud rates match. Flow Control Flow control does not apply to Infinet connections. TrackCXD This attribute does not apply to Infinet connections. Completing Configuration of Controllers After you enter and apply settings to connect a controller to a comm port, you use the Learn button to create controller objects with configuration data for each controller connected to this comm port. Learn also sends information about: • All the network-connected Infinet controllers to the Infinity controller • All the BACnet MS/TP network-connected b3 controllers and other BACnet third- party devices to the b4 or bCX1 40x0 controller. • All the controllers connected through a wireless subnetwork to the wireless adapter affixed to the bCX1 9640 Infinet controller.
- 149. Andover Continuum CyberStation Configurator’s Guide 137 When the learn process completes, you will be able to see these controllers on the Field Bus Controllers tab. Learn and bCX1 40x0 Controllers Before performing a routine Send to Database operation on a bCX1 40x0 series controller, you must first perform a "learn" operation. This ensures that the bCX1 40x0 first knows about the existence of its BACnet field bus controllers (b3 and third-party controllers). After the learn, the Send to Database fetches object information from all controllers residing on the field bus subnetwork and saves it to the CyberStation database. Before performing the Send to Database operation, make sure you have also selected the Save attached objects and controllers radio button in the Send to Database Options dialog. This ensures that data from child objects in child controllers (attached to the parent bCX1 40x0) are also saved. CAUTION: If you do not do these things, the Send to Database operation may fail for controllers residing on a bCX1 40x0 controller's field bus network. See Chapter 3, Continuum Explorer, for more information on Send to Database operations, and the Send to Database Options dialog. Comm 1 and 2 of a network controller can be configured as Infinet ports. Each Infinet port on a network controller can support up to 127 regular (building automation) Infinet controllers and up to 31 priority (security access and display) Infinet controllers. Configuring a Comm Port The comm port you select to configure and the settings you choose in the CommPort editor depend on the model of network controller and the device you want to connect to it. Refer to “Comm Port Settings for Specific Devices” to identify the appropriate settings to use for you devices. To configure a comm port, follow these steps: 1. In Continuum Explorer, expand the network controller whose comm ports you want to configure. 2. CommPort objects appear in the list of objects in the viewing pane. Double click the CommPort class folder under the controller. 3. Double click the CommPort object you want to configure. 4. In the CommPort editor, select the appropriate settings in each tab as described on the following pages. 5. Click OK.
- 150. TAC138 General Tab – CommPort Editor In the General tab, enter basic information about the comm port. Note: When Infinet, MSTP, or Wireless is selected in the Default Mode field, another tab, Field Bus Controllers, appears. See Field Bus Controllers Tab, later in this chapter. Description Type in a description for the comm port. You can use up to 32 alphanumeric characters. This attribute is optional, but providing a good description can aid other users. Comm Port Number The CommPort attribute displays the number of the comm ports you are editing. Default Mode Each comm port has a default mode. To change the default mode, select a different one from the Default Mode dropdown menu. The Settings tab displays different attributes, depending on the default mode you select. Note: In the event of a controller reset, each comm port reverts to its original default mode. For a complete list of default modes for each comm port on each controller, please see the section, Default Modes, later in this chapter. Printer Select this option when connecting a serial printer to this port. Command Select this option when you are connecting a VT100 or VT200 type terminal to this port and you want to have the terminal to display a command line. If you want the terminal to display windows and menus, select the Window option instead. To switch between Window and Command mode at the terminal, select the AutoSet option. Infinet (Comm 1 and 2 Only) Select this option to set up this comm port as an Infinet port. An Infinet port connects an Infinity controller to an Infinet network. When the default mode is set to Infinet, another tab is added to the CommPort editor: Field Bus Controllers. MSTP Select this option to set up this comm port as a BACnet Master-Slave/Token-Passing (MS/TP) port. The MS/TP option is the only option available on the b4920. It is also available on bCX1 40x0 BACnet controllers. MS/TP is required for the b4920 controller to communicate with other BACnet devices, such as b3 controllers.
- 151. Andover Continuum CyberStation Configurator’s Guide 139 Wireless Select this option to use a Wireless Adapter on a bCX1 96xx Infinet controller or a bCX1 40x0 BACnet controller, communicating over a wireless subnetwork. Lbus Select this option to set up communications between your controller and one or more IOU boards on an LBus. Lbus is supported for comm4 on a CX9200 or CX9300 controller and comm1 on a NetController. AutoSet Select this option when you are connecting a VT100 or VT220 type terminal to this port and you want to be able to switch between Window and Command mode. This option provides you with a blank screen when the terminal is first turned on. Type either Window or Command at the blinking cursor to select a mode. TankNet Select this option to connect to an Infinity level- sensing probe. XDriver (Support for an XDriver must be purchased) Select this option to use a customized external equipment driver to connect to a special piece of equipment. Note: Before you can select the XDriver, you must first install it using the instructions provided with the software. To select an XDriver file, click the browse button to locate and select the file for the XDriver. Depending on how you installed the XDriver, the file may or may not have a file extension of .xdr. NotConfigured Select this option if the comm port is available. Indicates that the port is not preset to any other default mode configuration. Viewing the Status of an XDriver Device In the General tab, click the XDriver Status button to view the status of the device that is using the XDriver. The XDriver Status button displays the following read-only information:
- 152. TAC140 Status Displays the status of the device, or XdrvNotInstalled when no XDriver file has been selected. Error Displays the last error to occur on the device. Error Time Displays the time and date that the last error occurred on the device. Error Count Displays the number of errors that have occurred on the device since you last set it to zero. Increments to 255 errors and remains set at 255 until you reset it to zero by clicking the Reset Count button. Settings Tab – CommPort Editor The Settings tab is where you view or edit the communications speed and handshaking settings for the mode that you have chosen for the port. Depending on which Default Mode you select on the General tab, some of the attributes on this tab may be unselectable (appear gray).
- 153. Andover Continuum CyberStation Configurator’s Guide 141 Baud Rate The Baud rate is the speed, measured in bits per second, at which the controller sends information to the device that you are connecting to the comm port. Select the baud rate that matches that required by the equipment connected to this port. Track CXD This option monitors a communications carrier detect signal called CXD. When selected, it enables the controller to detect when communication with connected objects has been lost. Depending on your modem configuration, the CXD (sometimes called DCD) signal (pin 8 on an RS-232 connector) is asserted "high" when the communications link is established between modems. Once the carrier signal is lost, CXD goes "low." Track CXD looks for this high-to-low transition and makes the controller reset this comm port to its default mode. Track CXD “cleans up” the comm port by logging off the last user. Track CXD is selected by default, and it is required for comm ports that are connected to modems. If Track CXD is not selected, the controller cannot respond to the loss of the CXD signal.
- 154. TAC142 Flow Control The flow control type determines how the comm port handles the flow of data between the controller and its attached device (usually a printer, modem or terminal). This process is also known as “handshaking.” Select one of the following options from the dropdown menu: NoFlowControl Select this flow control type if you do not want to regulate the flow of information between the controller and its attached printer, modem, or terminal. Without a flow control type, buffers that hold data that is being transmitted or received could overflow, and some data could get lost. CtsRts This flow control type uses hardware signals to send "clear to send" (Cts) and "request to send" (Rts) messages. Both of these messages must be acknowledged by the controller and its attached device before information can be transmitted. XonXoff This control flow type uses software signals in the form of characters that are sent as part of the data being transmitted. When the controller or its attached device detects that it has been sent an Xon character, it makes itself available to receive data. It considers all data received after the Xon character as valid. When it detects an Xoff character at the end of the data stream, the controller or attached device knows the transmission is complete. XonXoffCtsRts This flow control type uses both the software (XonXoff) and hardware (CtsRts) handshake methods for regulating the flow of information between the controller and its attached device. Current Mode This is a read-only attribute that shows you the default mode selected in the General tab. SecurityLevel Tab – CommPort Editor Refer to Chapter 4 for details regarding attaching or detaching SecurityLevel objects. Field Bus Controllers Tab – CommPort Editor When you set Default Mode on the General tab to Infinet, MSTP, or Wireless, on the Field Bus Controllers tab is added to the CommPort editor appears. This tab displays the controllers that reside on their respective field bus network — Infinet, BACnet MS/TP, or Wireless — connected to this comm port. The controllers will not display, however, until you click the Learn button on the Settings tab. The CommStatus column displays either Online or Offline for controllers listed in the Name column. When a controller is Online, it is communicating with the rest of the network. When a controller is Offline, it is not in communication with the rest of the network.. This information is read only.
- 155. Andover Continuum CyberStation Configurator’s Guide 143 Summary of Comm Port Characteristics The following table presents a summary of default modes and other modes for comm ports in the following controllers. 9200 Infinet Port User Port COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort - - Default Mode: Not Configured Other Modes: Window AutoSet Infinet TankNet XDriver Command on 9300 Default Mode: Not Configured Other Modes: Window AutoSet Infinet TankNet XDriver Command on 9300 Default Mode: AutoSet Other Modes: Window TankNet XDriver Command on 9300 Default Mode: Not Configured Other Modes: Window AutoSet Lbus TankNet XDriver Command on 9300 - -
- 156. TAC144 9400 Infinet Port User Port COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort - - Default Mode: Not Configured Other Modes: Window Command AutoSet Infinet TankNet XDriver Default Mode: Not Configured Other Modes: Window Command AutoSet Infinet TankNet XDriver Default Mode: AutoSet Other Modes: Window Command Printer TankNet XDriver Command Default Mode: Not Configured Other Modes: Window Command AutoSet TankNet XDriver Default Mode: LON Other Modes: XDriver 9924 Infinet Port User Port COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort Default Mode: Infinet Other Mode: XDriver - Default Mode: Not Configured Other Modes: Window Command AutoSet XDriver Default Mode: AutoSet Other Modes: Window Command AutoSet XDriver - - - Default Mode : TankNet Other Mode : XDriver 9702 Infinet Port User Port COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort - - Default and only Mode: Infinet Default Mode: AutoSet Other Modes: Printer - - - NetController Infinet Port User Port COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort - - Default Mode: Not Configured Other Modes: Window AutoSet Infinet TankNet XDriver Command L-BUS Default Mode: Not Configured Other Modes: TankNet XDriver Default Mode: AutoSet Other Modes: Window Printer XDriver Command Default Mode: Not Configured Other Modes: XDriver Default Mode: LON Other Modes: XDriver -
- 157. Andover Continuum CyberStation Configurator’s Guide 145 NetController II 9680 and 9681 Infinet Port User Port COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort - - Default Mode: AutoSet Other Modes: Printer Infinet Lbus LON PPP Wireless XDriver Default Mode: AutoSet Other Modes: Printer Infinet Wireless XDriver Default Mode: AutoSet Other Modes: Printer PPP XDriver Default Mode: AutoSet Other Modes: Printer I Lbus XDriver Default Mode: LON Other Modes: XDriver - ACX 57XX Series Infinet Port UserPort COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort - - Default Mode: AutoSet Other Modes: Infinet Wireless XDriver - - - - - Note: Although Wireless is a selection for COMM1, ACX 57xx series controllers will support Wireless as a future enhancement. bCX1 96xx Infinet Port User Port COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort - Default Mode: AutoSet Other Modes: Printer PPP Xdriver Default Mode: AutoSet Other Modes: Infinet Wireless Printer Xdriver - - - -
- 158. TAC146 bCX1 40x0 Infinet Port User Port COMM1 COMM2 COMM3 COMM4 COMM16 CustomPort - Default Mode: AutoSet Other Modes: Printer Default Mode: Autoset Other Modes: MS/TP Wireless Printer - - - -
- 159. Andover Continuum CyberStation Configurator’s Guide 147 Creating IOU Module Objects After you finish configuring a controller with the Comm port editor, you can define your input and output. Start by defining the IOU modules with the IOUModule editor. IOU modules are electrical units that contain a number of input and/or output circuits that are electrically and sometimes physically attached to controllers. They provide controllers with the ability to interface with the outside world. There are four types of IOU Modules: • Input modules • Output modules • Mixed input and output modules • Special-purpose modules 9
- 160. TAC148 Creating an IOU Module Object The following steps allow you to add an IOU Module object for an IOU Module connected to a controller. 1. Right click the controller that you want to own this module, select New, and then select IOUModule. 2. When the New dialog appears, name the IOUModule and click Create. General Tab – IOUModule Editor Use the General tab to enter basic information about the IOU module. Description The description is optional, but a good description of the IOUModule object helps others when they need to test, modify or manipulate the network. To enter a description, type up to 32 characters (including spaces) in the text field. IOU Number Enter the IOU number here. You must manually assign a unique number (between 1 and 32) for each IOU module on a network controller. Physically label the IOU modules with the numbers you assign. This number is not the same as the 12-digit module ID # assigned to the individual module at the factory. You will use this number when you configure points on this controller. Model Number The model number identifies the type of the IOUModule and is read from the module.
- 161. Andover Continuum CyberStation Configurator’s Guide 149 Comm Status This displays Online or Offline, depending on whether the controller is in communication with the module. Module ID and Program ID These TAC-assigned numbers appear after the Learn process. The only time you will need these numbers is when speaking to a TAC Support Representative. These numbers will help our staff to answer your questions. You may manually enter the Module ID number in this field, (if you know it), rather than following the Learn process. Learn Use the Learn button to commission the IOU module on the network. See “Commissioning an IOU Module” later in this chapter. Wink Use the Wink button after commissioning the IOU module to confirm that your system recognizes the IOU module. Click the Wink button. The Status light on the IOU module should flash. This indicates the IOU module was successfully commissioned. Update IOU Click the Update IOU button to browse for a *.iou file (a TAC-provided Flash File for individual modules) when updating IOU modules with new firmware. SecurityLevel Tab – IOUModule Editor The SecurityLevel tab shows the object security level and access privileges for the object. For more information, see Chapter 4, Security. Commissioning an IOU Module Perform this procedure after installing the IOU module on the controller. 1. In the IOUModule editor, click the Learn button. A dialog displays requesting the operator to press the Commission button on the physical module. 2. At the IOU Module, press the Commission button on the front panel. The dialog at the workstation should disappear indicating that it received the information from the module. If the module is not easily accessible, you can enter the module ID found on the label inside the cover of the module into field, and click the Apply button. 3. In the IOUModule editor, click the Refresh button. The ModuleID for commissioned module, the ProgramID field, and the IO model type (i.e., AO-4-8) are automatically entered. This information was received from the module. Also, the Comm Status should be online.
- 162. TAC150 Replacing an IOU Module Proceed as follows: 1. Remove power from the I/O Bus where the module is to be installed. 2. Replace the module, and re-apply power. 3. In CyberStation, open the IOUModule editor for the module you are replacing, and click the Learn button. 4. At the IOU Module, press the Commission button found on the front panel of the module. If the module is not easily accessible, you can enter the module ID found on the label inside the cover of the module into the field, and click the Apply button. 5. In the IOUModule editor, click the Refresh button. The Module ID for commissioned modules, the ProgramID field and the IO model type (that is, AO-4-8) are automatically entered. This information was received from the module. Also, the Comm Status should be on-line. Check that the version of the module reported on this screen is compatible with the current version of CyberStation. The fourth field in the Program ID is the version number. For example the Program ID of a DO-4 with version 10 is: 81:11:01:10:00:04:00:01 Version number
- 163. Andover Continuum CyberStation Configurator’s Guide 151 Configuring Alarms Considering the Alarm System Before setting up your alarm system, you need to consider the following questions: 1. What points or network objects do I want to monitor — for example, space temp sensors? 2. What conditions would cause a point to be in an alarm state — high limit, low limit, or off setpoint? 3. What actions do I would want to take place in the system in response to that point meeting those conditions? For example, alarms can be configured to send flashing alarm messages, play audio files, or send email in response to an alarm. 4. Who should be notified that an alarm condition exists? The size of your system will help to determine how may different sets of actions you should configure for alarms. If you have only one place to send alarms, you don’t need to create a lot of different sets of actions to be taken in response to alarms. Once you have decided what points need to have alarms, what the alarms will do, and who will be notified, you can begin using Continuum editors to create alarm system objects. Alarm objects are configured in the reverse order of the steps used in thinking about the alarm system described above. Alarms and BACnet Alarms are created as AlarmEnrollments for Infinity objects, and they are created as BACnet EventEnrollments for BACnet objects. An EventEnrollment defines a standardized object that represents and contains the information required for managing events within BACnet systems. You use the AlarmEnrollment editor to create, access, and edit AlarmEnrollment objects. Similarly, you use the EventEnrollment editor for BACnet EventEnrollment objects. (Please see Chapter 14 for a description of EventEnrollments and the EventEnrollment editor.) 10
- 164. TAC152 Basic Steps for Setting Up Alarms To set up alarms for Continuum objects use the following basic steps: 1. Create the EventNotification object(s) you need. 2. Create the AlarmEnrollment or EventEnrollment object(s) you need, each of which is associated with an EventNotification object. 3. On the Alarms tab (or Advanced Alarms tab) of an object editor, attach AlarmEnrollment objects to the point or network object. About EventNotification Objects EventNotification objects are linked to AlarmEnrollment objects, EventEnrollment (BACnet) objects, or basic alarms. One EventNotification can be associated with multiple alarm enrollment objects. EventNotification objects define which workstations receive events. The event states that are processed by Event Notification objects are: alarms, returns to normal, and alarm faults. In addition to event routing, Event Notifications define which hours events will be reported, and what actions are taken upon receiving the event such as: emailing, paging, logging, printing, displaying the alarm view, displaying graphics, running programs, playing audio, blinking, and so on. Event Notification objects provide prioritization of events, repeat timer functionality, acknowledgement rules, color coding, and deactivation criteria. For example, a workstation can be configured to display events between the hours of 9-5, and use the paging feature during the hours of 5-9 only if the alarm remains unacknowledged for the repeat interval. EventNotification objects route alarms to different workstations based on the problem source. For instance, security alarms can be routed to the guard workstation, HVAC alarms can be routed to the maintenance workstation, and IOModuleStatus alarms can be routed to the administrator’s station. Another usage is segmenting a site – EventNotifications can route alarms to different workstations based on the source of the event. For instance, all events occurring in BuildingA can be routed to WorkstationA and all events occurring in BuildingB can be routed to WorkstationB. We recommend you that you use EventNotification objects as severity levels. For example, create EventNotification objects named “Warning,” “Critical,” and “Alert,” and associate appropriate events with them accordingly. Furthermore, if site segmentation is used, we recommend that the location is added to the name. For example, the name BuildingACritical would be used in the example above. Adding and removing recipients from an event notification can affect the way several alarms are routed because a single event notification object can be attached to several alarm enrollment objects. About Configuring Alarm System Components To complete the tabs of the EventNotification and AlarmEnrollment object editors, you type information into text fields and make selections from dropdown menus in the tabs of
- 165. Andover Continuum CyberStation Configurator’s Guide 153 the editors. You then open a point editor and attach AlarmEnrollment objects to the point and set other alarm parameters. To create an EventNotification object, you’ll make decisions based on the following questions: Which colors and fonts will the notification have? You’ll answer this question by specifying font styles and background colors for each possible event state. Which notification actions will occur? You’ll answer this question by making selections from a list of possible notification actions. Who will be notified of the event? You’ll answer this question by creating a list of workstations where notification of the event will be delivered. How will users remove the event from the active alarm view? You’ll answer this question by selecting a condition that must exist before Continuum will remove the event from the Active Alarm View. Will Event Notification Include the Playing of Audio Files? You’ll answer this question by deciding whether or not to associate an audio file with each possible event state. Who will have permission to make changes to the configuration of this EventNotification? Please refer to Chapter 4, Security.
- 166. TAC154 Using the EventNotification Editor The EventNotification editor is a series of tabs. Each tab contains text fields, buttons, and dropdown menus that you’ll use to define or modify the EventNotification object. You’ll enter text in the text fields and make choices by clicking buttons and selecting from lists of possibilities. Creating the EventNotification Object To create an EventNotification object perform the following steps: 1. In the Explorer’s navigation pane, right click the Root or the folder to which you want to add an EventNotification object. 2. From the New dialog select EventNotification: 3. When the New dialog appears enter a name for the EventNotification object in the Object name text field. 4. Click the Create button to create the object and bring up the EventNotification editor. CAUTION When working with EventNotification objects, please be aware that when you edit existing attributes you are changing the way every associated basic alarm and AlarmEnrollment object is delivered. !!
- 167. Andover Continuum CyberStation Configurator’s Guide 155 The EventNotification General Tab In the General tab, you enter basic information about the event. Description The description, although optional, is an important part of an EventNotification object. A good description helps future users choose the correct EventNotification object to associate to a particular event or alarm. To enter a description, type it into the Description text field on the General tab. Your description can be up to 32 characters (including spaces) long. Ack Required This section is used for BACnet controllers only. Check the appropriate checkbox to specify whether acknowledgement is required in notifications generated for the following event transitions: Alarm ReturnToNormal Fault Priority Priority numbers help sort events in the Active Alarm View. One of the benefits of sorting by priority number is that it is one way to display critical events at the top of the active list. In the Active Alarm View, you determine whether high or low priority numbers display at the top by selecting either ascending or descending as your sort order. The range of priority numbers is 0 to 254. Each event state receives its own priority number. To enter a priority number for an event state, type it in its text field on the General tab.
- 168. TAC156 Colors and Fonts For every event state you can specify colors and font styles. The colors and fonts you select will display in the status bar and in the Active Event View or Active Alarm View when an event associated with this EventNotification is delivered. To select colors and fonts, place your cursor in the Alarm Colors, RTN Colors or Fault Colors area of the General tab. Right click to display a pop-up menu. To select a new font style and size, select Font. The Font dialog appears. Select a font and font style from the scrollable lists. As you make your selections, you’ll see an example of the font and all the settings you’ve chosen in the Sample text field. For more help, click the button. Click specific area of the Font dialog. Click OK to save your font settings. To select background color and text colors, select Background Color or Text Color. Click a basic color, or click Define Custom Colors if you don’t see a color you like. This adds a color matrix to the dialog. Define your color by changing the Hue, Sat, Lum, Red, Green, and Blue settings. You can enter either of these settings, or change them by clicking anywhere in the matrix and by moving the cursor. Click Add to Default Colors when you are finished. For more help, click the button. Click specific area of the Color dialog. Click OK to save your color settings. Repeat The repeat interval specifies how many minutes the workstation will wait until re-issuing the event. When an event is re-issued, its repeat actions are carried out. Re-issuing continues until the event is either silenced or acknowledged. To enter a repeat interval, type the number of minutes into the Repeat field on the General tab.
- 169. Andover Continuum CyberStation Configurator’s Guide 157 Ack Rules Acknowledgment rules simplify the task of acknowledging alarms whose EventNotification objects are configured for multiple entries. From the General tab, select one of the following rules from the Ack Rules dropdown menu. AckAll - Acknowledge all reported events for the same alarm. AckUntilTime - Acknowledge the currently selected event and all events reported before this one for the same alarm. AckOnlyThisOne - Acknowledge only the currently selected event for this alarm. These acknowledgment rules apply to just one object at a time. For example, if RoomTemp1 and RoomTemp2 both trigger an alarm named TooHot, when the operator acknowledges the alarm triggered by RoomTemp1 the AckAll and AckUntilTime rules won’t acknowledge the alarm triggered by RoomTemp2. Event Configuration Select either Multiple Entry or Single Entry. This determines whether or not the Active Alarm View will display an additional entry every time the event changes state. Single Entry is recommended, as this will decrease the number of entries in the Active Alarm View. If you select Multiple Entry, select an acknowledgment rule as well. Understanding Alarms Every reported event has an attribute named “ToState”. The value of this attribute is determined by the status of the alarm that triggered the event. At any given time, an event has one of three possible statuses: Alarm, Return to Normal, and Fault. Listed below you’ll see an explanation of each state and how each one triggers an event. Alarm When an object’s attributes changes to what has been previously established as being outside normal operating standards, the object’s event state changes to Alarm. If the AlarmEnrollment object or the basic alarm associated with the object has the Alarm report option selected, the controller sends this out as an event. This event displays in the Active Alarm View with a ToState value of Alarm. How and to whom the event is delivered is determined by the AlarmEnrollment object’s associated EventNotification object. Return to Normal When an object’s attributes changes to what has been previously established as being normal, the object’s event state changes to Return to Normal. If the AlarmEnrollment object or the basic alarm associated with the object has the Return to Normal report option selected, the controller sends this out as an event. This event displays in the Active Alarm View with a ToState value of Return to Normal. How and to whom the event is delivered is determined by the AlarmEnrollment object’s associated EventNotification object.
- 170. TAC158 Fault When a device that is local to the object detects a fault, the object is said to be in a Fault state. The ability to detect faults and the messages associated with faults vary depending on the device manufacturer. If the AlarmEnrollment object or the basic alarm associated with the object has the Fault report option selected, the controller sends this out as an event. This event displays in the Active Alarm with a ToState value of Fault. How and to who the event is delivered is determined by the associated EventNotification object. Note: When installing more than 64 CyberStation workstations (NetworkID 191-254), you will need to set the NetworkID to 0 and also set the DeviceID to a unique number. Refer to “Setting Up Workstation Parameters” in the Continuum Installation Guide, 30-3001-720. CyberStation workstations with NetworkID 0 shall receive alarms and participate as a normal CyberStation. The EventNotification Actions Tab The Actions tab lets you define how the event is enunciated. Print Alarm If the event is in an Alarm state, sends event notification to the system printer. This action requires the Alarm report option to be selected, and it requires that a workstation is selected as a printer in the Delivery tab. Print Return to Normal If the event is in a Return to Normal state, sends event notification to the system printer. This action requires the Return to Normal report option to be selected, and it requires that a workstation is selected as a printer in the Delivery tab.
- 171. Andover Continuum CyberStation Configurator’s Guide 159 Print Fault If the event is in a Fault state, sends event notification to the system printer. This action requires the Fault report option to be selected, and it requires that a workstation is selected as a printer in the Delivery tab. Print Acknowledgment Sends a message to the system printer when the event is acknowledged. The message contains the same information that is displayed in the alarm and event viewers. This action requires that a workstation be selected as a printer in the Delivery tab. Run Program Runs the Plain English program specified on the Alarms or Advanced Alarms tabs of the alarmed object’s editor. Not available for Basic Alarms. Remove from Alarm Line on Acknowledged Always removes the event from the status line alarm of the Active Alarm View, when acknowledged. Beep on Alarm If the event is in an Alarm state, causes workstations to beep continuously when the event is delivered. Beep on Return to Normal If the event is in a Return to Normal state, causes workstations to beep continuously when an event notification is delivered. Beep on Fault If the event is in a Fault state, causes workstations to beep continuously when event is in a Fault state. Play Audio on Alarm Plays the alarm audio file selected from the EventNotification or AlarmEnrollment Feedback tab. Play Audio on Return to Normal Plays the Return to Normal audio file selected from the Feedback tab. Play Audio on Fault Plays the fault audio file selected from the Feedback tab. Display Panel Displays the panel specified on the Alarms or Advanced Alarms tabs of the object editor. Not available for Basic Alarms. Display Alarm View Displays the Active Alarm View when the event is received. Note: The Active Alarm View’s View menu has an entry called Always on top. When this option is selected, the alarm view will always be the top most window. Display Video Displays the surveillance video monitor (the VideoLayout editor) when this alarm event occurs. For more information on VideoLayouts, please see Chapter 25. Blink on Alarm Causes events to blink in the status line of the Active Alarm View. Note that when Continuum is minimized, its task bar icon will blink instead.
- 172. TAC160 Email on Alarm Sends an Alarm event notification to all Email recipients in the EventNotification distribution list. Note: When running under Windows XP this distribution list is called Contact. Email on Return to Normal Sends a Return to Normal event notification to all Email recipients in the EventNotification distribution list. Email on Fault Sends a Fault event notification to all Email recipients in the EventNotification distribution list. Email on Acknowledgement Sends an event acknowledgement message to all Email recipients in the EventNotification distribution list. Page on Alarm Sends an Alarm event notification to all pager recipients in the EventNotification distribution list. Page on Return to Normal Sends a Return to Normal event notification to all pager recipients in the EventNotification distribution list. Page on Fault Sends a Fault event notification to all pager recipients in the EventNotification distribution list. Page on Acknowledgement Sends an event acknowledgement message to all pager recipients in the EventNotification distribution list. The EventNotification Delivery Tab The Delivery tab is where you create a recipient list. Every workstation in the list receives and views events associated with this EventNotification object in the status line of the Alarm Bar and their Alarm View.
- 173. Andover Continuum CyberStation Configurator’s Guide 161 Via the Recipients Configuration dialog described on the next page, for each workstation that you add to the recipient list, you specify the following: • The valid days the workstation will receive event notification. • The valid time periods during which the workstation will receive notification. • Which notification actions for which the workstation is responsible. Notification actions include forwarding, printing, e-mailing, paging and logging. These actions are optional; however, for compatibility with Infinity controllers, you must designate one workstation to forward events. • Whether the workstation is designated as one that downloads and forwards alarm notification messages to other BACnet recipient workstations. (At least one workstation recipient in the list must be designated this way. See the description of the Download To BACnet Device checkbox on the next page.) To delete a recipient workstation from the list, select it and click Remove Recipient. To add a recipient, click the Add Recipient button. This displays the Recipients Configuration dialog, shown and described on the next page. Note: The Send to All Workstations checkbox is always unselectable and appears in gray. See the description of the Recipients Configuration dialog, next. Recipient Click the button next to the Recipient field. This displays Continuum’s Browse dialog for devices. Use this dialog to find the workstation you want. Click Select to insert the correct path and workstation name into the Recipient field.
- 174. TAC162 BACnet Address To ensure that Continuum knows about a specific BACnet destination recipient, and to differentiate between a BACnet global broadcast and delivery to a specific BACnet device, check this checkbox. When you check this box, the Recipient field's browse button becomes a dropdown menu, offering the following choices: • Global Broadcast — Select this option to deliver event messages as a global BACnet broadcast. • Net:MAC — Select this option if the message must be delivered to a specific BACnet destination recipient. When you select this option, Net:Mac appears in the Recipient field. Identify the device by entering the network number and the MAC address number for the device in this field. The network number is an integer. The MAC address number is hexadecimal. For example: 13:002B. The hexadecimal MAC address number must have an even number of digits, include leading zeros in the octet. If you enter an odd number of digits, you will receive an error message. When you select the BACnet Address box, the Primary, Backup, and Repeat checkboxes become disabled. Guarantee Delivery Check this checkbox to guarantee delivery of message, from a BACnet device to CyberStation recipients or other BACnet device recipients. Download To BACnet Device Check this checkbox to download and forward alarms from this recipient workstation to other BACnet recipient workstations. This option conserves memory in BACnet devices in the system. At least one workstation in the recipient list must be designated as a downloading and forwarding workstation. When this is checked for this recipient, the Download column on the Delivery tab displays the value, True. Valid Days Select the days on which this workstation will receive notification. Simply click the checkboxes next to the days you want. From Time To Time Enter the From and To times this workstation can receive event notification. Select the hour, minute, second, or AM/PM setting you wish to change. Type over the existing value, or click the up and down arrows to change the value. Noncontiguous times are supported such as: From = 7pm To = 6am This is equivalent to 7pm – 11:59pm 12am – 6am
- 175. Andover Continuum CyberStation Configurator’s Guide 163 Primary, Backup, Repeat Select forwarding, emailing and paging notification tasks to be carried out by the primary and/or backup workstations as described below. Transitions In this section, select the event transition states for an event notification that is sent to this recipient workstation. Check the checkboxes for ToOffNormal, ToFault, and ToNormal. These selections specify which transitions control the delivery of an event notification to this recipient workstation. For example, you may not want to notify a security guard about a device fault. Distributing Tasks to Several Workstations Each workstation in your recipient list can be assigned tasks such as printing the event or sending email about the event to a select group of people. By assigning different tasks to different workstations, you can distribute important tasks to your faster machines, and give the less crucial tasks to slower machines. You can also designate a workstation as either the primary or backup machine for each task. Primary workstations are simply workstations that are primarily responsible for the task. Backup workstations only perform the task if the primary workstation is off-line. For this purpose, the Delivery tab’s Recipients Configuration dialog has three columns of responsibilities, Primary, Backup, and Repeat, and a list of tasks, shown below: To display the Recipient Configuration dialog, double-click a recipient you would like to edit, or click the Add Recipient button to work on a new recipient. To assign a task to a workstation, click in either the Primary or Backup column for that task. If you would like the workstation to perform the task only if the event has been repeated, click in the Repeat column as well. The repeat interval is determined by what you set in minutes on the Repeat field on the General tab. (See EventNotification General Tab, earlier in this chapter.) Each column contains the following actions: Print Prints the notification. Alarms, Returns to Normal, faults, and acknowledgements are sent to designated alarm printers of the primary and backup workstations. You can assign the path to the alarm printer via the Continuum Preferences dialog. The Windows default printer is used if the field is left blank. If “suppress form feed” is selected, it is assumed that a raster printer is being used. In this case, the printer must be local to the printing workstation.
- 176. TAC164 Forward Sends notification to the other workstations in the recipient list. This is currently used for all alarm acknowledgements, alarm silencing and BACnet alarms. Log This is applicable to versions earlier than version 1.5, which implemented enhanced alarm logging. If you have an old version (or if the Enhanced Alarm Logging checkbox on the Database Initialization dialog was not checked during Continuum installation) checking the Log box creates a log of events in a Listview. E-mail Sends email to everyone in this EventNotification email distribution list. Paging Pages everyone in this EventNotification page distribution list. Creating an EventNotification Email and Page Distribution List Requirements for forwarding CyberStation alarms via email or page: • The CyberStation workstations that have been designated primary and backup email and/or page handlers must have a MAPI-compliant email client such as MS Exchange or Outlook. • The email client application can communicate with an existing email server application, such as MS Exchange Server. • The primary or backup email/paging workstation must be running CyberStation at the time an alarm is generated. • Each EventNotification object associated with the alarms that you wish to email or page must have its own email distribution list in the personal address book or Contacts list of the client email application using a specified naming convention as outlined in Step 4 below. • This email distribution list must be stored in the first address book shown in the list of available address books in the email client application. For example, if you create an EventNotification distribution list in the Personal Address Book in Microsoft Outlook, then the Personal Address Book must be the first one showing in the address list dropdown menu when you open the Address Book. Creating an EventNotification Distribution List To create an email or page distribution list, proceed as follows: Note: The following steps are based on Microsoft Outlook. Other mail applications may have different menu names and choices but the general procedure is the same. 1. Open the Address Book for the email account on the CyberStation workstation that will be providing the email/paging service(s). Your toolbar may have a button for this. If not, use the Address Book option of the Tools menu. 2. Select New Entry from the Files menu. 3. Select the entry type Personal Distribution List and put this entry in the Personal Address Book.
- 177. Andover Continuum CyberStation Configurator’s Guide 165 4. In the Name field enter a name for the distribution list using the following format: For Email: ACC.eventnotification_name For Paging: ACC.page.eventnotification_name For example, if your EventNotification object is named Severe, the personal distribution list for email deliveries should be named: ACC.Severe. Likewise, your personal distribution list for page deliveries should be named: ACC.page.Severe. Note: Use the EventNotification object Name not the Alias, for example, Critical Temp, not CriticalTemp. 5. Add members (the email addresses or pager and service numbers of those to whom the notification of the alarm will be sent) to your personal distribution lists. 6. Set address book options so that the address book where your personal distribution lists are stored is the first one to be searched when sending emails or pages. For example, in Microsoft Exchange, select Options from the Tools menu. Click the Addressing tab. When sending mail, check names using these address lists in the following order area, use the Add button, then the up or down arrow buttons to add the correct address book to this field and position it at the top of the list. The EventNotification Deactivate Tab The Deactivate tab is where you select a condition that must exist before the controller removes the event from the Active Alarm View. To select a condition, click one of the following options:
- 178. TAC166 Acknowledged Removes the event when it is acknowledged Returned to Normal Removes the event when the event status returns to normal Acknowledged OR Returned to Normal Removes the event when either the event status returns to normal, or is acknowledged Acknowledged AND Returned to Normal Removes the event when both the event status returns to normal and is acknowledged Acknowledged AFTER Returned to Normal Removes the event when it is acknowledged only after its status returns to normal. Note: You can use the deactivation criteria along with the reporting options in the alarm enrollment editor to achieve the desired results. The EventNotification Feedback Tab Use the Feedback tab to associate an audio file to each event state. You use audio files when you want a recorded message or sound to play on workstations when an event is delivered. You can associate a different audio file to each event state. This is useful for alerting and informing operators as to the specific and appropriate response for different event states. Here are some basic points to keep in mind when associating audio files: • For every audio file you add to this tab, make sure you select the corresponding action on the Actions tab. In other words, if you associate an audio file with the Alarm state, select Play Audio on Alarm on the Actions tab. • You may also select audio files for AlarmEnrollment objects. Every AlarmEnrollment object has a designated EventNotification object that defines how the alarm will be
- 179. Andover Continuum CyberStation Configurator’s Guide 167 delivered. When an AlarmEnrollment object with audio has an EventNotification object with audio files, the AlarmEnrollment audio files take precedence. • Some objects can have basic alarms in addition to associated AlarmEnrollment objects. Basic alarms are specific to one object, unlike AlarmEnrollment objects, which can be associated to many objects. Like AlarmEnrollment objects, basic alarms have designated EventNotification objects that define how the basic alarm will be delivered. Consequently, the audio files you specify on this tab will apply to all basic alarms associated with this EventNotification object. • To associate an audio file to an Alarm, Return to Normal or Fault event state, click the button next to the appropriate text field. This will display the dialog shown below: Audio files have a .wav file extension. You may have to navigate to the system folder that contains your audio files. Click the button, then click in the Look in field for help on moving to different folders. Once you have found the file you want, select it and click the Open button. This will close the dialog and insert the correct path and audio file name into the Feedback tab. The EventNotification Security Level Tab For details in attaching or detaching Security Levels, see Chapter 4, Security.
- 180. TAC168 About AlarmEnrollment AlarmEnrollment objects define the set of conditions used to determine when a point is in an alarm state. They specify the text messages that appear in the Active Alarm View. When you create objects in Continuum, you have the option to attach up to eight alarms to it. For example, you could set up an InfinityInput object for a temperature sensor so that an alarm goes off when the temperature gets too high. Each AlarmEnrollment object is associated with an EventNotification object. To create an AlarmEnrollment object, you’ll make decisions based on the following questions: Which attributes will trigger this alarm? You’ll answer this question by selecting an attribute on the General tab. Most of the time alarms are set up to monitor the value attribute. Who will be notified of this alarm? You’ll answer this question by selecting an EventNotification object on the General tab. EventNotification objects determine, among other things, which workstations receive notification, and which methods are used for notification. What Algorithm will this alarm use? You’ll answer this question by selecting an algorithm and providing its parameters on the Algorithms tab. An algorithm is a set of rules by which an alarm is evaluated. What will operators see and hear when this alarm goes off? You’ll answer this question by writing text messages and selecting audio files for each event state. The text messages you write will appear in the Active Alarm View, alarm log, emails, pages, and printer output. After you have configured an alarm, you can review the details of the configuration with the following: • Active Alarm View • All Alarms ListView • Object editors Note: Continuum provides coverage for BACnet compliant devices. Configuring alarms for these devices requires a new object class called EventEnrollment. Refer to Chapter 14 for more information on the EventEnrollment editor.
- 181. Andover Continuum CyberStation Configurator’s Guide 169 Using the AlarmEnrollment Editor The AlarmEnrollment editor is a series of tabs. Each tab contains text fields, buttons, and dropdown menus that you use to define or modify AlarmEnrollment objects. You’ll enter text in the text fields, and make choices by clicking buttons and selecting from lists of possibilities. The AlarmEnrollment General Tab The General tab is where you’ll enter basic information about the event. You’ll provide information for the following attributes: Description The description, although optional, is an important part of an AlarmEnrollment object. A good description helps future users. To enter a description, type it into the Description text field on the General tab. Your description can be up to 32 characters (including spaces) long. Event Notification Browse for an EventNotification object. This will insert the correct path and object name into the Event Notification text field.
- 182. TAC170 Alarmed Attribute Only used for workstation alarms. Select an attribute from the dropdown menu. This is a list of all of the possible attributes from all object classes. Based on the algorithm parameters you set on the Algorithms tab, the value of the attribute you select from this list triggers the alarm. For security applications, the Alarmed Attribute will always be Value. Infinity always uses Value for a hi/lo limit or expression. Send When checked, each Send option causes the event to be displayed to the Active Alarm View and all recipients on the notification list when the associated point changes to that status. The Alarm option reports the alarm when the point goes into an alarm state. The Return to Normal option reports the alarm when the point returns to normal. The Fault option reports the alarm when a BACnet device local to the point detects and reports a mechanical fault. For example, if both Alarm and Return to Normal are checked, the event is displayed when the point first goes into alarm and again when it returns to normal. If no option is checked, no events are reported. Alarm Type The selection you make here determines what fields display on the Algorithms tab of this editor. The choices of Infinity alarm types are: Expression Infinity Low Limit Infinity High Limit *Change of State *Command Failure *Floating Limit *Out of Range *These alarms are only applicable to BACnet objects. Refer to “The EventEnrollment Algorithms Tab” in Chapter 14. Notification Type From the dropdown menu, select a notification type. The notification type specifies whether the notification message appears in the Active Alarm View as an alarm message, an event message, or a message of event acknowledgement.
- 183. Andover Continuum CyberStation Configurator’s Guide 171 The AlarmEnrollment Algorithms Tab The attributes on this tab change, depending on the Alarm Type you selected from the General tab. Time Delay Time Delay appears on the Algorithms tab for each of the choices of Alarm Type. In the Time Delay field, enter the number of seconds you want to postpone evaluating the alarm. For example, you may decide that the point value can exceed or fall below its alarm boundaries for 30 seconds before the alarm goes off. Note: The alarm must be active at the end of the time delay. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility by filtering out some nuisance alarms Algorithm Fields The other fields that appear on the Algorithms tab differ according to the Alarm Type selected on the General tab. The above figure reflects an Expression Alarm Type selection.
- 184. TAC172 Algorithm Parameters for an Infinity High Limit Alarm Infinity High Limit Alarms can be attached to the following Infinity objects: • InfinityNumeric • InfinityInput • InfinityOutput • InfinityDateTime • InfinitySystemVariable When you select Infinity High Limit from the Alarm Type of the General tab, the following fields appear on the Algorithms tab. This algorithm is used with Infinity points to report an alarm if the alarmed attribute value changes to a value that is equal to or above a high limit that you specify. You’ll also specify a value that the value must change to (or below) before a Return to Normal state can be reported. To Use an Infinity High Limit Algorithm: 1. Enter a high limit value in the text field marked High Limit. 2. Enter a return to normal value in the text field marked Return to Normal. Algorithm Parameters for an Infinity Low Limit Alarm Infinity Low Limit Alarms can be attached to the following Infinity objects: • InfinityNumeric • InfinityInput • InfinityOutput • InfinityDateTime • InfinitySystemVariable When you select Infinity Low Limit from the Alarm Type of the General tab, the following fields appear on the Algorithms tab: This algorithm is used with Infinity points to report an alarm if the alarmed attribute value changes to a value that is equal to or below a low limit that you specify. You’ll also specify a value that the value must change to (or above) before a Return to Normal state can be reported.
- 185. Andover Continuum CyberStation Configurator’s Guide 173 To Use an Infinity Low Limit Algorithm: 1. Enter a low limit value in the text field marked Low Limit. 2. Enter a return to normal value in the text field marked Return to Normal. Algorithm Parameters for an Expression Alarm When you select Expression from the Alarm Type dropdown menu of the General tab, the following field appears on the Algorithms tab: To enter an expression, type it into the text field. How Do Expression Alarms Work? An expression algorithm tests for a condition that is not within normal operating parameters. This condition is defined using an expression such as: ABS(VALUE - Point1) > 3 If the expression results in a value of TRUE, the associated point reports an alarm. If the expression results in a value of FALSE, the associated point does not report an alarm. Alarm Points in Expressions — Alarm points allow you to attach an expression alarm to multiple points. The expression on the Algorithms tab does this by including a "point" variable name, rather than an actual point name. When this expression alarm, in turn, is attached to an object (for example, an AnalogInput or a Door) the alarm references up to four alarm points, which are named Point 1, Point 2, Point 3, and Point 4. Alarm point configuration is performed via the Alarm Points dialog: The Alarm Points dialog is accessed from the Alarms tab or Advanced Alarms tab of the following object editors: AnalogInput, AnalogOutput, AnalogValue, BinaryInput, BinaryOutput, BinaryValue, Door, InfinityInput, InfinityNumeric, InfinitySystemVariable, MultistateInput, MultistateOutput, MultistateValue, or Network. (See: Attaching Alarms to a Point, later in this chapter.)
- 186. TAC174 Using alarm points saves you the trouble of having to change the expression every time you attach an expression alarm to a different point. You must configure these alarm points when you attach an alarm to an object. That is, you must specify the actual point names for every alarm point the expression references. The referenced point, for example, can be an input-point temperature reading. The AlarmEnrollment Feedback Tab The Feedback tab lets you write text messages for the Active Alarm View list and the Alarm Bar and to associate an audio file with each event state. Text Messages You can write a different message for each possible event state, Alarm, Return to Normal and Fault. Continuum supports ‘wild card’ characters ‘%n’ and ‘%d’, which inserts the corresponding name and description of the alarmed object. For example, “%n went into alarm” yields: “mytempsensor went into alarm.” A good text messages alerts operators to the nature and severity of the alarm. For example, “Temperature is too high” or “Door Forced Open.” For more on Text Messages, see the next section, Writing Alarm Messages. Audio Files Use audio files when you want a recorded message or sound to play on workstations when an event is delivered. You can associate a different file with each event state. This is useful for alerting and informing operators as to the specific and appropriate response for different event states.
- 187. Andover Continuum CyberStation Configurator’s Guide 175 Note: For every audio file you add to this tab, select the corresponding action on the Actions tab of the associated EventNotification object. In other words, if you associate an audio file with Alarm, make sure the associated EventNotification object has Play Audio on Alarm selected on its Actions tab. Note: Some EventNotification objects have audio files associated with event states as well. When an AlarmEnrollment object with audio has an associated EventNotification object with audio files, the AlarmEnrollment audio files take precedence. Writing Alarm Messages Use the Feedback tab to write the text message that will appear in the active list and the Alarm Bar. You can write a different message for each possible state: Alarm, Return to Normal, and Fault. Good text messages alert operators to the nature and severity of the alarm. To enter a text message, type it into the appropriate text field. Using the Name and Description Fields of Objects as Alarm Message Text You can create custom alarm messages with the %D and %N features of Continuum, without creating custom AlarmEnrollment objects for each Alarm, Return to Normal, or Fault: %D is like a shortcut to the Description field of the object to which the AlarmEnrollment is attached. %N is like a shortcut to the Name field of the object to which the AlarmEnrollment is attached. Use %D or %N in your text messages in the Alarm, Return to Normal, or Fault fields on the Feedback tab to insert the Description or Name of the object in alarm. When a point alarm, return to normal, or fault is generated, the message in Active Alarm View (see page 10-180) displays the point Description field inserted in place of the %D character and the point Name field inserted in place of the %N character. Example: A motion detector is configured as an InfinityInput named "Motion3B" and has a Description field entry "motion detect in 3rd fl comp lab, bldg B". An AlarmEnrollment object for an after hours motion alarm is created with the alarm text message, "%N, the %d, is in alarm. Call the security desk at 978 470-0555". When generated, the alarm will read "Motion3B, the motion detector in the 3rd floor computer lab, building B, is in alarm. Call the security desk at 978 470-0555". Note: This feature is case-insensitive. %D is the same as %d, %N is the same as %n.
- 188. TAC176 Attaching Alarms to a Point Once you have created the appropriate EventNotification and AlarmEnrollment objects, you need to open a point object editor. From the navigation pane of the Continuum Explorer: 1. Double click the Infinity controller that contains the points you want to alarm. 2. In the viewing pane of Continuum Explorer, right click the icon for the point, and select Open from the drop down menu. The object editor for that point will appear. 3. Select the Alarms tab (or Advanced Alarms tab on some object editors). The Alarms tab (or Advanced Alarms tab) appears. For example:
- 189. Andover Continuum CyberStation Configurator’s Guide 177 Using the Alarms / Advanced Alarms Tab of an Object Editor Use the Alarms tab (or Advanced Alarms tab) to browse for up to eight AlarmEnrollment objects to attach to the point. To attach an alarm to an object: 1. Click the browse button in one of the empty alarm fields. 2. Search and find the alarm you want. 3. Click the Select button. 4. Check the Enabled checkbox. To delete an attached alarm, select its name in the text field and press the Delete key on your keyboard. Graphic Click the browse button in the Graphic field to search for the desired graphic panel that you want to appear when the alarm goes off. Select the page number of the graphic panel you want first to appear. Program Click the browse button in the Program field to search for the desired report program or any other Plain English program to this object. Note: You cannot select an HTML report directly. To associate an HTML report with an object, you must select a program that uses the SHOWREPORT keyword to run an HTML report. An example of the SHOWREPORT keyword is: SHOWREPORT “C:PROGRAM FILESCONTINUUMREPORTSSYSTEMCHK.HTM” Alarm Points Alarm points allow any expression alarm that you attach on this tab to reference up to four "alarm points," named Point 1, Point 2, Point 3, and Point 4. Using alarm points saves you the trouble of having to change the expression (via the Algorithms tab of the AlarmEnrollment editor for that alarm object) every time you attach an expression alarm to a different point:
- 190. TAC178 See: Algorithm Parameters for an Expression Alarm, earlier in this chapter. To configure these alarm points for an attached expression alarm, click the Alarm Points button to bring up the Alarm Points dialog: Using the Alarm Points dialog, you must specify the actual point names for every alarm point the attached expression alarm references. The referenced point, for example, can be an input-point temperature reading. (See also: Using an Expression Algorithm.) Follow this procedure: 1. In the General tab of the AlarmEnrollment editor, for the alarm you want to attach, make sure that you select Expression for the Alarm Type. Any attached alarm to which you want to apply alarm points must be an expression alarm. 2. In the Algorithms tab of the AlarmEnrollment editor, enter the expression in the Expression field. When you want to use alarm points, the alarm point name (point1, point2, point3, or point4) must be part of the expression. For example: ...value > point1 + 2... 5. Save the AlarmEnrolllment object after making these expression-alarm changes. 6. On this tab of this editor, click the Alarm Points button to search for and select the name of an object for every alarm point referenced by attached expression alarm. The Alarm Points dialog appears, showing fields
- 191. Andover Continuum CyberStation Configurator’s Guide 179 where you may specify up to four point names, Point 1 through Point 4. 7. Click the browse button in one of the point's fields. 8. Once you have found the point you want, click the Select button. That point specified in the field will be associated with that alarm point and applied to the attached expression alarm, which references the point. 9. Click OK. Video Points Click the Video Points button to bring up the Video Points dialog: Use the Video Points dialog to assign cameras to doors and points and configure parameters that control video images, via VideoLayout objects, during alarm conditions. When the alarm goes off, a video layout is launched (if a VideoLayout object has been configured to work with video points) and displays the "video point" camera images in the its video image frames. In the Video Points dialog, you may also configure a camera to record a video clip, for specified number of seconds, when the alarm goes off. For complete information about video layouts and video configuration, please see Chapter 25, Configuring and Viewing Video. Use the Video Points dialog to assign between one and four "video point" cameras — point 1 through point 4. Use the Video Servers dropdown menu to select a video server on which the camera is located. (A VideoServer object must be already configured and the server online. See Using the Video Server Editor in Chapter 25.) Use the Cameras dropdown menu to select a camera for the numbered video point. (The camera must be configured and enabled on the selected video server.) Check the Rec. checkbox to enable the recording of a video clip from the selected camera. Recording begins at the moment the alarm goes off. In the Duration field, use the up and down arrows to select the number of seconds to record a video clip, once you check the Rec. checkbox. In the PTZ field, select the number of the preset camera view. (These PTZ
- 192. TAC180 (pan, tilt, zoom) capabilities are configured on the Integral video servers, using Integral software. See Overview of Integration and Configuration in Chapter 25.) If you are associating a VideoLayout with the video points for this object, then you must first reference these video points from the General tab of the VideoLayout editor. (See Chapter 25.) Active Alarm View The active alarm view window displays a list of active alarms. From this window you can perform the following basic tasks: • Respond to alarms • View information about alarms to which other operators have already responded • Organize alarm information The active alarm view is displayed one of two ways: • Alarm View mode • Status Line mode The Active Alarm view is never displayed in both modes ⎯ it is always in one or the other mode selected by the user. The Alarm View Mode To enter the Active Alarm View mode: 1. Right click the alarm icon in the Windows tool tray. 2. From the popup menu, select Alarm Viewer. The Active Alarm View window appears on the screen: Components of the Active Alarm View The Active Alarm View window contains a menu bar, a tool bar, and a list of alarms. A horizontal scroll bar at the bottom of the view is used to expand the Alarm List in order to cover all the information provided for each alarm. (See The Alarm List, later in this chapter.)
- 193. Andover Continuum CyberStation Configurator’s Guide 181 The Menu Bar Just beneath the Active Alarm View title bar is the menu bar. The menu bar consists of the following menus: • ObjectUsing_the_Object_Menu>(w95sec) • View • Acknowledge • Mute • Help Each of these menus is discussed below. The Object Menu The Object menu options are not available in this release: The View Menu The View menu consists of the following options. A check mark to the left of a menu option indicates that option is selected: Menu Option Description Toolbar Displays the tool bar when selected. Hides the tool bar when not selected. Status Bar Displays the status bar when selected. Hides the status bar when not selected. Sort Displays the Sort Criteria dialog, which defines the criteria for sorting the contents of the active alarm view. Auto Sort Automatically sorts the contents of the active alarm view whenever a new alarm is received, according to the criteria defined in the Sort Criteria dialog.
- 194. TAC182 Menu Option Description Freeze Stops alarm list scrolling when selected. Allows alarm list scrolling when not selected. Add/Remove Columns Allows you to add or remove columns from the Active Alarm View. Always on Top Upon opening the active alarm view, places the window on top of all other windows on your desktop. When you make this selection, you are prevented from clicking on any other window or process and bringing it in front of the Active Alarm View window. Hide Hides the active alarm view. When the active alarm view is hidden, the alarm view icon blinks in the alarm tray. Alarm Status Line Places the Active Alarm View into status line mode. The alarm that appears in the alarm status line is the first alarm (at the top of the list) that either has not been acknowledged or has been acknowledged but does not have the Remove From Status Line When Acknowledged box checked in the event notification object assigned to the alarm. In status line mode, the active alarm view list never appears. Likewise, in alarm view mode, the alarm status line never appears. Alarm Enrollment… Displays the alarm enrollment editor associated with the selected alarm. Event Notification… Displays the event notification editor that is associated with the selected alarm. Object… Displays the object editor of the object that is associated with the selected alarm. Program Output… Displays and runs the report program that is attached to the object that is associated with the selected alarm. Graphic… Displays graphic panel of the object that is associated with the selected alarm. Video Displays the surveillance video monitor (the VideoLayout editor) for the selected alarm when its point goes into alarm. This is the VideoLayout attached to the point for this alarm. (See Chapter 25, Configuring and Viewing Video.)
- 195. Andover Continuum CyberStation Configurator’s Guide 183 Menu Option Description Alarm Function Executes a user-defined Plain English function for the selected alarm, to make something special happen, regarding the alarm. The alarm's attributes are passed as arguments into the function, and the function runs. Note: See your Continuum CyberStation Release Notes for specific instructions on creating a custom, user- defined alarm function. The Acknowledge Menu The Acknowledge menu provides two methods for acknowledging alarms: Menu Option Description Ack Selected Selects a single alarm in the Active Alarm View list to acknowledge. Ack All Selects all the alarms in the Active Alarm View list to acknowledge. The Mute! Button This selection on the tool bar acts as a button since there is no menu associated with it. Clicking on it will mute (turn off) the sound of an audio alarm selected in the Alarm List of the Active Alarm View. The Help Menu Clicking on Help and then selecting Contents from the drop-down menu will take you to Continuum’s extensive online help system.
- 196. TAC184 The Tool Bar The below table provides you with the descriptions of the different Alarm View tool bar icons. The use of these icons is described throughout the following pages. Click This Icon… To . . . Print Screen. Not available in this release. Acknowledge all alarms. Acknowledge selected alarms. Freeze the scrolling list of active alarms. or Restart the scrolling of active alarms. Mute audio alarms. Run a report previously defined on the Alarms page of the object that caused the alarm. Bring up the surveillance video monitor (the VideoLayout editor) when a point goes into an alarm. This is the VideoLayout object attached to the point for this alarm. (See Chapter 25, Configuring and Viewing Video.) Display a graphics panel previously selected on Alarms page of the object that caused the alarm. Execute a user-defined Plain English function for an alarm in the list, to make something special happen, regarding the alarm. Select (highlight) an alarm, and click this alarm-function icon. The alarm's attributes are passed as arguments into the function, and the function runs. Note: See your Continuum CyberStation Release Notes for specific instructions on creating a custom, user-defined alarm function. Object. Displays the object editor that is associated with the selected alarm Event Notification. Displays the event notification editor that is associated with the selected alarm.
- 197. Andover Continuum CyberStation Configurator’s Guide 185 Click This Icon… To . . . Alarm Enrollment. Displays the AlarmEnrollment or EventEnrollment editor associated with the selected alarm. Auto Sort. Automatically sort the contents of the Active Alarm View whenever a new alarm is received, according to the criteria defined in the Sort Criteria dialog, which is accessed via the View menu. Access the Help topics for Active Alarm View. The Alarm List The Active Alarm View displays the following information about each alarm appearing in the Alarm List: Column Heading Column Contents Date/Time Date and time the alarm occurred. Name Name of the object that triggered the alarm. Value Value of the object that triggered the alarm. To State State Priority Priority number assigned to the alarm on the General tab of the AlarmEnrollment object. Type Type of alarm that was selected on the General tab of the AlarmEnrollment object. Message Message typed in on the Feedback tab of the AlarmEnrollment object. Event Notification Name of the EventNotification object. Alarm Enrollment Name of the AlarmEnrollment object. Operator Text Text entered by the operator to further explain actions taken in response to the alarm. An alternative is for the operator to click the text field column of the alarm and type text in that Alarm Viewer field. User Actions Dropdown menu of actions taken in response to each alarm. Acknowledged By User name of the person who acknowledged the alarm. This is filled in automatically when the alarm is acknowledged. Date/Time of Acknowledgement Date and time the alarm was acknowledged. This is filled in automatically when the alarm is acknowledged. Silenced By User name of the person who silenced the alarm. This is filled in automatically when the alarm is acknowledged.
- 198. TAC186 Column Heading Column Contents Date/Time of Silence Date and time the alarm was silenced. This is filled in automatically when the alarm is silenced. Forcing the Alarm View to Display via Popup Menu The Show on Active Alarm selection, located under Options in the alarm icon’s tool tray popup menu, allows you to force the active alarm view to display whenever an active alarm is triggered. To do this: Right click the alarm icon in the tool tray, then select Options: Show on Active Alarm is checked by default, so you must deselect it when you do not want the active alarm view to display on an active alarm. Selecting this option overrides the event notification for the active alarm, whenever the Event Notification editor’s Display Alarm View option for the alarm is not selected. Note: When neither the Show on Active Alarm option nor the EventNotification editor’s Display Alarm View option is selected for the active alarm, the active alarm view is not displayed. Instead, the alarm icon in the tool tray flashes. The Status Line Mode To enter the Active Alarm View mode: 1. Right click the alarm icon in the Windows tool tray. 2. From the popup menu, select Display and Alarm Status Line. 3. The Active Alarm Status Line appears in the Alarm Bar at the bottom of the Continuum Explorer window. When the active alarm view is in status line mode, the Active Alarm View window disappears. In Status Line mode, the alarm that appears in the status field: • Is the first alarm that would appear at the top of the Active Alarm View list. • Has not been acknowledged. • Has been acknowledged but does not have the Remove From Alarm Line on Acknowledged box checked in the Actions tab of the EventNotification editor.
- 199. Andover Continuum CyberStation Configurator’s Guide 187 You can also select the Status Line mode from the View menu by clicking on Alarm Status Line. In Status Line mode, you can right click the alarm icon in the Windows tool tray to access its context popup menu. Menu Option Description Hide Hides the status line. Alarm Viewer Switches from status line mode to alarm view mode, displaying the complete active alarm view list. Always on top Upon opening the active alarm view, places the active alarm view window on top of all other windows on your desktop. When you make this selection, you are prevented from bringing any other window or process to the front of the active alarm view window. To return to the Active Alarm View, click the alarm icon located at the right of the Status Line field. Working With the Features of the Active Alarm View The Active Alarm View is designed to help you respond to and document the results of each alarm quickly and easily. You can perform the following tasks directly from the Active Alarm View: Stop and Start Scrolling the Alarm List New alarms appear in the Active Alarm View as they occur. When this happens the alarm list scrolls down to make room for new alarms. If you need to concentrate on a particular alarm, you can momentarily stop the scrolling. This allows you to silence, add information or acknowledge that alarm without having to constantly scroll up to find it. When you have finished working with the alarm, you can restart the scrolling. There are two methods for stopping and starting the scrolling alarm list: Click the icon in the Active Alarm View tool bar. The icon, which resembles a traffic light, changes from a green to a red light, shown below: Click this icon to resume scrolling, or select Freeze from the View menu. Deselect it to resume scrolling.
- 200. TAC188 Silence Alarms When an operator silences an alarm, it is silenced on all recipient workstations and is logged in the alarm log. The User name, and date and time of silence appear in the Silenced By and Date/Time of Silence columns of the Active Alarm View. To Silence an Alarm: Click the button to the left of the alarm. You don’t need to select the alarm first. Once you have silenced an alarm, you can not "un-silence" it. You should continue the recommended acknowledgement process if you are playing audio files. Select the actions that have been taken in response to alarms. Note: If an alarm is silenced when CFR is active, the user will be prompted to add comments. See Enabling Operator Text Prompt for Alarm Acknowledgement in Chapter 5. Display Graphic Panels Associated with Alarmed Objects Some alarms have an associated graphic panel. The panel helps operators view the source of the alarm, and in some cases, operate the controls necessary to abate the alarm. To display an alarm’s associated graphic panel, select the alarm by clicking on it. Next, click the icon in the Active Alarm View toolbar. or Click Panel in the menu bar. Not all alarms have associated panels. Running Report Programs Some alarms have an associated report program. Although alarm reports vary depending on the programs that generate them, alarm reports commonly print or display information relating to the alarm. To run an alarm associated report program, select the alarm by clicking on it. Next click the icon in the Active Alarm View toolbar. or Click Program Output in the drop down View menu on the Menu Bar. Note: For you to run a report program, via this method, a program must be attached to the point that is goes into the alarm.
- 201. Andover Continuum CyberStation Configurator’s Guide 189 Acknowledging Alarms Acknowledging an alarm lets other operators know that you have seen the alarm and have taken the appropriate actions. When you use one of the following methods to acknowledge an alarm, your user name will appear in the alarm’s Acknowledged By column. Note: Version 1.51 of Continuum provides the option in the CFR Preferences dialog to require operator response in the form of explanatory text whenever an alarm is acknowledged. See Enable Operator Text Prompt for Alarm Acknowledgement in Chapter 5 for details. Click the ACK button to the left of the alarm that you wish to acknowledge. or Select an alarm by clicking on it, then click the Acknowledge icon in the tool bar. or Click the Acknowledge all alarms icon in the tool bar to acknowledge all active alarms in the list. Note: If the “Enable Operator Text Prompt for Alarm Acknowledgement” value is set to “True” in the CFR Preferences dialog, (see Note, above) the Acknowledge all alarms options will be disabled. or Select Ack Selected from the Acknowledge menu instead of clicking on the icons mentioned above. Viewing Alarm Information No matter who responds to an alarm, the Active Alarm View columns allow all operators to view the following details: Who Silenced the Alarm? Look in the Silenced By column for the user name of the operator who silenced the alarm. This information can be verified in the Alarm Log. What Action Was Taken? Look in the User Action and Operator Text columns to see what action was taken by the person who silenced or acknowledged the alarm. This information can be verified in the Alarm Log. Who Acknowledged the Alarm? Look in the Acknowledged By column to see the user name of the operator who acknowledged the alarm. This information can be verified in the Alarm Log. You can also view the details of any alarm in the Details View dialog.
- 202. TAC190 Displaying the Details View of an Alarm If you want a quick way to look at alarm information without scrolling from side to side, double left click the mouse on the selected alarm. The Details View dialog shown below comes onscreen. From Details View you can: Display the following objects associated with the alarm: • Alarmed object • EventNotification object • AlarmEnrollment object • Acknowledged by user object • Silenced by user object Type messages to the Operator Text field. Entering operator text is an optional task you can perform when responding to alarms. You can enter text that: • Provides additional information about the alarm • Describes the result of the action you took in response to the alarm • Describes a user action not found in the User Action list To enter operator text:
- 203. Andover Continuum CyberStation Configurator’s Guide 191 1. Enter comments in the Add field. 2. Click the Add button. The comments you have entered in the Add field now appears in the Operator Text field. or In the Active Alarm View, click the Operator Text field for the alarm you want to enter text about. 3. Type in the desired comments. 4. Click the ACK button. Creating a List of User Actions Before you can select from a list of user actions, you or someone in your company will have to create the list. To do this, create a text file named Alarm User Actions.txt. In this file, make a list of as many user actions as you like. Type each action on its own line, as shown below: • Repaired the unit • Shut down the unit • Called the fire department • Started evacuation procedure • Notified building security • Confronted the intruder • See Operator Text column The order in which you type the actions determines the order in which the actions will appear in the dropdown menu. Save or copy Alarm User Actions.txt to the following directory: Program FilesContinuum Tip: A complete list of user actions should include an entry such as See Operator Text to provide for unanticipated user actions. By providing this action, the responding operator need not leave the User Action column blank when special circumstances arise. Additionally, directing other operators to the operator text avoids any confusion as to the action that was taken. Select a User Action Selecting a user action for an alarm lets other operators know what has been done in response to that alarm. Locate the alarm in the Active Alarm View to which you would like to respond. Click the Selection control in the User Actions field to display the list. Click the user action of your choice. You may also make your selection from the Details View of the alarm.
- 204. TAC192 Note: If after displaying the list of user actions, you don’t see an action that accurately describes your response to the alarm, type the action you took in the Operator Text column or in the alarm Details View. Click the ACK button to acknowledge the alarm and save the entries for Operator Text and User Actions. Click the Cancel button to take no action here for the alarm. Muting Workstation Alarms Audio alarms play the audio files (.wav) selected in the EventNotification and/or Alarm Enrollment objects. When an audio alarm is triggered, the audio file plays on all designated recipient workstations. Some audio alarms are sent to loudspeakers. Continuum’s Active Alarm View has a mute function that lets you turn off the sound of alarms. Muting alarms stops the current sounds from playing on your workstation and connected loudspeakers only. A mute is logged as an activity. Important Note: Muting alarms is NOT the same as silencing an alarm. Muting Alarms There are three ways to turn off the sound of currently playing audio alarms: Click the mute icon in the Active Alarm View toolbar Click the mute icon in the Alarm Bar Click Mute! in the Active Alarm View menu. Configuring Alarm Messages in the Device Editor There are six text (see below) files that can be configured in any editor and are assigned in the Preferences tab of the Device editor. (See Chapter 14.) The contents of these files can contain any text (including HTML) and predefined XML tags that are used to substitute live alarm data automatically. You can use these XML tags to customize alarm messages for: • Printers • Emails • Pagers Name Default value Purpose NormalEmail normalemail.txt Alarm/RTN/Fault email message NormalPager normalpager.txt Alarm/RTN/Fault pager message NormalPrinter normalprinter.txt Alarm/RTN/Fault printer message AcknowledgeEmail acknowledgeemail.txt Acknowledge email message AcknowledgePager acknowledgepager.txt Acknowledge pager message AcknowledgePrinter acknowledgeprinter.txt Acknowledge printer Modifications to all these files will not take effect until Continuum is shut down and restarted. The following table provides the predefined XML tags and their descriptions.
- 205. Andover Continuum CyberStation Configurator’s Guide 193 XML Tag Description <date> The date of the alarm. Example: Tuesday, June 19, 2001 <time> The time of the alarm. Example: 4:37:59 PM <name> The name of the infinity object that generated the alarm. <value> The current value of the alarm. Example: 190.00 <state> The state of the alarm. The value can be alarm, return to normal, acknowledged, or fault. <priority> The current priority of the alarm. <type> The type of alarm that was triggered. Example: “Continuum High Limit” <message> The message of the alarm. For alarms, this currently returns “alarm.” <eventnotification> The name of the event notification for this alarm. <alarmenrollment> The name of the alarm enrollment for this event. <operatortext> The operator text for this alarm (set by those who acknowledged this event.) Organizing Alarm Information The Active Alarm View provides so much information that you may want to make some changes to make it easier to find the information you need most often. For example, you may want to hide information you do not need, move the columns you read most to the left, or change the order of the alarms to highlight certain trends. The follow list contains different ways to organize alarm information. • Hide or add columns of information • Rename columns • Move columns • Resize columns • Change the alarm sort order Adding or Hiding an Alarm View List Column 1. To add or hide a column to the Active Alarm View Alarm list, put the cursor on any column heading and right click the mouse to display a popup menu. 2. Click Hide or Add.
- 206. TAC194 3. Select the checkbox for the column you want to add or hide in the alarm list. 4. Click OK. Renaming an Alarm View List Column To rename a column: 1. Right click the column heading to be to display a popup menu. 2. Click Rename Heading. 3. Type the new column name in the pop up dialog that appears. Justifying an Alarm View List Column To change the justification of a column entry: 1. Right click the column heading to be to display a popup menu. 2. Click Justify and select Left, Right or Center justification. Formatting the Name Column To determine the format of the entry that will appear in the Name column, put the cursor on the Name column heading and right click the mouse to display the above menu. Click Format to display the following menu and select the desired name format to appear in the Active Alarm View.
- 207. Andover Continuum CyberStation Configurator’s Guide 195 Resizing Columns Use the mouse to change the width of the Active Alarm View columns. Place your mouse on the vertical line that separates two columns: Your cursor will change to look like this , indicating that you can move the column boundary to the left or right. Understanding Sort Order For every column by which you sort, you’ll specify whether it’s the primary, secondary, or tertiary (third) column in the sort order. The sort order defines what happens when the Active Alarm View finds two or more alarms that have the same column values. For example, if the primary sort column is Name, how does the Active Alarm View order two alarms for objects named RoomTemp1? Which one is listed first? If another column has been set up as the secondary sort attribute, the Active Alarm View uses the value of that second column to decide which alarm is listed first. The tertiary sort attribute works the same way. That is, if the Active Alarm View finds two or more alarms with the same primary column value and the same secondary column value, it uses the tertiary column value to decide how to list the alarms. For example, the alarms listed below are sorted in ascending order by Name, then by Value, then by To State. Name Value To State Door1 Unlocked Alarm Door4 Locked Alarm Door4 Locked Return to Normal RoomTemp1 72 Return to Normal RoomTemp1 85 Alarm In our example, Name is the primary sort column, Value is the secondary sort column, and To State is the tertiary sort column. First notice that the first three alarms are sorted by name. Next, notice that the two Door4 alarms are sorted by To State value because the values in the primary and secondary columns, Name and Value, are identical. Finally, notice that the RoomTemp1 alarms are sorted by value because they have the same name. Tip: Sort order does not affect the order of your columns. For easier reading, we suggest positioning your columns by their sort order. In other words, make sure your primary column is the first column, the secondary column is the second column, and the tertiary column is the third.
- 208. TAC196 Changing Alarm Sort Order You can sort alarms by the values of up to three columns. This is useful for grouping alarms to look for trends in, for example, the source of alarms, types of alarms, and which operators are responding most often. You’ll select which columns to by which to sort alarms in the Sort Criteria dialog shown below. To Sort Alarms by Columns: 1. Select Sort from the Active Alarm View menu to display the Sort Criteria dialog. 2. Select up to three columns from the Primary, Secondary and Tertiary dropdown menus. The columns you select establish the sort order that the Active Alarm View needs to sort by more than one column. 3. Click the Ascending checkbox to sort in ascending order, or clear it to sort by descending order (see below). 4. Click OK. Sorting in Ascending or Descending Order For every column by which you sort, you’ll specify either ascending or descending order (step 3, above). Ascending order starts with the lowest value and ends with the highest value. For time values, ascending order places the oldest events on top, descending order places the most recent events on top. For text, ascending order is A to Z. For numbers ascending order is 0 to the highest numeric value. Descending order starts with the highest value and ends with the lowest value. For text, descending value is Z to A. For numbers, descending value is the highest value to 0. Note that column values such as Active, Inactive, ON, OFF, Online, Offline, Enabled and Disabled are represented to Continuum by 1 and 0 respectively. These values will be sorted just like numeric values. Infinet Intrinsic Alarms When an intrinsic alarm occurs, the notification of an alarm is done in the Explorer’s Navigation pane and also in the Active Alarm View as described in this section.
- 209. Andover Continuum CyberStation Configurator’s Guide 197 The following four conditions cause an intrinsic alarm notification to occur. • Communication Status • Database Backup Needed (Infinet 2 devices only) • Database Backup Disabled (Infinet 2 devices only) • Database Backup Failed (Infinet 2 devices only) The table below provides a description of the intrinsic alarm conditions. Note: Intrinsic alarms conditions are cleared both automatically and manually. Alarm Condition Cause of Alarm Where is Alarm Displayed Return to Normal Condition Communication Status The NetController detecting the Infinet controller is offline. In the Active Alarm View if the Infinet Status Event Notification template object was configured. The NetController detecting the Infinet controller is online. Database Backup Needed The Infinet 2 device database needs to be backed up. The alarm is logged to the object status dictionary attribute. The Explorer displays an overlay icon and tooltip text based on this attribute. To read the tooltip, hover your mouse over the icon. When the database has successfully been backed up and the Explorer is refreshed and removes the overlay icon and tooltip text based on this attribute.
- 210. TAC198 Alarm Condition Cause of Alarm Where is Alarm Displayed Return to Normal Condition Database Backup Disabled The Infinet 2 database has been backed up 10,000 times, thus triggering the flash circuit breaker. The alarm is logged to the object status dictionary attribute, and an alarm is displayed in the Active Alarm View using the InfinetStatus Event Notification template object. The message displayed is: Backup disabled due to excessive use (Requires manual enable). The Explorer displays an overlay icon and tooltip text based on this attribute. You have to manually re-enable the backup. Also, the alarm is logged to the object status dictionary attribute, and an alarm is displayed in the Active Alarm View using the InfinetStatus EventNotification template object. The message displayed is: Backup re-enabled. The Explorer displays an overlay icon and tooltip text based on this attribute. Database Backup Failed An attempt was made to back up the Infinet 2 database, but was not successful due to an internal error (e.g., flash device failure). In the Active Alarm View using the InfinetStatus EventNotification template object. The message displayed is: Unable to backup controller due to unknown failure. The database has successfully been backed up. Also, the alarm is displayed in the Active Alarm View only if the InfinetStatus Event Notification template object was configured. The message displayed is: Backup failure corrected; backup completed.
- 211. Andover Continuum CyberStation Configurator’s Guide 199 Other Conditions that Cause an Intrinsic Alarm Notification In addition to the above four intrinsic alarms, the following conditions will also cause an intrinsic alarm notification to occur: • Offline editing • OS update failure • When a “Save from Controller” is required Database Fault Detection Alarm Configuration Requirements Continuum automatically responds to database faults. There are no configuration requirements involved in order to have the system detect, respond to, and recover from a database fault. However, you must be specified as a recipient in the FaultStatus EventNotification template object in order to receive the database fault alarm. The workstation DatabaseStatus system variable settings on the Basic Alarms tab are shown below. Normally, you should not need to edit it, since it is configured this way by default.
- 212. TAC200 Database Faults A database fault occurs whenever there is a problem accessing information from the database. This can happen for two reasons: • The connection between the Continuum workstation and the SQL database becomes defective. • The SQL database server is experiencing problems. Fault Detection When a database fault is detected, the system is set into a "warning state for five seconds while the fault is verified. If the fault continues past that time, the system enters a "no database mode". (It may take up to 2 minutes to verify the database fault.) When this occurs an icon will appear in the Explorer task bar at the bottom right-hand corner of the screen and a fault dialog will popup. A database fault message is written to the NT Event Log (see below) stating that the system has entered a "no database mode". Both the icon and the dialog will remain until the system recovers from the fault. However, clicking on the OK button will remove the dialog from the screen and send an entry to the NT Event Log (see below) stating that the dialog was acknowledged. Also, a database fault alarm will be displayed in the Active Alarm View window. Emails (optional) can be sent out to notify selected users that there is a database fault. This requires that the FaultStatus EventNotification object be configured with a recipient. If you log off the system during the "no database mode" a message is written to the NT Event Log indicating your action. Message: DATABASE FAULT! Continuum workstation is unable to communicate with the Continuum database server. The database may be offline, or the network connection to the server may be down.
- 213. Andover Continuum CyberStation Configurator’s Guide 201 Configuring Reports With version 1.7 and higher, CyberStation provides a powerful, versatile, graphical suite of features, called Reports, that allows you to gather, view, and compare data values, locally or remotely, manually or automatically, from virtually anywhere in your Continuum system. Overview This section provides an overview of Reports and the Report editor. Specifically: • What can I do with Reports? • What is the Report editor? • What is the ReportViewer? • What are preconfigured vs. ad hoc reports? • Before getting started — activating reports Note: To use any of the report features, your users must be given access to these features via the Security editor. What Can I Do with Reports? Using Reports, you may collect and filter data from a multiple number of dynamic building-control data sources (including extended logs) then display this data in graphically attractive bar charts, pie charts, trend charts, or columned text charts. With reports, you can: • Display report data using one of several data formats. • Display two or more reports simultaneously. 11
- 214. TAC202 • Modify report configurations on the fly while viewing them. • Schedule reports to run automatically at a specified time. • Save a report to a file, manually and/or automatically. • Email a report, manually and/or automatically. • Print a report. What Is the Report Editor? The Report editor is a powerful editor that you use to configure the class object, Report, allowing you to: • Select a report data source and report type, including a point's current value, extended log data, activity events, access events, alarms, and errors. (See: Source Tab.) • Select a chart type, including plotted trend charts, bar charts, pie charts, and text reports. (See: Source Tab.) • Filter point-object data that you want to show in the report, based on day/time, and various object characteristics. (See: Filter Tab.) • Build and modify a list of member objects, whose values you want to display in the report. (See: Filter Tab.) • Configure the "look and feel" of the report's output text headings, text captions, plot and scale configuration, and so on. (See: Output Tab.) • Specify the data format you wish to display — for example, Adobe PDF and web formats. (See: Output Tab.) • Specify how you wish to distribute a report automatically — to email addresses, to a printer, to a file, and so on. (See: Output Tab and Scheduling Automatic Reports.) • Configure, add, and remove columns for text reports. (See: Configuring Columns for Reports.) What Is the Report Viewer? When you run a report (easily accomplished via the Report editor or by double clicking on a Report object) the report is displayed in a special application window, called the ReportViewer. The ReportViewer allows you to: • View data via one of several data formats, such as HTML, XML, scalable vector graphics (SVG), and PDF. • View multiple reports. • Email, print, save, or reload the report you are viewing. • Zoom in, zoom out, and adjust the view of the chart you are viewing. • For more information, please see the help topic for the ReportViewer.
- 215. Andover Continuum CyberStation Configurator’s Guide 203 What Are Preconfigured and Ad Hoc Reports? At any given time, you work with reports using one of two general methods: • Preconfigured reports • Ad hoc reports Preconfigured reports — If you need to view report data for a specific set of values regularly, and the data sources, report type, output setup generally remain the same, then configure a Report object that can be accessed, run in the ReportViewer, and/or distributed at any time, manually or automatically. In Continuum Explorer, Report object files are placed in a Report object class folder, as other CyberStation objects are. With preconfigured reports, you may modify the configuration at any time. To create/modify a preconfigured report: 1. In Continuum Explorer, right click a folder or device, and select New, and then select Report, from the popup menu. 2. Enter a name for the Report object, and click the Create button. The Report editor appears. 3. Configure the Report object, using the Source, Filter, and Output tabs, and click Apply or OK. Note: To modify an existing Report object, right click the Report object in Explorer, and select Edit from the popup menu. Also, while in the ReportViewer, you may edit the parent object of the displayed report, thereby bringing up the Report editor. 4. To preview/run the report, click the View Report button. The report appears in the ReportViewer as you configured it. Ad Hoc Reports — If you need to view reports on the fly, without creating a Report object, then you may quickly locate the point (for example, an Infinity input) and run a report on it. Use ad hoc reports when you know you do not need to run a report regularly, when a Report object is not already created for the data you need to see. To create/modify an ad hoc report: 1. In Continuum Explorer, find the location of the point or points whose values you want to display in a report. 2. Right click the object. 3. From the popup menu, select View, then Report. The Report editor appears. 4. Configure the ad hoc report for that object, using the Source, Filter, and Output tabs. 5. In the Filter tab, be sure to add additional objects to the object member list, if necessary. 6. Click Apply, then click View Report. The report appears in the ReportViewer as you configured it.
- 216. TAC204 Note: As an option, you may save the ad hoc report to a file. (See: Output Tab.) Before You Get Started – Activating Reports Before using reports in CyberStation, you must activate reports in the CyberStation installation (database initialization) process in version 1.7 or higher. CyberStation supplies many Report templates that include bar-chart templates, pie-chart templates, and trend templates — giving Reports a certain default "look and feel." To use these templates (and thus, reports in general) you must import them during the CyberStation installation process, in version 1.7 or higher. In the Database Initialization dialog, you must check the Create/Update Graphical Report Settings checkbox. (For more information, please see the CyberStation Installation Guide, 30-3001-720.) If you do not check this checkbox then reports are not available. Since some reports use extended-log data, please be aware that there are tasks indirectly related to extended logging. These are: • Choosing extended logging backwards compatibility, so that "old" (pre-Version 1.7) extended logs are used with “new” reports based on extended-log data. This is done in the database initialization procedure. • Configuring several General Preference settings (6, 7, 8, and 9). • Designating one or more workstations to upload extended log data from the controller to the CyberStation database, via settings 21 and 22 of the Preferences tab of Device editor. For complete information, please see the subsection, Extended Logs, in Chapter 13, the description of the Device editor’s Preferences tab in Chapter 14 and the Andover CyberStation Installation Guide, 30-3001-720. Source Tab In the Source tab, shown below, you select the source and type of data on which you want to report — for example, extended log data, alarm event data, error event data, and so on. You also select the type of chart on which to plot your data — for example, pie chart, bar chart, trend chart, and so on. The settings on this tab work together with the settings on the other tabs of the Report editor (Filter and Output) to define the content of the report, before you run it in the ReportViewer.
- 217. Andover Continuum CyberStation Configurator’s Guide 205 Source Tab Attributes The following table describes the attributes on the Source tab. Editor Attribute Meaning Description Enter a text description of this Report object. Since this description may be used in an actual report output, be creative. Data Source From the dropdown menu, select one of the following sources of data, on which you want to report: • CurrentValue – This is a snapshot of the current value of an object at any given time. This includes any object that has a value. • ExtendedLog – This is a collection of additional point values, uploaded from a log on a controller to a workstation's CyberStation database. It is an extension of a "local" log, whose values are stored on a point's controller. Typically, Extended-log is selected for LAN controllers. See the extended log settings in the General Preferences dialog. See also: What Are Extended Logs? and descriptions of the Logs tab in the InfinityDateTime, InfinityInput, InfinityOutput, InfinityNumeric, and InfinityString editors. • Refreshed-Extended-Log — The extended-log values are updated or "refreshed" immediately — uploaded from the controller to the workstation's database — before they appear in the report. Use this data source when you want to see the
- 218. TAC206 Editor Attribute Meaning most "up-to-the-minute" extended log entries, not the entries based on the last specified update interval. Typically, this is used for remote (RAS) controllers, which require dial-up access for database uploads. See the extended log settings in the General Preferences dialog. See also: What Are Extended Logs? and descriptions of the Logs tab in the InfinityDateTime, InfinityInput, InfinityOutput, InfinityNumeric, and InfinityString editors. • AccessEvent — This is data associated with access attempts. There are many types of access-event data from which to choose. For example, you can see "most accessed doors" or "most active persons". Please see the section, Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. The names of these access events are self-explanatory. • AlarmEvent — This is data associated with system alarms. There are 22 available types of alarm data from which to choose. For example, you can see "most active alarmed objects" or "active alarms under a network". Please see the section, Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. The names of these alarm events are self explanatory. • ActivityEvent — This is data associated with system activities. There are 11 available types of activity data from which to choose. For example, you can see "login attempts per user" or "most common activities". Please see the section, Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. The names of these activity events are self-explanatory. • ErrorEvent — This is data associated with system errors. There are six available types of error data from which to choose. For example, you can see "error events per workstation" or "most common errors". Please see the section, Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. The names of these error events are self-explanatory. • ListView — This is the content of a ListView object, which you specify in the member object list on the Filter tab. This source has only one Report Type (ListView) and can one Chart Type (Text). Please see the section, Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. The text report that is generated looks similar to a CyberStation ListView.
- 219. Andover Continuum CyberStation Configurator’s Guide 207 Editor Attribute Meaning Note: When you select this source, the Configure Columns button is unselectable. The columns of the ListView object are duplicated in the text report. To configure the ListView report columns, do so from the ListView editor. Note: On the Filter tab, only one ListView object is selected. Note: The selections in the other three fields, Report Type, Chart Type, and Chart Subtype, change, depending on which Data Source you choose. Please see the section, Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. Report Type This narrows down the type of data on which you want to report, based on the Data Source. Select a report type from the dropdown menu. There are many report types available, for many different event scenario. This makes Reports a very powerful and useful tool. If you choose ExtendedLog or Refreshed-Extended-Log, then three report types are available: • The object value • The minimum and maximum object values • The average object value The CurrentValue has two report types, the snapshot of an object's value at any given time or the snapshot of a TrendLog buffer content. The other data sources have many report types from which to choose. For a list, please see: Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. The names of these report types are self-explanatory. Note: The selections in the remaining fields, Chart Type and Chart Subtype, change, depending on what you choose. See the table below. Maximum number of values in the report Enter an integer, representing the maximum number of values to plot in your report when you run it. The default is 100. You may need to experiment with this number to get the right amount of plotted data so that it makes the most sense, visually.
- 220. TAC208 Editor Attribute Meaning Chart Type Depending on which Data Source and/or Report Type, select Bar, Pie, Text, Trend, Minmax, or Clustered Bar, from the dropdown menu. Please see the section, Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. Chart Subtype Select the subtype compatible with your Chart Type. The Text chart has two subtypes available. All the others have one. Please see the section, Matching Data Sources, Report Types, Chart Types, and Chart Subtypes, later in this chapter. Note: When you select the Chart Type, the box on the right-hand side of the Source tab displays a graphic example of what this type of chart will look like. For example, if you select a pie chart, a pie graphic appears. If you choose a Clustered Bar chart, a clustered bar graphic appears. Configure Columns Click this button to launch the Selectable Columns dialog and add, remove, and sort columns for your report. The columns that are available for any given report change, depending on how you configure the Source tab. This applies only to text reports. (See Configuring Columns for a Report, later in this chapter.) View Report Click this button to run your report, based on all the criteria you have configured in the entire Report editor. When you run a report, it is displayed in the ReportViewer. (See The ReportViewer, later in this chapter.) Apply Click this button to save your Report configuration changes immediately, while remaining in the Report editor. (Click OK to save changes and dismiss the Report editor.) Matching Data Sources, Report Types, Chart Types, and Chart Subtypes When you select a data source, certain report types become selectable. In turn, depending on the Data Source/Report Type combination you choose, certain chart types and chart subtypes become selectable. The table on the next page shows you which reports are available on the Source tab, depending on the combination you select. Note: Two report types, Snapshot-of-object value and Snapshot-of-Trend-Log-buffer- content, are available for the CurrentValue source. Note: A "clustered" bar chart is a special two-dimensional chart, where a member object is associated with one or more related objects — for example, when you select a Report Type like Alarms-for-an-event-object-with-event-notification or Most-active- persons-entering-selected-door. In this bar chart, therefore, the "associated" objects are displayed next to (or "clustered" with) their member object.
- 221. Andover Continuum CyberStation Configurator’s Guide 209 To differentiate the member-object bar from its "satellite" object bars, the ReportViewer displays each bar in the cluster in a different color. The ReportViewer also displays a color key at the bottom of the report, listing the color, name, and type of object in the cluster. Data Source REPORT TYPE Chart Type Chart Subtype Bar AccBarChart Pie AccPieChart Snapshot-of-object-value Text AccTextHtmlA ccTextXML Trend AccTrend CurrentValue Snapshot-of-Trend-Log-buffer-content Text AccTextHtmlA ccTextXML Trend AccTrendObject-value Text AccTextHtml AccTextXML Minmax AccMinMaxMin-max-of-object-value Text AccTextHtmlA ccTextXML Bar AccBarChart Pie AccPieChart ExtendedLog Average-of-object-value Text AccTextHtmlA ccTextXML Refreshed- Extended-Log Same as ExtendedLog
- 222. TAC210 Data Source REPORT TYPE Chart Type Chart Subtype Bar AccBarChart Pie AccPieChart Most-accessed-doors Most-accessed-areas Most-accessed-controllers Most-active-persons Access-events-per-person Access-events-per-area Access-events-per-door Invalid-attempts-of-a-person Invalid-attempts-of-a-door Invalid-attempts-of-an-area Valid-and-invalid-attempts-of-a-person Lock-unlock-events-per-door Channel-override-events-per-door Persons-accessed-the-selected-area Areas-accessed-by-the-selected-person Access-equipment-fault-report Text AccTextHtml AccTextXML Clustered Bar AccClusteredB ar Door-use-by-person Area-use-by-person Controller-use-by-person Most-active-persons-entering-selected- area(s) Most-active-persons-entering-selected- door(s) Text AccTextHtml AccTextXML Bar AccBarChart AccessEvent Access-events-under-a-controller Text AccTextHtml AccTextXML
- 223. Andover Continuum CyberStation Configurator’s Guide 211 Data Source REPORT TYPE Chart Type Chart Subtype Bar AccBarChart Pie AccPieChart Alarm-transitions-per-object Most-active-alarmed-objects Offline-alarms-per-controller Offline-alarms-per-IOU-module Offline-alarms-per-field-controller Most-alarm(s)-acking-workstation Most-alarm(s)-silencing-workstation Most-alarm(s)-logging-workstation Most-alarm(s)-acking-user Most-alarm(s)-silencing-user Active-alarms-under-a-controller Active-alarms-under-a-field-controller Active-alarms-per-object Active-alarms-under-a-network Most-offline-IOU Most-offline-controller Most-offline-field-controller Active-unACKed-alarms-per-controller Text AccTextHtml AccTextXML Clustered Bar AccClusteredB ar AlarmEvent Alarms-for-an-event-object-with-alarm- enrollment Alarms-for-an-event-object-with-event- notification RTNs-for-an-event-object-with-alarm- enrollment RTNs-for-an-event-object-with-event- notification Text AccTextHtml AccTextXML
- 224. TAC212 Data Source REPORT TYPE Chart Type Chart Subtype Bar AccBarChart Pie AccPieChart ActivityEvent Activity-events-per-object Login-attempts-per-user Failed-login-attempts-per-user Failed-login-attempts-per-workstation Objects-created/saved-events-per-user Most-common-activities Activity-events-per-activity-type Activity-events-per-workstation Activity-events-per-controller Activity-events-per-controller-with- children Activity-events-per-user Text AccTextHtml AccTextXML Bar AccBarChart Pie AccPieChart ErrorEvent Error-events-per-object Error-events-per-workstation Error-events-per-controller Error-events-per-controller-with-children Error-events-per-user Most-common-errors Text AccTextHtml AccTextXML Configuring Columns for a Report When you click the Configure Columns button on the Source tab, the Selectable Columns dialog, shown below, appears. This applies only to text reports. Note: When you select a ListView as the Data Source on the Source tab, the Configure Columns button on the Source tab is unselectable. The columns of the ListView object are duplicated in the text report. To configure the ListView report columns, do so from the ListView editor. (See Chapter 23.)
- 225. Andover Continuum CyberStation Configurator’s Guide 213 From this dialog, you may add and remove columns for your report. You may also sort the order of columns. The columns that are available for any given report change, depending on which Data Source and/or Report Type you select on the Source tab.
- 226. TAC214 The following table describes the attributes of the Selectable Columns dialog. Dialog Attribute Meaning Columns Unselected Selected The columns available to display in your report, based on your settings on the Source tab, appear in these windows. The columns that initially appear in your report, by default, are listed in the Selected window. Other columns that are available, but not yet selected, appear in the Unselected window. Add Remove Adding a column – In the Unselected window, highlight the unselected column name you want to add, and click the Add button. This column moves to the Selected window. Removing a column – In the Selected window, highlight the column you do not want to appear in the report, and click the Remove button. This column moves to the Unselected window. Up Down In a report, columns appear from left to right, according to the order in the Selected window, whereby the first in the list is the leftmost column, and the last in the list is the rightmost column. To change a column's place in the report, highlight its column name, and click the Up or Down button to move the column up one position or down one position, respectively. Sort By Sort Attribute You may sort events according to three columns. The report displays several columns of information, according to the sort criteria you select here. Sorting is useful to look for trend. From the Primary, Secondary, and Tertiary dropdown menus, select up to three columns. The columns you select establish the sort order that the report uses. Sort Direction The checkboxes beside the Primary, Secondary, and Tertiary fields specify the sort direction for the column values. There are two directions: Ascending and Descending. For descending order, check the Descending checkbox. Ascending order is the default (no check). The following table describes the meaning of ascending and descending: For this value… …Descending and Ascending mean this Time values Ascending order places the oldest events on top. Descending order places the most recent events on top. Text Ascending order is from A to Z. Descending order is from Z to A.
- 227. Andover Continuum CyberStation Configurator’s Guide 215 Numbers Ascending order is 0 to the highest numeric value. Descending order starts with the highest value and ends with the lowest value. Binary values Columns with binary values, such as On and Off, are represented by 1 and 0, respectively. These values are sorted just like numeric values. Filter Tab In the Filter tab, shown below, there are two types of data on which you may apply a filter for your report: • Time data • Object data The Log Filter and the Time Interval attributes allow you to filter time by selecting a time filter or by setting up a specific "custom" time range. A log filter is an existing CyberStation-supplied filter object, such as Today and Last Week. For more information on these time-data attributes, please see the descriptions in the table below. You also build an object member list by filtering object data. Using the object member list, you specify individual objects on which to report. If you have thousands of objects, then selecting certain subsets of objects for your report becomes an important task. You may
- 228. TAC216 browse for and add one or more new members to the list via the Add button. Similarly, you may highlight one or more members in the list and remove them via the Remove button. Using the Path field, you may also specify the path of a controller to run (view) a report on the member-list objects within that controller in your system. For more information, please see the attribute descriptions, below. The settings on this tab work together with the settings on the other tabs of the Report editor (Source and Output) to define the content of the report, before you run it in the ReportViewer. Editor Attribute Meaning Log Filter Select this radio button when you want to specify a time range for the report, based on a CyberStation system-supplied filter. To do so, click the Log Filter field's browse button. The Browse dialog appears, displaying all the filters in the Root directory or any folder you specify. Select the filter you want, and click the Select button. The name of this filter appears in the Log Filter field. Time Interval Select this radio button when you want to define a specific "custom" time range for the report. To do so, select a specific starting date and time and a specific ending date and time, via the Start and End fields. Using the calendar — Click the Start or End field dropdown menu, and select a start date or end date, respectively, on the calendar that appears. Click the day of the month to select it. The selected day appears in a blue oval. (The current date appears in a red circle.) Use the right-arrow and left-arrow buttons at the top of the calendar to display the next month or previous month, respectively. When you click a day, the day appears in the field, and the calendar is dismissed. As an alternative to the calendar, you may "key in" the date. Click and highlight the day, month, or year in the Start or End field and enter the integers for month, day, and year. For example: 12/23/2003 1/15/2004 2/ 8/2004 Keying in a time To select a start and end time, click and highlight the hour, minute, or second field, and enter the integers for the hour, minute, or second to start or end. Also, you click PM/AM to specify afternoon/evening or morning.
- 229. Andover Continuum CyberStation Configurator’s Guide 217 Editor Attribute Meaning Member object list The member object list window contains a collection of points on which you want to run a report. At any one time, you may add or remove one or more objects from the list. For each member, the member object list columns display the object name and object class type. For each member, it also displays either the device ID (the name of the device to which the object belongs) or the owner name (the name of the folder in which the object resides). Note: To add an object to the member object list, you may either drag and drop an object from a Continuum Explorer window to the member object list window in this Filter tab, or use the Add button, described below. Add Click this button to add one object, or a multiple number of objects, to the member object list. When you click the Add button, the Browse dialog appears. Note: As an alternative you may also drag and drop an object from Continuum Explorer to the member object list window. From the Browse dialog, search for and select the object(s) you want to add. You may select several consecutive objects, just as you would do in Microsoft Windows Explorer. For example, click and highlight the first one in the tree, press and hold the Shift key, and click the last one in the tree. All the objects in between are highlighted. Similarly, you may select two or more individual, non-consecutive objects, just as you would do in Windows Explorer. For example, click and highlight the first one, then press and hold the Ctrl key, and click additional objects, one at a time, to add them to the collection. Click the Select button. The newly added objects appear in the member object list. Note: In the Browse dialog, you may use the network view button, folder-view button, and other buttons, as well as the Folder dropdown menu to expose the tree (as you would in Continuum Explorer) to adjust view of directory paths and available objects. Note: In the Browse dialog, you may also use the Objects of type dropdown menu to select only objects of a certain object class type. For example, if you select InfinityInput, only InfinityInput points appear in the Browse dialog window in the network view. In folder view, only the folders containing InfinityInput points appear. This is a powerful feature that narrows down your list.
- 230. TAC218 Editor Attribute Meaning Remove To remove one or more objects in the member object list, click and highlight the object(s) you want to remove, and click the Remove button. The members are immediately removed from the list. You may select multiple consecutive and non-consecutive objects in the member object list, as you would in Microsoft Windows Explorer. For details, please see the description under the Add attribute, above. Path Use the Path dropdown menu to search for and select, from the tree, a specific system controller whose member-list objects on which you want to run (view) a report. Specifying the path of a controller here is necessary when you have two or more controllers containing objects that have the same names from controller to controller. For example, one moment you may want to run a report on FanInput1 through FanInput8 residing on one fan controller, and the next moment run another report on the same named points on another fan controller. To switch views in the tree, right click the dropdown-menu down arrow and select Network View or Folder View from the popup. Configure Attribute Filter Click this button to bring up the Attribute Filter Configuration dialog, where you can filter values according to object attributes. When you select specific attributes for a specific object, their values appear in the report. From this dialog, beneath Unselected, from the Choose object class here dropdown menu, select an object whose attributes you want to filter. The attributes available for that object appear in the Unselected window. Note: The attributes in the Unselected list change, according to which object you select. To select one or more attributes, so that their values appear in the report, highlight the attribute, and click the >> button. The attribute appears in the right-hand Selected window. (Likewise to remove an attribute, highlight it in the Selected window, and click the << button. It moves back to the Unselected window.) When you have finished configuring the attributes, click OK. View Report Click this button to run your report, based on all the criteria you have configured in the entire Report editor. When you run a report, it is displayed in the ReportViewer.
- 231. Andover Continuum CyberStation Configurator’s Guide 219 Editor Attribute Meaning Apply Click this button to save your Report configuration changes immediately, while remaining in the Report editor. (Click OK to save changes and close the Report editor.) Output Tab In the Output tab, shown below, you configure the "look and feel" of the report output to appear in the ReportViewer — text headings, captions, plot and scale configuration, and so on as well as how the report is generated and outputted. The settings on this tab work together with the settings on the other tabs of the Report editor (Filter and Source) to define the content of the report, before you run it in the ReportViewer. Two fields on this tab, Output report to email address and Output report to file in path, work with automatic reports. That is, via a special tool, a report can be set up to run automatically at regularly scheduled times and then sent to the email addresses and/or file specified in these fields. See descriptions of these fields, below.
- 232. TAC220 Editor Attribute Meaning Heading Enter a text heading to appear at the top of the report. You may use wildcards in the text. (See the table of available wildcards, below.) The default is: %r where the wildcard %r is the report type. Subheading Enter a text subheading to appear beneath the heading, if desired. The default is: Report created at %t where the wildcard %t is the time when the report is generated. You may use wildcards in the text. (See the table of available wildcards, below.) X-caption Enter a text caption that describes the values along the X (horizontal) axis of the plot. You may use wildcards in the text. (See the table of available wildcards, below.) Y-caption Enter a text caption that describes the values along the Y (vertical) axis of the plot. You may use wildcards in the text. (See the table of available wildcards, below.) Z-caption Enter a text caption for the Z (for clustered bar chart). You may use wildcards in the text. (See the table of available wildcards, below.) Note: This field is selectable only when you run a report as a clustered bar chart. A clustered bar chart is only available with some Report Types belonging to the AccessEvent and AlarmEvent Data Sources. (See the table for these types in the Source tab.) Footnote Enter a text footnote, if desired. The default is: %p where the wildcard %p is the report page number. You may use wildcards in the text. (See the table of wildcards.)
- 233. Andover Continuum CyberStation Configurator’s Guide 221 Editor Attribute Meaning Heading Enter a text heading to appear at the top of the report. You may use wildcards in the text. (See the table of available wildcards, below.) The default is: %r where the wildcard %r is the report type. Selectable Text Fields: The Heading, Subheading, and Footnote fields are selectable for all chart types. However, the X-caption, Y-caption, and Z-caption fields are not selectable for a pie chart or text chart because they are relevant only for trend, bar, and clustered bar charts. Default Values in Caption Fields: The default values that appear in the X-caption, Y- caption, and Z-caption fields vary according to the Data Source, Report Type, and Chart Type that you have selected. For example, when you have a trend, the X-caption is Time, and the Y-caption is Value. For example, when you select an ActivityEvent data source and a Most-common-activities report type, the bar chart X-caption is Activity Type, and the Y-caption is Number of Activities. For example, when you select an AlarmEvent data source and a Most-alarm(s)-acking-workstation report type, the bar chart X-caption is Workstation, and the Y-caption is Number of ACKed Alarms. Available Wildcards for Text Fields Wildcard Description %r The report type %n The first five names of objects in the object member list %t The time that the report was generated %p The report page number %c Configuration data Showing configuration data is especially important when archiving printed reports, whereby it provides a better description of what the report is and what it contains. %d The description taken from the text in the Description field of the Source tab. %u The units that are described for the first object in the object member list. Display the full path in the report Check the checkbox to show object names or full pathnames in the report output.
- 234. TAC222 Editor Attribute Meaning Heading Enter a text heading to appear at the top of the report. You may use wildcards in the text. (See the table of available wildcards, below.) The default is: %r where the wildcard %r is the report type. One plot for all This radio button is selectable only when you run a trend- chart report – that is, when you select ExtendedLog as a Data Source and Object-value as a Report Type on the Source tab. Click this radio button when you want to compare the trends of multiple points with different scales on one X-and-Y plot. One plot per member This radio button is only selectable when you run a Report only for trend data. That is, when you select ExtendedLog as a Data Source and Object-value as a Report Type on the Source tab. Click this radio button when you want to place each point with its own scale on one X-and-Y plot. For example, if the trend data from point to point were very dissimilar, and they were unrelated, you would select one plot per member. For example, you could compare analog values with different scales to digital values with different scales — for example, digital values of 0 and 1 (off and on) and analog temperature values between 60 and 80 degrees. Based on this data, you may, for example, set a room-occupancy flag, which would then trigger the heating in your room, whereby the trend comparisons on one plot indicate how quickly your room heated up based on occupancy. Report Format Select either a "web" format or a PDF file format that you wish to display when you run your report in the ReportViewer: Web — Click this radio button if you are displaying a graphical (scalable vector graphics) image, such as a trend chart, bar chart, or pie chart, in the ReportViewer. Use the web format for HTML displays also. PDF — Click this radio button if you are outputting a report to an Adobe Acrobat PDF file. With this option, the content of the PDF file is immediately displayed in the ReportViewer. The Acrobat Reader is actually launched and embedded in the ReportViewer.
- 235. Andover Continuum CyberStation Configurator’s Guide 223 Editor Attribute Meaning Heading Enter a text heading to appear at the top of the report. You may use wildcards in the text. (See the table of available wildcards, below.) The default is: %r where the wildcard %r is the report type. Fixed Scale Click this radio button and enter integers in the From and To fields to designate the low and high limits of your scale, based for the units of the point values that are plotted. For example, the report could show a fixed temperature scale between 60 and 80 degrees. Use fixed scales when you do not want the system to set its own scales automatically, based on the point data being plotted. Output report to email address Check the checkbox and enter the email addresses of one or more email recipients who need to receive an automatic report. This is used by the report command line tool that schedules a report to run automatically, at a specific regular time. When this report runs automatically, it is emailed to the addresses in this field. Delimit email addresses with a semicolon. For more information, see Scheduling Automatic Reports. The email recipients listed here are also the default recipients used when you email a report manually, via the email button on the ReportViewer.
- 236. TAC224 Editor Attribute Meaning Heading Enter a text heading to appear at the top of the report. You may use wildcards in the text. (See the table of available wildcards, below.) The default is: %r where the wildcard %r is the report type. Output report to file in path Check the checkbox when you want to send an automatic report to a file. This is used by the report command line tool that schedules a report to run automatically, at a specific regular time. When this report runs automatically, it is saved to the file whose path is specified in this field. Click the browse button to search for and select the path in which you want save report file. (Or, as an alternative, you may enter the path in the field.) The system generates a file, with a unique filename, based on the name of the report and a timestamp. At the time the report is run, a timestamp is appended to the end of the filename (the Report object name). For more information, see Scheduling Automatic Reports. The file path listed here is also the default path used when you save a report to a file manually, via the Save As button on the ReportViewer. View Report Click this button to run your report, based on all the criteria you have configured in the entire Report editor. When you run a report, it is displayed in the ReportViewer. Apply Click this button to save your Report configuration changes immediately, while remaining in the Report editor. (Click OK to save changes and dismiss the Report editor.) Scheduling Automatic Reports Using a special application, ReportCmdLine, and the Microsoft Windows Scheduler, you may regularly run any report automatically at a specified time. When the report runs automatically, you may also have it automatically emailed to one or more email recipients and/or saved to a file. Note: On the Output tab, check the Output report to email address and Output report to file in path checkboxes, and specify the email addresses that should receive the automatic report, as well as the path of the file to which it should be saved.
- 237. Andover Continuum CyberStation Configurator’s Guide 225 Note: CyberStation must be running when you use the ReportCmdLine application. To set up and run a report automatically, perform this procedure: 1. If you want to email this report when it runs automatically, check the Output report to email address checkbox on the Output tab, and enter email recipients. Likewise, if you want to save the report to a file when it runs automatically, check the Output report to file in path checkbox, and enter the path of the file. 2. From the Start menu, select ProgramsAccessoriesSystem ToolsScheduled Tasks. The Scheduled Tasks dialog appears: Note: User interfaces are self-explanatory. 3. In the Schedule Tasks dialog, double click Add Scheduled Task. The Scheduled Task Wizard appears: Click Next. 4. In the next screen, search for the program you want to run (ReportCndLine). Click the Browse button. In the Select Program to Schedule dialog, navigate to and open the Program FilesContinuum folder, and select ReportCmdLine.exe. 5. The Scheduled Task Wizard displays the application name, ReportCmdLine, in the program naming field. If you wish, change this name from ReportCmdLine to another scheduled-task name in this field:
- 238. TAC226 6. On the same screen, select one of the radio buttons to specify how often you want this report to run automatically, and click Next. 7. On the next screen, select the time and day you want this scheduled task to start, and click Next. Enter a start time and start date, in their respective fields. Also use the radio buttons to make this task run every day, only on weekdays, or as a recurring day. The user-interface is self-explanatory: 7. On the next screen (shown on the next page) enter the name and password of a user in the Enter the user name and Enter the password fields, respectively, and click Next. The task will run automatically, as if it were started by that user.
- 239. Andover Continuum CyberStation Configurator’s Guide 227 8. The next screen informs you that the task has been successfully scheduled. It also provides the time and frequency of the task and the day it begins: If you want to configure more advanced properties for this scheduled task, check the checkbox entitled, Open advanced properties for this task when I click finish. 9. Click Finish. The ReportCmdLine (or whatever program name you designated earlier) dialog appears:
- 240. TAC228 This dialog contains the "advanced" properties for this task, as mentioned in the previous step. If you do not check this box in the previous step, the scheduled-task setup completes, and the ReportCmdLine dialog does not appear. 10. On the Task tab of the ReportCmdLine dialog (shown above) in the Run field, enter the command line syntax, as follows: "C:Program FilesContinuumReportCmdLine.exe" /o ObjectName /u UserName /t Type Note: When entering the command from here, please make sure you set the parameters outside the quotes surrounding the path name. If the ObjectName and/or UserName path contains a space, then you must also place quotes around those items. For example: "C:Program FilesContinuumReportCmdLine.exe" /o "ObjectName" /u "UserName" /t Type If ObjectName or UserName (when it contains a space) is not enclosed in quotes, the report does not run. Parameter Description /o ObjectName Enter the path name of the Report object you want to run automatically. It is recommended you use a full path, instead of the just the name of the object file.
- 241. Andover Continuum CyberStation Configurator’s Guide 229 Parameter Description /u UserName Enter the CyberStation user name. /t Type Enter an integer to specify the type of distribution: 0 — Save to a file 1 — Email 2 — Save to a file and email The email recipients and file path are specified on the Output tab. See step 1. 11. On the Task tab, in the Start in field, enter the path of the folder in which you are starting the application. In this case: "C:Program FilesContinuum" 12. Select the Schedule tab. 13. Click the Advanced button to bring up the Advanced Schedule Options dialog. As needed, configure more advanced settings, then click OK. 14. In the ReportCmdLine dialog, configure other advanced settings, as needed, on the Task, Schedule, and Settings tabs.
- 242. TAC230 15. Click OK to complete the setup. What Are Extended Logs? The Report editor allows you to view CyberStation extended log data in the ReportViewer in the form of an extended log report. This is associated with "new" extended logging, with Version 1.7 and higher. Before version 1.7, you created "old" extended logging — that is, created Plain English programs for extended logs. These programs facilitated extended log tables in the database, one table per controller. With version 1.7 and higher, you may use either type of extended logging, or both. Note: During CyberStation installation of version 1.7 or higher, in the database initialization process (the Database Initialization dialog) you check the Extended Logging Backwards Compatibility checkbox to retain the pre 1.7 method for creating extended logs, while also enabling new extended logging functionality. If you do not check this box, then you may not use the old (pre 1.7) method. For more information, please see the CyberStation Installation Guide, 30-3001-720. "Logs" vs. "Extended Logs" Logs store values for an Infinity point on the local controller. These non-extended "short term" logs are established via attributes on the Logs tab for InfinityInput, InfinityOutput, InfinityNumeric, and InfinityString. (For more information on logs, please see the Logs tab description for InfinityInput in Chapter 13.) CyberStation offloads the local-controller “extra” log entries for this point and stores them in the database. This happens once the maximum number of controller log entries is filled. You activate an extended log for a point by checking the Extended Logging checkbox on the Logs tab of its point editor. When you activate extended logs, the additional "extra" entries are transferred (uploaded) to the database before the entries are overwritten in the controller. The extended log is an extension of a log that continues recording values where the log leaves off. It records values depending on how you set up the short-term log via the Logs tab attributes for a point — number of entries, log type, and time interval — as well as the extended-log settings in the General Preferences dialog. For more information on extended logs and the General Preference dialog settings, please see Chapter 13. The ReportViewer You run, view, compare, and distribute reports in the CyberStation ReportViewer, a powerful and versatile tool. This section describes the following: • Viewing various report data formats • Running a report in the ReportViewer • Displaying multiple reports in the ReportViewer • Using the ReportViewer toolbar — emailing, printing, reloading, saving a report
- 243. Andover Continuum CyberStation Configurator’s Guide 231 Note: To use any of the report features, your users must be given access to these features via the Security editor. Viewing Report Data Formats The ReportViewer displays a report using the following data formats, depending on which type of report you have configured in the Report editor. For each report displayed in the ReportViewer, a format icon also appears on each report window tab along the bottom of the ReportViewer: Icon Data Format Displays a scalable vector graphics (SVG) format. This includes bar charts, clustered bar charts, pie charts, and trend charts. Displays an HTML text format, in the form of a table. Displays an XML text format, in the form of XML code. Displays the content of a PDF file, where the Adobe Acrobat PDF reader actually launches, and is embedded in, the ReportViewer window. Note: You may use the Adobe Acrobat PDF reader toolbar functions, such as Email, Print, Save and Copy, Search, zoom, text touch-up functions, and other Adobe functions, as if you were running the PDF reader. You specify PDF format on the Output tab of the Report editor.
- 244. TAC232 Here are several examples of the ReportViewer displaying a pie chart, bar chart, text chart, XML code, and a trend chart:
- 245. Andover Continuum CyberStation Configurator’s Guide 233
- 246. TAC234 Here is an example of the ReportViewer displaying the content of a PDF file, with the PDF reader embedded in the ReportViewer:
- 247. Andover Continuum CyberStation Configurator’s Guide 235 Running a Report in the ReportViewer You may run and view a report in the ReportViewer in one of the following ways: • Double click a preconfigured report object in Continuum Explorer to launch the ReportViewer. • Right click a preconfigured report object in Continuum Explorer, and from the popup menu select Open, to launch the ReportViewer. • Right click a preconfigured report object in Continuum Explorer, and from the popup menu, select Edit, to launch the Report editor. • Modify the report configuration, if desired, and click the View Report button in the Report editor to launch the ReportViewer. • Right click a CyberStation object for which you want to view an ad hoc report, and from the popup menu click View then Report to launch the Report editor. • Configure the report, and click the View Report button in the Report editor to launch the ReportViewer. • Schedule a report to run automatically, and have it emailed or saved to a file. (See Scheduling Automatic Reports, earlier in this chapter.) Note: If you run a report and no data is available to display in the report, based on your Report editor configuration, the following message appears in the ReportViewer: No data was returned for this report. Please check the report time interval and filter. Edit the parent object to ensure that your source, filter, and output settings feed data into the report. Displaying Multiple Reports in Report Viewer Within the ReportViewer, you may run and view two or more reports, whereby each report has its own report window and each window has its own tab, which you select along the bottom of the ReportViewer. The tab label states the name of the object. Note: In the ReportViewer, you may edit the parent object — that is, create differently configured variations of the same Report object — and display them as separate reports for the same object within the ReportViewer. When two or more reports for the same object are displayed, the object-name tab labels are numbered. For example: MyReport, MyReport(2), MyReport(3), and so on. Likewise, you may launch reports for additional Report objects and display separate reports (in the same ReportViewer) for the different objects. When you configure and run two or more reports, the first report window tab appears at the left margin of the ReportViewer, while subsequent report tabs appear to the right of the previous tab, as they are created. Initially, as you create two or more reports, the report whose tab you have selected appears alone, hiding the other reports. However, just as in Microsoft Windows, you may cascade and tile the report windows within the ReportViewer, via the Window dropdown menu, which gives you three choices: Cascade, Tile Horizontally, and Tile Vertically.
- 248. TAC236 Here is an example of multiple tiled reports: To select an individual report, either click its window or click its tab. Using the Toolbar — Emailing, Printing, Saving a Report The following table describes the buttons on the ReportViewer toolbar. Button Description Launches the Report editor for the parent Report object representing this report. You may edit the Report's configuration and run the report again. Reloads/refreshes the graphical report in the ReportViewer. Opens the Microsoft Print dialog, allowing you to print the report. Opens an email window, and either attaches the report as a file, or embeds the report content in the email window. The default email recipients are the ones you listed on the Output tab of the Report editor. Opens the Microsoft Save As dialog, allowing you, by default, to save the content of the report in an scalable vector graphics (.SVG) file, .HTML file, .XML file, or .PDF file, depending on how you configured your report and what data format you selected. The default file path is the one you listed on the Output tab of the Report editor. Opens the Open dialog, allowing you to search for a Report object in your system, then run it (via the Open button) in the ReportViewer.
- 249. Andover Continuum CyberStation Configurator’s Guide 237 Templates About CyberStation Templates A template is an object with pre-defined attributes that you use to create new objects with the same attribute settings. Templates let you quickly, easily, and consistently create new objects of the same class. Templates are a powerful tool for ongoing maintenance of your system. You can use templates to create objects such as points, controllers, alarms, and programs. When you use a template to create a new object, most of the work is already done. A template includes values for most or all of the attributes of the object. About Copied, Inherited, and Specified by User Attribute Values When you create a template, you specify values for attributes. In addition, you specify the source of attribute values in objects created from the template: When an attribute is copied from a template, that attribute value is passed to the new object being created from the template. That attribute can be changed afterward in the object without affecting the template. Any changes to that attribute in the template do not affect the copied attribute in any object created from that template. • Attributes inherited from a template retain a link to the template. Changes to these attributes in the template affect all objects created from that template. These inherited attributes are an easy way to maintain consistent attribute values across objects of the same class. If you try to change an inherited attribute in an object created from a template, CyberStation protects the link and offers several choices of actions, including updating the template or breaking the link to it. Note: If you create Personnel objects from a template, any attribute values with the inherited from Template data source cannot be edited in the Personnel Manager. 12
- 250. TAC238 • If the source of an attribute is Specified By User, CyberStation prompts you for the attribute value when you use the template to create the object. Creating a Template Object The following steps provide a general description of how to create a new template. The tabs that are displayed and the attributes for which you can enter values are determined by the type of object. Note: Do not attempt to create a template for any of the following BACnet point objects: AnalogInput BinaryInput Multi-stateInput AnalogOutput BinaryOutput Multi-stateOutput AnalogValue BinaryValue Multi-stateValue However, you may create templates for BACnet EventEnrollment and EventNotification objects. Configuration of EventEnrollments and EventNotifications at a large site can be a big job. It is recommended you create templates for these objects to save a lot of time and effort. (See “Considerations for EventEnrollment Templates,” later in this chapter. See also Chapter 14.) 1. In Continuum Explorer, open the Template folder. 2. Select the template subfolder where you want to store this template, or create a new subfolder. Note: When you create a personnel template, store it in the Personnel Templates folder, which is a subfolder of the Templates folder. Personnel templates stored elsewhere within CyberStation cannot be attached to profiles or to existing Personnel objects. 3. Right click the folder, select NewTemplate, and select the object class that you wish to create the template for from the popup menu. 4. Type the Object name and Alias in the New Template dialog that appears, and then click the Create button. 5. In the Template editor, specify the necessary information on the various tabs of the editor. 6. When you are finished, click OK. Entering Template Information The Template Information tab is where you’ll enter a name and alias for all objects that will be created from this template. When deciding on a name, try to be as descriptive as possible. Descriptive names help future users choose the correct templates to create objects from. For example, if you are creating an output point for operating fans, you might want to enter a name like “Turn_Fan On/Off.” Entering an alias is optional. If you leave this field blank, CyberStation will use the template’s alias.
- 251. Andover Continuum CyberStation Configurator’s Guide 239 CyberStation automatically avoids conflicts that are caused by duplicate object names when you create multiple objects using the template. If CyberStation detects an existing object with the same name, it appends an underscore and a number to the name of the new object. When CyberStation finds an existing object (for example, an alarm named alarm3), it renames the new object (for example, alarm3_1). The next time the same template is used to create an object in the same container, CyberStation will give the new object a name of alarm3_2. Entering Attribute Data Sources The Attribute Data Source tab is where you’ll choose a data source for the value for each attribute of the objects created from this template. See “About Copied, Inherited, and Specified by User Attribute Values” earlier in this chapter. Considerations for BACnet EventEnrollment Templates When you create templates for BACnet EventEnrollments, please be aware of the following: • Some fields are disabled in EventEnrollment template objects, and can be specified only in the objects created from the template. • The event type (Event Type field on General tab of EventEnrollment editor) cannot be changed once the template object is created. • If an inherited object is deleted from a third-party device in CyberStation, and the object is re-learned, the inheritance is broken. • Some event types are not supported on the Andover Continuum b4 and b3 controllers. (See Using the EventEnrollment Editor, in Chapter 14.) • In the Attribute Data Source tab, some EventEnrolllment attributes cannot be changed. These are: Setpoint Reference – Attribute (Algorithms tab in EventEnrollment editor, when the Floating Limit event type is selected.) Setpoint Reference – Object (Algorithms tab in EventEnrollment editor, when the Floating Limit event type is selected) Object (General tab in EventEnrollment editor) Attribute (the Event Property attribute, General tab in EventEnrollment editor) Creating an Object from a Template 1. In the Configuration Wizard (discussed in Chapter 2) click the tab with the template you want to use. 2. Drag the object icon or folder icon from the page of the Wizard to the container object in Continuum Explorer. You will be prompted by the Enter Attribute Values dialog for any attributes that had been designated as SpecifiedbyUser in the template(s).
- 252. TAC240 3. Enter the attribute value, and click the Next button for each prompted attribute. 4. After you see the message “The operation is finished,” click the Close button in the Creating Objects from Templates dialog to complete the creation of your new object. CyberStation automatically avoids conflicts that are caused by duplicate object names. If CyberStation detects an existing object with the same name, it appends an underscore and a number to the name of the new object. Once you have created a new object from a template you can review its attributes with the object editor or its Properties dialog. When you review the properties of an object created from a template, the name of the parent template appears at the bottom of the Main tab. Editing an Object Created from a Template When an attribute value is inherited, it cannot be changed in the object without breaking the link to the template. (Values inherited from a personnel template cannot be edited in the Personnel Manager.) Attempts to edit an inherited attribute value result in the following dialog, which requires users to select one of the options before they can make changes to the object: You can automatically change an inherited attribute in all objects created from a template by editing the attribute in the template.
- 253. Andover Continuum CyberStation Configurator’s Guide 241 Note: If you select the third option, Break the connection between this object and the template object…, you break the connection to the template for all attribute of the object itself, not just for the attribute you wanted to change. If you break the link between an object and a template, you cannot link the object to the template.
- 254. TAC242
- 255. Andover Continuum CyberStation Configurator’s Guide 243 Points, Logs, and Triggers What is a Point? Throughout Andover Continuum literature you’ll see references to the word “point”. In some cases its definition may be obvious; however there are instances where the term is not familiar. Inputs and outputs are referred to as “points”. An input point is a particular connection at a unique channel where an input sensor is connected. An output point is a particular channel where an actuator or other output device is connected. Points include internal memory locations that serve as “virtual” points. These locations act as storage locations for values that our programs change. Because they can be read and set just like inputs and outputs, we find it easier to refer to them in the same terms. Types of Points There are three types of points in the Andover Continuum system — hardware-defined, software-defined, and BACnet-defined. Hardware-Defined InfinityInput Connections to an Infinity input device InfinityOutput Connections to an Infinity output device Software-Defined InfinityDateTime Storage location where the current system time and date are available InfinityNumeric Storage location where numeric (number) information is stored InfinityString Storage location where ASCII text characters are stored BACnet-Defined CyberStation has nine points supported by BACnet devices. BACnet points are created on third-party BACnet devices or when an InfinityInput, InfinityOutput, or InfinityNumeric is created on an Andover Continuum b4920 or bCX1 40x0 InfinityController object or an Andover Continuum b3 InfinityInfinetCtlr object. BACnet points are: 13
- 256. TAC244 • AnalogInput, BinaryInput, and MultistateInput (created from an InfinityInput) • AnalogOutput, BinaryOutput, and MultistateOutput (created from an InfinityOutput) • AnalogValue, BinaryValue, and MultistateValue (created from an InfinityNumeric) Note: The term point is a CyberStation term. According to the BACnet standard, these nine points are known as BACnet objects. For more information, plase see About BACnet Objects, at the end of this chapter. See also Chapter 14, BACnet. About InfinityInput and InfinityOutput Points What Is an InfinityInput? An InfinityInput is a connection to an Infinity or Infinet controller for monitoring incoming signals from a sensor. Decisions we make during the configuration of an input determine how the controller will interpret and present that sensor input. The controller reads input values once per scan time and therefore can be updated automatically. Input Types CyberStation can monitor a variety of sensor types: • Contact closures • Thermistors • Voltage and current transducers • Current sensors • DC voltage signals • AC voltage signals • Supervised security inputs What Is an InfinityOutput? An InfinityOutput is a connection to an Infinity or Infinet controller where signals are sent to controlled devices. Outputs turn things on and off, provide variable voltages, currents or air pressures. Outputs also change value either by program control, the command line, or from a graphic panel control. Output Types Outputs send signals to controlled devices that are: • Digital (On – Off, such as contact closures) • Controlled by analog signals, voltage or current • Air pressure controlled
- 257. Andover Continuum CyberStation Configurator’s Guide 245 Before You Start Before creating input or output points you will need to know: • Information about the IO Module • IO card slot numbers (for CX 94xx controllers) • IOU board Lbus number (for CX 92xx controllers and NetControllers) • IOU modules used on L-Bus • Andover Continuum IO module number (for NetControllers) • Infinet device name and path (for InfinityInfinet Controllers) • Channel numbers where the physical connections are made • Information about the sensor (input) or controlled device (output) • Electrical type • Engineering units in which you want the data presented on the workstation • Display format in which you want the data presented on the workstation • Resistor type for supervised inputs Creating an InfinityInput Object To create an InfinityInput object: 1. In the navigation pane of the Continuum Explorer, locate the controller object that you want to add the InfinityInput object to. 2. Right-click the controller object. 3. Select New, then select InfinityInput to bring up the New dialog. 4. In the New dialog, name the InfinityInput in the Object name field. 5. Click the Create button to bring up the InfinityInput editor:
- 258. TAC246 The InfinityInput General Tab The General tab, shown on the previous page, has several attributes that you can provide values for and a few attributes that are set by the control system. Attributes that you set include Units, Description and State. Value If a point is enabled, input values are read from the sensor that the point is attached to, updating the Value attribute with each system scan. For testing purposes, you can force an input to a pre-set value after you have set the point’s State to Disabled. Units Units, also known as engineering units, add meaning to the point value. When displayed on the workstation next to the value, as in 40 % Humidity, or 75 Deg F, units help users understand what the point is doing. Enter up to 12 characters (including spaces) in the Units field. Don’t use double quotes. The text you enter here can be anything you want it to be. It is just a text string included to help the user. It has no affect on input point values. Description The description is optional, but a good explanation of the point helps others if they need to test, modify or manipulate the point in the future. The Description characters take up memory space in the controller. Type up to 32 characters (including spaces) in the Description field.
- 259. Andover Continuum CyberStation Configurator’s Guide 247 State Enabled means the point is under system control. When the point is Enabled, the control system reads the sensor and sets the Value attribute to the value taken from the environment. Disabled means the system no longer updates the value. If we set the point to a different value, it holds that value as long as the point remains disabled. Never set a point manually unless you are testing or repairing the system. Exported If this point is referred to in a program on another controller or has an alarm attached, you will see a check in this checkbox. The Exported attribute is set by the control system. There is no user entry in this field. Alarms This read-only attribute shows the number of active alarms associated with this point. The InfinityInput Settings Tab This tab, shown below, is where you define the following: • The electrical type (ElecType) of the device connected to this point • The input channel number • The IOU number of the input module (if applicable) • The format in which the value of this point is displayed on the workstation • Specific settings related to certain ElecTypes
- 260. TAC248 ElecType The electrical type specifies the ElecType attribute for all InfinityInput points. See Appendix B for a complete listing of the possible electrical types. Note: If you are creating this input for an Andover Continuum b4, bCX1 40x0, or b3 controller, then a BACnet AnalogInput, BinaryInput, or MultistateInput is also created, when you select an analog, digital, or multistate (supervised) ElecType, respectively. See About BACnet Objects at the end of this chapter, and see Chapter 14, BACnet. Invert If you select Digital as an electrical type, and want to invert the meanings of ON and OFF, click the Invert box (usually grayed out) to put a check mark in it. Channel Channel numbers are silkscreened onto the front of each type of IO unit on every type of controller. Typical channel number markings are IN18 (channel 18) on an Eclipse controller IO module or IN5 (channel 5) on an Andover Continuum IOU Module.
- 261. Andover Continuum CyberStation Configurator’s Guide 249 IOU Enter an IOU number for the following three types of controllers: CX9200. Enter the number of the IOU board on Lbus. A CX9400. Enter the slot number where the IO card is plugged in to the card rack. Andover Continuum NetController. Enter the number of the IO module or IOU board on Lbus that is sending the input. Assign the appropriate number for the module you are configuring. Format The format field is where you specify what display format you want to use to present the Value attribute to the operator. The # sign is a placeholder. Examples ###.### would be a number with three decimal places $### shows values greater than zero as ON, values equal to zero as OFF and values less than zero as –ON. Digital Filter Enable or disable the digital filter by selecting True or False from the dropdown menu. When the Digital Filter is True, value updates are slightly delayed in order to filter out sudden, radical changes in sensor readings (due to, for example, electrical surges). When the Digital Filter is False, the value is updated with every sensor reading. This provides slightly faster updates.
- 262. TAC250 The InfinityInput Conversions Tab The Conversions tab is where you enter information about how the controller converts the sensor readings (ElecValue) into engineering units Enter a conversion formula in the Conversion field or use the Auto Conversion fields to set the top and bottom of scale values. Input signals are converted to temperatures, relative humidities, atmospheric pressures, and so on. Threshold Enter the amount of change in engineering units that must occur before the point updates other objects such as programs, functions, alarms, reports and exports to other controllers. A threshold of zero increases network traffic, as all associated objects update with any change in point value. Conversion You enter a conversion formula for either of the two following circumstances: The conversion between the sensor reading ElecValue and engineering units is non-linear. For example, enter the formula SQRT(ELECVALUE)*500, if the square root of the ElecValue must be multiplied by 500 to equal the correct engineering unit Value. You want to limit or bias a linear conversion. For example, enter the formula (ELECVALUE + .5), to calibrate a temperature sensor reading. Note: Do not include VALUE = in the formula you enter in the Conversion field.
- 263. Andover Continuum CyberStation Configurator’s Guide 251 Auto Conversion Enter the top of scale for the engineering units in the Top field on the left. For example, if you entered % Humidity in the Units field on the General tab, your top of scale would most likely be 100, for 100%. Enter the bottom of scale for the engineering units in the Bottom field on the left. For example, if you entered % Humidity in the Units field on the General tab, your bottom of scale could be 0, for 0%. The fields for ElecType values are on the right side of the Auto Conversion section. The values you enter will be used in a linear conversion. Enter the top of scale for the electrical units in the upper ElecType field on the right. For example, if you selected Voltage in the ElecType dropdown menu on the Settings tab, your top of scale would most likely be 5, as this is the highest reading possible for voltage on many controllers. Enter the bottom of scale for the electrical units in the lower ElecType field on the right. For example, if you selected Voltage in the ElecType dropdown menu on the Settings tab, your bottom of scale would most likely be 0, as this is the lowest reading possible for voltage. Formulas entered in the Conversion field take precedence over the conversion generated by the Auto Conversion section, but the Auto Conversion will recognize a limiting or biasing formula and use it in its conversion. Test the Point Once you have completed the General, Settings and Conversions tabs of the editor, you have supplied enough information to create the point. Now is a good time to save the point and test your preliminary configuration. Save the Point Click InfinityInput editor’s OK button. Verify Value The Explorer’s Command Line should show the correct path to the controller . Enter PRINT Pointname You should see the current value of the point in the response line. Verify ElecValue From the Command Line, enter PRINT Pointname ELECVALUE You should see the current input electrical value of the point in the response line.
- 264. TAC252 InfinityInput Logs Tab In the Logs tab, shown below, you define logs and extended logs for the point. A log is a collection of point values. The structure, also known as an array, looks like a two-column table. The first column contains an index of entry numbers. The second column contains recorded values. In the Logs tab, you define and activate two types of logs for a point: • Logs — Log entries are stored on the local controller that owns the point. See Logs, later in this section. • Extended logs —CyberStation offloads the local-controller “extra” log entries for this point and stores them in the database. This happens once the maximum number of controller log entries is filled. When you activate extended logs, the additional "extra" entries are transferred (uploaded) to a workstation's CyberStation database, to capture them before they are deleted in the controller. The extended log, which is an extension of a log, continues recording values where the log leaves off. It records values depending on how you set up the short-term log. These extended log entries can be uploaded from both local-area network (LAN) controllers and remote-access services (RAS) network controllers to the workstation. (See Extended Logs, later in this section.) Extended logs work according to the attribute settings on this tab, as well as: • Extended-log settings on the Preferences tab of the Device editor for a workstation. (For more information on these settings, see Extended Logging, later in this section, and Chapter 14, BACnet.)
- 265. Andover Continuum CyberStation Configurator’s Guide 253 • Extended-log settings 7, 8, 9, and 10, in the General Preferences dialog. (For more information on these settings, see Extended Logging, later in this section.) Automatic Logs and Manual Logs For Infinity Input, Output, Numeric, String, and DateTime points, you can set up one of two basic types of short-term logs: • Logs that the system updates automatically • Logs that you update manually Automatic Logs — Automatic logs are generated by CyberStation at specific intervals that you define via the attribute settings on this tab, as well as the preference settings in the General Preferences dialog. (See Extended Logs, later in this section, for General Preference settings.) For example, the following picture depicts an automatically updated log for a point named SupplyAir: CyberStation updates automatic logs by inserting new values into the first log entry. Every interval, a new value is stored in the first log entry, pushing existing values down to the remaining entries. When the specified number of entries is full of values, the bottom value "drops off” when a new value is inserted. When working with logs, you won’t actually see structures like the one shown above. Instead, you use point names and index numbers to retrieve values stored in logs. To do this, simply enclose the index number in square brackets [ ] directly after the point name. For example, to print the sixth entry (72) of the log for SupplyAir, use the following command: PRINT SupplyAir[6]
- 266. TAC254 Manual Logs — Unlike automatic logs, CyberStation cannot set manual logs. Manual logs are set either from the Command Line editor or a Plain English program. To update a manual log, simply enclose the index number in square brackets [ ] directly after the point name. The example below sets the third log entry of an array named MyNum: SET MyNum[3] TO 12 Note: To perform calculations on logs, see the following Plain English keywords: SUM AVERAGE MINIMUM MAXIMUM Logs The following table describes the attributes in the Logs section of this tab. These settings affect extended logs, when extended logging is activated. Number of Entries Enter an integer representing the number of entries. The maximum number of entries allowed in a log depends on the memory available on your controller, but cannot exceed 32,767 entries per log. When this number is exceeded, and you have activated extended logging, then the first-in-first-out log entries are transferred (uploaded) to a workstation's CyberStation database. If extended logging is not activated, then the first-in-first-out log entries are deleted from the controller. Type In the Type field, use the down arrow to show a list of available log types and select one: Manual Not set by CyberStation. Can be set only from the command line, a report, or a Plain English program LogInstantaneous CyberStation stores the current value of this point at the beginning of every interval LogAverage CyberStation calculates the average point value over every interval, using a weighted average algorithm. Average values are stored at the end of every interval. LogMinimum CyberStation compares all values over an interval, finds the minimum and stores it at the end of every interval LogMaximum CyberStation compares all values over an interval, finds the maximum and stores it at the end of every interval
- 267. Andover Continuum CyberStation Configurator’s Guide 255 Interval If the Type is not Manual, set the Interval. This determines how often CyberStation stores new values in the log. The values that you enter for days, hours, minutes and seconds are combined to create the total interval. For example, if you enter a 1 for days and a 12 for hours, the log will be updated every 1.5 days. Similarly, if you need a 90-minute interval, enter a 1 for hours and a 30 for minutes. Days – maximum value is 365 Hours – maximum value is 23 Minutes – maximum value is 59 Seconds – maximum value is 59 Tip: In order to have a log updated at the same time every hour (every quarter hour, or every half hour, for example) your interval must be evenly divisible into one hour (1 min, 2 min, 3 min, 4 min, 5 min, 6 min, 10 min, 12 min, 15 min, 20 min, or 30 min). Extended Logs To activate extended logs for this point, check the Extended Logging checkbox. When you activate extended logs, the additional "extra" entries are transferred (uploaded) to a workstation's CyberStation database, to capture them before they are deleted in the controller. The extended log, which is an extension of a log, continues recording values where the log leaves off. It records values depending on how you set up the short-term log. These extended log entries can be uploaded from both LAN controllers and RAS controllers to the workstation. In addition to checking the Extended Logging box and setting the Number of Entries, Type, and Interval attributes on a point's Logs tab, your administrator also configures settings 7, 8, 9, and 10, in the General Preferences dialog.
- 268. TAC256 The General Preferences dialog is shown below: Setting 7, Extended Log Database Check Interval (minutes) — This is the time interval, in minutes, that CyberStation checks the database for points that are enabled for automatic extended logging, checks the extended logging table, and uploads the point data. The default is 5 minutes. Increase for RAS Network: If you know you will be performing extended-log uploading from controllers on a RAS (remote) network, it is good practice to increase the number of interval minutes because this process takes longer on such a network. Data is lost when this process takes longer than 5 minutes beyond the number of minutes specified here. It is also good practice to decrease the Extended Log maximum RAS Buffer Percentage (see setting below). Setting 8, Extended Log Maximum LAN Buffer Interval (minutes) — This is the maximum time interval, in minutes, that CyberStation may check each controller on a LAN network for new extended logging data. Setting 9, Extended Log Maximum RAS Buffer Percentage — This is the maximum amount (percentage) of new point log data allowed to accumulate in a controller on a RAS network, before it is downloaded automatically. It is a percentage of total controller log size. CyberStation knows the logging interval and the log buffer size on a RAS controller, and it calculates when a certain percentage of the buffer in the controller is filled. It dials into the controller when the percentage is exceeded to download the log data. This may be any percentage between 0 and 100 percent. Decrease to Ensure More Frequent Downloads: Make sure this percentage is small enough to ensure more frequent downloading. Data is lost when a downloading operation takes longer than 5 minutes beyond the number of minutes specified in the
- 269. Andover Continuum CyberStation Configurator’s Guide 257 setting above, Extended Log Data Check Interval. It is also good practice to increase the number of minutes in that setting (see above). Setting 10, Extended Log Automatic Purge Interval (days) — This is the number of days to keep extended log data in the database before purging it. Extended log data is stored in a single internal table, so purging the data after a specified number of days prevents this table from becoming too large. A value of 0 ensures that the data is never purged. To access the General Preference dialog, right click the Continuum symbol located in the bottom right-hand corner of the screen, and select General Preferences. Settings 1…6 of the General Preference dialog are related to password-management configuration. For more information, please see Chapter 5. Enabling a Workstation for Extended Logging — You may enable or disable any workstation to download extended log data from controllers on a local-area network (LAN) or from controllers on a remote-access services (RAS) network, to the workstation. This is done via settings 19 and 20 (Enable personnel distribution to controllers on the LAN and Enable personnel distribution to RAS networks) on the Preferences tab of the Device editor for the workstation device that you wish to enable or disable. Your must determine which workstations at your site are best suited to perform this task. For more information, see the Preferences tab of the Device editor, in Chapter 14. Extended Logging Backwards Compatibility (“Old” and “New” Extended Logs) — Before version 1.7, you created Plain English programs for extended logs. These programs facilitated extended log tables in the database, one table per controller. During CyberStation installation of version 1.7 or higher, in the database initialization process (the Database Initialization dialog) you check the Extended Logging Backwards Compatibility checkbox to retain the pre 1.7 method for creating extended logs, while also enabling new extended logging functionality. If you do not check this box, then you may not use the old (pre 1.7) method. Note: The "old" extended log tables, created before your upgrade to version 1.7, remain in the database. When a "new" extended log table is created, if necessary, data from an "old" table are copied and merged with the data in the "new" table. For more information, please see the CyberStation Installation Guide, 30-3001-720. Extended Logs and Reports — Extended log data, as well as other report data sources, can be presented in a report and displayed in the form of attractive trend chart, text chart, bar chart, or pie chart. CyberStation supplies many Report object templates that include bar-chart templates, pie-chart templates, and trend templates — giving reports a certain default "look and feel." To use these Report templates, your must import them (and thus activate reports) during the CyberStation installation process, in an upgrade to version 1.7 or higher. During installation, in the Database Initialization dialog, you must check the Create/Update Graphical Report Settings checkbox. If this box is not checked, then the TAC-supplied Report templates are not available. For more information, please see the CyberStation Installation Guide, 30-3001-720, as well as descriptions of Reports and the Report editor in Chapter 11.
- 270. TAC258 Setting 11 - Time Interval Between Requests Setting 11 of the General Preferences dialog is the number of milliseconds that CyberStation waits before it polls controllers and networks for value changes in points embedded in Pinpoint graphics panels. The default is 30 ms. This delay between poll requests enhances performance by ensuring that a controller/network is not flooded with too many requests. Note: This setting is applied globally, to all controllers/networks – to all Infinity controllers, Infinet controllers, Infinet networks, Andover Continuum BACnet controllers, BACnet networks, and third-party BACnet controllers. If a third-party request interval is longer than this global setting, the third-party interval overrides this setting. If a third-party interval is shorter than this global setting, the global setting overrides. (The longer interval prevails.) Remote access services (RAS) controller graphic points are polled synchronously, so this setting does not affect graphics on remote controllers. Settings 12, 13 – Fieldbus Personnel Distributions Setting 12: Number of Concurrent Fieldbus Personnel Distributions — This General Preference setting is the number of concurrent personnel distributions that are sent from each workstation to controllers on each field bus network. The default (and minimum) value is 1. Maximum value is 4. This setting, which works in conjunction with setting13, improves performance by preventing or large numbers of personnel records from flooding field bus controllers. See also Chapter 20, Managing Personnel Distribution. Time Interval Between Fieldbus Personnel Distributions — This General Preference setting is the amount of time (in milliseconds) that CyberStation waits before it sends another personnel distribution to controllers on the same fieldbus network. The default value is 30. Minimum value is 0. Maximum value is 15000 (15 seconds). This setting, which works in conjunction with setting 12, improves performance by preventing large numbers of records from flooding field bus controllers. It is also useful when there are many workstations performing access distribution. (That is, set it higher if there are many workstations.) See also Chapter 20, Managing Personnel Distribution. Settings 14, 15 – NetController Personnel Distributions Setting 14: Number of Concurrent NetController Personnel Distributions – This is the number of concurrent personnel distributions that are sent from each workstation to NetControllers and all other Ethernet-level controllers. The default (and maximum) value is 4 and the minimum value is 1. This setting works in conjunction with setting 15. Setting 15: Time Interval Between NetController Personnel Distributions -- This is the amount of time (in milliseconds) that CyberStation waits before it sends another personnel distribution to NetControllers and all other Ethernet-level controllers. The default (and minimum) value is 0 and the maximum value is 15000 (15 seconds). This setting, which works in conjunction with setting 14, improves performance by preventing large numbers of personnel records from flooding these Ethernet-level controllers. It is also useful when there are many workstation performing access distribution.
- 271. Andover Continuum CyberStation Configurator’s Guide 259 The InfinityInput Triggers Tab The Triggers tab is where you’ll associate triggers with a point. Triggers are Plain English programs whose status changes to active when the point value changes by at least the amount of the Threshold attribute setting. One point may have numerous triggers associated with it. Conversely, one program can be triggered by many points. To associate an Infinity program with a point, click the Add button. This will display a Browse dialog for Plain English programs. Once you have found the Infinity program you want, click the Select button, and that program will be added to the point’s trigger list. To delete an Infinity program from the trigger list, click it, then click Remove button.
- 272. TAC260 The InfinityInput XDriver Tab If you have purchased a special device that you have connected to a controller, TAC can develop special software that allows your device to work with the controller. The software is called an “XDriver.” After you have connected your device to the controller, and installed the XDriver software, you need to specify the comm port that you used in the XDriver window. Use the dropdown menu to select the desired comm port. Once the proper comm port has been selected additional XDriver parameters will be required (see your XDriver documentation). The InfinityInput Security Level Tab Refer to Chapter 4 for details on entering information into the Security Level tab.
- 273. Andover Continuum CyberStation Configurator’s Guide 261 InfinityOutput Points An InfinityOutput point is an object that you create on Infinity or Infinet controllers. An output point changes or affects the environment by controlling a piece of equipment such as a heater or fan. Infinity controllers have numerous (the number varies depending on the type of controller) channels for output points. A channel in this case is simply an area in the controller than can be physically connected to a device. When you create an InfinityOutput point, you define it by specifying values for its attributes. An attribute can be thought of as a characteristic of the point. For example, you have many attributes such as height, weight, hair color, and age. Some of the attributes for an InfinityOutput point include value, electrical type, display format, threshold. You’ll specify values for these attributes and many more in the following tabs of the InfinityOutput editor. Creating an InfinityOutput Object You create an InfinityOutput object in the same way that you created an InfinityInput object. Repeat the steps for an InfinityInput object, but replace the word InfinityInput with InfinityOutput throughout the steps. This brings up the InfinityOutput editor:
- 274. TAC262 The InfinityOutput General Tab The General tab has several attributes that you can provide values for and a few attributes that are set by the control system. Value When a point is enabled and active, the control system updates it automatically. Never set a point’s value manually unless you are testing or repairing the system. Always disable a point before setting the value manually. Units Units, also known as engineering units, add meaning to the point value. When displayed on the workstation next to the value, as in % open, or PSI, units help users understand what the point is doing. Enter up to 12 characters (including spaces) in the Units field. Don’t use double quotes. The text you enter here can be anything you want it to be. It is just a text string included to help the user. It has no affect on input point values. Description The description is optional, but providing a good explanation will help others work with the point. Type up to 32 characters (including spaces) in the Description field. State Select Enabled or Disabled from the dropdown menu. When the point is enabled, the control system sets the value to the desired output setting. When the point is disabled, a program can't set the point. A user can set it from the Command Line or a control on a graphic panel. Never set a point manually unless you are testing or repairing the system. Exported A check in the Exported checkbox means that programs or reports on another controller use this point's value. Alarms The Alarms attribute displays the number of active alarms associated with this point.
- 275. Andover Continuum CyberStation Configurator’s Guide 263 The InfinityOutput Settings Tab The Settings tab is where you specify various settings regarding the output point, such as the channel number and the electrical type. ElecType Select one of the electrical types from the dropdown menu. Note: If you are creating this output for a b4, bCX1 40x0, or b3 controller, then a BACnet AnalogOutput, BinaryOutput, or MultistateOutput is also created when you select an analog, digital, or multistate (tristate) ElecType, respectively. See About BACnet Objects at the end of this chapter, and see Chapter 14, BACnet. Voltage The output point is a voltage type. Enter a conversion formula on the Conversions tab. Digital The output point is an ON or OFF contact closure. You can use the Invert checkbox to invert the meanings of ON and OFF. Current The output is a current type Tristate The output is a tristate type (ON, OFF, −ON) ACC_Pneumatic Not used
- 276. TAC264 ReaderDoor (Infinity only) The controller is an Infinet controller, other than a 700 series, and the point is controlling a door or mag strike lock on a door with a card reader on an EMX 190 or a CRM 100 module. This output type usually applies only if you do not have the access control version of Infinity. HiResVoltage The controller is an Infinet controller and the point is a voltage output on an EMX 151 or AOM 500. HiResCurrent The controller is an Infinet controller and the point is a current output on an EMX 151 or an AOM 500. PanelMeter The output is for an LED display on an Andover Continuum door-mounted display module . Channel Channel numbers are silkscreened onto the front of each type of IO unit on every type of controller. Typical channel number markings are OUT1 (channel 1) on an Eclipse controller IO card or OUT3 (channel 3) on an Andover Continuum IO Module. IOU Enter an IOU number for IO in the following three types of controllers: CX9200: Enter the number of the IOU board on the Lbus. These IOU numbers are set with dipswitches. Look at the dipswitches to determine the IOU number. CX9400: Enter the slot number where the IO card is plugged in to the card rack. The slots are numbered from left to right, starting with 1. Andover Continuum NetController: Enter the number of the IO module or the IOU number on Lbus that is sending the output. Assign the appropriate number for the module you are configuring. For example, for Andover Continuum IO modules, you may decide to number the modules from left to right, starting with the top DIN rail. NetControllers can control up to 32 IOU modules. Label the IOU modules with the numbers you assign. This number is not the same as the 12-digit module ID # assigned to the individual module at the factory. Outputs created on any other types of controllers, will show the IOU field grayed out. Format The format field is where you specify what display format you want to use to present the Value attribute to the operator. The display format $### shows values greater than zero as ON, values equal to zero as OFF and values less than zero as −ON.
- 277. Andover Continuum CyberStation Configurator’s Guide 265 About Displaying Percents There are two ways to show percent values to the user, depending on how you configure the Value and Units attributes for an output point. 1. On the General tab of the editor, include a % sign as the first character of the Units attribute. For example: %RH This will have no effect on the Value attribute of the point. 2. On the Settings tab of the editor, include a % sign in the Format field. For example: %###.# When the % sign is in the display format field this way, the Value of the point will automatically be multiplied by 100 and a % sign added when the point is displayed. Note: If using this method with an Auto Conversion, the ‘top of scale’ should be set to 1, not 100. This second method of showing percents is commonly used with analog outputs. For example in the Plain English Language print statement: Print “The value is set to ⏐%### open.”, WATER_VALVE prints the value in numeric characters as a percentage of the scale for the WATER_VALVE point with the scale set from 0 to 1, where 0 is fully closed and 1 is fully open. So if the value is .45, the statement prints: The value is set to 45% open. The InfinityOutput Conversions Tab The Conversions tab (shown on next page) is where you enter a conversion formula or set Auto Conversion fields to convert engineering units to control signals. The output value is converted and displayed based on the formula in the Conversion or Auto Conversion fields. Value/10 in the Conversion field would carry out the same conversion as shown in the Auto Conversion section. Test the Point Once you have completed the General, Settings and Conversions tabs of the editor, you have supplied enough information to create the point. Now is a good time to save the point and test your preliminary configuration. Save the Point Click InfinityInput editor’s OK button. Verify Value The Explorer’s Command Line should show the correct path to the controller . Enter PRINT Pointname You should see the current value of the point in the response line.
- 278. TAC266 Verify ElecValue From the Command Line, enter PRINT Pointname ELECVALUE You should see the current input electrical value of the point in the response line. Continuing On Once you have tested the point, reopen the editor and complete the remaining tabs to finish configuring the point. Enter information into the Triggers, Alarms, Logs and XDriver tabs of the InfinityOutput editor. Complete these tabs using the explanations provided earlier in this chapter for completing the same tabs of the InfinityInput editor. Refer to Chapter 4 for details on entering information into the Security Level tab.
- 279. Andover Continuum CyberStation Configurator’s Guide 267 About Infinity Software Points Software points are holding places for information. They are numerics, datetimes, or strings. Infinity software points are those that exist on Infinity controllers (including NetControllers) and Infinet controllers that are connected to the Andover Continuum system. InfinityNumeric InfinityNumeric points are storage locations in an Infinity controller’s memory. They store numeric information, such as temperature setpoints. They can store the values ON, OFF and – ON as well as floating point numbers such as “1.52, 6.14” and so on. They are also used when configuring Andover Continuum enclosure door display modules. InfinityDateTime InfinityDateTime points store date and time information used in schedules and are used to create time stamps. InfinityString InfinityString points are storage locations for plain text messages in an Infinity controller’s memory. These can include logical paths to physical devices such as printers, or messages that are displayed to an operator. Creating Infinity Software Points To create new Infinity software points you type information into text fields and make selections from dropdown menus in the tabs of the CyberStation InfinityNumeric, DateTime and String editors. Once you have created the new points, you can review the details of the configuration several different ways: • Object editor • Object Properties dialog, also called the Info Viewer • ListView or class default ListView • From the Command Line Creating an InfinityNumeric Object You create an InfinityNumeric object in the same way that you created an InfinityInput object. Repeat the steps from the InfinityInput procedure, but replace the word InfinityInput with InfinityNumeric throughout the steps. This brings up the InfinityNumeric editor, as shown on the next page.
- 280. TAC268 Note: For instructions on how to use objects editors in general refer to Chapter 3. The InfinityNumeric General Tab Attributes that you can set for all InfinityNumeric points include Value, Units, Description, State, Format and Setpoint. For points connected to certain IOU modules, you also set the Channel and IOU numbers and Direction. Value The initial value of a newly created InfinityNumeric point is 0.000. Enter value in the field or set it from the command line. Units Units (engineering units) make clear the type of information the point registers. They display next to the Value, as in 72 Deg F, to help users. Other examples of engineering units are: % Humidity and Deg C. Type up to 12 characters (including spaces). Don’t use quotation marks. Description A description of up to 32 characters (including spaces) is optional, but a good explanation helps users when they need to test, modify, or manipulate the point. Channel and IOU Numbers (NetControllers Only) Set channel and IOU numbers so the point’s value can be read or changed by a display module. Enter the channel number as it is marked on the controller. Enter an IOU number.
- 281. Andover Continuum CyberStation Configurator’s Guide 269 Direction Direction is required only if the point’s value can be read or be changed by a display module. Select one of the following from the Direction dropdown menu: IOInput Allow changing the point value from the controller only. IOOutput Allow changing the point value from the control system only. IOBidirectional Allow changing the point value from both the controller and the control system. BACnet Object Type If this Infinity Numeric is associated with a BACnet device (b4, bCX1 40x0, or b3 controllers only) then it must become an AnalogValue, BinaryValue or MultistateValue object. From the dropdown menu, select AnalogValue, BinaryValue, or MultistateValue. See About BACnet Objects at the end of this chapter, and see Chapter 14, BACnet. State Select Enabled or Disabled from the dropdown menu. The control system can change an Enabled point from a program or report, but not a Disabled point. Setpoint Check the Setpoint checkbox so the controller stores the current point value in the CyberStation database. Format The format field is where you specify what display format you want to use to present the Value attribute to the operator. The # sign is a placeholder. Examples: ###.### would be a number with three decimal places $### would equal on/off/-on. Exported If Exported is checked, it means that programs or reports on another controller use this point's value or has an alarm attached. Continuing On Once you have tested the point, reopen the editor and complete the remaining tabs to finish configuring the point. Enter information into the Triggers, Alarms, Logs, and XDriver tabs of the InfinityNumeric editor. Complete these tabs using the explanations provided earlier in this chapter for completing the same tabs of the InfinityInput editor. Refer to Chapter 4 for details on entering information into the Security Level tab. Creating an InfinityDateTime Object You create an InfinityDateTime object in the same way that you created an InfinityInput object. Repeat the steps for InfinityInput, but replace the word InfinityInput with InfinityDateTime throughout the steps. This brings up the InfinityDateTime editor:
- 282. TAC270 Note: For instructions on how to use objects editors in general refer to Chapter 3. The InfinityDateTime General Tab InfinityDateTime points store date and time information used in schedules and are used to create time stamps. They print from Plain English in the format: MM/DD/YY. Value The initial value of a newly created InfinityDateTime point is 1/1/89. Enter value in the text field or set it from the command line. Description A description of up to 32 characters (including spaces) is optional, but a good explanation helps users when they need to test, modify, or manipulate the point. Channel and IOU Numbers Set channel and IOU numbers so the point’s value can be read or changed by a display module. Enter the channel number as it is marked on the controller. Enter an IOU number. On 9200 CX controllers, IOU numbers are set with dipswitches. After you enter these numbers, select a direction, if applicable (NetController only).
- 283. Andover Continuum CyberStation Configurator’s Guide 271 Direction Direction is required only if the point’s value can be read or be changed by a display module. Select one of the following from the Direction dropdown menu: IOInput Allow changing the point value from an Andover Continuum display module only. IOOutput Allow changing the point value from the control system only. IOBidirectional Allow changing the point value from both the Andover Continuum display module and the control system. State Select Enabled or Disabled from the dropdown menu. The control system can change an enabled point from a program or report but not a disabled point. Setpoint Check the Setpoint checkbox so the controller stores the current point value in the CyberStation database. Exported The Exported attribute is set by the control system. A check in the Exported checkbox means that programs, reports, or alarms on another controller use this point's value. Continuing On Once you have tested the point, reopen the editor and complete the remaining tabs to finish configuring the point. Enter information into the Triggers, Logs and XDriver tabs of the InfinityDateTime editor. Complete these tabs using the explanations provided earlier in this chapter for the InfinityInput editor. Refer to Chapter 4 for details on entering information into the Security Level tab. Creating an InfinityString Object You create an InfinityString object in the same way that you created an InfinityInput object. Repeat the steps from the InfinityInput procedure, but replace the word InfinityInput with InfinityString throughout the steps. This brings up the InfinityString editor, shown on the next page. The InfinityString General Tab InfinityString points are storage locations for plain text messages in an Infinity controller’s memory. These can include logical paths to physical devices such as printers, or messages that are displayed to an operator.
- 284. TAC272 Value This field is blank in a newly created point. Description A description of up to 32 characters (including spaces) is optional, but a good explanation helps users when they need to test, modify, or manipulate the point. String Size The default InfinityString point size is 132 characters. You can set a lower number, being sure to pad the size in case you later change the string. The control system truncates characters that exceed the specified string size. Channel and IOU Numbers (NetController Only) Set channel and IOU numbers so the point’s value can be read or changed by a display module. Enter the channel number as it is marked on the controller. Enter an IOU number. On 9200 series CX controllers, IOU numbers are set with dipswitches. After you enter these numbers, select a direction. (See below.)
- 285. Andover Continuum CyberStation Configurator’s Guide 273 Direction Direction is required only if the point’s value can be read or be changed by a display module. Select one of the following from the Direction dropdown menu: IOInput Allow changing the point value from the controller only. IOOutput Allow changing the point value from the control system only. IOBidirectional Allow changing the point value from both the controller and the control system. State Select Enabled or Disabled from the dropdown menu. The control system can change an enabled point from a program or report, but not a disabled point. Setpoint Check the Setpoint checkbox so the controller stores the current point value in the CyberStation database. Continuing On Once you have tested the point, reopen the editor and complete the remaining tabs to finish configuring the point. Enter information into the Triggers, Logs and XDriver tabs of the InfinityString editor. Complete these tabs using the explanations provided earlier in this chapter for the InfinityInput editor. Refer to Chapter 4 for details on entering information into the Security Level tab. About BACnet Points Just as Andover Continuum b4920, bCX1 40x0, and b3 BACnet devices must first be created as InfinityController objects and InfinityInfinetCtlr objects, so too must the nine BACnet points, listed at the beginning of this chapter, first get created as Infinity points. Specifically, if they are attached to Andover Continuum BACnet controllers, they are initially created as InfinityInputs, InfinityOutputs, and InfinityNumerics. How Are BACnet Points Created? When an InfinityController object is created for an Andover Continuum BACnet b4920 or bCX1 40x0 controller, or when an InfinityInfinetCtlr object is created for an Andover Continuum BACnet b36xx, b38xx, or b39xx controller, both Infinity and BACnet points are created.
- 286. TAC274 The following table illustrates this creation: When you create this Infinity point for its b4/bCX1 40x0 InfinityController or b3 InfinityInfinetCtlr … This BACnet object is also created for its corresponding b4/bCX1 40x0/b3 BACnet Device InfinityInput (with analog electrical type) AnalogInput InfinityInput (with digital electrical type) BinaryInput InfinityInput (with multistate “supervised” electrical type) MultistateInput InfinityOutput (with analog electrical type) AnalogOutput InfinityOutput (with digital electrical type) BinaryOutput InfinityOutput (with multistate “tristate” electrical type) MultistateOutput InfinityNumeric (created as an AnalogValue) AnalogValue InfinityNumeric (created as a BinaryValue) BinaryValue InfinityNumeric (created as a MultistateValue) MultistateValue BACnet Input and Output Objects – When you create an InfinityInput and select an analog, binary, or multistate electrical type (via the ElecType field in the Settings tab of the InfinityInput editor) a BACnet AnalogInput, BinaryInput, or MultistateInput is also created, respectively. BACnet Value Objects – When you create an InfinityNumeric and select AnalogValue, BinaryValue, or MultistateValue as the BACnet Device Type field in the General tab of the InfinityNumeric editor, a BACnet AnalogValue, BinaryValue, or MultistateValue is also created, respectively. These editors and their tabs are shown earlier in this chapter. Note: For third-party BACnet devices that are integrated into the Andover Continuum system, AnalogInput, BinaryInput, and MultistateInput objects were already created as objects on those third-party BACnet controllers. When InfinityInputs, InfinityOutputs, and InfinityNumerics are first created, their BACnet counterparts are not simultaneously created. The BACnet counterpart is created when, from Continuum Explorer, you highlight the BACnet controller (b4, bCX1 40x0, b3), right click, and from the popup menu select Send To Database. See Chapter 3 and Chapter 14. In Continuum Explorer, after these BACnet points are created and learned into the system, they appear as Infinity points in the CyberStation/Infinity portion of the navigation pane, and as BACnet points in the BACnet Devices portion of the navigation pane. On the Infinity side, they appear in CyberStation/Infinity class folders beneath the InfinityController and InfinityInfinetCtlr object icons. Likewise, on the BACnet side, they appear in BACnet default class folders beneath their Device icons. (See Chapter 3 and Chapter 14 for more information on these Explorer views.)
- 287. Andover Continuum CyberStation Configurator’s Guide 275 BACnet Andover Continuum fully supports the BACnet standard. Andover Continuum’s BACnet product line includes controllers, expansion IO modules, repeaters, routers, and CyberStation workstations modified as BACnet Operator Workstation (B-OWS). This chapter describes CyberStation’s implementation of BACnet support, including BACnet- compliant editors and other BACnet features that help you successfully configure and integrate BACnet devices into your building control system. What is BACnet? BACnet stands for Building Automation and Control network. It is a communication protocol, developed by the American Society of Heating, Refrigerating and Air- Conditioning Engineers, Inc. (ASHRAE), that allows products made by different manufacturers to be integrated into a single building automated control system. This means that as long as they meet the ANSI/ASHRAE BACnet Standard, different manufacturers products can seamlessly communicate data to each other over a network. The types of products include controllers, workstations, actuators, and sensors. In BACnet, each of these products is referred to as a device. In order for communications to occur between two different systems a common network technology is required. BACnet supports six different types of networks: Ethernet, BACnet/IP, ARCNET, MS/TP, Point-to-Point, and LonTalk. Continuum supports MS/TP, a twisted-pair cabling arrangement based on the RS-485 standard, and BACnet/IP for its BACnet networking requirements. BACnet provides a standard to model each BACnet device in a building automation system network as a collection of software entities called objects. Each object is characterized by a set of attributes called properties. A third feature, called services, provides messages needed for manipulating the device’s objects and properties. BACnet Objects The BACnet protocol is based on objects, properties, and services. Objects are the logical representation of system data. Objects may represent single physical points or 14
- 288. TAC276 logical groupings/collections of points that perform a specific function. The BACnet standard objects supported are: AnalogInput AnalogOutput AnalogValue BinaryInput BinaryOutput BinaryValue Calendar Device File EventEnrollment Loop MultistateInput MultistateOutput MultistateValue Program Schedule TrendLog EventNotification (NotificationClass in the BACnet standard) Properties Objects are examined and controlled by a set of properties that belong to each object. BACnet properties are equivalent to attributes in CyberStation. (Refer to Key Concepts in Chapter 1.) Examples of object properties are name, type, present value, status flags, high-limit, low limit, and so forth. The most commonly used property for interoperability is Present Value. Each BACnet device also has a device object containing properties that can be used to verify communications, identify the vendor, and identify software and firmware revision and other characteristics of the device. The device object’s properties represent the externally visible characteristics of a BACnet device. Note: CyberStation provides object editors for most BACnet objects. The user interfaces in these editors have the same “look and feel” as other CyberStation/Infinity object editors. BACnet properties appear inside the editors, the way CyberStation attributes do. (See the sections, BACnet Defined Objects and Infinity and BACnet Object Editors, later in this chapter.) Important: While using these object editors, you will notice that certain properties/attributes and, in some cases, entire sections and tabs are unselectable (appear gray). This means that they are not supported on or applicable to the device on which the object resides — for example, on Andover Continuum b4920, bCX1 (40x0 series), and b3 controllers, and certain third-party BACnet devices.
- 289. Andover Continuum CyberStation Configurator’s Guide 277 Services In order for two different devices to interoperate, a common set of services is required. BACnet services provide messages for accessing and manipulating properties of device objects. For example, the devices need to identify themselves (I Am, Who Is), read and write data (Read Property, Write Property), and so forth. BACnet defines 35 services that are grouped into six categories: Alarm and Event Device Management File Transfer Object Access Virtual Terminal Security Andover Continuum’s BACnet Product Line The Andover Continuum line of BACnet products includes a variety of controllers, expansion modules, and other devices that conform to the ASHRAE standard’s BACnet Advanced Application Controller (B-AAC) device profile. Andover Continuum CyberStation conforms to the ASHRAE B-OWS profile. Both the B-AAC controllers and the B-OWS-enhanced CyberStation are classified as “native” BACnet devices, meaning that they can interoperate directly with other manufacturers (third-party) BACnet devices. BACnet-Related Documentation For more information on BACnet, Andover Continuum’s BACnet product line, and Andover Continuum’s implementation of BACnet, please see the following: • Introducing BACnet - A Guide for Continuum Users, 30-3001-863 • BACnet Controller Technical Reference, 30-3001-862 • bCX1 Series Controller Technical Reference, 30-3001-890 • ANSI/ASHRAE Standard 135-2004: BACnet A Data Communication Protocol for Building Automation and Control Networks • BACnet PICS (Protocol Implementation Conformance Statements), located on the BACnet page of TAC’s tech support web site. PICS are detailed descriptions of a device’s inherent BACnet capabilities. PICS tell a potential user what objects and BACnet services a device supports. It also details the type of communications network, the baud rate, the range of values each object property expects and whether or not a property is read-only. (This site’s BACnet page has many other useful BACnet documents.) • CyberStation online help
- 290. TAC278 Post Installation System Integration Once the new BACnet hardware devices have been installed on your system and CyberStation software has been installed in accordance with the CyberStation Installation Guide, 30-3001-720, start up CyberStation. (See Starting CyberStation in Chapter 1.) Access the Continuum Explorer. Normally you will be in the All Paths view. Locating BACnet Devices To find new BACnet devices: 1. Ensure that setting 1, Enable BACnet, in the BACnet Preferences dialog is set to “True”. (See the BACnet Preferences dialog later in this chapter.) 2. Right click Root in the Explorer’s navigation pane. The object dropdown menu appears: 3. Select Find New BACnet Devices. The new BACnet network icon appears in the navigation pane. 4. Click the + sign next to display BACnet devices, folders, and other objects: Note: You can also right click an InfinityController and select Find New BACnet Devices. BACnet Device Icons
- 291. Andover Continuum CyberStation Configurator’s Guide 279 BACnet Icons In CyberStation, BACnet-related icons appear in the Explorer to differentiate between BACnet and non-BACnet devices. These icons are shown below. BACnet Devices Continuum Third Party Continuum i2 Third Party CyberStation BACnet Device BACnet Device Workstation Workstation (blue) (olive) (gray) (olive monitor) (blue monitor) Folders BACnet BACnet Default CyberStation Default Folder Class Folder Class Folder (blue) (blue) BACnet Class Objects BACnet BACnet BACnet AnalogInput AnalogOutput AnalogValue BinaryInput BinaryOutput BinaryValue MultistateInput MultistateOutput Networks BACnet Network Color differentiates between Andover Continuum (blue) and third-party (olive) BACnet devices, folders, and workstations. Also, Andover Continuum i2 devices appear in gray.
- 292. TAC280 The following illustration shows Continuum Explorer with many of these BACnet and non- BACnet icons. Note that the upper portion of the navigation pane shows Infinity (non- BACnet) icons, whereas the lower portion shows BACnet icons, beneath the BACnet network icon:
- 293. Andover Continuum CyberStation Configurator’s Guide 281 Saving BACnet Devices to the Database The new BACnet devices need to be added to CyberStation’s SQL database. By default, each new BACnet device icon has a yellow exclamation flag next to it. When you place the cursor over the flag, the following tool tip appears: RootBACnet Device xxxxxxx requires a save to database. CyberStation offers you two ways to accomplish this – manually or automatically. Manual Save to Database To manually save a BACnet device to the database: 1. Right click the BACnet device. A popup menu appears. 2. Select Send to Database option from the popup menu: This causes the content of the device to be uploaded to the SQL database. Once the process is complete, select Refresh from the Explorer’s View menu (or click the Explorer’s refresh button) and the exclamation flag disappears from the device’s icon. Automatic Save to Database You can set up CyberStation so that each new BACnet device is automatically saved to the database (upon learning of new BACnet devices) by performing the following procedure: 1. Right click the Continuum icon in the window taskbar (tool tray). 2. Select BACnet Preferences from the popup menu: 3. In the BACnet Preferences dialog (shown on the next page) change the value of item 2, Automatically save new BACnet devices to the database, from False to True.
- 294. TAC282 4. Find new BACnet devices. Right click over the Root directory in the Explorer, and from the popup menu, select Find New BACnet Devices. (See the procedure, Locating BACnet Devices, earlier in this chapter.) Viewing Options CyberStation offers you three ways to view Andover Continuum BACnet controllers in the Explorer. The choices are: • As both Infinity/Infinet Controller objects and BACnet Device objects • As BACnet devices only • As a Infinity/Infinet controllers only Viewing Both Infinity Controllers and BACnet Devices To view Andover Continuum BACnet controllers as both Infinity/Infinet Controller objects and as BACnet Device objects in the Explorer’s navigation pane: 1. From the Explorer’s View dropdown menu, select Show TAC BACnet Device As... 2. Select Infinity Controller and BACnet Device:
- 295. Andover Continuum CyberStation Configurator’s Guide 283 The navigation pane of the Explorer now reflects this viewing selection. For example: Viewing BACnet Device Only To view Andover Continuum BACnet controllers only as BACnet Device objects in the Explorer’s navigation pane: 1. From the Explorer’s View dropdown menu, select Show TAC BACnet Device As… 2. Select BACnet Device Only. The navigation pane of the Explorer now reflects this viewing selection. For example: Viewing Infinity Controller Only To view Andover Continuum BACnet controllers as Infinity/Infinet Controller objects in the Explorer’s navigation pane: 1. From the View dropdown menu, select Show TAC BACnet Device As… 2. Select Infinity Controller Only. b4920 controllers, b4Controller1 and b4Controller2 are shown with Infinity Controller icons in the The same controllers (with the same names) are also shown with BAC t i i th bCX1 controllers, b4Controller1 and b4Controller2, do not appear as Infinity Controllers in the Infinity portion of the tree.
- 296. TAC284 The navigation pane now reflects this viewing selection. For example: Disabling BACnet The first setting (Enable BACnet) in the BACnet Preferences dialog allows you to disable communication with all BACnet devices on your system. To accomplish this: 1. Right click the Continuum icon in the window taskbar (tool tray). 2. Select BACnet Preferences from the popup menu: 3. In the BACnet Preferences dialog, change the value on item 1, Enable BACnet, from True to False. 4. Change your viewing options to Infinity Controller Only: Once you have performed this procedure, CyberStation no longer sends or responds to BACnet communication requests and works completely in the context of CyberStation/Infinity class objects. To return to BACnet, change the Enable BACnet setting to True (its default setting) and change your viewing option to Infinity Controller and BACnet Device. bCX1 controllers, b4Controller1 and b4Controller2, do not appear in the BACnet portion of the
- 297. Andover Continuum CyberStation Configurator’s Guide 285 BACnet View The Explorer provides a BACnet View selection in its View dropdown menu. This selection shows only the BACnet portion of the Explorer tree. To use this view: 1. Click the down arrow attached to the Explorer bar icon in the quick picks toolbar. 2. Select BACnet View from the dropdown menu: The navigation pane shows the BACnet devices portion of the tree: Hiding Out of Service Devices You can hide any out-of-service devices that you do not want to appear in the Explorer by performing the following procedure: 1. In the Explorer, right click the device you wish to hide. 2. Select Open from the dropdown menu. The Device editor appears. (Refer to the next page.) 3. Check the Out of Service checkbox in the Device editor. 4. Click the editor’s OK button. 5. Select Hide Out of Service Devices from the Explorer’s View menu: 6. Select Refresh from the Explorer’s View menu, or click the Explorer’s refresh button The selected device should not appear on the refreshed Explorer view. Registering a BACnet Broadcast Management Device (BBMD) If your workstation is designated as a BACnet Broadcast Management Device (BBMD), click the BBMD Registration button (located in the BACnet Preferences dialog) to view the BBMD Registration dialog, which is a list of system BBMDs that are registered with your BBMD workstation — the other BBMDs that yours knows about. This list is an internal table, known as the BBMD table. BBMDs ensure that broadcast messages are delivered among all BACnet devices across subnetworks. Your BBMD must know about other BBMDs as part of the broadcast process. In addition to the BBMD table, each BBMD also has a table of foreign devices. These are BACnet devices to which broadcast messages are routed.
- 298. TAC286 For each BBMD, the BBMD Registration dialog lists the IP address, network port, broadcast disk mask, and last "teach time" — the last time you used the Teach button to inform other BBMDs about the existence of your BBMD and BBMD table. (See Teaching BBMDs, below.) Adding BBMDs You may add a BBMD to your BBMD table, as follows: 1. From the BACnet Preferences dialog, click the BBMD Registration button: The BBMD Registration dialog appears: 2. Click the Add button. The Add BBMD dialog appears:
- 299. Andover Continuum CyberStation Configurator’s Guide 287 3. Enter the IP address, network port, and broadcast distribution mask of the BBMD. Note: If you also want to learn about the BBMDs contained within the internal table of the BBMD you are adding, check the Import all BBMDs from device checkbox. The BBMDs from that table are added to the registered list (your table). 4. Click OK, then from the BBMD Registration dialog, click Refresh. Teaching BBMDs From the BBMD Registration dialog, you may teach other system BBMDs about the existence of your BBMD (including the BBMDs listed in your internal BBMD table). 1. From the BACnet Preferences dialog (shown in previous section) click the BBMD Registration button. The BBMD Registration dialog (shown in previous section) appears. 2. Click the Teach button. A window appears showing the progress of the teach process, before the process completes. The Last Teach Time column in the BBMD Registration dialog will reflect this teach. Deleting BBMDs From the BBMD Registration dialog, you may delete one or more BBMDs. 1. From the BACnet Preferences dialog, click the BBMD Registration button. The BBMD Registration dialog appears. 2. Highlight (select) a BBMD entry in the list. 3. Click the Delete button, then click the Refresh button.
- 300. TAC288 Note: Click the Exit button to dismiss the BBMD Registration dialog. For important related BBMD information, see also the Details tab and the Foreign Devices tab of the Device editor, which is discussed next. For complete information on BBMDs, please see Introducing BACnet – A Guide for Continuum Users, 30-3001-863. The Device Editor Once a BACnet device has been saved to the CyberStation SQL database, you can open its Device editor. To do this, right click the Device icon in the Explorer’s navigation pane, and select Open from the dropdown menu. The Device editor opens with the General tab displayed. Note: When you are editing a BACnet Device object, fields in the editor will be unselectable (grayed-out) for those properties that the BACnet device does not support. The General Tab The general tab summarizes the network features of the device, most of which are automatically supplied by the system. A few remaining inputs and actions are supplied by the user. A summary of all the features on the tab is described below. Description Name of the device and its node number. BACnet Network Number Specifies the ID of the BACnet IP network
- 301. Andover Continuum CyberStation Configurator’s Guide 289 Model Name Displays a model name based on the information it receives via the BACnet protocol. Device Node ID The node ID number assigned to the device Device Status Based on the current status of the device, this displays one of the following: Operational ― indicates the device is working and is ready to receive or transmit data. DownloadRequired ― indicates the device requires a download of information NonOperational ― indicates the device is offline or that a fault has been detected. OperationalReadOnly ― indicates the device is working and ready to transmit data. DownloadInProgress ― indicates a download is in progress and the device will not be ready to transmit data until the download is complete. Comm Status CyberStation sets the comm status to OnLine or OffLine depending on whether the workstation is in communication with the device. Primary Access Server Check this checkbox to designate this workstation as the primary access server. Secondary Access Server Check this checkbox to designate this workstation as the secondary access server. BACnet MAC Address The Media Access address assigned to the device. Auto Download Enables a device to auto download schedules to controllers. Probe Time Set the interval in seconds by which the device checks the comm status of the other connected CX series controllers and CyberStation workstations. When the device does not receive a response from another CX controller or CyberStation within the probe time, it changes their comm status to Offline.
- 302. TAC290 Probe Type From the dropdown menu, select one of the following. Note: Probe Type is used only for third-party BACnet devices. Probe — Probing occurs at the interval specified in Probe Time. The default is 60 seconds. The advantage of this is that CyberStation detects a device going offline regardless of whether or not CyberStation is attempting communications with the device. The disadvantage is excess probe traffic for devices. ProbeOnDemand — Probing does not occur unless a communications transaction with the target device fails. Once a transaction fails then probing occurs at the interval specified in Probe Time until the device comes back online. The advantage is that additional requests to the controller fail immediately. The disadvantage if that node failure is not detected until a CyberStation application needs to communicate with a controller. ProbeOff — Probing does not occur. The advantage is that there is never probe traffic to the device. The disadvantage is that each request to the device fails only after the transaction times out. BACnet Max Master The Max Master property is a value that specifies the highest possible address for master nodes. Out of Service When checked, hides the selected device. (See Hiding Out-of- Service Devices, earlier in this chapter.) BACnet Workstation Add check in checkbox to identify a third-party device as a workstation. It will show up as an olive computer icon in the Explorer. Location Type in the physical location of the device (optional). Container Type Enter up to 32 characters of text that indicates the container type (workstation). Serial Number Specifies the controller’s serial number, which is retrieved once the workstation is in communication with the controller and you have used the Teach button to update your network. Default Folder Specifies the default folder under which the device will appear. Reinitialize Device When selected, brings up the Reinitialize Device dialog. (See below.) Teach Invokes the teach mode (see next page)
- 303. Andover Continuum CyberStation Configurator’s Guide 291 Reinitializing Andover Continuum BACnet Controllers Andover Continuum BACnet controllers contain EPROM flash memory that can be upgraded electronically. Whenever a reset is desired or power failure occurs, these controllers can be reinitialized. This can be accomplished as a cold start or a warm start, defined as follows: • Cold Start — when the controller comes up from a reset and recalls a backup copy of the controller’s original RAM database • Warm Start — when the controller comes up from a reset and recalls a copy of the controller’s database at the time the reset or power failure occurred. To reinitialize a controller proceed as follows: 1. Click the Reinitialize Device button (previous page) to bring up the Reinitialize Device dialog: 2. Click the State field’s down-arrow button to open the dropdown menu. 3. Click the desired reinitialize state (Coldstart or Warmstart). 4. Enter your password in the Password field. (Enter password on third-party BACnet devices only. Andover Continuum BACnet controllers do not require a password.) 5. Click the OK button. Teach Click this button to perform a manual "teach". This updates or "teaches" all Infinity controllers (including Andover Continuum BACnet controllers) about this CyberStation device and teaches all Infinity controllers about each other and about all devices. Note: The Teach feature is implemented on CyberStation devices only. It is not implemented on BACnet devices. When you click the Teach button, a Select Teach Mode dialog appears:
- 304. TAC292 Teach supports two modes of operation: Mode Description Device Teach Click the Device Teach radio button to teach all Infinity controllers, including b4920/bCX1 (40x0 series) controllers, on the network about the existence and properties of this device. Global Teach Click the Global Teach radio button to teach everything – to teach each Infinity Controller, and each b4920/bCX1 (40x0 series) controller, about the other Infinity controllers that are on the same network, and to teach all Infinity controllers about all devices.
- 305. Andover Continuum CyberStation Configurator’s Guide 293 The Details Tab The Details tab supplies various information about the BACnet device. Two of the most important items on this tab are the Supported Object Types and the Supported Services windows, which list the objects and services that are supported by the device. This tab also allows you to designate this device as a BACnet Broadcast Management Device (BBMD) or register this device as a foreign device with an existing BBMD. Supported Services Lists the types of BACnet services that are supported by the device. Supported Object Types Lists BACnet objects that are supported by the device. Vendor Name Displays the name of the vendor who manufactured the device. Vendor ID Displays the vendor's corporate ID number. Software Revision Displays the version number of the software application supported by this device. Firmware Revision Displays the version number of the device’s firmware.
- 306. TAC294 Protocol Version Displays a number that indicates which specific set of standardized protocol services and object classes this object supports. Protocol Revision Displays the version number of the firmware innate to the standardized protocol services and object classes this object supports. Database Revision Displays the version number of the CyberStation database. Max APDU Length Accepted Represents the maximum number of octets that may be contained in a single, indivisible application layer protocol data unit. APDU Retries Displays the maximum number of times that an APDU (application protocol data unit) shall be retransmitted. The default value is 3. If you have access permission, you may change the number in this field. APDU Timeout Displays the amount of time in milliseconds between retransmission of an APDU requiring acknowledgment for which no acknowledgment has been received. The default value is 60,000 milliseconds. If you have access permission, you may change the number in this field. Max Info Frames Specifies the maximum number of information frames that may be sent before the device must pass the token. The field is selectable (writable) if this device is a node on an MS/TP network. If it is not writable or otherwise user- configurable, its value shall be 1. Segmentation Support Indicates whether or not this device supports segmentation of messages, and if so whether it supports segmented transmission, reception, or both. The possible values are listed below: Segmented Both – Supports both segmented transmission and reception. Segmented Received – Supports only segmented reception. SegmentedTransmit – Supports only segmented transmission. NoSegmentation – Does not support segmentation.
- 307. Andover Continuum CyberStation Configurator’s Guide 295 Segment Timeout Displays the amount of time in milliseconds between retransmission of an ADPU segment. The default value is 2000 milliseconds. In order to achieve reliable communication, all intercommunicating devices should have the same Segment timeout value. If you have access permission, you may change the number in this field. Max Segments Accepted Displays an integer that represents the maximum number of message segments allowed. Max # of Async Requests Note: This attribute is used only for third-party BACnet devices. This attribute specifies how many concurrent requests will be sent to the device. You may either: Accept the default (1). This is non-concurrent. Enter another integer that specifies the maximum number of concurrent requests that the Pinpoint graphics application can send to this device to update the values of points and objects attached to graphic controls inside an open Pinpoint graphics file. Accepting 1, the default — Accepting 1, the default, means that the requests (or the "polling" of point/object values) occur one request at a time. When you accept 1, the request interval (time between requests) must also be set. (See Request Interval, below.) Note: For the least impact on network performance, the default is recommended. This avoids heavy polling traffic. Changing the Default Value — When you enter an integer of 2 or higher, Pinpoint polls the device in multiple, concurrent read-property requests. Use this feature if you believe the Pinpoint data-value updates are too slow. Concurrent polling works best for devices attached to an Ethernet network. It is not recommended for devices attached to a field-bus network, such as MS/TP. Note: The Request Interval field (see below) is not selectable if you enter a value of 2 or higher. The Request Interval field is used only for sequential (non-concurrent) data polling (when the value is 1).
- 308. TAC296 Request Interval Note: This attribute is used only for third-party BACnet devices. This field can be set only when the Max # of Async Requests is set to 1 (the default). The request interval is the number of milliseconds that elapse between two sequential (non-concurrent) data-value requests. (The Pinpoint graphics application sends requests to this device to update the values of points and objects attached to graphic controls inside an open Pinpoint graphics file. See also Max # of Async Requests, above.) You may either: Accept the default value (500 milliseconds). Enter another value, in milliseconds. Note: For best performance, the default (500 milliseconds) is recommended.
- 309. Andover Continuum CyberStation Configurator’s Guide 297 BACnet Broadcast Management Device Check this checkbox if the device is a BACnet Broadcast Management Device (BBMD). A BBMD facilitates the delivery of broadcast messages among BACnet devices located on different TCP/IP subnetworks. Note: As of this version, a workstation and a bCX1 40x0 controller can be designated a BBMD. By default, this checkbox is not checked. When it is not checked, you may register this device (as a foreign device) with an existing BBMD. Enter values in the fields of the Foreign Device Registration section, located beneath the checkbox. These fields are described below. A foreign device is a BACnet device that has an IP subnet address different than other BACnet devices with which it must share broadcast communication. When you check it, the Device editor also displays a Foreign Devices tab, which lists foreign devices that are registered — all the ones that the BBMD knows about. The Foreign Devices tab is described later in this chapter. (Each BBMD has an internal table of foreign devices, as well as an internal table of other BBMDs.) Note: See also Registering a BACnet Broadcast Management Device (BBMD), earlier in this chapter.. The BBMD Registration feature allows you to maintain a registered list of other BBMDs (the internal table of BBMDs). For complete information on BBMDs, please see Introducing BACnet - A Guide for Continuum Users, 30- 3001-863. Foreign Device Registration BBMD IP Address Enter the IP address of the BBMD with which you want to register this device as a foreign device. This field defaults to 0. BBMD Port Enter the BACnet network port (hexadecimal integer) of the BBMD with which you want to register this device as a foreign device. This field defaults to 0xBAC0. Time to Live Enter the number of seconds that a foreign device registration is active that is, how long it remains registered in the table of foreign devices of the BBMD. If no re- registration occurs before the time expires, the foreign device is purged from the table when the time expires. The default is 300 seconds (5 minutes).
- 310. TAC298 Note: For complete information on all BACnet properties, please see ANSI/ASHRAE Standard 135-2004: BACnet A Data Communication Protocol for Building Automation and Control Networks. The Backup/Restore Tab Using the Backup/Restore tab, you can automatically back up configuration information from this BACnet device to your database, as well as automatically restore it from the database to this device. The configuration information resides in a special configuration file, which is stored as an object — the BACnet class object, File. (See Chapter 21.) You can also archive it locally in a text file (ASCII dump file.) The backup selections on this tab — see also the editor attributes table below — allow you to: • Back up configuration information (stored in a special File object called ACCConfiguration) for this BACnet controller and save it to your CyberStation database. Note: You can also perform this operation for one or more devices via the right-click container popup menu in Continuum Explorer's navigation pane. Please see Backing Up a Device's Configuration in Chapter 21.
- 311. Andover Continuum CyberStation Configurator’s Guide 299 • Back up configuration information for this controller from the database and archive it into a text (ASCII dump) file. • Simultaneously back up this controller's configuration information to the database and copy (archive) it to a text (ASCII dump) file. The restore selections on this tab — see also the editor attributes table below — allow you to: • Restore configuration information from your database to this BACnet controller. Note: You can also perform this operation for one or more devices via the right-click container popup menu in Continuum Explorer's navigation pane. Please see Restoring a Device's Configuration in Chapter 21. • Restore archived configuration information (contained in a text ASCII-dump file) to your database. • Simultaneously restore the archived configuration information (contained in a text ASCII-dump file) to your database and to this controller. The File object — When a backup operation is performed for a BACnet device, a File object (a BACnet class object) is created. This object, which is stored in the File object class folder residing in its respective BACnet controller, is named ACCConfiguration and it contains configuration information for that controller — all the configuration settings for objects in the controller. For more information please see Chapter 21, Managing Configuration Files. Backup To Database Time Displays the last date/time the configuration information was backed up from the controller to the database. Backup Failure Timeout Enter the time to allow a backup to complete before a backup operation ends due to a timeout. Last Restore To Device Time Displays the date/time the configuration information was last restored to the controller. Last Restored Archive File Displays the path of the last archive (.dmp) file to be restored.
- 312. TAC300 Backup Select one of the radio buttons to perform a backup operation, as follows: To Database — Back up the content of the ACCConfiguration file from this controller and save it to your database. Database To Archive — Back up the saved configuration in your database from the database to an archived (ASCII .dmp) file. In the Archive File Name field, click the browse button, search for, and select the file into which you want to archive the information. To Database and Copy to Archive — Perform both backup operations. That is, back up ACCConfiguration from this controller to the database and archive it to an ASCII .dmp file. In the Archive File Name field, click the browse button, search for, and select the file into which you want to archive the information. When you have selected the operation you want and (if needed) have selected an archive file, click the Backup button to execute the backup operation. For Andover Continuum BACnet controllers, the Distribution Properties dialog appears, showing progress messages about the status of the backup operations. For some third-party BACnet controllers, you are first prompted to enter a password. If the password is accepted, the operation begins. Restore Select one of the radio buttons to perform a restore operation, as follows: From Database — Restore the content of the ACCConfiguration file from your database to this controller. From Archive to Database — Back up the content of an archive file to the database. In the Archive File Name field, click the browse button, search for, and select the file whose configuration information you want to restore to the database. From Archive To Database and Device — Back up the content of the archive file to the database and to the controller. In the Archive File Name field, click the browse button, search for, and select the file from which you want to restore to both the database and controller. Configuration Files In Archive — This window lists one or more ACCConfiguration file images contained within the particular archive (.dmp) file that you have
- 313. Andover Continuum CyberStation Configurator’s Guide 301 selected. It helps you identify whether or not this is the correct archive file that you want to restore. Archive Backup Time — When you select the archive (.dmp) file that you want to restore, this field displays the last time that the information in this archive file was backed up from the controller to the database. This timestamp helps determine whether or not this is the archive file that you want to restore. Note: You may use the restore operations on this tab to restore archive-file information to one or more controllers. To do so, access the Device editor for every controller to which you want to restore the archived information. When you have selected the operation you want and (if needed) have selected an archive file, click the Restore button to execute the restore operation. For Andover Continuum BACnet controllers, the Distribution Properties dialog appears, showing progress messages about the status of the restore operations. For some third-party BACnet controllers, you are first prompted to enter a password. If the password is accepted, the operation begins. The Known Devices Tab The Known Devices tab lists the BACnet devices that exist on the network that can be monitored by this device. Entries in the list identify the actual device addresses that are used when the device is accessed via a BACnet service request.
- 314. TAC302 Device Displays the path of the device. BACnetNetworkNumber Specifies the ID of the BACnet network. BACnetMacAddress The Media Access address assigned to the device. The Foreign Devices Tab If this device is designated as a BACnet Broadcast Management Device (BBMD), then this Foreign Devices tab appears in the Device editor: This tab lists all the foreign devices contained in the BBMD's internal foreign device table. A foreign device is a BACnet device that has an IP subnet address different from those comprising the BACnet/IP network. Foreign devices are registered with a BBMD. This registration makes it possible for the BBMD to facilitate the delivery of broadcast messages among registered BACnet devices located on different system subnetworks. Note: The BACnet Broadcast Management Device checkbox on the Details tab must be checked for the Foreign Devices tab to appear. For more information on BBMDs, please see Introducing BACnet – A Guide for Continuum Users, 30-3001-863. For each foreign device listed, this tab displays the following information. The values in this tab reflect the properties of subscriptions of foreign devices registered with CyberStation. • IP Address — The IP address of the BBMD with which you want to register this device as a foreign device. This is specified in the Details tab. • Port — The BACnet network port (hexadecimal integer) of the BBMD with which you want to register this device as a foreign device. This is specified in the Details tab.
- 315. Andover Continuum CyberStation Configurator’s Guide 303 • Time To Live — The total number of seconds that a foreign device registration inactive – that is, how long it will be registered in the table of foreign devices of the BBMD. If no re-registration occurs before the time expires, the foreign device is purged from the table when the time expires. This is specified in the Details tab. • Time Remaining — The number of remaining seconds that a foreign device will be registered in the table of foreign devices. If the foreign device is not re-registered before this time expires, then it is purged from the table when the time expires. The Time Tab The Time tab is where you synchronize the BACnet device time and date to the systems local time and date: Local Time Enter the local time – hour: minutes: seconds AM or PM UTC Offset Enter the Universal Time Coordinate (UTC) offset in minutes. This is the difference in minutes between your local time and Greenwich Mean Time. Note: When entering this number, use the opposite sign (negative or positive) from what you actually want the system to write. For example, if you are 300 minutes (5 hours) ahead of GMT, enter: -300 If you are -240 minutes (4 hours) behind GMT, enter: 240 Local Date Enter the date – month/ day/ year. Daylight Savings Check if daylight savings time is in effect. Synchronize to Local Time and Date Use the BACnetDevice window to locate the new BACnet device. (See below.) To synchronize the new BACnet device with the system’s local time and date: 1. Scroll through the BACnetDevice window to locate the new BACnet device.
- 316. TAC304 2. Click the device to highlight it. 3. Click the Add button. 4. Click the Sync Time button. Note: To remove a BACnet device’s local time and date from the system, perform steps 1 and 2 (above), and the click the Delete button. The Alarms Summary Tab This tab provides an alarm summary from the BACnet device each time the Refresh button is selected: Event Object Displays the event object that caused the alarm. Alarm State Displays the state of the alarm. Acked Transitions Displays one of three alarm acknowledgement transition events: ToOffnormal ToFault ToNormal These are cleared upon the occurrence of the corresponding event and set under any of these conditions:
- 317. Andover Continuum CyberStation Configurator’s Guide 305 Upon receipt of the corresponding acknowledgment Upon the occurrence of the event if the corresponding flag is not set (meaning event notifications will not be generated for this condition and thus no acknowledgment is expected) Upon the occurrence of the event if the corresponding flag is set (meaning no acknowledgment is expected) The Preferences Tab Note: The Preferences tab is only applicable to CyberStation workstations. It is not supported for Andover Continuum b3, b4920, and bCX1 (40x0 series) devices or for third-party BACnet devices. This tab presents settings that you set by typing in values, selecting the location of files and file paths from dropdown menus, or selecting true or false conditions. Setting Description Value 1 Command Prompt in the Command Line application Command prompt for the CyberStation command line application. 2 The location of the badge format files Select files from the browse dialog. 3 The default badge format Type in the format.
- 318. TAC306 Setting Description Value 4 Default Report Viewer Type in the report viewer file (notepad.exe, and so on) 5 Increment Report File Select True or False 6 Maximum entries in the Alarm Viewer Type in the number. 7 Maximum entries in the Access Event Viewer Type in the number. 8 The location of the Plain English Wizard files Type in the file path. 9 Path to the Alarm Printer Type in the file path. 10 Suppress form feeds when printing alarms Select True or False. 11 Use preset image cropping Select True or False. 12 thru 14 Alarm, Return to Normal and Fault Email Format file path for each item Use the Open dialog to select the file path. 15 thru 17 Acknowledge File Path for each item Use the Open dialog to check the path. 18 The file name of main menu Use the Open dialog to check the path. 19 Enables and disables the immediate distribution of personnel records from this workstation to controllers on the local area network (LAN). True (enabled) is the default. When this feature is enabled, the workstation inspects the status of the database, and if there are pending distribution- event transactions, it performs the distributions. Note: This preference should be set only by a system administrator. When to disable this preference — Typically, you would set this preference to False if the workstation is running a lot of applications, such as graphics. If there are several workstations at this site, disabling it on the web server may result in better performance. It also gives you the choice of turning it off for a workstation that is shut down at the end of a day. When to enable this preference — Typically, you would set this preference to True for workstations that are dedicated servers (running 24 hours per day and seven days per week, typically in a back Select True or False.
- 319. Andover Continuum CyberStation Configurator’s Guide 307 Setting Description Value room) and for other workstations based on the number of distributions and throughput. The more workstations that are distributing, the faster the distribution occurs. For related information, please see Chapter 20, which describes the Access Distribution View. 20 Enables and disables the immediate distribution of personnel records from this workstation to controllers on remote access services (RAS) networks. True (enabled) is the default. When this feature is enabled, the workstation inspects the status of the database, and if there are pending access distributions, it performs the distributions. Note: This preference should be set only by a system administrator. The guidelines for disabling and enabling this preference (given in setting 19) also apply to setting 20. Please see setting 19, above. For related information, please see Chapter 20, which describes the Access Distribution View. Select True or False. 21 Enables and disables the downloading of extended log data from the controllers on the local area network (LAN) to this workstation. TRUE (enabled) is the default. Note: This preference should be set only by a system administrator. When to disable this preference — Typically, you would set this preference to FALSE if the workstation is running a lot of applications, such as graphics. If there are several workstations at this site, disabling it on the web server may result in better performance. It also gives you the choice of turning it off for a workstation that is shut down at the end of a day. When to enable this preference — Typically, you would set this preference to TRUE for workstations that are dedicated servers (running 24 hours per day and seven days per week, typically in a back room) and for other Select True or False.
- 320. TAC308 Setting Description Value workstations based on the number of amount of downloading and throughput. For more extended log preference settings, please see the description of the General Preferences dialog in Chapter 13. 22 Enables and disables the downloading of extended log data from the controllers on a remote access services (RAS) network to this workstation. TRUE (enabled) is the default. Note: This preference should be set only by a system administrator. The guidelines for disabling and enabling this preference (given in setting 21) also apply to setting 22. Please see setting 21, above. For more extended log preference settings, please see the description of the General Preferences dialog in Chapter 13. Select True or False. 23 Establishes the data-refresh rate for an active graphic in the web.Client Pinpoint graphics application. Note: Graphics objects are created in CyberStation, in Pinpoint “design” mode. You may not create, design, or modify graphics objects in web.Client. However, in web.Client you may open a graphic panel, monitor its values and, in “run” mode, dynamically adjusting those values. (See the web.Client online help.) Enter the rate (in seconds) at which you want to poll values in web.Client Pinpoint graphics continuously and automatically. When web.Client graphics are in use, they are automatically refreshed at this rate. The default is 5 seconds. Type in the number of seconds or accept the default.
- 321. Andover Continuum CyberStation Configurator’s Guide 309 Setting Description Value 24 This setting is used by the CyberStation Pinpoint graphics application. Enter a rate (in milliseconds) at which you want to poll graphics panel values in real time and refresh the canvas in a Pinpoint graphics object, when the application is active (selected in the foreground on a PC). The range of acceptable values is 20 ms to 32000 ms (32 seconds). The default is 20. Setting a value outside this range generates an error message. Tips: Using the default or another low number means that graphics are constantly refreshed. However, some processors may become sluggish if they are less able to handle such a rapid rate. In this case, you would want to use a higher number, such as 250 or 500 ms, to stabilize performance. Enter the rate in milliseconds. 25 This setting is used by the CyberStation Pinpoint graphics application. Enter a rate (in milliseconds) at which you want to poll graphics panel values and refresh the canvas in a Pinpoint graphics object, when the application is inactive (not selected in the foreground on a PC). The range of acceptable values is 20 ms to 32000 ms (32 seconds). The default is 20. Setting a value outside this range generates an error message. For some usage tips, see the note in setting 24, above. Enter the rate in milliseconds. 26 Use Personnel Manager. True is the default selection, indicating that the Personnel Manager, a powerful and easy-to-use tool for creating, editing, and managing Personnel objects is the editor for Personnel objects at this workstation. Select False if you want to use the Personnel editor, a dialog similar to other CyberStation editors. Select True or False.
- 322. TAC310 Security Level Tab The access permissions configured in a security level allow you to customize (deny)access to individual CyberStation objects. Security levels are actual CyberStation objects (Security Level objects) configured via the Security Level editor. A security level can deny access to a CyberStation object editor on a page-by-page basis using object-level security. Object-level security is a way to deny user groups the ability to create, delete, or change individual CyberStation objects. Every object editor in CyberStation has a Security Level tab that displays a list of all existing security level objects. Selecting a security level object here attaches that security level to the object being edited. To attach a security level to this point, locate the security level in the Name column and click the radio button next to it. To detach a security level from this point, locate the security level in the Name column and double-click the radio button to remove the black dot it contains. Or you can right click the security level in the Name column to bring up a popup menu. Click Clear Selection in the popup menu. Refer to Chapter 4 for information on the attaching security levels to a BACnet device. The Next Step Once you are finished with the BACnet Device editor, you can begin to configure alarms for your BACnet devices.
- 323. Andover Continuum CyberStation Configurator’s Guide 311 Configuring BACnet Alarms Configuring alarms for BACnet devices deviates somewhat from the standard CyberStation alarm configuring procedure described in detail in Chapter 10. Basically, to configure a standard CyberStation alarm you: • Create the EventNotification object(s) • Create the AlarmEnrollment object(s) associated with the EventNotification object • Attach AlarmEnrollment objects to the point to be monitored However for configuring BACnet devices the BACnet object class, EventEnrollment, replaces the AlarmEnrollment object. The EventEnrollment Object The EventEnrollment object is required for BACnet systems. It defines a standardized object that represents and contains the information required for managing events within BACnet systems. An EventEnrollment defines criteria that, when applied to the attached object, will generate an event and transmit an event message to recipients defined by the attached EventNotification. The EventEnrollment object contains the event-type description, the parameters needed to determine if the event has occurred, and a link to an EventNotification object and the object to which the event applies. You use the EventEnrollment editor to access and edit EventEnrollment objects. Creating The EventEnrollment Object To create an EventEnrollment object, perform the following procedure: 1. In the Explorer’s navigation pane, right click the icon of the device to which you want to add an EventEnrollment. Note: For Andover Continuum b4920, bCX1 (40x0 series), and b3 controllers, right click its InfinityController or InfinityInfinetController object icon, respectively, in the upper Infinity portion of the navigation tree. For third-party devices, right click its Device object icon in the BACnet portion of the navigation tree. You cannot create an EventEnrollment for a b4920, bCX1 (40x0 series), or b3 controller via its BACnet Device object. 2. From the New dialog, select EventEnrollment: 3. When the New dialog appears, enter a name for the EventEnrollment object in the Object name field. 4. Click the Create button to create the object and bring up the EventEnrollment editor.
- 324. TAC312 Using the EventEnrollment Editor The EventEnrollment editor contains four tabs that you use to define the event object. In doing this you will make decisions based on the following questions: Which property will trigger this event? You’ll answer this question by selecting an Event Property on the General tab. Most of the time alarms are set up to monitor the value event. Who will be notified of this alarm? You’ll answer this question by making selections in the EventNotification and Recipient dropdown menus on the General tab. EventNotification objects determine, among other things, which workstations receive notification, and which methods are used for notification. (Refer to About EventNotification Objects in Chapter 10.) What Algorithm will this event use? You’ll answer this question by selecting an algorithm and providing its parameters on the Algorithms tab. An algorithm is a set of rules by which an alarm is evaluated. The type of algorithm is determined by the Event Type selection you make on the General tab. What will operators see and hear when this alarm goes off? You’ll answer this question by writing text messages and selecting audio files for each event state. The text messages you write appear in the Active Alarm View, alarm status bar, alarm log, emails, pages, and printer output. (Refer to Active Alarm View in Chapter 10.)
- 325. Andover Continuum CyberStation Configurator’s Guide 313 The EventEnrollment General Tab The General tab is where you enter basic information about the event. Description Type a description of the EventEnrollment object. It can be up to 32 characters (including spaces) in length. Event Notification Browse for an EventNotification object. This will insert the correct path and object name into the Event Notification field. Object Browse for the applicable event object. Event Property Browse the BACnet properties listing in the dropdown menu, and select a property. The list includes all of the properties for all of the BACnet objects. Except for the TrendLog object, Andover Continuum only supports the Value property. For a TrendLog object, the Event Property may also be LogBuffer. Send When checked, each Send option causes the event to be displayed in the Active Alarm View and all recipients on the notification list when the associated point changes to that status. The Alarm option reports the alarm when the point goes into an alarm (OffNormal) state. The Return to Normal option reports the alarm when the point returns to normal. The Fault option reports the alarm when a BACnet device local to the point detects and reports a mechanical fault.
- 326. TAC314 Event Type The selection you make here determines what fields display on the Algorithms tab of this editor. The choices of BACnet event types are: Change of Bitstring Change of State Change of Value Command Failure Floating Limit Out of Range Buffer Ready (for TrendLogs – Chapter 17) Note: The Change of Bitstring and Command Failure algorithms are selectable for third-party BACnet devices only. They are not available for Andover Continuum b4920, bCX1 (40x0 series), and b3 BACnet devices. When you attach a TrendLog as an object, Buffer Ready is always displayed in this field, and LogBuffer is always displayed in the Event Property field. (Please see a related procedure in Chapter 17, Configuring TrendLogs, for configuring algorithmic notifications for TrendLogs.) Notification Type From the dropdown menu, select a notification type. The notification type specifies whether the notification message becomes an alarm message, an event message, or a message of event acknowledgement. AlmNotification – Defines the event as type alarm, appearing in the Active Alarm View when the event occurs. EvtNotification – Defines the event as type event, appearing in Active Alarm View when the event occurs. Acks – Defines the event as type ack-notification, appearing in the Active Alarm View when the event occurs. *Recipient Select workstation to receive the alarm from the browse dialog. *Process Id Identifies the process in the receiving device for which notification is intended. *Priority Property of type Unsigned that convey the priority to be used when issuing event notifications in the case when a Notification Class object is not used. The purpose of prioritization is to provide a means to ensure that alarms or event notifications with critical time considerations are not unnecessarily delayed. The possible range of priorities is 0 - 255. A lower number indicates a higher priority.
- 327. Andover Continuum CyberStation Configurator’s Guide 315 *Confirmed Notification Property of type BOOLEAN, shall convey whether confirmed (TRUE) or unconfirmed (FALSE) event notifications shall be issued when a Notification Class object is not used. *Only applicable to third party devices. Grayed out for all Andover Continuum devices. The EventEnrollment Algorithms Tab The Algorithms tab is where you set the parameters for the algorithm that will be used to evaluate the event. The appearance of this tab is determined by the Event Type selection that was made on the General tab. Time Delay Time Delay appears on the Algorithms tab for all of the Event Type selections, except Buffer Ready. (See the General tab.) Type the number of seconds in the Time Delay field you want to postpone evaluating the alarm. For example, you may decide that the point value can exceed or fall below its alarm boundaries for 30 seconds before the alarm goes off. If at the end of the 30 seconds, the object is in alarm, the alarm goes off regardless of its state during the 30-second delay. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility by filtering out some nuisance alarms. Algorithm Parameters The other fields that appear on the Algorithms tab differ according to the Event Type selected on the General tab. The above figure reflects an Out of Range Event Type selection. The algorithm parameters that you set for each of the event types are described on the following pages.
- 328. TAC316 Algorithm Parameters for an Out of Range Event When you select Out of Range from the Event Type on the General tab, the fields shown below appear on the Algorithms tab: High and Low Limits The high and low limits simply establish boundaries for the point value. When the point value either exceeds the high limit or falls below the low limit, the alarm goes off. To enter these limits, type them into the fields. Dead Band Value The dead band value establishes a range, known as a dead band, within the high and low limits. This range is used to define a subset of acceptable or normal values. The dead band value that you supply is subtracted from the high limit and added to the low limit. The resulting values form the high and low ends of the range of normal values. To enter a dead band value, type it into the Deadband field. The following figure shows a range of normal values formed by a dead band value of 1. The low and high limits are 45 and 74, respectively. The normal range is 46 to 73, because 45 + 1 = 46, and 74 - 1 = 73: Note that the dead band value is optional. If you leave this value at 0, then all values between the high and low limits are considered normal. When the associated point attribute exceeds or falls below the normal range, its Event State attribute changes to High Limit or Low Limit, respectively.
- 329. Andover Continuum CyberStation Configurator’s Guide 317 Algorithm Parameters for a Change of Bitstring Event When you select Change of Bitstring from the Event Type on the General tab, the Algorithms tab appears, as shown below. A change of bitstring occurs when: • The value of the referenced property becomes equal to one of the values contained in the Bitstring Values list, after applying the Bitmask. • That value remains equal for the duration of seconds displayed in the Time Delay field. The change of bitstring generates a ToOffnormal transition, and an event notification is sent. A change of bitstring clears (transitions ToNormal) when: • The value of the referenced event property is no longer equal to one of the values contained in the Bitstring Values list, after applying the Bitmask. • That value remains not equal for the duration of seconds in the Time Delay field. Time Delay Time Delay appears on the Algorithms tab for each of the choices of Event Type on the General tab. Type the number of seconds in the Time Delay field you want to postpone evaluating the alarm. For example, you may decide that the point value can exceed or fall below its alarm boundaries for 30 seconds before the alarm goes off. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility by filtering out some nuisance alarms.
- 330. TAC318 Bitmask This field represents a bitmask that is used to indicate which bits in the referenced property are to be monitored by the algorithm. A value of 1 in a bit position indicates that the bit in this position in the referenced property is to be monitored by the algorithm. A value of 0 in a bit position indicates that the bit in this position in the referenced property is not significant for the purpose of detecting this change of bitstring. Bitstring Values This is list of bitstrings that apply to this event algorithm. This list of bitstrings defines the set of states for which the referenced property is OffNormal. Only the bits indicated by the Bitmask are significant. If the value of the referenced property changes to one of the values in this bitstring list, then the referenced property of this EventEnrollment object makes a ToOffnormal transition, and appropriate notifications are sent. Algorithm Parameters for a Change of State Event This algorithm detects changes of state in a specific event object. When you select Change of State from the Event Type on the General tab, the Algorithms tab appears, as shown below:
- 331. Andover Continuum CyberStation Configurator’s Guide 319 A change of state occurs when: • The value of the referenced property becomes equal to one of the values contained in list of values in the Alarm On field. • That value remains equal for the duration of seconds displayed in the Time Delay field. This type of event may only be applied to a property that has discrete or enumerated values, including Boolean. The change of state generates a ToOffnormal transition, and an event notification is sent. A change of state clears (transitions ToNormal) when: • The value of the referenced property is no longer equal to one of the values in the list • That value remains not equal for the duration of seconds in the Time Delay field. Time Delay Time Delay appears on the Algorithms tab for each of the choices of Event Type on the General tab. Type the number of seconds in the Time Delay field you want to postpone evaluating the alarm. For example, you may decide that the point value can exceed or fall below its alarm boundaries for 30 seconds before the alarm goes off. If at the end of the 30 seconds, the object is in alarm, the alarm goes off regardless of its state during the 30-second delay. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility by filtering out some nuisance alarms. Alarm On This is a list of values that apply to the referenced property. The types of values here may only be discrete or enumerated values, including Boolean.
- 332. TAC320 Algorithm Parameters for a Change of Value Event When you select Change of Value from the Event Type scroll box on the General tab page the Algorithms tab page will appear as shown below. A change of value always generates a ToNormal transition and occurs when: • The absolute value of the referenced property changes by an amount equal to or greater than the value displayed in the Reference Property Increment field. • That amount remains equal to or greater than this value for the duration of seconds displayed in the Time Delay field. If the referenced property is a bitstring data type, then the change of value occurs when: • Any of the bits defined in the Bitmask field changes state. • The bits remain changed for the duration of seconds in the Time Delay field. Time Delay Time Delay appears on the Algorithms tab for each of the choices of Event Type on the General tab. Type the number of seconds in the Time Delay field you want to postpone evaluating the alarm. For example, you may decide that the point value can exceed or fall below its alarm boundaries for 30 seconds before the alarm goes off. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility by filtering out some nuisance alarms. Bitstring Check this checkbox if the referenced property is a bitstring. When you check this checkbox, the Bitmask field becomes selectable, and the Reference Property Increment field becomes non-selectable. Reference This is the increment by which the referenced property must change in
- 333. Andover Continuum CyberStation Configurator’s Guide 321 Property Increment order for the event to occur. Bitmask This field represents a bitmask that is used to indicate which bits in the referenced property are to be monitored by the algorithm. A value of 1 in a bit position indicates that the bit in this position in the referenced property is to be monitored by the algorithm. A value of 0 in a bit position indicates that the bit in this position in the referenced property is not significant for the purpose of detecting this change of bitstring. Algorithm Parameters for a Command Failure Event When you select Command Failure from the Event Type on the General tab, the Algorithms tab appears, as shown below. A command failure occurs when the value of the referenced property differs from the value of the attribute specified in the Feedback Reference section, for the duration of seconds displayed in the Time Delay field. This algorithm may be used, for example, to verify that a process change has occurred after writing to a property. This type of event shall only be applied to a property that has a discrete value. The command failure generates a ToOffnormal transition, and an event notification is sent.
- 334. TAC322 A command failure clears (transitions ToNormal) when the value of the referenced property becomes equal to the value of the attribute specified in the Feedback Reference section, for the duration of seconds in the Time Delay field. Time Delay Time Delay appears on the Algorithms tab for each of the choices of Event Type on the General tab. Type the number of seconds in the Time Delay field you want to postpone evaluating the alarm. For example, you may decide that the point value can exceed or fall below its alarm boundaries for 30 seconds before the alarm goes off. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility by filtering out some nuisance alarms. Feedback Reference This is used to select an attribute of an object with which the attribute of this EventEnrollment will be associated. Object Displays the name of the object, whose value is being compared to the value of the attribute that is selected in the Attribute field. Attribute From the dropdown menu, select a Feedback Reference attribute, whose value is to be compared with the value of the referenced property of the attached object. Algorithm Parameters for a Floating Limit Event The Floating Limit Algorithm tests to see if the alarmed attribute deviates from a range of values. A setpoint reference, high and low differential limits, and a dead band determine this range of values. This is known as a floating limit because the range of values is determined by the current value of the setpoint. How Do Floating Limit Algorithms Work? A Floating Limit algorithm causes the associated point to report changes in the alarmed attributes value using the examples discussed below. Example of High Diff Limit Floating Limit Equation Alarm states are reported when: attribute value > set point reference value + High Diff Limit for Time Delay seconds
- 335. Andover Continuum CyberStation Configurator’s Guide 323 Assumptions • Selected Alarmed Attribute = Value • Point associated with this EventEnrollment object = AnalogInput named RoomTemp1 • Current set point = 70 • High Diff Limit = 4 • Low Diff Limit = 25 Discussion For example, suppose the value for RoomTemp1 changes from 72 to 75. This change would result in an alarm state, because the following floating limit equation results in TRUE: attribute value > set point reference value + High Diff Limit OR 75 > 70 + 4 Diagram This diagram shows how a Floating Limit algorithm detects an alarm state. Example of Low Diff Limit Floating Limit Equation Alarm states are reported when: attribute value < set point reference value - Low Diff Limit for Time Delay seconds
- 336. TAC324 Assumptions • Selected Alarmed Attribute = Value • Point associated with this EventEnrollment object = AnalogInput named RoomTemp1 • Current set point = 70 • High Diff Limit = 4 • Low Diff Limit = 25 Discussion Now suppose the value for RoomTemp1 changes to 44. This change would also result in an alarm state because the following floating limit equation also results in TRUE: attribute value < set point reference value - Low Diff Limit OR 44 < 70 - 25 Diagram Same as above. Example of Floating Limit Using the Deadband Equation Alarm states are reported when: attribute value > (set point reference value - Low Diff Limit) + dead band value for Time Delay seconds Assumptions • Selected Alarmed Attribute = Value • Point associated with this EventEnrollment object = AnalogInput named RoomTemp1 • Current set point = 70 • High Diff Limit = 4 • Low Diff Limit = 20 • Deadband = 1 Discussion For example, suppose the value for RoomTemp1 changes from 75 to 72. This change would result in a normal state, because the following floating limit equations result in TRUE: attribute value < (set point reference value + High Diff Limit) - dead band value OR 72 < 70 + 4 – 1 and attribute value > set point reference value - Low Diff Limit + dead band value OR
- 337. Andover Continuum CyberStation Configurator’s Guide 325 72 > 70 - 20 + 1 Diagram When you select Floating Limit from the Event Type on the General tab, the Algorithms tab appears, as shown below. Time Delay Time Delay appears on the Algorithms tab for each of the choices of Event Type on the General tab. Type the number of seconds in the Time Delay field you want to postpone evaluating the alarm. For example, you may decide that the point value can exceed or fall below its alarm boundaries for 30 seconds before the alarm goes off. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility by filtering out some nuisance alarms.
- 338. TAC326 High Diff Limit This field establishes the value amount that is allowed above the high limit of the acceptable range of values (deadband). This "diff" amount is added to the value of the Setpoint Reference attribute. The reference property value is then compared with the attribute value to determine if a floating high-limit event has occurred. Low Diff Limit This field establishes the value amount that is allowed below the low limit of the acceptable range of values (deadband). This "diff" amount is subtracted from the value of the Setpoint Reference attribute. The reference property value is then compared with the attribute value to determine if a floating low-limit event has occurred. Deadband The value in the Deadband field establishes a range, known as deadband, within the high and low limits. This range defines a subset of acceptable, normal values. The deadband value that you supply is subtracted from the high limit and added to the low limit. The resulting values form the high and low ends of the range of normal values. Enter a value in the Deadband field. Object Search for and select a Setpoint Reference object, whose attribute value you want to compare with the value of the referenced property. Attribute Select an attribute of the selected Setpoint Reference object. This value is compared with the value of the referenced property. Value is the default. To use a Floating Limit algorithm: 1. Type in the High Diff and Low Diff differential limits. 2. Type in a Deadband value (optional). 3. Next, select a Setpoint Reference. 4. Click the button in the Object field. The Browse dialog appears. 5. In the Browse dialog, click the object you want to highlight it. 6. Click the Select button in the Browse dialog, and the correct path and object name will be inserted into the Object field. 7. Finally, select an attribute from the Attribute dropdown menu. Buffer Ready The Buffer Ready type is used only when you have attached a TrendLog object in the Object field of the General tab. In this case, this EventEnrollment algorithm accommodates workstation recipients who need to be notified when new records are added to a TrendLog object, so that the records can get downloaded to each workstation's database. (Please also see a related procedure, in Chapter 17, Configuring TrendLogs, for configuring algorithmic notifications for a TrendLog.)
- 339. Andover Continuum CyberStation Configurator’s Guide 327 The Current State Tab The Current State tab is a read-only page that indicates the present (current) state of the EventEnrollment object. Event State Indicates the current state of the event. Last Time Stamp Indicates the times of the last event notifications for the three listed conditions. To OffNormal Indicates the last time that the event transitioned to the OffNormal state. To Normal Indicates the last time that the event transitioned to the Normal state. To Fault Indicates the last time that the event transitioned to the Fault state. The Security Level Tab See Chapter 4 for details regarding the attachment of security levels to a BACnet device. The Next Step Once you are finished configuring alarms for your BACnet devices, you will need to consider the assignment of BACnet command priorities to certain object properties and the creation of objects with BACnet object editors. Using Templates for EventEnrollment and EventNotification Objects It is recommended that you use CyberStation templates to create EventEnrollment and EventNotification objects that share similar information. At large sites, configuration of EventEnrollments and EventNotifications can be a very big job. Templates save a lot of time and effort. Please see Chapter 12, as well as help topics for templates in the CyberStation online help system.
- 340. TAC328 Command Prioritization In a building control system, an object may be manipulated by any number of different applications. Each such application program has a well-defined function it needs to perform. When the actions of two or more application programs conflict with regard to the value of an object’s property, a decision process must be implemented to determine which application has priority. Commandable Properties In a BACnet system, a prioritization scheme is used to assign varying levels of priorities to object properties (referred to as “commandable properties”). At present, the objects that have commandable properties are: Object Commandable Property Analog Output Present_Value Binary Output Present_Value Multi-state Output Present_Value Analog Value Present_Value Binary Value Present_Value Multi-State Value Present_Value Each of these objects is responsible for acting upon its commandable property in accordance with a command priority list. Application Priority Assignments Command priorities are assigned priority levels from 1 (highest) to 16 (lowest). The standard command priority array list from the ANSI/ASHRAE Standard 135-2004 is shown below. Priority Level Application Priority Level Application 1 Manual-Life Safety 9 Available 2 Automatic-Life Safety 10 Available 3 Available 11 Available 4 Available 12 Available 5 Critical Equipment Control 13 Available 6 Minimum On/Off 14 Available 7 Available 15 Available 8 Manual Operator 16 Available
- 341. Andover Continuum CyberStation Configurator’s Guide 329 For interoperability between BACnet systems, it is necessary that all BACnet devices implement the same priority scheme. In CyberStation, this requirement is implemented by incorporating the 16 priorities in the BACnet Preferences dialog. The standard command priority list is reflected in a dropdown menu on the Value column of the CyberStation BACnet Preferences dialog: The seven applications that require BACnet command priority level assignments are: • CyberStation programs • Command Line • Editor • ListView • web.Client • Other • Pinpoint To assign BACnet command priorities to these applications: 1. Right click the Continuum icon in the window task bar (tool tray). 2. Select BACnet Preferences from the popup menu. 3. Scroll down to setting 4 – BACnet Command Priority for CyberStation Programs. 4. Click the entry in the Value column to open the priority list scroll box. 5. Scroll to the desired priority and click it. 6. For settings 5 through 10, repeat steps 4 and 5 for the remaining BACnet command priorities. CAUTION The assignment of BACnet command priorities described in the following steps should only be accomplished by the system administrator.
- 342. TAC330 BACnet Defined Objects In Infinity, there are two types of points: Hardware-Defined InfinityInput Connections to an Infinity input device InfinityOutput Connections to an Infinity output device Software-Defined InfinityDateTime Storage location where the current system time and date are available InfinityNumeric Storage location where numeric (number) information is stored InfinityString Storage location where ASCII text characters are stored Note: Refer to Chapter 13 for a discussion of each of the above points. BACnet devices support ASHRAE Standard 135-2004, which means that they support these corresponding object classes: BACnet Defined AnalogInput BinaryInput MultistateInput AnalogOutput BinaryOutput MultistateOutput AnalogValue BinaryValue MultistateValue Mapping Infinity Points to BACnet Objects In order to provide compatibility with Andover Continuum b4920, bCX1 (40x0 series), and b3 controllers, mapping between Infinity points and BACnet objects is necessary, as shown in the following table: Infinity Point Values Maps to BACnet Voltage, Current, Temperature AnalogInput Digital BinaryInput InfinityInput Counter, supervised MultistateInput Voltage, Current AnalogOutput Digital BinaryOutput InfinityOutput Tristate MultistateOutput AnalogValue BinaryValue InfinityNumeric MultistateValue InfinityString Plain text messages No equivalent InfinityDateTime Date and time data No equivalent
- 343. Andover Continuum CyberStation Configurator’s Guide 331 To become accustomed to this concept, start by viewing objects on the Continuum Explorer. Some examples are given on the following pages. There are two views shown of each example. The first shows the Infinity view, and the second shows the BACnet view. InfinityInput to AnalogInput The point-mapping table on the previous page shows that an InfinityInput point maps to a BACnet AnalogInput object. An example of this relationship is show below: InfinityInput AnalogInput One of the Infinity points, PhotoCell, did not map because it did not fit the BACnet profile for an AnalogInput. InfinityOutput to BinaryOutput The point-mapping table shows that an InfinityOutput point maps to a BACnet BinaryOutput object. An example of this relationship is show below:
- 344. TAC332 InfinityOutput BinaryOutput In the above example, only the FanStart InfinityOutput point mapped to a BinaryOutput object. Neither the ValueControl point (an analog type) nor the TriStateValue point (a multistate type) fit the BACnet profile for a BinaryOutput. InfinityNumeric to AnalogValue The point-mapping table shows that an InfinityNumeric point maps to a BACnet AnalogValue object. An example of this relationship is shown below:
- 345. Andover Continuum CyberStation Configurator’s Guide 333 InfinityNumeric AnalogValue In this example, all four InfinityNumeric points fit the BACnet profile AnalogValue objects. Infinity and BACnet Object Editors In Infinity, there are Infinity point editors: InfinityInput, InfinityOutput, InfinityNumeric, InfinityString and InfinityDateTime. (See Chapter 13.) In CyberStation, Andover Continuum introduces BACnet object editors — one for each of the BACnet objects listed in the mapping table earlier in this chapter. There is no BACnet equivalent for InfinityString and InfinityDateTime points. BACnet object editors are described on the following pages. Using BACnet Object Editors In an Andover Continuum system containing Andover Continuum BACnet-compliant b4920, bCX1 (40x0 series), and b3 controllers, you typically configure controllers and their attached points using the Infinity view, with Infinity point editors. BACnet object editors are used primarily to view and modify objects created on third-party BACnet devices that have been integrated into the system. They also allow all users to view
- 346. TAC334 Andover Continuum BACnet objects, on b3, bCX1 (40x0 series), and b4920 devices, as third-party devices would see them. However, if your system has no third-party devices, but does have b4920, bCX1 (40x0 series), and b3 controllers, there would normally be no reason to view them as BACnet objects in the BACnet Devices portion of the Continuum Explorer navigation pane. Although the combined Infinity/BACnet view is enabled by default, you would normally configure, view, and work with Andover Continuum BACnet-compliant controllers and their objects using the Infinity Controller Only view option via the Explorer’s View dropdown menu, described earlier in this chapter. That is, you would view and work with InfinityController and InfinityInfinetCtlr objects, instead of b4920, bCX1 (40x0 series), and b3 BACnet Device objects. You would view and work with InfinityInputs, InfinityOutputs, and InfinityNumeric points, instead of AnalogInput/Output/Value objects, Binary Inputs/Outputs/Value objects, and MultistateInputs/Outputs/Value objects. Note: Although you would view and work with them on the Andover Continuum side, you still must find and save them into the BACnet side for proper configuration and operation. See the section, Post-Installation System Integration, earlier in this chapter. If you are viewing third-party BACnet devices, you may also find out which objects and services are supported for the device, using the Details tab of the Device editor, described earlier in this chapter. New BACnet objects on a b4920, bCX1 (40x0 series), or b3 controller are created from Infinity point editors — that is, entirely from the Infinity view. Before creating BACnet objects as InfinityInputs, InfinityOutputs, and InfinityNumerics, you will have: • Installed and commissioned a new Andover Continuum b4920 or bCX1 (40x0 series) controller in the system. (See Appendix A for information on commissioning a new controller.) • Created and fully configured one or more InfinityController objects. (See Creating an InfinityController Object in Chapter 7.) • Created one or more InfinityInfinetContrller (b3) objects. • Within the Explorer, selected Find New BACnet Devices to locate the new controllers. (This is described earlier in this chapter.) • Within the Explorer, performed a Send To Database operation. (This is described earlier in this chapter.) To configure Infinity points attached to the new b4920, bCX1 (40x0 series), and b3 controllers, you do so in the Infinity view on the Explorer. For example, you create an InfinityInput point from the InfinityInput editor, then select an electrical type that makes it analog, binary, or multistate. (Refer to Chapter 13.) Note: BACnet objects in third-party BACnet devices become visible and incorporated within the system when the Find New BACnet Devices and Send To Database operations are performed. They do not require the use of an InfinityInput, InfinityOutput or InfinityNumeric editor, and are always listed as BACnet objects, with their BACnet devices, in the BACnet Devices portion of the Explorer viewing pane.
- 347. Andover Continuum CyberStation Configurator’s Guide 335 For example, assume that you have created an InfinityInput point called Fan1Status, and that it was assigned to a sensor that would supply electrical-current input signals to the controller. It would therefore have been assigned Voltage in the Elec Type field of the InfinityInput editor’s Settings tab. (See InfinityInput Settings Tab in Chapter 13.) In the BACnet view, if you were to decide to use it, this InfinityInput point would map, as an AnalogInput, to the corresponding BACnet Device object that corresponds to the b4920, bCX1 (40x0 series), or b3 controller. If you decide to use the BACnet view, once you have configured and saved the object, you may view it from its BACnet device, as follows: 1. Click the + next to the BACnet devices icon in the Explorer’s navigation pane. 2. Click the + sign next to the Andover Continuum BACnet controller device icon to expand it. 3. An AnalogInput BACnet folder should appear beneath the device icon. Click the folder to open it: 4. The Fan1Status InfinityInput object that you created should appear in the Explorer’s viewing pane, as an AnalogInput: 5. Double click this icon to open the BACnet AnalogInput editor. From this BACnet editor, you may modify this object. BACnet AnalogInput Editor You use the BACnet AnalogInput editor to refine the object (created as an InfinityInput on a b4920, bCX1 (40x0 series), or b3 controller or as an AnalogInput on a third-party BACnet device). It represents analog values such as voltage, current, temperature, and so on. This editor has five tabs that let you type in or select information, or in some cases supply you with data. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third-party BACnet devices, not for objects attached to Andover Continuum b4920, bCX1 (40x0 series), and b3 controller devices. AnalogInput General Tab The General tab has several properties for which you provide values, and a few properties that will be set by the control system.
- 348. TAC336 Value View or enter a value into this field. Units Select a unit of measure from the dropdown menu. Update Interval Enter an integer to specify the maximum time (in hundredths of a second) between updates to the value, when the input is not overridden and not out-of-service. Description Enter up to 32 characters (including spaces) in this field. Device Type Indicates the type of device that is connected to this AnalogInput. Out of Service Check this checkbox to put this object out of service so that it loses communication with its attached device. Putting the object out of service is a good way to test the object and the functions that rely on it. You can simulate various situations by manually changing the value or reliability attributes. This allows you to see how associated functions react to these changes. Format Enter a numeric display format. For example: ###.### Status Provides information on the object's condition. The condition can be one of the following: InAlarm ⎯ indicates that the Event State has a value other than normal. Overridden ⎯ indicates that a local device has manually overridden the point.
- 349. Andover Continuum CyberStation Configurator’s Guide 337 OutOfService ⎯ indicates that the object is disabled. Fault ⎯ indicates that the Reliability property has a value other than NoFaultDetected. Reliability Provides an indication of whether or not the controller has detected a malfunction that might compromise the integrity of the object's present value. The attribute can be one of the following: NoFaultDetected ⎯ indicates that the present value is reliable and that no fault is detected. OverRange ― indicates that the sensor is reading a value that is higher than the normal operating range. OpenLoop ⎯ indicates that the connection between the object and the device is providing a value resulting from an open circuit. UnreliableOther ⎯ Indicates that the controller detects an unreliable present value and that none of the above conditions describe the nature of the problem. NoSensor ⎯ indicates that no sensor is connected to the AnalogOutput point. UnderRange ⎯ indicates that the sensor is reading a value that is lower than the normal operating range. ShortedLoop ⎯ indicates that the connection between the object and the device is providing a value resulting from a closed circuit. AnalogInput Basic Alarms Tab The Basic Alarms tab is where intrinsic alarms are defined specifically for this object. Note: This is enabled for BACnet objects attached to third-party BACnet devices. It is not supported on Andover Continuum b4920, bCX1 (40x0 series), and b3 controllers. An example of a Basic Alarms tab, populated with information for a third-party device, is shown below. The information here determines when the alarm will go off, and what happens when it does. Information that determines what happens when the alarm goes off is built into the EventNotification object that you associate with this alarm. (Refer to EventNotification in Chapter 10.) The EventNotification object defines how and to whom the alarm is sent.
- 350. TAC338 Event State Displays the value of the To State attribute which is set by the control system. If you have set up this object to report alarms, this attribute displays Normal when the object is not in an alarm state and OffNormal when it is. If you have not set up the object to report alarms, this attribute always displays NORMAL. Acknowledge Received For Displays the value of the Acknowledge Received For property. Displays ALARM, FAULT, or NORMAL if acknowledgements have been received for reported alarms, faults, or return-to-normal events, respectively. These values display only if both of the following conditions are true: You have selected the report options for these events. The associated EventNotification object requires acknowledgement for these events. COV Increment Enter the number of units — for example, degrees — that must increase or decrease before a COV is triggered, and COV notification is sent to a client . An increment of 0 appears by default. CAUTION: Set this increment high enough so that the subscriber is not inundated with too many COV notifications. Even the tiniest value changes can trigger too many COVs. Do not accept the default, 0. Leaving it at 0 will produce negative results. High Limit Enter a high limit for the object. Check the Enable checkbox to the right to enable the high limit. The high and low limits establish boundaries for the object value. When the object value exceeds the high limit, or falls below the low limit, the alarm goes off.
- 351. Andover Continuum CyberStation Configurator’s Guide 339 Low Limit Enter a low limit for the object. Check the Enable checkbox to the right to enable the low limit. Time Delay Enter a time delay in seconds. The time delay postpones the alarm for the amount of time you specify. For example, you may decide that the object value can exceed or fall below its boundaries for 30 seconds before the alarm goes off. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility. Dead Band Enter a dead band value. The dead band value establishes a range, known as a dead band, within the high and low limits. This range is used to define a subset of acceptable, or normal, values. The dead band value that you supply is subtracted from the high limit, and added to the low limit. The resulting values form the high and low ends of the range of normal values. Report In the Report section, you may select up to three report options: Alarm, Return to Normal, and Fault. When selected, these options trigger the basic alarm in the following situations: The Alarm option triggers the basic alarm when the object's Event State changes to OffNormal. The Return To Normal option triggers the basic alarm when the object's Event State changes to Normal. The Fault option triggers the basic alarm when a local device detects a fault. Notification Type From the dropdown menu, select a notification type. The notification type specifies whether the notification message becomes an alarm message, an event message, or a message of event acknowledgement. AlmNotification – Defines the event as type alarm, appearing in the Active Alarm View when the event occurs. EvtNotification – Defines the event as type event, appearing in Active Alarm View when the event occurs. Acks – Defines the event as type ack-notification, appearing in the Active Alarm View when the event occurs. Event Notification Select an EventNotification object by clicking the browse button. The Browse dialog appears. Locate the Event Notification object that you want. Select it and click the Select button. This will insert the correct path and EventNotification name into the Notification class field.
- 352. TAC340 AnalogInput Advanced Alarms Tab The Advanced Alarms tab allows you to attach up to eight alarms to an object. (See Attaching Alarms to a Point in Chapter 10.) Note: This tab is only enabled for CyberStation/Infinity objects. It is disabled for all BACnet objects. You may also use this page to attach a graphic panel and a report or other program to the object, via the Graphic and Program fields, respectively. When an AnalogInput object generates an alarm, either via an associated EventEnrollment, Basic Alarm or Advanced Alarm, the associated graphic can be programmed to automatically launch. (See Graphic below.) The graphic can also be manually launched via the Alarm View Graphic button. (See View Menu in Chapter 10.) Similarly, a program can be configured to run automatically when this object goes into alarm and can also be run manually via the corresponding Alarm View Program Output button. (See Program below and View Menu in Chapter 10.) Graphic Browse for the graphic panel program file that you want to display when the object goes into an alarm state. Program Browse for the program that you want to run when the object goes into an alarm state.
- 353. Andover Continuum CyberStation Configurator’s Guide 341 Alarm Points Alarm points allow any expression alarm that you attach on this tab to reference up to four "alarm points," named Point 1, Point 2, Point 3, and Point 4. Using alarm points saves you the trouble of having to change the expression (via the Algorithms tab of the AlarmEnrollment editor for that alarm object) every time you attach an expression alarm to a different point. For complete information, please see the section, Using the Alarms/Advanced Alarms Tab of an Object Editor, in Chapter 10. Video Video Points Video points allow you to assign cameras to doors and points and configure parameters that control video images, via VideoLayout objects, during alarm conditions. When the alarm goes off, a video layout is launched (if a VideoLayout object has been configured to work with video points) and displays the "video point" camera images in the its video image frames. In the Video Points dialog, you may also configure a camera to record a video clip, for specified number of seconds, when the alarm goes off. For complete information on this field, and how to use Video Points, please see the section, Using the Alarms/Advanced Alarms Tab of an Object Editor, in Chapter 10. See also Chapter 25, Configuring and Viewing Video. AnalogInput Triggers Tab The Triggers tab is not applicable to BACnet devices. Triggers are not supported for objects associated with Andover Continuum b3, b4920, and bCX1 (40x0 series) controllers or third party BACnet devices. It is applicable to CyberStation/Infinity objects only. (Refer to InfinityInput Triggers Tab in Chapter 13.) AnalogInput Security Level Tab The access permissions configured in a security level allow you to customize (deny) access to individual CyberStation objects. Security levels are actual CyberStation objects (Security Level objects) configured via the Security Level editor. (See Chapter 4.) A security level can deny access to a CyberStation object editor on a page-by-page basis using object-level security. Object-level security is a way to deny user groups the ability to create, delete, or change individual CyberStation objects. Every object editor in CyberStation has a Security Level tab, shown on the next page, that displays a list of all existing security level objects. Selecting a security level object here attaches that security level to the object being edited.
- 354. TAC342 To attach a security level to this point, locate the security level in the Name column and click the radio button next to it. To detach a security level from this point, locate the security level in the Name column and double-click the radio button to remove the black dot it contains. Or you can right click the security level in the Name column to bring up a popup menu. Click Clear Selection in the popup menu. BACnet AnalogOutput Editor An AnalogOutput is a BACnet object that is created with the InfinityOutput editor. (See Chapter 13) They can also be learned in from a third-party device, or created via the AnalogOutput editor. AnalogOutputs are associated with BACnet devices. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third- party BACnet devices, not for objects attached to Andover Continuum b4920, bCX1 (40x0 series), and b3 controller devices. When you create an InfinityOutput object for an Infinity b4920 or bCX1 (40x0 series) controller, or an Infinity Infinet b3 series controller, and select an analog electrical type via the Settings tab of the InfinityOutput editor, a BACnet AnalogOutput is created. (Refer to Chapter 13.) AnalogOutput General Tab The General tab has several attributes that you can provide values for, and a few attributes that are set by the control system. Many fields on this tab are also view-only.
- 355. Andover Continuum CyberStation Configurator’s Guide 343 Present Value This field displays this object's present value that the current priority (the priority level that appears in the Present Priority field) is currently commanding to this object. This field is non-editable. Present Priority This field displays the current priority level that is currently commanding the present value of this object. This field is non-editable. Command Value This field is used for setting the value of the analog output at the default command priority displayed in the Command Priority field. By default, the command priority is set to the command value established in the BACnet Preferences dialog. The default is Manual Operator. If you have access permission, you may change the value in this field for this command priority level. Command Priority This field displays the default command priority value that is used when setting and relinquishing the value. By default, this field is set to the command value established in the BACnet Preferences dialog. This field is non-editable. Set Click this button to assign the new value (the value that you just changed in the Command Value field) to this object.
- 356. TAC344 Relinquish Click this button to relinquish the non-NULL value of the priority level that appears in the Command Priority field. Note: Relinquishing the value means changing it to NULL, so that the next higher-numbered priority level that holds a non-NULL value begins to command its value to the object. From the Command Priority tab, your administrator may relinquish values at all command priorities. Units Select a unit of measure from the dropdown menu. Description Enter up to 32 characters (including spaces) in this field to describe the object. Device Type Enter the type of device that is connected to this analog output object. Update Interval Enter an integer to specify the maximum time (in hundredths of a second) between updates to the value, when the input is not overridden and not out-of-service. Out of Service Check this checkbox to put the object out of service, so that it loses communication with its attached device. Putting the object out of service is a good way to test the object and the functions that rely on it. You can simulate various situations by manually changing the value or reliability attributes. This allows you to see how associated functions react to these changes. Format Enter a numeric display format. For example: ###.### Status Provides information on the object's condition. The condition can be one of the following: InAlarm ⎯ indicates that the Event State property has a value other than NORMAL. Overridden ⎯ indicates that a local device has manually overridden the object. Fault ⎯ indicates that the Reliability property has a value other than NoFaultDetected Out of Service ⎯ indicates that the object is disabled.
- 357. Andover Continuum CyberStation Configurator’s Guide 345 Reliability Provides an indication of whether or not the controller has detected a malfunction that might compromise the integrity of the object's present value. The attribute can read one of the following: NoFaultDetected ⎯ indicates that the present value is reliable and that no fault is detected. OpenLoop ⎯ indicates that the connection between the object and the device is providing a value resulting from an open circuit. Unreliable Other ⎯ indicates that the controller detects an unreliable present value and that none of the above conditions describe the nature of the problem. NoOutput ⎯ indicates that no sensor is connected to the AnalogOutput object. ShortedLoop ⎯ indicates that the connection between the object and the device is providing a value resulting from a closed circuit AnalogOutput Command Priority Tab In this tab page you may view members of the BACnet priority array (a list of priority levels) and their values for this BACnet object. You may also select a priority level for this BACnet object and change the level's value (thereby overriding its current commanded value) as well as relinquish a priority level — set it to NULL — so that: • It no longer commands a value to this BACnet object at the select priority level. • The next highest priority level may command a non-NULL value. When first configuring your system, also remember to set the value in the Relinquish Default field, located at the bottom of this tab. This default value is commanded to the object when all priority level values are relinquished (in other words, when they become all NULL). This protects against users who inappropriately click the Relinquish button on the General tab and/or on this tab. See the subsection, Application Priority Assignments, earlier in this chapter, for command priority levels. CAUTION Only system administrators should be granted security access permission to use this tab page.
- 358. TAC346 Present Value This field displays the object’s present value that the current priority (the priority level that appears in the Present Priority field) is currently commanding to this object. This field is non-editable. Present Priority This field displays the current priority level that is currently commanding the present value to this object. This field is non-editable. Command Value This field is used for setting the value of the analog output at the default command priority displayed in the Command Priority field. By default, this field is set to the command value established in the BACnet Preferences dialog. The default is Manual Operator. If you have access permission, you may change the value in this field for this command priority level. Command Priority This field displays the default command priority level value. By default, this field is set to the command value established in the BACnet Preferences dialog. From this field's dropdown menu, you may change this level's value, which appears in the Command Value field. Also, from the Command Priority dropdown menu, you may select any other priority level, and also change its value. Set Click this button to assign the new value (the value that you just changed) to this object at the corresponding command priority.
- 359. Andover Continuum CyberStation Configurator’s Guide 347 Relinquish Click this button to relinquish the non-NULL value of the priority level that appears in the Command Priority field. Note: Relinquishing the value means changing it to NULL, so that the next higher-numbered priority level that holds a non-NULL value begins to command its value to the object. To relinquish any level's value, first use the Command Priority dropdown menu to select the priority level whose value you want to relinquish, then click Relinquish. Priority Array Window This window contains the BACnet priority array — a list of the names of all 16 BACnet protocol command priority levels, along with the value that each level in the array is currently commanding. Relinquish Default Enter a value to command to this object when all command priority levels have been relinquished (when all values become NULL). This ensures the object has a value at all times. Set this field when you first configure the system. Basic Alarms, Advanced Alarms, Triggers, and Security Level Tabs These tabs are covered under the AnalogInput editor. BACnet AnalogValue Editor An AnalogValue is a BACnet object that is created via the InfinityNumeric editor. (Refer to Chapter 13.) They can also be learned in from a third-party device, or created via the AnalogValue editor. AnalogValues are associated with BACnet devices. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third- party BACnet devices, not for objects attached to Andover Continuum b4920, bCX1 (40x0 series), and b3 controller devices. When you create an InfinityNumeric point for an Infinity b4920 or bCX1 (40x0 series) controller, or an Infinity b3 series controller, and select AnalogValue in the BACnet Object Type field of the InfinityNumeric editor’s General tab, a BACnet AnalogValue is created. (Refer to Chapter 13.) AnalogValue points are temporary storage locations in the controller’s memory that store floating-point numbers. AnalogValue General Tab With the exception of Units (discussed below) the remainder of items on this tab is covered under AnalogOutput General Tab.
- 360. TAC348 Units Select a unit from the dropdown menu. When displayed next to the value, as in 72 Degrees F, or 17 Employees, units help users understand what the point is doing. Format Enter a numeric display format. The default is: ###.### Basic Alarms, Advanced Alarms, Triggers and Security Level Tabs These tabs are covered under the AnalogInput editor. BACnet BinaryInput Editor A BinaryInput is a BACnet object that is created via the InfinityInput editor, or on third- party devices. They can be learned from a third-party device, or created via the BinaryInput editor. BinaryInputs are associated with BACnet devices. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third- party BACnet devices, not for objects attached to Andover Continuum b4920, bCX1 (40x0 series), and b3 controller devices. When you create an Infinity Input point for an Infinity b4920 or bCX1 (40x0 series) controller, or an Infinity b3 series controller, and select a digital/binary electrical type on the Settings tab of the InfinityInput editor, a BACnet BinaryInput point is created. Typically, these inputs are used to detect whether a particular piece of equipment, like a fan or a pump is running or idle. The ON state usually indicates the equipment is running, whereas the OFF state usually indicates the equipment is idle.
- 361. Andover Continuum CyberStation Configurator’s Guide 349 BinaryInput General Tab Value Select ON or OFF from the dropdown menu. Description Enter up to 32 characters (including spaces) in this field. Device Type Enter the type of device that is connected to this input. Out of Service See Out of Service covered under AnalogOutput General Tab. Status See Status covered under AnalogOutput General Tab. Reliability See Reliability covered under AnalogOutput General Tab.
- 362. TAC350 BinaryInput Settings Tab Inactive Text Enter text for an inactive state. This text is displayed as the value when the binary input is in the inactive state. Active Text Enter text for an active state. This text is displayed as the value when the binary input is in the active state. Polarity Select either Normal or Reverse from the Polarity dropdown menu. BinaryInput Counters Tab In the Counters tab, you find the amount of time the point has been in an active state, and the date and time the state changed last. You can also find out when this information was last reset. This tab is divided into two sections: • Active Time • Change of State
- 363. Andover Continuum CyberStation Configurator’s Guide 351 Active Time Elapsed Time ― Shows the number of seconds since the point's status changed from Inactive to Active. Last Reset ― Shows the date and time the elapsed time was last reset. Reset Elapsed Active Time on Next Save― For the controller reset the Elapsed Active Time the next time data are saved, check this checkbox. Change of State Value Changed at ― Shows the date and time the state last changed. Change-of-State Count ― Shows you how much time the state has changed. Last Reset ― Shows the time when this count was last reset to zero. Reset Change-of-State Count on Next Save ― For the controller reset the Change of State Count the next time data are saved, check this checkbox.
- 364. TAC352 BinaryInput Basic Alarms Tab The Basic Alarms tab is where intrinsic alarms are defined specifically for this object. Note: This is enabled for BACnet objects attached to third-party BACnet devices. It is not supported on Andover Continuum b4920, bCX1 (40x0 series), and b3 controllers. The information here determines when the alarm will go off, and what happens when it does. Information that determines what happens when the alarm goes off is built into the EventNotification object that you associate with this alarm. (Refer to EventNotification in Chapter 10.) The EventNotification object defines how and to whom the alarm is broadcast. Keep in mind that basic alarms apply only to the object in which they were created. Another way to configure alarms in BACnet is to use the EventEnrollment class. Event State See Event State under AnalogInput Basic Alarms Tab. Acknowledgement Received For See Acknowledgement Received For under AnalogInput Basic Alarms Tab. Alarm Where Value Is Select Off or On from the dropdown menu. An alarm is triggered based on this value. Report See Report under AnalogInput Basic Alarms Tab. Time Delay Enter a time delay in seconds. The time delay postpones the alarm for the amount of time you specify. For example, you may decide that the point value can exceed or fall below its boundaries for 30 seconds before the alarm goes off. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility. Notification Type See Notification Type under AnalogInput Basic Alarms Tab. Event Notification See Event Notification under AnalogInput Basic Alarms Tab. BinaryInput Advanced Alarms, Triggers, and Security Level Tabs These tabs are covered under the AnalogInput editor.
- 365. Andover Continuum CyberStation Configurator’s Guide 353 BACnet BinaryOutput Editor A BinaryOutput is a BACnet object that is created with the InfinityOutput editor, or on third-party devices. They can be learned from a third-party device, or created via the BinaryOutput editor. BinaryOutputs are associated with BACnet devices. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third- party BACnet devices, not for objects attached to Andover Continuum b4920, bCX1 (40x0 series), and b3 controller devices. When you create an InfinityOutput for an Infinity b4920 or bCX1 (40x0 series) controller, or an Infinity b3 series controller, and select a digital/binary electrical type via the Settings tab of the InfinityOutput editor, a BACnet BinaryOutput is created. (Refer to Chapter 13.) Typically these outputs are used to switch a particular piece of equipment, like a fan or a pump, ON or OFF (the equivalent BACnet values are active and inactive). BinaryOutput General Tab The General tab has several properties that you can provide values for, and a few attributes that are set by the control system. The fields on this tab are view-only if the particular device does not support them.
- 366. TAC354 Refer to AnalogOutput General Tab for a description of all the items that appear on this tab. BinaryOutput Settings Tab The Settings tab has the following properties, described below. Inactive Text Enter text for an inactive state. This text will help future operators determine the meaning of values for this point. Active Text Enter text for an active state. This text will help future operators determine the meaning of values for this point. Minimum On Time Enter the minimum time in seconds that the point will remain active after it has been changed to active. Minimum Off Time Enter the minimum time in seconds that the point will remain inactive after it has been changed to inactive. Polarity Select either Normal or Reverse from the Polarity dropdown menu.
- 367. Andover Continuum CyberStation Configurator’s Guide 355 BinaryOutput Counters and Basic Alarms Tab Pages Refer to BinaryInput Counters Tab. Refer also to BinaryInput Basic Alarms Tab, except for the Feedback Value property (described below). Feedback Value Select the inactive entry or the active entry from the dropdown menu. The object must equal this value for an alarm to occur. (These selections represent text set in fields on the Settings tab.) BinaryOutput Command Priority Tab The items on this tab are covered under the AnalogOutput editor. BinaryOutput Advanced Alarms, Triggers, and Security Level Tabs The items on these tab pages are covered under the AnalogInput editor. BACnet BinaryValue Editor A BinaryValue is a BACnet point object that is created via the InfinityNumeric editor, or on third-party devices. They can be learned from a third-party device, or created via the BinaryValue editor. BinaryValues are associated with BACnet devices. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third- party BACnet devices, not for objects attached to Andover Continuum b4920, bCX1 (40x0 series), and b3 controller devices. When you create an InfinityNumeric for an Infinity b4920 or bCX1 (40x0 series) controller, or an Infinity b3 series controller, and select BinaryValue in the BACnet Object Type field of the InfinityNumeric editor's General tab, a BinaryValue is created if the Infinity or Infinet controller on which it resides was created as a BACnet device. (Refer to Chapter 13.) Typically, BinaryValues are used as control system parameters that have only one of two possible values that you define.
- 368. TAC356 BinaryValue General Tab This tab is covered under the BinaryOutput editor. BinaryValue Settings, Counters, and Basic Alarms Tabs These tabs are covered under the BinaryInput editor. BinaryValue Command Priority Tab This tab page is covered under the AnalogOutput editor. BinaryValue Advanced Alarms, Triggers and Security Level Tabs These tabs are covered under the AnalogInput editor. BACnet MultistateInput Editor A MultistateInput is a BACnet object that is created via the InfinityInput editor, or on third- party devices. (Refer also to Chapter 13.) They can be learned from a third-party device, or created via the MultistateInput editor. MultistateInputs are associated with BACnet devices. When you create an InfinityInput for an Infinity controller, and select a multistate (Supervised) electrical type, via the Settings tab of the InfinityInput editor, a BACnet MultistateInput is created if the controller on which it resides was created as a Andover Continuum BACnet-compliant device — specifically: • As a b4920 or bCX1 (40x0 series) controller • As a b36xx, b38xx, or b39xx controller
- 369. Andover Continuum CyberStation Configurator’s Guide 357 In these cases, a MultistateInput is created with three states: On, Off, and Trouble. See also the subsection, MultistateInput States Tab. Note: For third-party BACnet devices that become part of the Andover Continuum system, MultistateInput objects were already created as objects on those third- party BACnet controllers. Therefore, Continuum Explorer already lists these objects as MultistateInputs within third-party devices. Controllers have channels for sensors. A channel in this case is an area in the controller that can be physically connected to a sensor. A sensor is a device that measures and reports on specific environmental factors, such as temperature, humidity, water pressure, and air flow. MultistateInput values represent one of a specific set of possible states that you define. Each state that you define has its own numeric value. The state text is what users see as the object’s value. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third- party BACnet devices, not for objects attached to Andover Continuum b4920, bCX1 (40x0 series), and b3 controller devices.
- 370. TAC358 MultistateInput General Tab The items on this tab, shown below, are covered under the BinaryInput editor.
- 371. Andover Continuum CyberStation Configurator’s Guide 359 MultistateInput States Tab This tab lists the number of states this object has, as well as the text values of each state. Depending on the type of BACnet device on which the input was configured, and depending on how the MultistateInput itself was configured, the number and types of states may vary. If it was configured as an InfinityInput object for a Andover Continuum b4920 or b3 controller, with a Supervised multistate electrical type — ElecType on the Settings tab of the InfinityInput editor — then the MultistateInput has three states named Off, On, and Trouble, as shown below: However, if the MultistateInput was configured on a third-party BACnet device, it may have a different number of states, configured with text names from that device. For example, a third-party MultistateInput might have four states named Quiet, Active, Fault, and Disabled. Note: You may change the state of this MultistateInput via the Value field’s dropdown menu on the General tab. Each state listed in the State Text field has a its own text and numeric value beginning with 1: 1 <= value <= number of states
- 372. TAC360 Number of States This is an integer that defines the number of states for this object. The number must be greater than zero. State Text This is a BACnet array of character strings (text values) representing all possible states of the object. The number of text values matches the number of states defined in the Number of States field. MultistateInput Basic Alarms Tab With the exception of Alarm Values and Faults Values (described below) the remainder of the properties on this tab is covered under the AnalogInput editor. Alarm Values This list specifies the states that the MultistateInput must equal before a ToOffnormal event is generated. This is required if intrinsic reporting is supported by this object. Fault Values As an option, this list specifies the states that the MultistateInput must equal before a ToFault event is generated. If it becomes equal to any of the states in the list, and no physical fault has been detected, then Reliability (General tab) has the value, MultistateFault. This is required if intrinsic reporting is supported by this object. MultistateInput Advanced Alarms, Triggers, and Security Level Tabs The properties on these tabs are covered under the AnalogInput editor.
- 373. Andover Continuum CyberStation Configurator’s Guide 361 BACnet MultistateOutput Editor A MultistateOutput is a BACnet object that is created via the InfinityOutput editor, or on third-party devices. (Refer also to Chapter 13.) They can be learned from a third-party device, or created via the MultistateOutput editor. MultistateOutputs are associated with BACnet devices. When you create an InfinityOutput for an Infinity controller and select a multistate (Tristate) electrical type via the Settings tab of the InfinityOutput editor, a BACnet MultistateOutput is created if the controller on which it resides was created as an Andover Continuum BACnet device — specifically: • As a b4920 controller or bCX1 (40x0 series) controller • As a b36xx, b38xx, or b39xx controller In these cases, a MultistateOutput is created with three states: On, Off, and -On. See also the subsection, MultistateOutput States Tab. Note: For third-party BACnet devices that become part of the Andover Continuum system, MultistateOutput objects were already created as objects on those third- party BACnet controllers. Therefore, Continuum Explorer already lists these objects as MultistateOutputs within third-party devices. An output object changes or affects the environment by controlling a piece of equipment, such as a heater or fan. MultistateOutput values represent one of a specific set of possible states that you define. Each state that you define has its own numeric value. The state text is what users see as the object's value. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third- party BACnet devices, not for objects attached to Andover Continuum b4920 , bCX1 (40x0 series), and b3 controller devices.
- 374. TAC362 MultistateOutput General Tab Refer to BinaryOutput General Tab for a description of all the properties that appear on this tab.
- 375. Andover Continuum CyberStation Configurator’s Guide 363 MultistateOutput States Tab This tab lists the number of states this object has, as well as the text values of each state. Depending on the type of BACnet device on which the input was configured, and depending on how the MultistateOutput itself was configured, the number and types of states may vary. If it was configured as an InfinityOutput object for an Andover Continuum b4920, bCX1 (40x0 series), or b3 controller, with a Tristate multistate electrical type — ElecType on the Settings tab of the InfinityOutput editor — then the MultistateOutput has three states named Off, On, and -On, as shown below: However, if the MultistateOutput was configured on a third-party BACnet device, it may have a different number of states, configured with text names from that device. Note: You may change the state of this MultistateOutput via the Present Value field on the General tab.
- 376. TAC364 Each state listed in the State Text field has a its own text and numeric value beginning with 1: 1 <= value <= number of states Number of States This is an integer that defines the number of states for this object. The number must be greater than zero. State Text This is a BACnet array of character strings (text values) representing all possible states of the object. The number of text values matches the number of states defined in the Number of States field. MultistateOutput Basic Alarms Tab With the exception of Feedback Value (described below) the remainder of properties on this tab is covered under BinaryInput Basic Alarms Tab. Feedback Value This specifies the value that the MultistateOutput must equal for an alarm to occur. MultistateOutput Advance Alarms, Triggers, and Security Level Tabs These tabs are covered under AnalogInput Basic Alarms Tab. BACnet MultistateValue Editor A MultistateValue is a BACnet object that is created, and assigned state values, via the InfinityNumeric editor and third-party BACnet devices. (Refer also to Chapter 13.) They can be learned from a third-party device, or created via the MultistateValue editor. MultistateValues are associated with BACnet devices. When you create an InfinityNumeric for an Infinity controller and select MultistateValue in the BACnet Object Type field of the InfinityNumeric editor's General tab, a BACnet MultistateValue is created if the controller on which it resides was created as an Andover Continuum BACnet device — specifically: • As a b4920 or bCX1 (40x0 series) controller • As a b36xx, b38xx, or b39xx controller Note: For third-party BACnet devices that become part of the Andover Continuum system, MultistateValue objects were already created as objects on those third- party BACnet controllers. Therefore, Continuum Explorer already lists these objects as MultistateValues within third-party devices. Typically, a MultistateValue is used as a control system parameter whose value can be any one of a set that you define. For example, you can create a MultistateValue object named DayofWeek whose value can be Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday. Note: The Triggers and Advanced Alarms tabs are unselectable (appear gray) for all BACnet objects because they are enabled only for CyberStation/Infinity objects only. Also, the Basic Alarms tab is supported for BACnet objects attached to third-
- 377. Andover Continuum CyberStation Configurator’s Guide 365 party BACnet devices, not for objects attached to Andover Continuum b4920, bCX1 (40x0 series), and b3 controller devices. Creating and Assigning State Values for a MultistateValue As mentioned on the previous page, on an Andover Continuum b4920, bCX1 (40x0 series), or b3 controller, you create a MultistateValue object as an InfinityNumeric point. For example: As shown above, on the General tab of the InfinityNumeric editor, select MultistateValue from the BACnet Object Type field’s dropdown menu. Enter a value, in the Value field, and select the corresponding units of measure from the dropdown menu in the Units field. A MultistateValue, when it is created as an InfinityNumeric, can have a wide variety of different sets or “clusters” of values. In addition to assigning an integer or floating-point numeric value and units, you may also assign such things as days of the week, or months of the year, or other non-numeric (text) state values. In the Value field, when you enter a non-numeric text value, such as “Monday,” CyberStation searches its internal System Value Cluster (SVC) tables for the cluster of states to which “Monday” belongs — in this case, a cluster that lists seven states (index 1…7). In the MultistateValue editor, you may change the Present Value field of the General tab to select another cluster member. (See the subsection, MultistateValue General Tab.) An InfinityNumeric that has been designated as a MultistateValue can also be assigned a “value cluster” that resembles a binary object. For example, it can have three states (index of 3) with state values of On, Off, and –On. Or, it can have two states with state
- 378. TAC366 values of Active and Inactive. Entering “On” or “Inactive” in the Value field triggers an automatic search to the CyberStation SVC tables, for the appropriate multistate cluster member. Those values are then reflected in the MultistateValue object editor. CAUTION: You must assign a value for multistate objects (in this case, a cluster type) in the InfinityNumeric editor. You may reassign a state (a member of a cluster) in a Multistate editor, but you cannot assign a cluster itself. If you do not assign a value in the InfinityNumeric editor, then by default, the MultistateValue is assigned a dummy value of “State-1” with an index of 256 — State-1 through State-256. MultistateValue General Tab Refer to BinaryOutput General Tab for a description of all the items that appear on this tab. (Note that this tab does not have the Device Type field that appears on the BinaryOutput and MultistateOutput General tabs.) MultistateValue States Tab If the MultistateValue was created as an InfinityNumeric for an Andover Continuum b4920, bCX1 (40x0 series), or b3 controller, the States tab reflects the multistate cluster value that you entered on the General tab of the InfinityNumeric editor. For example, if you entered “Wednesday,” the cluster representing days of the week is shown in the MultistateValue editor. The integer 7 appears in the Number of States field, and the values Sunday through Saturday appear in the State Text field. As mentioned earlier in
- 379. Andover Continuum CyberStation Configurator’s Guide 367 this section, in the InfinityNumeric editor, you can assign a wide variety of different clusters of values. MultistateValue Basic Alarms Tab The items on this tab are covered under the MultistateInput editor. MultistateValue Command Priority Tab This tab is covered under the AnalogOutput editor. MultistateValue Advanced Alarms, Triggers and Security Level Tabs These tabs are covered under the AnalogInput editor.
- 380. TAC368 BACnet Program Editor The Program Editor allows you to run, suspend, restart, halt, and check the status of BACnet programs, running on Andover Continuum BACnet devices – b4920, bCX1 (40x0 series) and b3 controllers – and third-party BACnet devices. Note: On third-party BACnet devices, you can also load and unload BACnet programs via the Program Editor, depending on whether the third-party device supports these capabilities. You cannot load and unload programs on Andover Continuum BACnet devices. The properties on the General tab are compliant with the BACnet standard. If an InfinityProgram object is created on a b4920, bCX1 (40x0 series), or b3 controller via the Plain English IDE then the program can be viewed in two places in the CyberStation system because: • b4920, bCX1 (40x0 series), and b3 controllers exist as Infinity controller and InfinityInfinet controller objects, respectively, on the "Infinity side" of the system. In this case, the program is an InfinityProgram object. • b4920, bCX1 (40x0 series), and b3 controllers also can be viewed as Device objects. In this case, the program is a BACnet Program object.
- 381. Andover Continuum CyberStation Configurator’s Guide 369 Note: Refer to the Plain English Language Reference Guide, 30-3001-872, for complete details on the IDE. The Program Editor General Tab The General tab provides you with the following information, some are read only and others you fill in. Program State This status line displays the current state of the process executing the BACnet program. One of the following values is displayed: Idle — The process is not executing Loading — The program is being loaded Running — The program is currently executing Waiting — The program is waiting for some external event. Halted — The program is halted because of some error condition. Unloading — The program has been requested to terminate. Reason for Halt and Description of Halt These status lines display a numeric error code, a text value, and a text description, of an error that has caused the executing program to halt. (It also tells you when the program is executing normally.) Reason for Halt — The Reason for Halt status line displays an integer plus one of the following values: Normal — The program is not halted due to any error condition. Load Failed — The program could not complete loading. Internal — The program is halted by some internal mechanism. Program — The program is halted by a program-change request. Other — The program is halted for some other reason. Description of Halt — The Description of Halt field displays a user- written text description (originating in the local BACnet device on which the application program resides) that accompanies to the error code and value displayed in Reason for Halt. Program Location Depending on the local BACnet device and programming environment, this field may display the line of code that is currently executing (or that is halted) within the program. For example, it may display a line number, program label, or section name. The content of what is displayed is defined locally. Instance of Displays the local name (originating in the local BACnet device) of the program being executed. The content of what is displayed is defined locally. Load and Upload Loads and unloads the content of a program, are available only in some third-party BACnet devices. They are not available on Andover Continuum BACnet devices.
- 382. TAC370 Run Executes the program. Restart Restarts execution of the program after it has been halted. Halt Halts the program while it is executing. Description Describes the application being carried out by this process. Out of Service Check this checkbox if you wish to put this program out of service (disable it). You must check this box while the program is running. When it is out of service, it loses communication with its attached device. It is a good way to test the program and the processes that rely on it. Status Displays one of four flags that indicate the general status of the program. Three of the flags are associated with the values of other properties of this object. A more detailed status could be determined by reading the properties that are linked to these flags. The four flags are: In_Alarm — The program is in an alarm state. Fault — The program is in a fault state. Overridden — The program has been overridden by a mechanism that is local to the corresponding BACnet device. Out_Of_Service — The program is in an out-of-service (disabled) state. Reliability Displays information about whether or not the controller has detected a malfunction that might compromise the integrity of the program.
- 383. Andover Continuum CyberStation Configurator’s Guide 371 Configuring Schedules and Calendars The Schedule editor allows you to create Continuum Infinity and/or BACnet Schedule objects. A schedule is essentially a collection of scheduled events that typically determine, for example, when equipment runs, processes occur, personnel have access to an area, doors are locked or unlocked, and so on. A schedule comprises standard days and user defined standard days, such as holidays. A schedule also includes BACnet exception schedules, special calendar entries based on the BACnet Calendar object, which Continuum supports. These Calendar entries can be single days, a range of days, or recurring days, in accordance with the BACnet standard. You can therefore create or reference Calendar object values and integrate them into a Schedule object. This chapter covers: • Schedule views – finding your way around • The Configuration tab • Working with exception schedules • Working with standard days and user-defined days • The Current State tab • Proprietary Schedule properties for programs • Mass Create – populating devices with a schedule • Mass Change – updating multiple schedules • Calendars and the Calendar editor 15
- 384. TAC372 Schedule Views – Finding Your Way Around This section discusses the various schedule views, and also offers some information for finding your way around in the Schedule editor. Schedule Views The Schedule editor presents yearly, weekly, and daily views. To see each view, simply click the Yearly, Weekly, or Daily tab, respectively:
- 385. Andover Continuum CyberStation Configurator’s Guide 373
- 386. TAC374 To move to the next/previous year, week, or month, click the right-arrow button (next) or left-arrow button (previous) at the top of the respective tab. On these various views, there are scheduled events for standard days and user-defined standard days, as well as exception schedule calendar entries. Continuum supplies only one default user-defined day — Holiday. You may create other user-defined standard days. The standard days, Monday through Friday, appear in one default color (light blue) while the weekend standard days, Saturday and Sunday, appear in another default color (medium blue). The user-defined day, Holiday, appears in red, by default. Note: You may change the color of a standard or user-defined day when you edit one of these days. Note: To see more of the schedule events on the weekly and daily views, increase the size of your Schedule editor window, as you would increase the size of any Microsoft window. Exception and Standard Day Tabs On the left side of the Schedule editor, you see two tabs — Exception and Standard Days. Each tab shows an expandable tree structure. For example: The Standard Days tab lists the Weekly Schedule tree (Monday through Sunday) as well as the User Defined Days tree (Holiday by default, plus any other user-defined standard day you create). For more information, see: Working with Standard Days and User-defined Days, later in this chapter.
- 387. Andover Continuum CyberStation Configurator’s Guide 375 The Exception tab lists the Exception Schedule tree, which includes calendar entries (single days, ranges of days, recurring days) that have been assigned (selected) or referenced. The Exception Schedule tree includes user-defined standard days. For more information, see: Working with Exception Schedules, later in this chapter. Note: An exception-schedule entry is sometimes based on the BACnet Calendar object, which Continuum supports, in accordance with the BACnet standard. These Calendar object values can be integrated into a Schedule object. (See Calendars and the Calendar Editor, later in this chapter.) Note: To see more of the entries in the Exception and Standard Day trees, increase the size of your Schedule editor window, as you would increase the size of any Microsoft window. Configuration You configure all Schedules, both for Infinity and BACnet controllers, using the Configuration tab. The attributes on this tab define a schedule, when and where it takes effect, when it is enabled or disabled, how it is downloaded to a controller, and so on. When you create a Schedule object on a BACnet controller, such as an Andover Continuum b4 controller, the Infinity-related attributes on the Configuration tab are not visible. Likewise, when you create a Schedule object on an Infinity controller, the BACnet-related attributes are not visible. For more information, see: Configuration Tab, on the next page. Note: When you create a Schedule object on a BACnet controller, such as an Andover Continuum b4 controller, the Infinity-related attributes in the Schedule editor, such as some attributes on the Configuration tab, are not visible. Likewise, when you create a Schedule object on an Infinity controller, the BACnet-related attributes are not visible. Note: When you make changes to standard days in a schedule, they take effect globally for all years within the schedule and affect all objects set by that schedule. Current State The Current State tab, which is visible only for a BACnet controller’s Schedule object, displays information about the value of the current event. For more information, see Current State Tab later in this chapter.
- 388. TAC376 Mass Create and Mass Change The Schedule editor allows you to copy and distribute (populate) a Schedule object to two or more devices on your system. It also allows you to make Schedule-object changes to many other Schedule objects. Click the Copy button to expose the Mass Create and Mass Change tabs appended to the right side of the editor. These tabs are normally hidden. To expand and retract the width of the Mass Create/Mass Change tab area, place your cursor on the right edge of the yearly, weekly, or daily view (typically the yearly view) until it becomes a double right- left arrow cursor. Drag this cursor left or right to expand or retract, respectively. To close the Mass Create/Mass Change tab area, click the X button. For more information, see Mass Create - Populating Devices with a Schedule and Mass Change - Updating Multiple Schedules, later in this chapter. Configuration Tab Use the Configuration tab to configure schedules, both for Infinity and BACnet controllers. The attributes on this tab define a schedule, when and where it takes effect, when it is enabled or disabled, how it is downloaded to a controller, and so on. Note: When you create a Schedule object on a BACnet controller, such as an Andover Continuum b4 controller, the Infinity-related attributes on this tab are not visible. Likewise, when you create a Schedule object on an Infinity controller, the BACnet- related attributes are not visible. The Configuration tab attributes on a BACnet controller are shown on the next page.
- 389. Andover Continuum CyberStation Configurator’s Guide 377 The following table provides descriptions of attributes that appear on the tab for a Schedule object created on a BACnet controller. Editor Attribute Meaning Description Enter a description for this Schedule object. Clear Past Events Check this box when you need to delete BACnet special events that no longer impact an exception schedule. This may become necessary to conserve memory in controllers on your system when updated exception schedules are sent to controllers. By default, this box is not checked. When you check this box, save the Schedule, and re-open the editor, the box is checked. Important things to know about this feature: • If you do not check this box, exception schedule event data (everything ever created) are re-sent to controllers. This can quickly consume memory, especially in controllers with limited memory capacities. • Events must be at least three days old before they are automatically removed. Continuum calculates this by comparing the day on which the event expires to the current workstation time.
- 390. TAC378 Editor Attribute Meaning Of the four types of exception choices (Date, Range of Dates, Recurrence, and Calendar Reference) only Date and Range of Dates may be automatically removed. Newly created exceptions that take effect and expire in the past are removed immediately — Exception entries that meet the above criteria are automatically removed from view either when the box is initially checked or when the editor opens with the box already checked. If you inadvertently add new exceptions whose expiration dates are in the past (more than three days old) these expired events will also be removed from view the next time the editor opens. In all cases, the exception value is written as it appears in the view when you click the OK or Apply button. In addition to using this checkbox, you can also conserve memory by creating partial-day exception schedules. See Partial-Day Exception Schedules, later in this chapter. Effective From/To Using Effective From and To fields to select a day that designates when the schedule becomes active and inactive. Click the dropdown-menu down arrow to use the calendar to select a day that designates when the schedule becomes active and inactive. Or, as an alternative, click (highlight) the month, day, or year field and enter the digits for the month, day, or year. Show BACnet Date Fields — Check this checkbox to use the BACnet properties for these date fields. (Remove the check to use the "system" Effective From/To.) The BACnet date fields, which are self-explanatory, allow you to enter any month, day, year, and day of week. Using the month dropdown menu, you may select a specific month, Any month, Even months, or Odd months. Using the day-of-week dropdown menu, you may select a specific day or Any day. Note: To select any day or any year, simply enter the word "Any" into the day or year field, respectively. Right-click switching between fields — To switch between the BACnet fields and From/To (or "system") fields, right click anywhere in or near the fields, and select BACnet or System from the popup menu, depending on which fields you prefer. Priority Using the dropdown menu, select a BACnet command priority for this Schedule object.
- 391. Andover Continuum CyberStation Configurator’s Guide 379 Editor Attribute Meaning Time Scale From the dropdown menu, select the number of minutes with which you want to partition an hour in the daily and weekly views. Selections are: 5 minutes, 6 minutes, 10 minutes, 15 minutes, 30 minutes, 60 minutes. The time scale applies to the entire schedule. For example, if you select 15 Minutes, four time slots (demarcated by gray lines) appear within each hour in the daily and weekly views throughout the schedule. For example, if you select 5 Minutes, 12 time slots (demarcated by gray lines) appear within each hour in the daily and weekly views. Default Data Type To apply a certain data type to all new Schedule events by default, select a type from the dropdown menu. Note: It is recommended that you first assign a default data type before creating new events for this schedule. BACnet standard revision 2004 requires that one data type is specified for schedule events. The data types of old events are not affected by this selection. However, when you assign a default data type, a message appears, telling you that some existing scheduled events have different (non-default) data types. If you receive this message, you should manually delete them. When you set this default type, it also assigns this type as the default in the Value Type fields in the Schedule Default section and in the "apply at midnight" section. Schedule Default Value Value Type This section (enabled only for devices that support the BACnet standard revision 2004 and higher) displays a default value/type for the entire schedule when no other value is assigned. That is, the scheduled default is used as a "last resort" for the present value when no other exception or weekly scheduled event is in control. Check the NULL checkbox to relinquish control of a commanded property when no scheduled events are in effect. Note: When you set the Default Data Type (see above) the schedule default value type is set to that default data type automatically. Note: The Schedule Default value also works with partial-day exception schedules. Please see Partial-day exception schedules , later in this chapter.
- 392. TAC380 Editor Attribute Meaning Apply value and type to all Schedule events at midnight. Value Value Type Check this checkbox to ensure that all weekly and exception Schedule events are reset at midnight to the value and data type specified in the Value and Value Type fields. An event is scheduled at midnight automatically so that you do not have to do it manually. Note: This checkbox is checked by default for pre-revision 2004 schedules. If your schedules do not support revision 2004, do not remove the check from this box. This ensures that a value/type are applied at midnight, thereby allowing a "whole day" schedule. Note: With the introduction of the Schedule Default in revision 2004, you can use the Schedule Default section (see above) to apply a value/type, whereby this schedule default is applied to events at midnight automatically, in absence of any other event in control at midnight. When this box is checked, the value/type specified here takes effect at midnight (00:00) for any new exception schedule that you create. (See also: Working with Exception Schedules and Working with Standard and User-defined Days.) Enter a value, and from the dropdown menu select a data type, to be applied at midnight to all weekday and schedule event entries. They must be applied at midnight to comply with the BACnet standard. (For more information on Value, Value Type, and the Time Value dialog, please see: Working with Exception Schedules and Working with Standard and User-defined Days.) Note: These fields are selectable only when the Apply this value and type to all Schedule events at midnight checkbox is checked. Object Property List This window lists BACnet objects that are set by this schedule. To add a schedule to the list, click the Add button and from the Search for an object property reference dialog, search for and select an object, then click the Select button. The selection appears in the list. To remove an object from the list, highlight it in the list, then click Delete.
- 393. Andover Continuum CyberStation Configurator’s Guide 381 The Configuration tab attributes on an Infinity controller look like this:
- 394. TAC382 The following table provides descriptions of attributes that appear on this tab for a Schedule object created on an Infinity controller. Editor Attribute Meaning Description Enter a description for this Schedule object. State Use the dropdown menu to enable or disable the schedule. Point Configuration In the Occupancy field, enter the path or click the browse button to search for Infinity DateTime point that designates when the schedule becomes active. In the Unoccupancy field, enter the path or click the browse button to search for an Infinity DateTime point that designate when the schedule becomes inactive. In the Occupancy Point field, enter the path or click the browse button to search for the InfinityNumeric or InfinityOutput object that will be set by this schedule. A schedule is used to turn the object on (active) or off (inactive). Time Scale From the dropdown menu, select the number of minutes with which you want to partition an hour in the daily and weekly views. Selections are: 5 minutes, 6 minutes, 10 minutes, 15 minutes, 30 minutes, 60 minutes. The time scale applies to the entire schedule. For example, if you select 15 Minutes, four time slots (demarcated by gray lines) appear within each hour in the daily and weekly views throughout the schedule. For example, if you select 5 Minutes, 12 time slots (demarcated by gray lines) appear within each hour in the daily and weekly views. Events These five fields display current information about this schedule's events. Present Value — Displays the current event value: Active or Inactive. Occupancy Time — Displays the specified occupancy time from Occupancy time field, above. Unoccupancy Time — Displays the specified unoccupancy time from Unoccupancy time field, above. Next Occupancy Time — Displays the next day/time the schedule becomes active. Next Unoccupancy Time — Displays the next day/time the schedule becomes inactive. Note Enter information about this schedule. This note appears in weekly and daily calendar views.
- 395. Andover Continuum CyberStation Configurator’s Guide 383 Editor Attribute Meaning Automatic Schedule Download Check this checkbox, and select a day and time, to download this schedule's values automatically from the workstation database to the controller on which this schedule was opened. Use the day dropdown menu to select a day. To select a time, click and highlight the hours, minutes, seconds, or AM/PM field to select the hour, minute, second, and AM/PM, you want the automatic download to occur. Use the up and down arrows to move to the previous hour/minute/second and to select AM or PM. Action To download this schedule’s values to the controller immediately (and not wait for the designated download day/time) click the Download Events to Controller NOW button. Working with Exception Schedules This section covers: • Overview • Creating an exception entry • Partial-day exception schedules • Exception schedule icons • Editing, deleting, and moving an exception entry • Making user-defined standard days exception schedules • Creating an exception entry via Daily and Weekly tabs • Selecting (highlighting) an entire month or an entire week on the yearly view Overview Using the Exception tab, you may create and/or reference a BACnet exception schedule to your Schedule object. An exception schedule is a special schedule entry that is sometimes based on the BACnet Calendar object, which Continuum supports. These exception entries can be single days, a range of days, recurring days, or a referenced Calendar object, in accordance with the BACnet standard. You can therefore integrate Calendar object values into a Schedule object. Note: Exception schedules can also be partial days, as of the implementation of the BACnet protocol revision 4. That is, you can create two or more exception schedules for the same day. See also Partial-day exception schedules, later in this chapter. Note: You may not use a recurring-day entry or referenced Calendar-object exception entry for a schedule created on an Infinity controller — only a BACnet controller. The Exception tab lists the Exception Schedule tree, which includes single days, ranges of days, recurring days, and referenced calendar days that have been assigned
- 396. TAC384 (selected). This includes the assignment of user-defined days, as well as any new exception entry that you create or reference via the Exception Schedule tree. Creating an Exception Entry To create a new exception entry, follow this procedure: 1. Click the New Exception button beneath the Exception Schedule tree (or right click Exception Schedule and select New Exception from the popup). The Special Event dialog (or BACnet Special Event dialog for BACnet controllers) appears: 2. In the Entry Type section, select one of the following radio buttons: Date Range of dates Recurrence Calendar Reference Notice the data fields on the right side of the dialog are different for each selection. Note: The Recurrence and Calendar Reference radio button selections do not appear for a Schedule on an Infinity controller. 3. Enter the desired information in the data fields on the right side of the dialog. These fields are self-explanatory.
- 397. Andover Continuum CyberStation Configurator’s Guide 385 Note: For year, month, day, and day of week, you can select "any," as opposed to a specific selection. To do so, check the respective Any checkboxes. Also, for Month, you may use the dropdown menu to select Odd Months or Event Months, as opposed to a specific month. For range, enter a starting and ending date. For recurrence, enter a recurring weekday for a particular month. For example, if you were defining "Thanksgiving," you could choose Last, Thursday, and November. For a calendar reference, click the Calendar Reference Object field's browse button. The Select an object dialog appears. Search for and select the Calendar object (on a BACnet controller) that you want to reference and integrate into your Schedule object. Click the Select button. The Calendar object path appears in the Calendar Reference Object field. 4. Select either the Time Value List radio button (when you want to add one or more unique time values to apply to the new entry) or the User Defined Standard Day radio button when you want select the time value of an existing user-defined day, such as Holiday. If you select Time Value List, go to step 5. If you select User Defined Standard Day, go to step 6. 5. Click the Add button. The Time Value dialog appears: In the Time field, select a time at which you want this entry's event to apply a value — hour, minute, second. Note: If you want to use BACnet time fields (in which you can specify a specific time or any time) check the BACnet Time Fields checkbox. There are four BACnet time fields. From left to right, enter the hour, minute, second, and hundredth of second. To enter any hour, any minute, any second, or any hundredth of second, enter the word "Any" in the desired field. In the Value field and Value Type field (schedule on a BACnet controller) enter a value and value type. For example, on a BACnet controller, for a temperature value, you could enter a real number and select Real from the Value Type field's dropdown menu. For example, you could enter a text value, then select Character String as a value type.
- 398. TAC386 For a schedule on a BACnet controller, choices for Value Type are: Boolean Unsigned Integer Signed Integer Enumerated Date Time Character String Real BACnet Object Identifier Double Octet String Bit String Note: Check the NULL checkbox to relinquish control of a commanded property when no scheduled events are in effect. Note: The Value Type field is not available for a schedule on an Infinity controller. Value field choices on an Infinity controller are Active and Inactive (on/off). For example: In the Notes field, describe the entry's event. These notes, along with the values, appear in the weekly and daily views. Click OK. The time/value entry appears in the Time Value List window in the Special Event dialog. Repeat this procedure if you want to apply two or more times/values for this entry. For example, you may create one time/value to raise the temperature at 7:00 a.m. to 70 degrees, and another to lower the temperature at 9:00 pm to 55 degrees.
- 399. Andover Continuum CyberStation Configurator’s Guide 387 CAUTION: Too many exception-entry events scheduled on one day can create time/value conflicts. If this happens, the following warning appears on the Daily tab, as well as the Weekly tab for each conflicted day: There are too many events in this day. Please double-click to see details. Double click over this warning on the Daily or Weekly tab. The Time Values for Day dialog appears, displaying a list of times/values for events scheduled on that day. Note: The values you select are applied to the attached objects listed in the Object Property List (BACnet controller) on the Configuration tab. On an Infinity controller, values are applied to the InfinityNumeric or InfinityOutput point specified in the Occupancy Point field on the Configuration tab. Note: You may also access the Time Value dialog (and create a new exception event) by clicking in the time margin or a non-event slot in the Daily or Weekly tab. The Time Value dialog accessed from those tabs asks for a start-time event, as well as an end-time event. For example: "Rest of the day" end time — As described above, when you access the Time Value dialog on the Daily or Weekly tab, and you are asked to specify both a start time and an end time. Here you have the option of specifying a midnight end time by checking the Rest of the day checkbox. Check this box when this event needs to be active for the remainder of the day. It also saves you the time of filling in the End time fields. Again, if you want to use BACnet time fields (in which you can specify a specific time or any time) check the BACnet Time Fields checkbox. Go to step 7.
- 400. TAC388 6. From the dropdown menu, select the user-defined standard day whose value you want to apply to this new entry. Note: The values you select are applied to the attached objects listed in the Object Property List (BACnet controller) on the Configuration tab. On an Infinity controller, values are applied to the InfinityNumeric or InfinityOutput point specified in the Occupancy Point field on the Configuration tab. 7. In the Event Priority field of the BACnet Special Event dialog, select a BACnet command priority (1...16) from the dropdown menu. This priority is useful if there are exception schedule event conflicts. For more information on BACnet command priority, see the Help topic, Working with Command Priorities, in your Continuum online help, and Chapter 14, BACnet, and your BACnet Standard. 8. In the Name field, enter a name or description of the day, range, recurrence, or referenced entry. This name appears for this entry in tree. 9. Click OK. The new entry is added to the tree. Note: At this point, you may right click the Daily or Weekly tab and from the popup menu and select the number of minutes with which you want to partition an hour in the daily and weekly views. Selections are: 5 minutes, 6 minutes, 10 minutes, 15 minutes, 30 minutes, 60 minutes. (This is known as the Time Scale, which you may also set on the Configuration tab.) The time scale applies to the entire schedule. For example, if you select 15 Minutes, four time slots (demarcated by gray lines) appear within each hour in the daily and weekly views throughout the schedule. For example, if you select 5 Minutes, 12 time slots (demarcated by gray lines) appear within each hour in the daily and weekly views. Partial-Day Exception Schedules The BACnet standard, revision 2004, introduces partial-day exception schedules. Before revision 2004, an exception schedule governed an entire day, an entire day for each day in a range or days, or an entire day for each day of recurring days. This meant that an exception schedule would stay in control for an entire day and never relinquish control back to weekly scheduled events for that day, since a weekly schedule yields to an exception schedule. Passing Control Back to Weekly Schedule on Same Day -- Partial-day exception scheduling allows you to control a portion of a given day, rather than the whole day. This means that exception events and weekly events can be integrated into the same day, as needed. Important one-time exception events now can temporarily interrupt the weekly schedule (for only as many hours as it needs to) and then hand control back to the weekly schedule. That is, regularly scheduled events are no longer completely ignored when a weekly and exception schedule fall on the same day. Before revision 2004, to overcome this dilemma, weekly schedule events were often included in the exception schedule. This was the only way to add additional events to that day.
- 401. Andover Continuum CyberStation Configurator’s Guide 389 For example, take a classroom that is normally controlled by a weekly schedule, where the room is occupied from 9:00 a.m. to 3:00 p.m. But suppose that one particular Wednesday a special lab takes place from 6:00 to 8:00. Before revision 2004, if an exception schedule were added to allow this room to be occupied from 6:00 to 8:00 on a particular Wednesday, that exception would also need to specify the room as occupied from 9:00 to 3:00 because all Wednesday's normal events would be overridden. Partial-day scheduling removes that limitation. When an exception event ends, control can be passed back to the weekly schedule. In the classroom example, this allows you to specify an exception entry only from 6:00 to 8:00. You can pass control from the exception back to the weekly schedule by specifying a special value (NULL) in the exception's time value list. In the classroom case, it means that the exception could look like this: • 6:00 a.m. - Specify the value (for example, turn on heat or light) that makes the room occupied. • 8:00 a.m. - Specify the value that makes the room not occupied. • At a time after 8:00, but before 9:00 - Specify NULL. Note: The exception and weekly schedule properties can also interact with the Schedule Default property, which might allow the above schedule to be specified differently, but control identically. See also the Configuration tab. Using Two Exception Schedules on the Same Day -- Before revision 2004, it was not possible to use different exceptions to control different parts of the same day. Now, one exception can control a morning's events and another exception control the evening's events. Using the previous classroom example, suppose that, on a Sunday, the room must be occupied from 6:00 a.m. to 8:00 a.m., and again from 9:00 to 3:00 p.m. No weekly schedule is in effect for Sunday. This means that the exceptions could look like this: Exception 1 • 6:00 a.m. - Specify the value that makes the room occupied. • 8:00 a.m. - Specify the value that makes the room not occupied. • At a time after 8:00, but before 9:00 - Specify NULL. Exception 2 • 9:00 a.m. - Specify the value that makes the room occupied. • 3:00 p.m. - Specify the value that makes the room not occupied. Partial-Day Exceptions and Schedule Default -- Partial-day exception schedules can also work with the schedule default value, established in the property, Schedule Default. (See also the Configuration tab.) The value of the schedule default is the value the schedule takes at any moment where there are no exception or weekly events in control. Using the first classroom example (exception vs. weekly events), the 8:00 value, which makes the room unoccupied, is not necessary if the schedule default has the same
- 402. TAC390 value. Instead, the exception can just specify the NULL value and cause the schedule default to take control because there are no weekly events at 8:00 a.m. Exception Schedule Icons As you add exception entries, the Exception Schedule tree identifies them in the list with the following icons: Single day Range of days Recurring days Calendar object reference When you expand an entry, its time values and command priorities appear in the tree. The exception entries are highlighted on the yearly view and noted in the weekly and daily views. Note: Dates listed in the tree appear in red on the yearly view. If you select a day in the tree, it appears in blue on the yearly view. Note: When you click and select a date in the yearly view, you may right click and assign a user-defined standard day. Any day that is assigned in this manner also appears in the tree. See also: Working with Standard Days and User-defined Days, later in this chapter. Editing, Deleting, and Moving an Exception Entry Editing an Entry — To edit an existing exception entry in the Exception Schedule tree, simply right click its icon/entry in the tree, and select Edit from the popup menu. The Special Event dialog appears. Use the procedure for creating an exception entry, above, as guidelines. Deleting an Entry — To delete an exception entry in the Exception Schedule, simply right click its icon/entry in the tree, and select Delete from the popup menu. The entry is removed from the tree and the calendar view. Moving an Entry in the Tree — To move an entry up or down in the tree, simply right click its icon/entry, and select Up or Down from the popup menu. The entry is inserted above the previous or next entry in the tree, respectively. Making User-Defined Standard Days Exception Entries From the Standard Day tab, in the User Defined Day tree, when you assign a user- defined standard day (or a range of user-defined standard days) on the yearly view, the day or range also becomes part of the exception schedule. For more information, see: Working with Standard and User-defined Days, later in this chapter.
- 403. Andover Continuum CyberStation Configurator’s Guide 391 Creating an Exception Entry via Daily and Weekly Tabs On the Daily and Weekly tabs of the Schedule editor, you may click inside a time slot, or the time margin, to bring up the Time Value dialog and add a time/value event. (See procedures above for information on the Time Value dialog.) When you access the Time Value dialog from these tabs, it provides two sections for the Start time and End time. Hence you are creating two time/value events in using one dialog — a start event and an end event. Selecting an Entire Month or Entire Week on the Yearly View To select (highlight) an entire month or an entire week: 1. Select the Yearly tab. 2. To select (highlight) an entire month, click inside the day initials for that month (S M T W T F S). To select (highlight) an entire week, click to the left of that week (to the left of Sunday "S" of that week). Working with Standard Days and User-defined Days This section covers the following: • Overview • Editing a weekly standard day • Creating and editing a user-defined standard day • Assigning one or more single user-defined standard days • Assigning a range of user-defined standard days in the yearly view • Resetting a user-defined standard day as a weekly standard day • Deleting a user-defined standard day • Using exception schedules exclusively (deleting weekly standard day events) • Selecting (highlighting) an entire month or an entire week from Yearly tab Overview The Schedule editor, by default, supplies weekly standard days (Monday through Sunday). These standard days are listed on the Standard Day tab, in the Weekly Schedule tree. You may modify any weekly standard day. Within each standard day, you add and edit events, specifying the time these events become active and inactive during the day, as well as values for these events — for example, temperature values, on/off switches, and so on.
- 404. TAC392 Note: For schedules on an Infinity controller, an event value can only be either on (active) or off (inactive). However, on a BACnet controller, you may apply many different types of event values — for example, real numbers, character strings, arrays, Boolean values, and so on, and change these values during the course of a day, as needed. Event information, including notes on and the current state of each event, appears within the daily and weekly calendar view of a weekly standard day. Also on the Standard Day tab, in the User Defined Day tree, you may create user- defined standard days. Only one user-defined standard day is supplied by default — Holiday. Note: When you edit standard days and user-defined standard days, you make global changes that affect all weeks of all years within that schedule, and all objects that are attached to that schedule. Editing a Weekly Standard Day To edit a standard day and add/modify events within that standard day, perform this procedure: 1. Select the Standard Day tab. 2. In the Weekly Schedule tree, right click the standard day you want to edit (Monday...Sunday) and select Edit from the popup. The standard day dialog appears. (The name of the standard weekday is the title of the dialog.) 3. Check the background color, and change this color, if desired. If you wish to pick a new color for this weekday, click the color box. From the Color dialog, select a new color, as you would in Microsoft Windows. Click OK, after selecting the new color. This color is shown in all the views, as well as in the Standard Day tab, for this weekday. 4. To add a new standard-day event, click the Add button. To edit an existing standard-day event, in the Event List highlight the event you want to change, and click the Edit button. The Time Value dialog appears. Note: To delete an existing standard-day event, in the Event List highlight the event you want to delete, and click the Delete button. The event is removed from the list. In the Time Value dialog: In the Time field, select a time at which you want this event to apply a value — hour, minute, second. Note: On a BACnet controller, if you want to use BACnet time fields (in which you can specify a specific time or any time) check the BACnet Time Fields checkbox. There are four BACnet time fields. From left to right, enter the hour,
- 405. Andover Continuum CyberStation Configurator’s Guide 393 minute, second, and hundredth of second. To enter any hour, any minute, any second, or any hundredth of second, enter the word "Any" in the desired field. In the Value field and Value Type field (schedule on a BACnet controller) enter a value and value type. For example, on a BACnet controller, for a temperature value, you could enter a real number and select Real from the Value Type field's dropdown menu. For example, you could enter a text value, then select Character String as a value type. Note: The Value Type field is not available for a schedule on an Infinity controller. Value field choices on an Infinity controller are Active and Inactive (on/off). For a schedule on a BACnet controller, choices for Value Type are: Boolean Unsigned Integer Signed Integer Enumerated Date Time Character String Real BACnet Object Identifier Double Octet String Bit String Check the NULL checkbox to relinquish control of a commanded property when no scheduled events are in effect. In the Notes field, describe the entry's event. These notes, along with the values, appear in the weekly and daily views. Click OK. The event appears in the Event List window in the standard day dialog. Repeat this procedure if you want to apply two or more time/value events for this entry. For example, you may create one time/value to raise the temperature at 7:00 a.m. to 70 degrees, and another to lower the temperature at 9:00 pm to 55 degrees. Note: The values you select are applied to the attached objects listed in the Object Property List (BACnet controller) on the Configuration tab. On an Infinity controller, values are applied to the InfinityNumeric or InfinityOutput point specified in the Occupancy Point field on the Configuration tab. Note: You may also access the Time Value dialog (and create a new event) by clicking in the time margin or a non-event slot in the Daily or Weekly tab. The Time Value dialog accessed from those tabs asks for a start-time event, as well as an end-time event. For example:
- 406. TAC394 "Rest of the day" end time — As described above, when you access the Time Value dialog on the Daily or Weekly tab, and you are asked to specify both a start time and an end time. Here you have the option of specifying a midnight end time by checking the Rest of the day checkbox. Check this box when this event needs to be active for the remainder of the day. It also saves you the time of filling in the End time fields. 5. Check the Apply events to all weekdays in weekly schedule checkbox to copy this weekday's events to all other weekdays. 6. Click OK. The standard day changes appear throughout the Schedule editor. Note: At this point, you may right click the Daily or Weekly tab and from the popup menu select the number of minutes with which you want to partition an hour in the daily and weekly views. Selections are: 5 minutes, 6 minutes, 10 minutes, 15 minutes, 30 minutes, 60 minutes. (This is known as the Time Scale, which you may also set on the Configuration tab.) The time scale applies to the entire schedule. For example, if you select 15 Minutes, four time slots (demarcated by gray lines) appear within each hour in the daily and weekly views throughout the schedule. For example, if you select 5 Minutes, 12 time slots (demarcated by gray lines) appear within each hour in the daily and weekly views.
- 407. Andover Continuum CyberStation Configurator’s Guide 395 Creating and Modifying a User-defined Standard Day To create a new user-defined standard day, or modify an existing one, perform this procedure: 1. Select the Standard Day tab. 2. To add a new user-defined standard day: Click the New User Defined Day button beneath the User Defined Day tree (or right click User Defined Day, and select New from the popup). To edit an existing standard day: In the User Defined Day tree, right click the name of the user-defined standard day you wish to change. The Standard Day dialog appears. Note: Only one user-defined standard day is provided, by default — Holiday. 3. Check the background color, and change this color, if desired. If you wish to pick a new color for this user-defined standard day, click the color box. From the Color dialog, select a new color, as you would in Microsoft Windows. Click OK, after selecting the new color. This color is shown in all the views, as well as in the Standard Day tab, for this user- defined standard day. Note: The default color for Holiday is red. 4. To add a new user-defined-standard day event, click the Add button. To edit an existing user-defined standard day event, in the Event List, highlight the event you want to change, and click the Edit button. The Time Value dialog appears. Note: To delete an existing user-defined standard day event, in the Event List highlight the event you want to delete, and click the Delete button. The event is removed from the list. In the Time Value dialog: In the Time field, select a time at which you want this event to apply a value — hour, minute, second. Note: On a BACnet controller, if you want to use BACnet time fields (in which you can specify a specific time or any time) check the BACnet Time Fields checkbox. There are four BACnet time fields. From left to right, enter the hour, minute, second, and hundredth of second. To enter any hour, any minute, any second, or any hundredth of second, enter the word "Any" in the desired field. In the Value field and Value Type field (schedule on a BACnet controller) enter a value and value type. For example, on a BACnet controller, for a temperature value, you could enter a real number and select Real from the Value Type field's dropdown menu. For example, you could enter a text value, then select Character String as a value type.
- 408. TAC396 Note: The Value Type field is not available for a schedule on an Infinity controller. Value field choices on an Infinity controller are Active and Inactive (on/off). For a schedule on a BACnet controller, choices for Value Type are: Boolean Unsigned Integer Signed Integer Enumerated Date Time Character String Real BACnet Object Identifier Double Octet String Bit String Check the NULL checkbox to relinquish control of a commanded property when no scheduled events are in effect. In the Notes field, describe the entry's event. These notes, along with the values, appear in the weekly and daily views. Click OK. The event appears in the Event List window in the Standard Day dialog. Repeat this procedure if you want to apply two or more time/value events for this entry. For example, you may create one time/value to raise the temperature at 7:00 a.m. to 70 degrees, and another to lower the temperature at 9:00 pm to 55 degrees. CAUTION: Too many exception-entry events scheduled on one day can create time/value conflicts. If this happens, the following warning appears on the Daily tab, as well as the Weekly tab for each conflicted day: There are too many events in this day. Please double- click to see details. Double click over this warning on the Daily or Weekly tab. The Time Values for Day dialog appears, displaying a list of times/values for events scheduled on that day. Note: The values you select are applied to the attached objects listed in the Object Property List (BACnet controller) on the Configuration tab. On an Infinity controller, values are applied to the InfinityNumeric or InfinityOutput point specified in the Occupancy Point field on the Configuration tab. Note: You may also access the Time Value dialog (and create a new event) by clicking in the time margin or a non-event slot in the Daily or Weekly tab. The
- 409. Andover Continuum CyberStation Configurator’s Guide 397 Time Value dialog accessed from those tabs asks for a start-time event, as well as an end-time event. 5. Click OK. The user-defined standard day changes appear throughout the Schedule editor. Note: At this point, you may right click the Daily or Weekly tab and from the popup menu select the number of minutes with which you want to partition an hour in the daily and weekly views. Selections are: 5 minutes, 6 minutes, 10 minutes, 15 minutes, 30 minutes, 60 minutes. (This is known as the Time Scale, which you may also set on the Configuration tab.) The time scale applies to the entire schedule. For example, if you select 15 Minutes, four time slots (demarcated by gray lines) appear within each hour in the daily and weekly views throughout the schedule. For example, if you select 5 Minutes, 12 time slots (demarcated by gray lines) appear within each hour in the daily and weekly views. Assigning One or More Single User-defined Standard Days To assign one or more single user-defined standard days in your schedule: 1. Select the Yearly tab. 2. In the yearly view, select (left click) the day you wish to assign, and then right click. From the popup menu, select Assign a User Defined Standard Day, as well as the name of the user-defined day you wish to assign. The yearly view shows that day as the user-defined day you selected, in its designated color. The Exception Schedule tree also lists that day as a single exception day, with its single-day icon. (See: Working with Exception Schedules, earlier in this chapter.) Note: To assign two or more individual (non-consecutive) user-defined standard days, hold down the CTRL key, and click (highlight) the individual days you wish to assign. Right click, and proceed as described, above. (Holding the SHIFT key in this way allows you to assign two or more consecutive days.) Assigning a Range of User-defined Standard Days in Yearly View To assign a range of user-defined standard days: 1. Select the Yearly tab. 2. In the yearly view, click and hold the mouse button on the first day of the range (for example, February 15). 3. Drag the cursor on the calendar to the last day of the range (for example, February 22). The range (February 15...22) is highlighted. 4. Right click, and from the popup menu, select Assign a User Defined Standard Day, as well as the name of the user-defined day you wish to assign for that range. The yearly view shows a range of that user-defined day, in the designated color.
- 410. TAC398 The Exception Schedule tree also lists these days as an exception range of days, with its range icon. (See: Working with Exception Schedules, earlier in this chapter) Resetting a User-defined Standard Day to a Standard Day To reset a user-defined standard day to a weekly standard day: 1. Select the Yearly tab. 2. In the yearly view, select (left click) on the user-defined day you wish to set back to a weekly standard day, and then right click. 3. From the popup, select Reset to weekly schedule. Note: This also applies to ranges and recurrences. Deleting a User-defined Standard Day To delete a user-defined standard day: 1. Select the Standard Day tab. 2. In the User Defined Day tree, right click the user-defined day you wish to delete. 3. From the popup menu, select Delete. Caution: The user-defined standard day is deleted and removed from everywhere it is used, including the Exception Schedule. Using Exception Schedules Exclusively (Deleting Weekly Standard Day Events) If you do not wish to use the weekly standard day schedule (as listed in the Weekly Schedule tree), and want to use exception schedules exclusively, perform the following procedure. Using an exception schedule exclusively is beneficial when you need non- repetitive schedules — for example, when students are entering and leaving a laboratory, based on their course requirements and the amount of time it takes them to finish their work, rather than a weekly scheduled time-allotment. 1. Select the Standard Day tab. 2. Right click Weekly Schedule. 3. From the popup, select Delete Weekly Events. WARNING: When you make this selection, all existing events in all weekly standard days are removed from your schedule. Selecting an Entire Month or Entire Week on Yearly View To select an entire month or an entire week: 1. Select the Yearly tab. 2. To select (highlight) an entire month, click inside the day initials for that month (S M T W T F S).
- 411. Andover Continuum CyberStation Configurator’s Guide 399 To select (highlight) an entire week, click to the left of that week (to the left of Sunday "S" of that week). Current State Tab This tab displays information about the value of the current event. This tab is not visible on Schedules for Infinity controllers. Editor Attribute Meaning Present Value Displays the present value of the current event. This can be of any BACnet time/value type. (See Working with Exception Schedules and Working with Standard and User-defined Days.) Reliability Indicates whether or not a malfunction has been detected, compromising the integrity of the present value of the current event. Possible reliability settings are: • NoFaultDetected – Indicates that the present value is reliable and that no fault has been detected. • UnderRange – Indicates that the sensor connected to the input is reading a value that is lower than the normal operating range. • OverRange – Indicates that the sensor connected to the input is reading a value that is higher than the normal operating range. • UnReliableOther – Indicates that the sensor has detected that the present value is unreliable and that none of the above conditions describes the nature of the problem. Status Flags Provides information on the condition of the value of the current event. The condition can be one of the following: • InAlarm – Indicates that the event state has a value other than NORMAL. • Overridden – Indicates that a local device has manually overridden the object. • Fault – Indicates that the Reliability has a value other than NoFaultDetected. • OutOfService – Indicates that the object is disabled. Transition Time Note: These Transition Time fields appear only on controllers that support the BACnet Standard protocol revision 4. Displays the day/time when objects in the object property list (Configuration tab) transition from one value to another. Previous — Displays the last day/time objects transitioned (changed) from one value to another. Next — Displays the next day/time that objects will transition
- 412. TAC400 Editor Attribute Meaning (change) from one value to another. Following — Displays the day/time, following the next transition, that objects will transition (change) from one value to another. Note: See also Proprietary Schedule Properties for Programs, below. SetValue Check the Out Of Service checkbox when you want to assign a fixed value to schedule event — when you do not want to compute the value from the weekly schedule, exception schedule, or schedule defaults. When this box is not checked, the fields are not selectable. Proprietary Schedule Properties for Programs Andover Continuum BACnet controllers support proprietary Schedule-object properties that are used in Plain English programs to optimize the start and stop times for scheduled events in HVAC systems. These proprietary properties are based on scheduled occupancy times — for example, when rooms need to be prepared with heating before occupancy or when lights need to be shut off after occupancy. Note: See also the Transition Time fields on the Current State tab. The properties are: Property Identifier Meaning PreviousTransitionTime 512 The time when the Schedule's Present_Value most recently changed value NextTransitionTime 513 The time when the Schedule's Present_Value is next scheduled to change value after the time indicated by Next_Transition FollowingTransitionTime 514 The time when the Schedule's Present_Value is next scheduled to change value after the time indicated by Next_Transition These properties are unsigned integer values, each giving a date and time expressed as the number of seconds. Plain English, which specifies the behavior of Program objects, can compare these times with the present time and compute time intervals. In a Plain English program, the value of the each property would be specified as follows: ScheduleName PreviousTransitionTime ScheduleName NextTransitionTime ScheduleName FollowingTransitionTime
- 413. Andover Continuum CyberStation Configurator’s Guide 401 where ScheduleName is the name of the Schedule object, whose event start and stop times are being computed. Each transition indicates a scheduled change in the value of the Schedule's Present_Value property. These values are stored as, and can be read or written as, InfinityDateTime objects. Note: In a Plain English program, the ReadProperty function can be used to retrieve the values of these properties. (These properties are read-only.) When determining a transition, time-value pairs that specify the same value as the Schedule's PresentValue (that do not change the value) are not considered transitions. Similarly, if two or more time-value pairs have the same time, only the last pair with that time is used for determining a transition. For more information on Plain English, please see the Plain English Language Reference, 30-3001-872, and the Continuum online help. Mass Create – Populating Devices with a Schedule Using the Schedule editor's Mass Create tab, you may immediately copy and distribute (populate) this Schedule object to other devices on your system. This is very useful when other controllers throughout your system need to use this schedule. In the Schedule editor, click the Copy button to expose expose the Mass Create tab and Mass Change tab, appended to the right side of the editor. These tabs are normally hidden, as shown below:
- 414. TAC402 When you click the Copy button, the tabs become visible, as shown below: To expand and retract the width of the Mass Create/Mass Change tabs, place your cursor on the left border of the tab area until it becomes a double-arrow cursor. Drag this cursor left or right to expand or retract, respectively. When the tab area covers part of the Yearly, Weekly, or Daily view, as shown above, use the horizontal scroll bar to see the right side of the view. To close the Mass Create/Mass Change tab area, click the X button, located in the upper-right corner of the tab area. As the tab indicates, there are three general steps for populating a schedule: • Search for controllers you want to populate. • Select the controllers to receive this schedule. • Populate (distribute) the schedule to the selected controllers. To “mass create” a schedule, follow this procedure: 1. On the Mass Create tab, in the search field of Step 1 (Search for devices to populate with this schedule), use the wildcard asterisk to enter an alphanumeric string contained in the paths of controllers that need to have this schedule. For example, *fan* would list all the controllers whose paths have the string "fan". Note: If you want to list all controllers, and not narrow the list, leave this field blank (with just the asterisk). 2. Click the Search button. Based on what you enter in the search field, controller paths are listed under the Device column in the window of Step 2.
- 415. Andover Continuum CyberStation Configurator’s Guide 403 Note: If your schedule is created on a BACnet controller, BACnet devices are listed. Likewise, if it is created on an Infinity controller, Infinity devices are listed. 3. In the list, highlight (select) one or more controllers with which you want to populate this schedule. Also: To select them all, right click a controller and choose Select All from the popup menu. To deselect them all, right click a controller and choose Select None from the popup menu. To remove entries from the list, highlight them and click the Remove button. (Or you may right click an entry, and select Remove Devices from the popup menu.) Adding a controller to the list — To add device entries to the list, click the Add button (or right click an entry and select Add Devices). The Selection dialog appears. Note: As an alternative you may also drag and drop device objects from Continuum Explorer to the member object list window. From the Selection dialog, search for and select the device objects you want to add. Use the Objects of type dropdown menu to select the object class you want to add: InfinityController, InfinityInfinetCtrl, or Device. Only objects of that object class type appear. (For Infinity schedules, the Device object is not available in this dropdown menu.) Click the Select button. The paths of the newly added objects appear in mass-create list. Note: In the Selection dialog, you may use the network view button, folder-view button, and other buttons, as well as the Folder dropdown menu to expose the tree (as you would in Continuum Explorer) to adjust view of directory paths and available objects. Click the Populate button (Step 3). The schedule is copied to the selected devices in the list. Note: Look at the Status column in the list in Step 2. For each list member, this column states whether the population process has succeeded or failed. If the process fails — If the process fails, some possible explanations are: • One or more controllers are offline. • The schedule contains a Calendar object reference and you are attempting to populate a BACnet controller that does not support Calendar objects. • You are attempting to copy a schedule to your own controller (the one on which the schedule was created). • You are attempting to copy a schedule to a controller that does contain the objects listed in the Object Property List of the Configuration tab (BACnet) or that does contain the attached Occupancy Point object of the Configuration tab (Infinity).
- 416. TAC404 Mass Change – Updating Multiple Schedules Note: In the Schedule editor, click the Copy button to expose expose the Mass Create tab and Mass Change tab, appended to the right side of the editor. These tabs are normally hidden. For details on expanding and collapsing these tabs in the editor, please see the previous section, Mass Create. Using the Schedule editor's Mass Change tab, you may immediately copy your Schedule configuration to other Schedule objects on your system, thereby "updating" them. This is very useful when other schedules require the exact same events, special calendar days, attached objects, and so on. Click the right-arrow button in the right-hand corner of the editor to expose the Mass Change tab (along with the Mass Create tab) appended to the right side of the editor: As the tab indicates, there are three general steps for updating a schedule: • Search for schedules you wish to update. • Select the schedules whose configurations need to be updated. • Update the selected schedules by copying (overwriting) this schedule's configuration over theirs. To “mass change” a schedule, follow this procedure:
- 417. Andover Continuum CyberStation Configurator’s Guide 405 1. On the Mass Change tab, in the search field of Step 1 (Search for schedules to update), use the wildcard asterisk to enter an alphanumeric string contained in the paths of schedules that need to be updated. For example, *sched* would list all the controllers whose paths have the string "sched". Note: If you want to list all schedules, and not narrow the list, leave this field blank (with just the asterisk). 2. Click the Search button. Based on what you enter in the search field, schedule paths are listed under the Device column in the window of Step 2, and the names of those Schedule objects listed under the Schedule Name column. 3. In the list, select one or more schedules you want to update. Also: To select them all, right click in the list and choose Select All from the popup menu. To deselect them all, right click in the list and choose Select None from the popup menu. To remove entries from the list, highlight them and click the Remove button. (Or you may right click an entry, and select Remove Devices from the popup menu.) To edit any schedule in the list, right click the schedule you want to edit, and select Edit Schedule from the popup menu (or simply double click the schedule). The Schedule editor for that schedule appears with its current (last-saved) configuration. If at any time you wish to return to the original (previous) original schedule, click the Return to path at the bottom, beneath Step 3. Adding a schedule to the list — To add schedule entries to the list, click the Add button (or right click an entry and select Add Schedules). The Selection dialog appears. Note: As an alternative, you may also drag and drop Schedule objects from Continuum Explorer to the member object list window. From the Selection dialog, search for and select the Schedule objects you want to add. Only objects of object class type, Schedule, appear. Click the Select button. The paths of the newly added objects appear in mass- change list. Note: In the Selection dialog, you may use the network view button, folder-view button, and other buttons, as well as the Folder dropdown menu to expose the tree (as you would in Continuum Explorer) to adjust view of directory paths and available objects. 4. Click the Update button (Step 3). Your schedule configuration overwrites the configurations of the selected schedules in the list.
- 418. TAC406 Note: Look at the Status column in the list in Step 2. For each list member, this column states whether the update process has succeeded or failed. Calendars and the Calendar Editor Calendar is a standard BACnet class object. A Calendar object is typically used with and referenced by Schedule objects. You use Calendar simply to select a day on a yearly view of a calendar, as you would according to the BACnet standard. Specifically, via the Calendar Entry dialog, you establish: • A single-day • A range of dates • A recurrence of a day You create a Calendar object on an Infinity b4920, b40xx series, or b3 controller, in the Infinity view of the Continuum Explorer. A Calendar object, like other BACnet objects on the Continuum system, is placed in both an Infinity Calendar class folder beneath the b4, b40xx series, or b3 controller, and in a BACnet Calendar class folder beneath its corresponding b4, b40xx series, or b3 controller in the BACnet view. Note: In the BACnet view, you may create a Calendar object on a third-party BACnet device, but not on an Andover Continuum BACnet device. Note: Some BACnet controllers support a Schedule but do not support a Calendar. Others support both objects. Infinity legacy (non b4 and b3) controllers support Schedule objects, but not Calendar objects.
- 419. Andover Continuum CyberStation Configurator’s Guide 407 Adding or Removing a Calendar Entry The Calendar editor's right-hand pane displays a yearly calendar on the Yearly View tab. The left-hand pane contains a Date List tree: The Date List tree lists all established dates single days, ranges of days, and recurring days and identifies them in the list with the following icons: Single day Range of days Recurring days Note: Dates listed in the Date List appear in light blue on the calendar. If you select a day in the Date List, it appears in yellow on the calendar. The Present Value field displays the current value of the Calendar object. Enter a description of the Calendar object in the Description field. Adding and Removing a Single Day via Calendar Click — You may add a single day to the Date List by clicking once on an individual day on the calendar. The single day entry immediately appears in the Date List.
- 420. TAC408 Note: When you add a day in this way, notice its entry is not named in the Date List. To name it, right click its new Date List entry, and from the Calendar Entry dialog, enter a name in the Name field. (Or in the tree, you may simply click inside its empty name field and enter a name the way you would for a file in Microsoft Windows Explorer.) Note: You may also use the yearly calendar to assign two or more individual (non consecutive) dates. Hold down the CTRL key, and click (highlight) the individual days you wish to assign. Right click, and proceed as described, above. You may also remove a day by clicking once on a single established "red" or "blue" day on the calendar. When you do so, you are asked: Do you want to remove all calendar entries that reference this date? Click Yes to remove the date or No to keep it. Adding Calendar Entries via Calendar Entry Dialog — Add a single day, range of days, or recurring days, using the Calendar Entry dialog. To add an entry: 1. Click the New Calendar Entry button, or right click an entry in the Date List, and select New Calendar Entry. The Calendar Entry dialog appears. 2. In the Entry Type section, select one of the following radio buttons. Date Range of dates Recurrence Notice the calendar data fields on the right side of the dialog are different for each selection. 3. Enter the desired information in the calendar data fields on the right side of the dialog. These fields are self-explanatory. For range, enter a starting and ending date. Note: You may also use the yearly calendar to assign a range of days. In the yearly view, click and hold the mouse button on the first day of the range (for example, February 15). Drag the cursor on the calendar to the last day of the range (for example, February 22). The range (February 15...22) is highlighted. Enter a name by editing its calendar entry in the Date List. For recurrence, enter a recurring weekday for a particular month. For example, if you were defining "Thanksgiving," you could choose Last, Thursday, and November. 4. In the Name field, enter a name or description of the day, range, or recurrence entry. This name appears for this entry in the Date List. 5. Click OK. The new entry is added to the Date List.
- 421. Andover Continuum CyberStation Configurator’s Guide 409 Editing or Removing an Entry via Date List — To edit an existing entry, right click the entry, and select Edit from the popup menu. The Calendar Entry dialog appears for that entry. Modify the data as needed. To remove an entry from the Date List tree, right click the entry, and select Remove from the popup menu. The entry is immediately removed from the tree and the calendar view.
- 422. TAC410
- 423. Andover Continuum CyberStation Configurator’s Guide 411 Configuring Loops Overview A Loop is a BACnet standard object that allows you to create a feedback system without manually creating or editing Plain English code. The loop feedback system is comparable to cruise control for a car. Just as cruise control automatically adjusts variables to maintain the desired speed, the loop object automatically adjusts input values to achieve the desired setpoint and remain at the setpoint indefinitely. The ultimate goal is for the input to reach the setpoint in the shortest amount of time possible. It does so by using a PID (Proportional, Integral, and Derivative) control algorithm. The controller obtains the value of the input when it polls the current value of the input reference (sensor, valve, and so on.). Then, the controller uses the PID algorithm to adjust the input to come as close as possible to the setpoint. The result of the PID algorithm determines an output that is then assigned to the output reference, or an object whose values control such things as sensors and dampers. The controller continues to alter the value of the output to maintain the input value at the value of the setpoint. The error, or the difference between the input value and the setpoint value, is used to adjust the output value. The PID algorithm uses the error's value to measure how much the loop should be adjusted. The Tuning tab gives you the opportunity to adjust these values or to tune the loop to fit your particular preference. You create a Loop-object feedback system using the Loop editor and its tabs. Using the General tab, you can monitor and alter the current state of the loop. The Tuning tab also contains a dynamically updating graph that displays loop, output, input, and setpoint values as they change over time. This tab is interactive because you can tune the loop and customize the graph to your liking. This chapter presents the following topics: • General Tab • Tuning Tab • What Is PID? 16
- 424. TAC412 • Tuning the PID Loop • Customizing the PID Graph • Basic Alarms Tab and Advanced Alarms Tab General Tab The General tab allows you to view and/or alter the current state of the loop object. Note: All output-reference, setpoint-reference, and input-reference values are references to objects that were originally created either as points on Andover Continuum controllers, or as BACnet objects on third-party BACnet controllers.
- 425. Andover Continuum CyberStation Configurator’s Guide 413 The following table describes the attributes on the General tab. Editor Attribute Meaning Description Enter up to 32 characters including spaces to describe the loop. Units From the dropdown menu, select the type of units desired for the output value. Present Loop Value Displays the result of the most recent PID calculation. This value is used to set the output reference object and the priority defined by the present pool priority. Present Output Value Displays the present value of the output reference object. This value is usually equal to the present loop value. However, if the output reference object is commanded at a higher priority or disabled (out of service) then the present value of the output may have a different value. Present Loop Priority Specify the desired BACnet command priority of the Loop object. Present Output Priority Displays the BACnet command priority of the object (output reference) to which the loop is writing. This command priority is configured within the individual BACnet object, in its object editor. Output Reference Select the object/attribute to which the loop writes. Using the browse button, search for and select the object. Then select an object attribute, such as Value, from the dropdown menu. The attributes that appear in the menu vary, according to the object that is selected. Note: The Index field is read-only and the user cannot alter the value. See also Index below. Input Value Displays the current value of the input reference object Input Reference Select the object from which the loop obtains the current value. Using the browse button, search for and select the object. Then select an attribute from the dropdown menu. The attributes that appear in the menu vary, according to the object that is selected. Index This field allows you to specify the element of a BACnet array property. If you select an array as the input reference (PriorityArray from the dropdown menu) the Index field enables and allows you to reference a specific element of the array. Specify the array element by selecting the up and down arrows or by entering the desired array-element number.
- 426. TAC414 Editor Attribute Meaning Setpoint If you prefer to enter a specific setpoint value for this loop, select this radio button. When you select this button, the field enables and the Setpoint Reference fields (see below) disable. In this Setpoint field, you can only enter numeric values. Numbers with decimals are acceptable entries. Setpoint Reference If you prefer instead to reference an object whose value becomes the loop's setpoint, select this radio button. When you select this button, the fields enable and the Setpoint field (see above) disables. Click the browse button, and search for and select the object whose property value become the setpoint. Use the dropdown menu to select the type of property. The properties that appear in the menu vary, according to the object that is selected. Index This field allows you to specify the element of a BACnet array property. If you select an array (the PriorityArray attribute from the dropdown menu) the Index field enables and allows you to reference a specific element of the array. Specify the array element number by using the up and down arrows or by simply entering a number. Update Interval Enter the time (in milliseconds) the PID loop should wait before re-evaluating its output. Note: Do not make this value too small because you want to give the environment a chance to react to the output. If the loop updates the output too frequently, the equipment can burn out. Check the manufacturer's recommendations to avoid causing harm to the equipment. Out of Service Check this checkbox to indicate that the loop object is out of service and has lost communication with its attached device. Putting the point out of service is a good way to test the point and the functions that rely on it. You can simulate various situations by manually changing the value or reliability attributes. This allows you to see how associated functions react to these changes.
- 427. Andover Continuum CyberStation Configurator’s Guide 415 Editor Attribute Meaning Status Provides information on the loop's condition. The condition can be one of the following: • InAlarm -- Indicates that the Event State attribute has a value other than NORMAL. • Overridden -- Indicates that a local device has manually overridden the point. • Fault -- Indicates that the Reliability property has a value other than NoFaultDetected. • OutOfService -- Indicates that the point is disabled. Reliability Provides an indication of whether or not the controller has detected a malfunction that might compromise the integrity of the loop's present value. The attribute can read one of the following: • NoFaultDetected -- Indicates that the present value is reliable and that no fault is detected. • OpenLoop -- Indicates that the connection between the point and the device is providing a value resulting from an open circuit. • UnReliableOther -- Indicates that the controller detects an unreliable present value, and that none of the above conditions describes the nature of the problem. More About an OpenLoop State – Here are some conditions that could cause an OpenLoop state: The Controlled_Variable_Reference or Manipulated_Variable_Reference properties reference an AnalogInput or AnalogOutput, where the Channel (Infinity property) is not configured. This causes the Out_Of_Service property for the AnalogInput or AnalogOutput to always have a value of True, which in turn causes the Loop's Reliability property to have a value of OpenLoop. • The Present Loop Value is different than the Present Output Value, after the Loop updates the output value. This can occur when the output value (Manipulated_Variable_Reference) is currently commanded by another process at a higher priority than that at which the Loop writes. This could be a common occurrence when the Loop is configured to write to the Present_Value property of an object that has a priority array, and the Loop is writing at a lower priority than something else.
- 428. TAC416 Editor Attribute Meaning • When the Loop is initially configured and saved, the Reliablility property may initially be displayed as "OpenLoop", even though it is properly configured. If the editor is refreshed (generally within a few seconds) the Reliablity property should change to NoFaultDetected. Note: The editor only shows the Priority Array attribute in the Input and Setpoint Reference dropdown menus if the reference is an AnalogValue. The dropdown menu also displays all attributes that are float values; therefore, it might show attributes that the controller does not support. Tuning Tab The Tuning tab contains all the PID (proportional, integral, derivative) loop variables. It also contains a dynamically updating graph that displays loop, output, input, and setpoint values as they change over time. This tab is interactive. That is, you can tune the loop and customize the graph to your liking. Before Version 1.73, Continuum users created Plain English programs to set the PID gain constants and tune the loop. Now you can accomplish these tasks via the Tuning tab. (See also What Is PID? later in this chapter.)
- 429. Andover Continuum CyberStation Configurator’s Guide 417 Editor Attribute Meaning Loop Value Check this checkbox to display the loop value on the graph. Click the Loop Value hyperlink to bring up the Graph Configuration dialog, where you can customize the graph's Loop plot properties. Using the dialog's navigation tree, you can click Output, Input, or Setpoint to switch to those plot properties, respectively. Click Display to show the graph's display properties. The Loop Value field is read-only and cannot be changed. See Customizing the PID Graph, later in this chapter. Output Value Check this checkbox to display the output value on the graph. Click the Output Value hyperlink to bring up the Graph Configuration dialog, where you can customize the graph's Output plot properties. Using the dialog's navigation tree, you can click Loop, Input, or Setpoint to switch to those plot properties, respectively. Click Display to show the graph's display properties. This field is read-only and cannot be changed. See Customizing the PID Graph, later in this chapter. Input Value Check this checkbox to display the input value on the graph. Click the Input Value hyperlink to bring up tthe Graph Configuration dialog, where you can customize the graph's Input plot properties. Using the dialog's navigation tree, you can click Loop, Output, or Setpoint to switch to those plot properties, respectively. Click Display to show the graph's display properties. This field is read-only and cannot be changed. See Customizing the PID Graph, later in this chapter. Setpoint Value Check this checkbox to display the setpoint value on the graph. Click the Setpoint Value hyperlink to bring up the Graph Configuration dialog, where you can customize the graph's Setpoint plot properties. Using the dialog's navigation tree, you can click Loop, Output, or Input to switch to those plot properties, respectively. Click Display to show the graph's display properties. This field is read-only and cannot be changed. Note: In order to change the value of the setpoint, go to the General tab and change the value. Select the Apply button to activate the value change.
- 430. TAC418 Editor Attribute Meaning Maximum Loop Value Enter the maximum value that the PID algorithm can assign to the loop. If the output should never go above a certain value, set the limit in this field. Minimum Loop Value Enter the minimum value that the PID algorithm can assign to the loop. If the output should never go below a certain value, set the limit in this field. Poll Frequency Specify the number of seconds the graph should wait before polling the controller for the new setpoint and input values. Sample Size Select the intervals of time for the X axis. The maximum sample size is 10; the larger the sample size, the more points the graph displays. Note: Non-default values that you select for Poll Frequency and Sample Size take effect immediately, as you manipulate a live graph in real time while the Loop editor is open. Non-default values cannot be saved they revert back to the default values when you close the Loop editor because these attributes are technically not part of the Loop object. When you change these values, the Apply button does not become selectable. The Graph The graph displays the effects the PID algorithm has on the input, output, and setpoint values. The graph dynamically shows how the values you assign to the proportional, integral, and derivative constants alter the value of the loop. To start the graph, right click the graph and select Start from the popup menu. Double-click the graph (or right click the graph and select Maximize from the popup menu) to maximize the graph into its own separate window. You can also customize the graph configuration by right clicking the graph and selecting the Display from the popup menu. Capturing the Graph: You may capture a screenshot of the current graph (create a graphic file) by right clicking the graph and selecting Save Screenshot. This feature makes it easy to distribute the graph to others and to illustrate documents. See Customizing the PID Graph, later in this chapter. Proportional Specify the value for the proportional constant in the Value field and select the type of units from the dropdown menu Integral Specify the value for the integral constant in the Value field and select the type of units from the dropdown menu. Derivative Specify the value for the derivative constant in the Value field and select the type of units from the dropdown menu.
- 431. Andover Continuum CyberStation Configurator’s Guide 419 Editor Attribute Meaning Error This field displays the difference between the input and the setpoint. Last Error This field displays the previous difference between the input and the setpoint. Bias The bias is the amount of the initial value of the output reference. If the PID algorithm produces a value of X, then the final value of the loop will be X plus the bias. For example, if the valve starts at 10% open, as opposed to 0, you have to add that initial value (the bias) to the value of the loop. Action Select one of the following from the dropdown menu. • Direct — Select this when you want an increase in the output value to cause an increase in the input value, and vice versa. For example, select this option if the valve must open in order to increase the temperature. • Reverse — Select this when you want an increase in the output value to cause a decrease in the input value, and vice versa. For example, select this option if the valve must close in order to increase the temperature. What Is PID? Note: In order to tune a loop, you should already have some experience with PID and feedback loops. PID control refers to three types of control actions that are used in the process of modulating equipment, such as valves, dampers, and variable-speed devices. It is essentially a balancing act between the Proportional, Integral, and Derivative controls to reach the desired setpoint. These three types of controls are defined as follows: • Proportional - Control based on how far the input is away from the setpoint. • Integral - Control based on the average error over time. (The error is the • difference between the input and the setpoint.) • Derivative - Control based on how quickly the input is approaching the setpoint. PID control combines the three types of control actions, which improve control accuracy and lessens the time it takes for the input to reach the setpoint. Note: The input is also referred to as the controlled variable because it is the environmental factor you want to control. Proportional Control Proportional control produces a control signal based on the difference between an actual condition and a desired condition — for example, the difference between the actual temperature and the setpoint. The controller sends a signal that is directly proportional to this difference, or the error. (the difference between the input and the setpoint). Although
- 432. TAC420 simple and fast, proportional action alone produces a small amount of error, or an "offset," which prevents the system from reaching the desired setpoint. The Proportional control algorithm is as follows: Proportional = Kp * Err where Kp is the Proportional Gain and Err is the error (the difference between the input and the setpoint) Proportional Integral (PI) Control PI control sums the error over time, or takes the integral of the error. By adding the value of the last error to the proportional signal, the control loop produces a control action over time. In turn, the current value moves closer to the setpoint value. Combining proportional and integral actions reduces offset error but produces a different kind of error overshoot. Essentially, the integral action overcompensates, causing the value to go past the setpoint. This is called the "overshoot." Another limitation to the PI control is that the algorithm produces a problem called "integral windup." Integral windup occurs when the output and input reach their maximum values and cause a large error to exist. This persistent error causes the sum of errors to become very large, and this, in turn, requires a large error in the opposite direction to bring the sum back to zero. Integral windup is detrimental because the equipment is forced to stay at its extreme for long periods of time, which impacts comfort and results in a waste of energy. The PI algorithm is as follows: PI = Ki * ∑Err δTime where Ki is the Integral Gain, ∑Err is the sum of errors since the error became greater than the threshold, and δTime is the change in error since the last PID update. Proportional Integral Derivative (PID) Control Derivative action provides an additional control action that anticipates the difference between the current and desired conditions. The derivative action significantly reduces overshoot by counteracting the result of the proportional and integral algorithm. To reduce the overshoot, derivative action determines the rate of change of the error. The controller then uses this derivative to pace the device, producing a more stable output. The PID algorithm is as follows: Output = (Kp * Err) + ( Ki * ∑Err δTime) + (Kd * δErr / δTime) + Bias where Output is the output of the controller, Kp is the Proportional Gain, Err is the error (the difference between the input and the setpoint), Ki is the Integral Gain, ∑Err is the sum of errors since the error became greater than the threshold, δTime is the change in error since the last PID update, Kd is the Derivative Gain, δErr is the change in error since the last PID update, and the Bias is the offset adjustment parameter.
- 433. Andover Continuum CyberStation Configurator’s Guide 421 Tuning the PID Loop The process of setting values to the Proportional, Integral, and Derivative (PID) gain constants is called tuning the PID loop. (See Tuning Process below.) Tuning configures a feedback loop so that the input value reaches the setpoint value in the shortest amount of time possible. You perform this configuration by entering values in the Loop editor's Tuning tab. The Tuning tab also includes a dynamic graph that displays the realtime changes in the loop's values. PID control tells the controller how much to adjust an output reference, such as a valve or damper setting, so that the setpoint value is reached in the shortest amount of time possible. (See also Loop Tuning Hints later in this chapter.) Note: To ensure a more effective result, it is recommended you test the loop before starting the actual tuning process. By testing the loop performance, you can avoid any problems that may arise when actually tuning the loop. Check the Out of Service checkbox on the General tab to test the loop without affecting the actual components. Tuning Process Note: In order to tune a loop, you should already understand PID and have some experience with feedback loops. The most common method for tuning the loop is the process of trial and error — that is, tuning while observing the response to setpoint changes. After specifying objects/attributes for the Output, Input, and Setpoint sections on the General tab, perform the following procedure. To tune a PID loop using the Loop editor, follow this procedure: 1. Modulate the output. That is, determine how often the controller should update the output. Enter a value in the Update Interval field on the General tab 2. Set the action of the output reference. Select either Direct or Reverse from the Action field's dropdown menu on the Tuning tab. 3. If you wish to enter an initial value for the output reference, insert the value in the Bias field on the Tuning tab. 4. Enter the PID gain constants into the corresponding fields on the Tuning tab. One way to ensure a steady control is to enter a value in the Proportional field and leave the Integral and Derivative values at 0. After you see the resulting output change on the graph and in the other fields on the Tuning tab, modify the integral and derivative gains until you achieve the result you want. Try entering the initial integral value for the integral gain and reduce the value until you achieve a steady loop. Do the same for the derivative value. Note: The value of the proportional gain constant is usually 1.0 or below.
- 434. TAC422 Loop Tuning Hints Here are some general tips that might help you tune a loop: • Eliminate the bias when the output is being ramped from the start point. The ramping acts as a slowly increasing bias. • Eliminate the Derivative gain PID control loops that produce setpoint reset signals. For example, eliminate the derivative gain if a room temperature control loop resets the supply air temp setpoint or VAV flow setpoint. It is important to reset setpoints smoothly and slowly to reduce erratic secondary control responses. • Some control loops cannot be accurately tuned by simply manipulating gain factors. There are other factors that influence the accuracy of control loops. Some of these factors are as follows: o The controlled device (or output reference), such as a damper or a valve, must be sized properly. o The difference between the controlled variable and the controlled medium cannot be too extreme. For example, the control loop could be compromised if you are attempting to control a reheat coil for a 70- degree leaving air temp when the hot water supply temperature is 210 degrees and the entering air temperature is 68 degrees. o The sensor SPAN must be small enough to be sensitive to the application while no conditions fall outside the range's minimum and maximum values. o The sensor position should be in a location that best represents the average of the application. For example, duct temperature sensors should not be located close to heating coils to avoid heating by radiation. Customizing the PID Graph You can customize the "look and feel" of the graph displayed on the Tuning tab of the Loop editor to suit your own personal tastes. Specifically, using the Graph Configuration dialog, you can: • Alter the display configuration • Alter the plot configuration
- 435. Andover Continuum CyberStation Configurator’s Guide 423 Here are some examples of what a plotted graph looks like:
- 436. TAC424 Copying a Graph Configuration After customizing your graph, you can copy the graph configuration to another Loop object. To do so, follow this procedure: 1. From the Tuning tab, right click the graph. 2. From the popup menu, select Copy then To. 3. Choose the To option from the submenu. 4. Search for and select the Loop object to which you wish to copy the graph. When you create a new Loop object, you can also copy a graph configuration from an existing Loop object into the new Loop object. To do so, follow this procedure: 5. Create a new Loop object, and select the Tuning tab. 6. Right click the graph. 7. From the popup menu, select Copy, then From. 8. Search for and select the existing Loop object from which you want to copy a graph. 9. Search for and select the Loop object to which you wish to copy the graph.
- 437. Andover Continuum CyberStation Configurator’s Guide 425 Altering Display Configuration via Graph Configuration Dialog To alter the graph's display properties, right click the graph, and select Display from the popup menu. The Graph Configuration dialog for display appears. The following table describes the attributes of the four major sections of the dialog. Editor Attribute Meaning Graph Properties In the Name field, enter up to 32 character (including spaces) to describe the graph. Enter the minimum and maximum values for the Y-axis in the Minimum and Maximum fields. The Scroll Direction dropdown menu allows you to select the direction from which the new value plots move on the graph — Right to left or Left to right. Check the appropriate checkbox to display the following: Display values on mouse over -- When this box is checked, you may move your mouse cursor over a plot on the graph to display a text tooltip that lists the current values for Loop, Output, Input, and Setpoint. Each entry appears in its designated color. Display grid -- When this box is checked, the grid appears on the graph. If the box is not checked, no grid appears. Update y axis min and max values dynamically -- When this box is checked, the graph dynamically updates a range of values displayed on the Y axis, based on the minimum and maximum values currently plotted. To show all minimum/maximum values, check the "Display all min max values along the y axis" box.
- 438. TAC426 Display notches along the x and y axis -- When this box is checked, notch lines protrude on the outside of the X and Y axes where the grid lines meet the axis lines. Display all min max values along the y axis -- When this box is checked, the speciified minimum and maximum values (specified in Minimum and Maximum fields) appear on the Y axis. This checkbox is selectable only if the "Display notches along the x and y axis" box is checked. Colors Customize the colors of the Background, Foreground, Axis, Text, and Grid by clicking the browse button next to the corresponding field. Using the color-palette dialog, select the desired color and click the OK. The color appears in the field. X-Axis Properties Enter the X-axis label in the Name field. Select the desired number of grid columns in the Columns field by clicking the up and down arrows or by entering the number manually. Similarly, in the Label Interval field, choose the number of intervals between the labeled time increments on the X-axis. Click the up and down arrows to specify an amount or enter the number manually. Y-Axis Properties Enter the Y-axis label in the Name field. Select the desired number of grid rows in the Rows field by clicking the up and down arrows or by entering the number manually. Similarly, in the Label Interval field, choose the number of intervals between the labeled time increments on the Y-axis. Click the up and down arrows to specify an amount or enter the number manually.
- 439. Andover Continuum CyberStation Configurator’s Guide 427 Altering Plot Configuration via Graph Configuration Dialog To customize the graph for specific plots, bring up the Graph Configuration dialog in one of the following ways: • On the Tuning tab, click the hyperlinked colored text of the plot you wish to configure: Loop Value Output Value Input Value Setpoint Value • Right click the graph, and select Plot Properties. The Graph Configuration dialog appears. Depending on which plot you want to configure, select one of the following from the popup menu: Input Value Setpoint Value Loop Value Output Value The Graph Configuration dialog for plots appears. Using the navigational tree on the left-hand side of the dialog, you can expand Plot, and switch from one plot configuration to another.
- 440. TAC428 The following table describes the attributes of the four major sections of the dialog. Editor Attribute Meaning Plot Properties In the Label field, enter up to 32 characters (including spaces) to describe the plot. In order to specify the minimum and maximum values for the plot check the appropriate checkbox. The Minimum and Maximum fields will enable and allow you to enter in the limits. Check the Update this plots min and max values dynamically checkbox to automatically update the plot based on the minimum and maximum values. This checkbox is only enabled if the Specify this plots min and max values checkbox is selected. Line Properties Change the color of the line by clicking the browse button and then selecting a specific color from the dialog. Click the OK button to finalize the change. Assign a style to the line by selecting an option from the corresponding dropdown menu. Specify the width of the line by clicking the up and down arrows or by entering the number manually. Point Properties Change the color of the point by clicking the browse button and then selecting a specific color from the dialog. Click the OK button to finalize the change. Assign a style to the point by selecting an option from the corresponding dropdown menu. Specify the width of the point by clicking the up and down arrows or by entering the number manually. Border Properties Change the color of the border by clicking the browse button and selecting a specific color from the dialog. Specify the width of the border by clicking the up and down arrows or by entering the number manually.
- 441. Andover Continuum CyberStation Configurator’s Guide 429 Basic Alarms Tab and Advanced Alarms Tab The Basic Alarms tab is where intrinsic alarms are defined specifically for this object. Note: This is enabled for some BACnet objects attached to third-party BACnet devices. It is not currently supported on Andover Continuum BACnet controllers. The information here determines when the alarm will go off, and what happens when it does. Information that determines what happens when the alarm goes off is built into the EventNotification object that you associate with this alarm. The EventNotification object defines how and to whom the alarm is broadcast. Editor Attribute Meaning Event State Displays the value of the To State attribute, which is set by the control system. If you have set up this object to report alarms, this attribute displays Normal when the object is not in an alarm state and OffNormal when it is. If you have not set up the object to report alarms, this attribute always displays NORMAL.
- 442. TAC430 Editor Attribute Meaning Acknowledge Received For Displays the value of the Acknowledge Received For attribute. Displays ALARM, FAULT, or NORMAL if acknowledgements have been received for reported alarms, faults, or return-to- normal events, respectively. These values display only if both of the following conditions are true: • You have selected the report options for these events. • The associated Event Notification object requires acknowledgement for these events. COV Increment Specify a COV increment, or the minimum change in the present value, for the object. If the difference between the present value and the last present value of the loop is greater then the COV increment, an alarm is sent. Error Limit Enter an error limit for the object. If the current error exceeds the set error limit, an alarm is sent. Time Delay Enter a time delay in seconds. The time delay postpones the alarm for the amount of time you specify. For example, you may decide that the object value can exceed or fall below its boundaries for 30 seconds before the alarm goes off. Using time delays cuts down on the number of active alarms and reduces both system traffic and operator responsibility. Report In the Report section, you may select up to three report options: Alarm, Return to Normal, and Fault. When selected, these options trigger the basic alarm in the following situations: • The Alarm option triggers the basic alarm when the object's Event State changes to OffNormal. • The Return To Normal option triggers the basic alarm when the object's Event State changes to Normal • The Fault option triggers the basic alarm when a local device detects a fault.
- 443. Andover Continuum CyberStation Configurator’s Guide 431 Editor Attribute Meaning Notification Type From the dropdown menu, select a BACnet notification type. The notification type specifies whether the notification message becomes an alarm message, an event message, or a message of event acknowledgement. AlmNotification — Defines the event as type alarm, appearing in the Active Alarm View when the event occurs. EvtNotification — Defines the event as type event, appearing in Active Alarm View when the event occurs. Acks — Defines the event as type ack-notification, appearing in the Active Alarm View when the event occurs. Event Notification Select an Event Notification object by clicking the browse button. The Browse dialog appears. Locate the Event Notification object that you want. Select it and click the Select button. This will insert the correct path and Event Notification name into the Notification class field. The Advanced Alarms tab is disabled for BACnet objects (b4, bCX1, b3, and third- party). They are supported for Infinity (non-BACnet) objects only. See the appropriate Infinity object editor.
- 444. TAC432
- 445. Andover Continuum CyberStation Configurator’s Guide 433 Configuring Trend Logs Overview A TrendLog is an object that allows you to configure the logging of data from other BACnet object property. You can log data on an object/property using one of these methods: • Change of values (COV) — When the object/property value is changed, the TrendLog is notified and another entry is added to the log. (See the General tab on the next page.) • Periodic polling of data — Entries are logged via regular continuous polling of an object/property. (See the General tab.) Each TrendLog object has an internal buffer, stored on the controller, whereby the TrendLog acquires data and stores it in its buffer. (See also the Data tab later in this chapter.) When entries are added to the log, workstations can be automatically notified of new entries, and workstations can automatically download them to their databases. (See also the Basic Alarms tab later in this chapter.) The records in a TrendLog object can also be run as a trend report, displayed in the ReportViewer, after the TrendLog object is specified in the Report editor. (See Chapter 11, Configuring Reports.) It can be launched via the View Report button on the Data tab. 17
- 446. TAC434 General Tab On the General tab, configure basic information for this TrendLog. You also select either of the following logging methods: • Change of Value (COV) • Periodic poll Guidelines for Choosing a Logging Method Here are some guidelines for choosing a logging method. (See also the attribute descriptions in the table below.) • Before choosing a method, perform an assessment of how the data will be changing, how the data will be used, and how much memory each method would use for any given application. • COV is generally more accurate and can be more memory-efficient, depending on how often the logged object reports a COV. BACnet objects (AnalogInput, AnalogOutput, AnalogValue) support a property called COV Increment. You may adjust this value for logged objects, thereby allowing you to control how frequently a COV is reported. • For frequently changing values, periodic polling provides more predictable results. If the COV Increment in the logged object is set to 0 (the default) room temperature readings could produce thousands of records per day. Without changing the COV Increment of the input, periodic polling (for example, every 30 minutes - 48 records per day) is more efficient. Note: Be aware that the Threshold attribute (Conversions tab of InfinityInput object editor – Chapter 13) and the COV Increment property (Basic Alarms tab of the AnalogInput, AnalogOutput, and AnalogValue editors – Chapter 14) have two different effects. Setting the Threshold higher (for example, degrees Fahrenheit) only affects the activity of the present value. It is the setting of the COV Increment higher that reduces the number of COV events in the logged object. • COV is generally a better choice for binary outputs that do not change their values more than a few times per day. With periodic polling, you may not know when the output value changes. For example, if you set polling to occur every 30 minutes, you know only that the output is polled every 30 minutes -- that 48 records are stored each day, even if their value changes, for example, only three times. With COV, you not only have three records stored but also know precisely when those records were stored (precisely when the values changed). • Changing the COV Increment of the logged object (as opposed to changing the COV increment of the TrendLog) is generally better for reducing network traffic. The system filters events at the source, rather than at the TrendLog object, which may reside on an external controller.
- 447. Andover Continuum CyberStation Configurator’s Guide 435 The following table describes the attributes on the General tab. Editor Attribute Meaning Description Enter a description of the TrendLog you are creating. Enabled/Disabled Select Enabled to activate the TrendLog so that it logs entries, or Disabled, to disable all logging. While the TrendLog is an enabled state, some TrendLog properties cannot be modified (for example, Log Buffer Size). Logged Object Click the browse button to search for and attach a BACnet object whose property values you wish to log. The path of the object appears in the field. Logged Property From the dropdown menu, select the logged object's property for which you want to create log entries, using the desired logging method. (See below.) Note: The properties listed in this menu change, depending on which type of object you select, because properties differ from object to object.
- 448. TAC436 Editor Attribute Meaning Index The index dropdown menu allows you to select an array element of a BACnet array property. The integer represents the array element (and a BACnet command priority) whose values you want to log. (This field is not selectable if an array property is not designated as the logged property.) Log Buffer Size This field indicates the maximum number of entries (or records) that you can store in a log. You may change this number only when the TrendLog is disabled. Click Apply, and re-enable the TrendLog after changing the number, to reactivate logging. The default is 10. Some BACnet controllers may implement a limit on this number. If you receive an error when changing the buffer size, the number may exceed the limit set by the controller. In this case, either lower the number in this field or create the TrendLog externally, on another BACnet device. Note: While the TrendLog is enabled, you cannot change this property. Stop Logging When Buffer is Full Check this checkbox if you want to disable logging when this TrendLog's buffer gets full (when it reaches its maximum Log Buffer Size.) To begin logging again, do one of the following, then re-enable the log: • Remove the check here. • Increase the Log Buffer Size. • Clear the content of the log buffer. (See the Data tab.) Change of Value (COV) See also Guidelines for Choosing a Logging Method, above. If you want to log an entry when an object/property's value changes, select this radio button. The controller on which this TrendLog runs uses COV interval and increment values to subscribe to COVs on other controllers. COV Resubscription Interval — The interval, in seconds, at which the COV subscriptions to other controllers are refreshed. The default is 320 seconds. COV Increment — The increment in a value change (the number of units, for example, degrees) that must increase or decrease before a COV is triggered. An increment of 1 appears initially in this field. When the Default checkbox is checked, it defaults to whatever is appropriate for the BACnet controller —
- 449. Andover Continuum CyberStation Configurator’s Guide 437 Editor Attribute Meaning usually 0 or NULL. Note: The values in these fields cannot be changed if this TrendLog resides on an Andover Continuum BACnet controller, only on some third-party BACnet controllers. Periodic Poll See also Guidelines for Choosing a Logging Method, above. If you want to log entries based on periodic polling of the object/property, select this radio button. Log Interval — Enter the frequency at which you want the TrendLog to request the value — the frequency of days, hours, minutes, seconds, and hundredths of seconds. For example, if you want the TrendLog to poll the value every 5 seconds, enter (or use the up/down arrow buttons to select) 05s in the seconds field, and leave all other fields at 0. Enable Start Time If you want logging to begin at a specific day and time, check this checkbox, select a day from the dropdown menu, and use the up/down arrow buttons to select a time. To continue logging indefinitely, without stopping, do not check the Enable Stop Time checkbox. Enable Stop Time If you want logging to stop at a specific day and time, check this checkbox and select a day from the dropdown menu, and use the up/down arrow buttons to select a time. If logging is already underway and you do not need a start time, but do want it disabled at a specific time, do not check the Enable Start Time checkbox. Note: The Timed Activation settings are not based on recurring intervals. That is, you cannot set start/stop times for each day. They simply designate one period of time, one begin time and one end time. Data Tab The Data tab displays the current entries in this TrendLog, as well as general information about the log. It also allows you to filter the logs that are displayed.
- 450. TAC438 Dialog Attribute Meaning Record Count Displays the current number of records in the controller's internal buffer for this TrendLog. Record Count Since Creation Displays the number of records that have been logged since this TrendLog was created. Filter Last Check the Filter checkbox when you want to limit the number of records manually downloaded and displayed in the record list (or "grid") on the lower half of this Data tab. In the Last field, enter (or use the up/down arrows to select) the number of records to download and display in the list. Important: Do not enter a number greater than 4000. The most recent records in a buffer are downloaded to a workstation's database, and the number of records that can be manually downloaded is capped at 4000. Therefore, this means that if a buffer has more than 4000 records, the least recent records residing in the buffer (above the 4000 record count) are never downloaded. Refresh Grid Click this button to refresh the list of records and display the most recent object/property values being logged.
- 451. Andover Continuum CyberStation Configurator’s Guide 439 Dialog Attribute Meaning Clear Records Click this button to remove all records in the TrendLog. View Report Click this button to launch a graphical Trend report in the ReportViewer. The report is a snapshot of contents of the TrendLog buffer. See also Reports and the Report Editor in Chapter 11. List of records The table in the lower half of the Data tab displays records currently residing in the TrendLog's buffer. TimeStamp column displays the date and time the record was logged. StatusFlags column displays a BACnet flag (InAlarm, Fault, Overridden, or Out_Of_Service). These are the logged object's status flags, and they are not always available since a controller may or may not associate these flags with the log record. The flags appear here when they are set (True). For example, if all the flags are False, then the column is empty, even though the Status_Flags property value is stored as part of that record. LogDatum column displays the actual status message that is logged. It could be any BACnet data type, although most controllers only support a few basic ones. LogDatum might also contain messages like "log-disabled," "failure," error messages, and so on. For more information on status flags and LogDatum, please see the BACnet Standard.
- 452. TAC440 Extended Logging Tab This tab displays information about the last time this TrendLog's records were downloaded from its controller to a workstation database. The values displayed here are specific to automatically downloaded records; manual downloads (via the Data tab) do not update this information. Specifically: • Last Download Time — Lists the day and time of the last time a workstation downloaded records from the controller the database. • Last CyberStation to Log Data — Lists the name of the workstation that performed the last download. • Number of records downloaded — Lists the total number of records that the workstation downloaded during the last download.
- 453. Andover Continuum CyberStation Configurator’s Guide 441 Basic Alarms Tab You may configure the way that workstations receive notifications — as well as which workstations to notify — when new records are added to this TrendLog, so that the data is downloaded to each workstation's database. There are two methods for reporting TrendLog data to workstations: • Intrinsic notification — You configure TrendLog notifications using the attributes on this tab, as well as the EventNotification editor, where you specify which workstations to notify. (Please see the table of attribute descriptions below.) Note: Intrinsic notifications are supported only on some third-party BACnet controllers. They are not supported on Andover Continuum BACnet controllers. If intrinsic notifications are not supported in this device, the attributes on this tab are disabled and unselectable. • Algorithmic notification — You configure TrendLog notifications externally (outside the TrendLog editor) using the EventEnrollment editor. (Please see the procedure for configuring algorithmic notifications below.) Note: Algorithmic notifications are supported on Andover Continuum BACnet controllers.
- 454. TAC442 Editor Attribute Meaning Event Notification Using the browse button, search for and attach an EventNotification object to this TrendLog. This EventNotification specifies the workstation recipients to be notified when new records are added to this TrendLog. (Please see the Delivery tab of the EventNotification editor.) Notification Type From the dropdown menu, select a notification type. The notification type specifies whether the notification message becomes an alarm message or an event message in the Active Alarm View. • AlmNotification — Defines the event as type alarm, appearing in the Active Alarm View when the event occurs. • EvtNotification — Defines the event as type event, appearing in Active Alarm View when the event occurs. • Acks — Defines the event as type ack-notification, appearing in the Active Alarm View when the event occurs. Note: Choosing AlmNotification or EvtNotification produces the same result. Acks has no function when it is applied to TrendLogs, and it should be ignored. Notification Threshold Enter the number of new records that must accumulate in the TrendLog before the workstations are notified. When new- record count reaches this number, a notification is sent. New Records Displays the number of new records that have been added to the TrendLog.
- 455. Andover Continuum CyberStation Configurator’s Guide 443 Editor Attribute Meaning Last Notify Record Previous Notify Record Current Notify Record Depending on which revision of the BACnet Standard is supported by the device, this tab displays either: Last Notify Record or: Previous Notify Record Current Notify Record With the latest (2004) revision, Last Notify Record is displayed. With the previous (2001) revision, Previous Notify Record and Current Notify Record are displayed. Last Notify Record displays the number of the last record about which workstations were notified. The record number is the last record received in the notification. For example, if the last record was the ninety-ninth in a series of records, the record number would be 99. Previous Notify Record and Current Notify Record display timestamps, whereby the date/time becomes the actual identify of the record. Current Notify Record is the most recent record received in the notification, and Previous Notify Record is the last record (the one preceding the current record) received in the notification. To Normal / Buffer Ready Events Check the Buffer Ready Event Enabled checkbox to enable the delivery of notifications for this TrendLog. For intrinsic notifications, this box must be checked so that workstations receive notifications according to the threshold and other configuration settings. Note: This is enabled only for third-party controllers that support intrinsic notifications. Active Event State is ready-only. When it is checked it signifies the event state is in a Normal (Return To Normal) state. Last Notification Time is a read-only field that displays the date/time the notification was delivered. Notification Acknowledged is read-only. When it is checked, it signifies that acknowledgements have been received for return-to-normal events.
- 456. TAC444 Editor Attribute Meaning To Fault / COV Failure Events Check the COV Failure Event Enabled checkbox to send a notification if there is a failure with the COV subscription. This is used when Change Of Value has been selected as the logging method. (See the General tab.) Note: This is enabled only for third-party controllers that support intrinsic notifications. Active Event State is ready-only. When it is checked it signifies the event state is in a Fault (To Fault) state. Last Notification Time is a read-only field that displays the date/time a failure notification was delivered. Notification Acknowledged is read-only. When it is checked, it signifies that acknowledgements have been received for the failure events. Configuring Algorithmic Notifications To configure external, algorithmic notification, perform the following procedure, using the EventEnrollment, EventNotification, and Device editors. 1. Create a TrendLog for which you want to configure an algorithmic notification. (Please see the other TrendLog editor help topics.) 2. On the General tab of the EventEnrollment editor, in the Event Notification field, click the browse button, and search for and attach an EventNotification object. (See Chapter 14.) 3. On the General tab of the EventEnrollment editor, in the Object field, click the browse button, and search for and attach the TrendLog object whose records you want to report to workstations, via the attached EventNotification object. When you attach a TrendLog object, the following fields are automatically configured • LogBuffer is entered in the Event Property field. LogBuffer represents the list of records displayed in the Data tab in the TrendLog editor. • Buffer Ready is entered in the Event Type field. • Return to Normal is checked in the Send section. 4. On the General tab of the EventEnrollment editor, from the Notification Type dropdown menu, select a type. Note: This number serves the same purpose as the Notification Type field in the TrendLog editor (intrinsic method). See the description in the tab-attributes table above or in the General tab of the EventEnrollment editor. 5. On the Algorithms tab of the EventEnrollment editor, enter the number of new records that must accumulate in the attached TrendLog before the workstations are notified. When new-record count reaches this number, a notification is sent. When
- 457. Andover Continuum CyberStation Configurator’s Guide 445 Buffer Ready is the Event Type, only one field, Notification Threshold, appears on this tab. Note: This number serves the same purpose as the Notification Threshold field in the TrendLog editor (intrinsic method). 6. On the Delivery tab of the EventNotification editor, specify the workstations to be notified when new records are added to the attached TrendLog. Note: Recipient workstations listed on the Delivery tab must be up and running in order for records to get delivered to the database. If all workstations are CyberStations, then one CyberStation must receive the information. See Chapter 10. 7. On the Preferences tab of the Device editor for each workstation, ensure that preference 21, Download Extended Log data from controllers on the LAN, is set to True. 8. For this device, perform a Send to -> Database operation. Note: Failure to perform this step will prevent Continuum from downloading TrendLog records. 9. During the process, in each editor, be sure to click Apply and/or OK to save your work. See Chapter 14 for more information on the EventEnrollment and Device editors. See Chapter 10 for more information on the EventNotification editor.
- 458. TAC446
- 459. Andover Continuum CyberStation Configurator’s Guide 447 Configuring Areas and Doors Configuring Andover Continuum for Security and Access Control Areas and doors, with personnel, are the central elements of security and access control in the Andover Continuum system. This chapter provides an overview of access control in your Andover Continuum system. It also provides detailed information for configuring areas and doors in CyberStation, and for using two important access-control features, area lockdown and controller condition levels. Chapter 19 provides detailed information about creating and managing personnel information in CyberStation. Key Terms for Access Control Access Validation The process of checking conditions that must be met before a person is allowed into an area. Access validation conditions include, but are not limited to: • Valid site number on the access card • Valid card number • Valid personal identification number (PIN) for keypad entry • Schedules that determine when doors can unlock and for whom 18
- 460. 448 TAC Anti-Passback Violation There are two types of Anti-Passback violations: area based and time based: • Area-based violations occur when personnel attempt access from a non-adjacent area. This could occur if the person tailgated into an area. Adjacent Area objects have at least one common door in their respective lists. As people move through areas, CyberStation keeps track of the last area entered by each person. A person causes a violation when he or she tries to use a door that isn’t in the list of the last known area associated with the person’s card or key code. • The system can be configured to prevent the same card or access code from being used more than once within a pre- determined time to enter the same area. A time-based anti- passback violation is an attempt to use the card or code twice before the anti-passback time configured in the door settings expires. Clearance Level A value assigned in a Personnel object that determines whether a person can access an area based on the condition level in effect for the area. You can assign the same clearance level to all areas to which the person is allowed access, or you can assign different values to different areas for the person. For more information about clearance levels, see “Personnel Clearance Levels and Controller Condition Levels” in Chapter 19, Personnel. Condition Level (not available for all controllers) A controller variable that establishes the security alert level (sometimes called the “threat level”) in effect at doors in areas managed by the controller. The value of this variable is compared to the clearance level for a person seeking access to determine whether access is permitted. Clearance level is defined in Personnel objects. Executive Privilege (not available for all controllers) An attribute you can select in a Personnel object to enable the person to enter or exit areas to which he or she is assigned when those areas are in the Lockdown state. Global Condition Level (not available for all controllers) A CyberStation feature that enables you to send a new Condition Level value to all controllers that support the Condition Level variable. This changes the condition level at all the controllers. Invalid Attempt An attempt to access an area by a person who is: • Not authorized to enter the area • Not authorized by schedule (for example, not authorized to be in the facility at night or on weekends) • Not in the controller or CyberStation database
- 461. Andover Continuum CyberStation Configurator’s Guide 449 Lockdown (not available for all controllers) The state in which doors to an area are locked, and remain locked, until the Lockdown state is cleared. In the Lockdown state, only personnel who are assigned executive privilege access can enter or exit areas to which they have access. This feature helps you quickly control area access in an emergency. Passback The use of an authorized card by more than one person to gain access through a controlled door. For example, the card owner uses the card to gain access, and then "passes back" the card to another person who can use the card to gain access through this or another door. Request-to-Exit (RTE) Device A device, such as a pushbar, motion detector, or button, that is used instead of a card reader or keypad to pass through a door. Supervised Input An input on a controller or expansion unit that monitors the resistance of the device attached to it. If the wiring is tampered with, the resistance of the circuit changes. This change in resistance causes the switch to go into a Trouble state. In CyberStation, you can configure Trouble conditions to trigger alarms. Tailgating The practice of following another person into an area without swiping a card or entering an access code. If an individual has tailgated into an area, the system does not have an accurate record of the individual’s location or of the number of occupants in an area. About Areas, Doors, and Personnel An area is a space that is accessed only by passing through an access control device, such as a card reader or keypad. An area can be accessed through one or more doors. A door is a portal controlled by an access control device, leading to a specific area. Each door becomes part of two different areas, one on each side. One or both sides can be controlled by access control devices. Personnel are the people in your facility who require access to various areas. A Personnel object is a CyberStation object that contains access control information, including access card data, area assignments, and other information, for one person. (Personnel objects can also contain other data, such as employee information, photograph, and personal information.) The controllers use the information in a Personnel object to determine whether the person is allowed access. When you configure a Door object, you assign each of its access control devices to an area. The door name is then included in the Doors to Area tab in the Area editor for that Area object, as shown in the following illustration.
- 462. 450 TAC When you create Personnel objects, you assign the areas to which each person has access. The Personnel object is then included in the People with access tab in the Area editor, as shown in the following illustration.
- 463. Andover Continuum CyberStation Configurator’s Guide 451 The following diagram is an example of how areas and doors can be defined and controlled. Card Reader Lab Outside Door 2 Office Door 3 Lobby Door 1 Request-to- Exit Keypad Glass Break Detector Motion Detector Motion Detector Door 4 Card Reader Lab Outside Door 2 Office Door 3 Lobby Door 1 Request-to- Exit Keypad Glass Break Detector Motion Detector Motion Detector Door 4 In this example, Door 2 has both an entry reader and an exit reader. Personnel must present their access cards to enter and exit the area labeled Lab. They can enter the Office area through Door 3 by typing a code at a keypad. They can exit the Office area to the Lobby area through Door 3 without using a card or keypad entry. They can also exit the Office area through Door 4, which has a Request-to-Exit device. Sequence for Creating Access Control Objects Configure access control objects in the following order. 1. Create Area objects. 2. Create Door objects, and associate each Door object with an Area object. 3. Create Personnel objects, and assign them to the Area objects to which they are allowed access. When you finish, you have Area, Door, and Personnel objects that work together to check which personnel can access which areas: • Each Area object has a list of Door objects and a list of authorized personnel. • Each Door object is configured with an entry reader and exit reader (optional) that associates each reader with one Area object. From the Door object, you can see which person was the last to go through.
- 464. 452 TAC • Each Personnel object has a list of Area objects to which the person is allowed access. Creating an Area Object The following procedure describes how to create an Area object. 1. In Continuum Explorer, right click the folder where you want to store your areas, select New, and then select Area from the popup menu. 2. Enter the area name, and click the Create button. 3. In the General tab of the Area editor, enter a description of the area. 4. If you want to assign a SecurityLevel object to the area, select the SecurityLevel tab, and then select a SecurityLevel object. 5. Click OK. You can now assign doors and personnel to this Area object. Creating a Door Object The following sections describe how to configure a Door object using the Door editor to specify schedule, area, and other information to control movement of people through the door. The Entry Status and Exit Status tabs show read-only data on such details as last person admitted, time admitted, last invalid person, and entry count. A door can provide access to two different areas (the areas on either side of the door). When you configure a door, you assign areas to it. The door name automatically appears in the Doors to Area tab of those Area objects Door objects are always created in the controller to which the door sensors, access card readers and keypads are wired. The exact configuration details for a Door editor depend on the model of the controller or IOU module to which your access control devices are wired. 1. In Continuum Explorer, right click the controller where you want to create the door, select New, and then select Door from the popup menu. 2. Enter the door name, and click the Create button. 3. Refer to the following sections to enter and save the appropriate settings in the Door editor. Data that Defines a Door Object You need to provide the following information when you configure a Door object: • Site codes and format information for access control card sets • IOU, channel and area information for entry and exit card reader and keypad inputs • Type of validation (card, site, PIN, etc.) • Channel numbers for the following Door outputs and inputs o Door lock output
- 465. Andover Continuum CyberStation Configurator’s Guide 453 o Alarm output (optional) o Exit request input (optional) o Door switch input (optional) o Bond sensor input (optional) (AC-1 Plus) o ADA Input (optional) (AC-1 Plus) o ADA Exit Request (optional) (AC-1 Plus) • The schedules used to lock and unlock doors (optional) • The InfinityNumeric objects that those schedules turn on and off (optional) General Tab – Door Editor The General tab lets you enter and monitor basic information about the door. Description Enter up to 32 characters including spaces to describe this door. A good description can help others realize the door's significance and physically locate it and its access control equipment. Door Lock Displays whether the door is locked or unlocked. You can also lock or unlock the door by selecting Locked or Unlocked from the dropdown menu. Changing this setting has no effect if the Lockdown state is present. Door Switch Displays whether the door has been open, closed or tampered with. The Door Switch is a supervisory input from the door you are assigning to the controller. The field displays Open, Closed or Trouble. Trouble indicates that a problem, such as a cut wire or a shorted wire, is present at the door switch. Door State Select Disabled or Enabled. Disabled means that no personnel access is allowed through the door. Enabled means valid access is permitted to authorized personnel. Operating Mode Not implemented in this version.
- 466. 454 TAC Card Formats Tab – Door Editor Use the Card Formats tab to enter information about your access cards, and if needed, your keypad. Note: For more information on the use of multiple custom formats with specific controllers, see Appendix E. Site Codes Enter up to four site codes that are valid at this door. If communication problems prevent the door from communicating with the device controller or the access server that manages access control information in your network to validate individual card numbers, you can configure the door to allow access with a valid site code. You specify these settings on the Entry Reader and Exit Reader tabs. General Code Enter the keypad code that allows personnel access through a specific door. Any personnel who know this general code will be allowed access through the door. Arm Code Not implemented in this release. Card Format Click either Wiegand or ABA. ABA Formats Select either ABA Format 2 or Custom. This format must match the card format used by the personnel. Note: Andover Continuum supports custom ABA cards. Each custom ABA format must be defined as a special InfinityString object. See Appendix E.
- 467. Andover Continuum CyberStation Configurator’s Guide 455 Wiegand Formats Select the card format of the cards used by your personnel. Channels Tab – Door Editor Use the Channels tab to specify information about the access control hardware. ADA (Alternate Door Access) options allow you to configure a door to accommodate disabled persons by allowing for longer than usual door unlock and open periods. A controller that supports these features, such as the AC-1 Plus, is required. Door Output Channel Displays the channel number to which the door lock is wired. For ACX 700 controllers, the value of this attribute depends on how the strike controlling the door has been wired to the controller or the expansion units. If one expansion unit has been used with the 700, its Door Output Channel is 4. If two expansion units have been used, the second 190 Door Output Channel is 5. On an AC-1 module the Door Output Channel is 1. The door output relay can be a normally open (NO) or normally closed (NC) device. Invert Click this checkbox to invert the meanings of Locked and Unlocked. Door Strike Seconds Enter the number of seconds the door is to remain unlocked after a valid access. Door Ajar Seconds Enter the number of seconds, 0 to 255, that you want the door to be ajar after the Door Strike Seconds have elapsed. Forced Entry Delay Enter the number of seconds, 0 to 255, that you want to delay the delivery of forced-entry alarms/events that are caused by non-forced-entry "door bounce." ADA Output Channel Enter the number of the ADA output channel number to which an electronic door opener is wired. You designate ADA status for individual personnel in the Personnel object for each person who requires it. ADA Output Strike Seconds Enter the number of seconds you want the door to remain unlocked after a valid access by personnel with disabilities. ADA Door Ajar Seconds Enter the number of seconds, 0 to 255, the door can be ajar after the ADA Output Strike Seconds have elapsed.
- 468. 456 TAC Alarm Output Channel Enter the channel number to which the alarm is wired if a flashing or beeping alarm for the door has been installed. Channel 9 on an ACX 781 controller is a spare channel. Connect it to a light or some other signaling device physically near the door. In the event of an alarm, this channel will be activated. Use Channel 2 (Auxiliary) for alarm output on an AC-1. Alarm Relay Seconds Enter the number of seconds the alarm output channel remains energized when a Door attribute goes into alarm. Exit Request Input Channel Enter the channel number as it is marked on the controller. Every input connection area (channel) on every type of controller is numbered. The Exit Request Input for an AC-1 is Channel 3. Exit Request Input Resistor Type Select a resistor type (10K ohms) from the dropdown list. Unlock on Exit Request Check this checkbox if you want to unlock the door every time an exit request occurs. Otherwise, clear the checkbox. Note: If the door is in the Lockdown state, all requests to exit are ignored, even if this option is selected. Door Switch Input Channel Enter the channel number to which the door switch is wired. The door switch input channel monitors whether the door is open or closed. Every input connection area (channel) on every type of controller is numbered. Enter the channel number as it is marked on the controller. The Door Switch Input for an AC-1 is Channel 2. Door Switch Input Resistor Type Select a resistor type from the dropdown list. Relock upon Door Closure Check this checkbox to lock the door 1 second after it is closed. If this checkbox is not checked, the door is locked 1 second after the door switch is opened. Bond Sensor Input Channel Enter the channel number to which the bond sensor is wired. The bond sensor determines the physical latch position. Every input connection area (channel) on every type of controller is numbered. Enter the channel number as it is marked on the controller. Bond Sensor Input Resistor Type Select a resistor type from the dropdown list.
- 469. Andover Continuum CyberStation Configurator’s Guide 457 ADA Exit Request Input Channel Enter the channel number to which the ADA Exit Request Input is wired. The ADA Exit Request Input requests that the door be opened — when the request is transmitted the system presumes that the door is unlocked — to allow exit from a restricted area for a disabled person. Every input connector area (channel) on every type of controller is numbered Enter the channel number as it appears on the controller. ADA Exit Request Input Resistor Type Select a supervised input connection scheme from the dropdown list. ADA Input Channel Enter the channel number to which the ADA Input is wired. The ADA input requests that the door be opened — when the request is transmitted the system presumes that the door is unlocked — providing a disabled person with entrance to a restricted area. Every input connector area (channel) on every type of controller is numbered. Enter the channel number as it appears on the controller. ADA Input Resistor Type Select a supervised input connection scheme from the dropdown list. See the following sections for more information about supervised inputs. Supervised Input and Switch Types If the wiring is tampered with, the resistance of the circuit changes. This change in resistance causes the switch to go into a Trouble state, which can cause the door to go into an alarm condition. You should attach all supervised inputs to a Trouble alarm. The normal state of the switch is the state the switch is in when the door is closed. All ACX700 / 780 controller series inputs are supervised inputs. ACX 57xx series controllers also have supervised inputs. All inputs on an AC-1 are supervised inputs.
- 470. 458 TAC The table below summarizes the selections in the dropdown menus in these fields based upon your switch configuration. Wiring configurations for each switch type are shown on the following page. Supervised Input Type Switch Type NOSeries Normally-open switch with a resistor in series. NOParallel Normally-open switch with a resistor in parallel. NOSerPar Normally-open switch with a resistor in parallel and an added resistor in series. NCSeries Normally-closed switch with a resistor in series. NCParallel Normally-closed switch with a resistor in parallel. NCSerPar Normally-closed switch with a resistor in parallel and an added resistor in series. The table below summarizes the ACX781 door switch configuration options. Supervised Inputs Controller and Expansion Unit 1 - 8 700 Series Inputs 9 or 10 First Expansion Unit Inputs 11 or 12 Second Expansion Unit Inputs 1 - 32 780/781 Controller Inputs
- 471. Andover Continuum CyberStation Configurator’s Guide 459 NC Series AUX or DOOR or REX RET Contact Closure External Resistor 10 KΩ Sensor Switch Position Resistance Value Value Closed Closed 10 K Off Open Open Infinite On Shorted Zero K Trouble Wire cut Infinite On NC Parallel AUX or DOOR or REX RET Contact Closure External Resistor 10 KΩ Sensor Switch Position Resistance Value Value Closed Closed Zero K Off Open Open 10 K On Shorted Zero K Off Wire cut Infinite Trouble NC Series and Parallel AUX or DOOR or REX RET Contact Closure External Resistors 10 KΩ Sensor Switch Position Resistance Value Value Closed Closed 5 K Off Open Open 10 K On Shorted Zero K Trouble Wire cut Infinite Trouble NO Series AUX or DOOR or REX RET Contact Closure External Resistor 10 KΩ Sensor Switch Position Resistance Value Value Closed Open Infinite Off Open Closed 10 K On Shorted Zero K Trouble Wire cut Infinite On No Parallel AUX or DOOR or REX RET Contact Closure External Resistor 10 KΩ Sensor Switch Position Resistance Value Value Closed Open 10K Off Open Closed Zero K On Shorted Zero K On Wire cut Infinite Trouble NO Series and Parallel AUX or DOOR or REX RET Contact Closure External Resistors 10 KΩ Sensor Switch Position Resistance Value Value Closed Open 10K Off Open Closed 5 K On Shorted Zero K Trouble Wire cut Infinite Trouble
- 472. TAC460 Options Tab – Door Editor In the Options tab, you specify schedules to lock and unlock the door. You also select the types of access events sent from the controller to a CyberStation workstation for logging and viewing. Note: If the door is in the Lockdown state, all schedules for locking and unlocking are ignored. The schedules resume when the Lockdown state is cleared. Door Force Lock Schedule Browse for and select an InfinityNumeric point controlled by the schedule if you want to control this door with the following conditions: • When the schedule is on, the door is locked but access is permitted to all personnel by card swipe and/or keypad entry. (Allow use of door.) • When the schedule is off, the door is locked and card reader and keypad access is denied to all personnel. (No access through the door) Door Force Unlock Schedule Browse for and select an InfinityNumeric point controlled by the schedule if you want to control this door with the following conditions: • When the schedule is on, the door is unlocked. CyberStation ignores this door and any other schedules attached on the Entry Reader and/or Exit Reader tabs of the Door editor. • When the schedule is off, the door is locked but access is permitted to all personnel by card swipe and/or keypad entry. (Allow use of door.) Anti-Passback Control You can select a setting to control passback events. Passback is the use of an authorized card by more than one person to gain access through a controlled door. For example, the card owner uses the card to gain access, and then "passes back" the card to another person who can use the card to gain access through this or another door. Anti-passback control settings allow you to specify whether the program checks where a card was recently used within the facility: • Within Controller - Select this option to check whether a card was recently used at other doors assigned to the same controller as this door. • Network Wide - Select this option to check whether a card was recently used at another door in the network.
- 473. Andover Continuum CyberStation Configurator’s Guide 461 Anti-Passback Type Area Based Control - This option enforces Anti-Passback violations based on areas. Zone Number Based Control - Not implemented in this release. Send Access Events Select the events that you want to log for this door. You can view the logged events at the Access Events tab of the Door editor and in the Active Event View. Select the checkbox next to each event that you want to log. Valid Attempts Occurs when a card number or access code has been accepted as valid and the door switch detects that the door has opened. Invalid Attempts Occurs when a card number or access code is rejected and access is denied. Exit Requests Occurs when someone uses a keypad, card reader, motion detector, or Request-to-Exit button to ask the system to unlock a door so the person can leave an area. Forced Entries Occurs when the door switch detects that the door lock is locked and the doors with is open, or the input is tampered with (Trouble condition). Door Ajar Occurs when a door remains open longer than the number of seconds specified for the Door Strike and Door Ajar attributes combined. Valid Access - No Entry Occurs when a card number or access code has been accepted as valid, and the door switch detects that the door has not opened. About Associating Schedules with Doors CyberStation offers many different ways to link schedules and doors. The control requirements of a particular building or area should determine how you configure the Door editor to permit or deny access based on schedules. For example, a lobby door may have different locking requirements than one door of many into an auditorium. The fields where you link Door objects to schedules are labeled as Schedule fields. The objects you attach in the Schedule fields are the InfinityNumeric points that are turned on and off by the schedules. You do not attach the Schedule objects themselves. XDriver Tab – Door Editor If you purchased a special device that you connected to a controller, TAC can develop special software that allows your device to work with the controller. The software is called an XDriver. After you connect your device to the controller and install the XDriver software, you need to specify the comm port that you used in the XDriver window.
- 474. TAC462 On the XDriver tab, select a comm port from the dropdown menu for the Commport field. Entry Reader Tab – Door Editor In the Entry Reader tab, you enter settings that identify the IOU module or controller that controls the card reader or keypad. You make selections that determine what the controller does with information taken from the reader (and keypad, if used) and how it determines whether or not the door will open. If the door has a card reader or keypad on both sides, enter settings for the second reader/keypad in the Exit Reader tab. Note: If the door is in the Lockdown state, the door is locked, and these settings are ignored. The settings resume when the Lockdown state is cleared. Reader IOU Enter the number of the IOU module connected to the card reader. You can find the IOU module number in the General tab of the IOUModule editor. If the door is controlled by an Infinet controller, leave the Reader IOU at zero. Reader Channel Enter the channel number on the IOU module or controller that is connected to the reader. An AC-1 Reader Channel is 1. Keypad Channel Enter the channel number on the IOU module or controller that is connected to the keypad. An AC-1 Keypad Channel is 1.
- 475. Andover Continuum CyberStation Configurator’s Guide 463 Area Click the browse button. In the Browse dialog, select the area to which the door gives access. When you save the settings for this door, CyberStation automatically assigns the door to the area you selected. Note: Selecting an area from the Browse dialog ensures that the full path name for the Area object is entered into the field. Validate Reader or PIN Not implemented in this release. Access Validation Select one or more conditions the controller uses to decide whether to open the door. You can select one or more validation conditions for each operating mode. To gain access through this door, a person must provide valid credentials for all the validation conditions you selected. Use the Access Validation settings to determine how the controller validates access information from this reader/keypad in the following operating modes: • Normal: Devices, controllers, and the CyberStation workstation are communicating normally. • Comm Fail: The local controller and the CyberStation workstation that manages access control information in your network (the access server) are unable to communicate. • No Database: The IOU module or controller is unable to obtain access information from the database at the network controller. This can occur if communication between the two has failed. It also occurs if the network controller has been reset so that its database has no access data to provide. Validate Site Select this condition if you want the controller to require a valid site code on the access card. Validate Card Select this condition if you want the controller to require a valid card number on the access card. Validate PIN Select this condition if you want the controller to check the numbers pressed at the keypad to see if they form a valid personal identification number (PIN). General Code Check the numbers pressed at the keypad to see if they match the general code you entered in the Card Formats tab.
- 476. TAC464 Door Forced Lock Schedule Check this checkbox to control this door with the following conditions: • When the schedule is on, the door is locked and card reader and/or keypad access is denied to all personnel. • When the schedule is off, the door is unlocked and access is permitted to all personnel by card swipe and/or keypad entry. Personnel Schedule Not implemented in this release. Reader Schedule Not implemented in this release. Entry Options Tab – Door Editor In the Entry Options tab, you select options that help enforce the access validation choices and reader options. Note: If the door is in the Lockdown state, the door is locked, and all entry option settings are ignored. The settings resume when the Lockdown state is cleared. Reader Enable Schedule Not implemented in this release. Department Point Browse for the InfinityNumeric point that holds the department number of the last person through the door. This number is taken from the Personnel object created when you add a person to the system.
- 477. Andover Continuum CyberStation Configurator’s Guide 465 Timed Anti-Passback Minutes Enter the number of minutes during which an individual cannot enter through the same area again. Zone Number Not implemented in this release. Allow Entry on a Timed Anti-Passback Violation Allows re-entry to an area within the time in Timed Anti- Passback Minutes. Anti-Passback Protection Makes the controller check for individuals who have tailgated. A violation is logged when someone tries to gain access through this door without obtaining valid access through other doors to reach this door. This can occur if a person enters through a door that was opened for someone else who provided valid access credentials. Allow Entry on an Anti-Passback Violation Permits access even though it appears the individual has tailgated. This checkbox is available when the Anti-Passback Protection checkbox is selected. PIN Duress Lets personnel signal a duress situation by entering a special PIN when forced into an area by an unauthorized individual. Reverse Card Duress Lets personnel signal a duress situation when an access card is not swiped properly. An alarm can be set to go off if this occurs. Allow Entry on a Reverse Card Allows an entry when a card is swiped with the front of the card facing the building rather than away from it. (This does not work for proximity cards.) Entry Status Tab – Door Editor The Entry Status tab lets you view the following information about the door’s entry status. Current Operating Mode Displays Card mode, Site mode and Card Mode, or PIN mode. Last Person Admitted Displays the name of the person associated with the last card number or access code used to go through the door. Time Admitted Displays the time the last person went through the door. Last Person’s Department Displays the last person's department number. Last Invalid Person Displays the name of the person who last attempted to enter but was not granted access. Last Invalid Time Displays the time of the last invalid attempt.
- 478. TAC466 Last Card Number Displays the number encoded in the last valid card swiped. Last Site Number Displays the site code encoded in the last card swiped. (Wiegand cards only, as the last card number for ABA cards is always 0) Entry Count Displays the total number of personnel that have entered through this door with valid access credentials. You can use a Plain English command to reset the door count. For example: Set DoorName EntryCount to 0. Exit Reader Tab – Door Editor In the Exit Reader tab, you enter settings that identify the IOU module or controller that controls the card reader and/or keypad used to exit the area that can be accessed using the reader/keypad specified in the Entry Reader tab. If no access validation is needed to exit the area, and no card reader or keypad is in use, you do not need to enter any values on this tab. This tab is configured the same way as the Entry Reader tab. Note: If the door is in the Lockdown state, the door is locked, and these settings are ignored. The settings resume when the Lockdown state is cleared. Reader IOU Enter the number of the IOU module connected to the card reader. You can find the IOU module number in the General tab of the IOUModule editor. If the door is controlled by an Infinet controller, leave the Reader IOU at zero. Reader Channel Enter the channel number on the IOU module or controller that is connected to the reader. An AC-1 Reader Channel is 1. Keypad Channel Enter the channel number on the IOU module or controller that is connected to the keypad. An AC-1 Keypad Channel is 1. Area Click the browse button. In the Browse dialog, select the area to which the door gives access. When you save the settings for this door, CyberStation automatically assigns the door to the area you selected. Note: Selecting an area from the Browse dialog ensures that the full path name for the Area object is entered into the field. Validate Reader or PIN Not implemented in this release.
- 479. Andover Continuum CyberStation Configurator’s Guide 467 Access Validation Select one or more conditions the controller uses to decide whether to open the door. You can select one or more validation conditions for each operating mode. To gain access through this door, a person must provide valid credentials for all the validation conditions you selected. Use the Access Validation settings to determine how the controller validates access information from this reader/keypad in the following operating modes: • Normal: Devices, controllers, and the CyberStation workstation are communicating normally. • Comm Fail: The local controller and the CyberStation workstation that manages access control information in your network (the access server) are unable to communicate. • No Database: The IOU module or controller is unable to obtain access information from the database at the network controller. This can occur if communication between the two has failed. It also occurs if the network controller has been reset so that its database has no access data to provide. Validate Site Select this condition if you want the controller to require a valid site code on the access card. Validate Card Select this condition if you want the controller to require a valid card number on the access card. Validate PIN Select this condition if you want the controller to check the numbers pressed at the keypad to see if they form a valid personal identification number (PIN). General Code Check the numbers pressed at the keypad to see if they match the general code you entered in the Card Formats tab. Door Forced Lock Schedule Check this checkbox to control this door with the following conditions: • When the schedule is on, the door is locked and card reader and/or keypad access is denied to all personnel. • When the schedule is off, the door is unlocked and access is permitted to all personnel by card swipe and/or keypad entry. Personnel Schedule Not implemented in this release. Reader Schedule Not implemented in this release.
- 480. TAC468 Exit Options Tab – Door Editor In the Exit Options tab, you select options that help enforce the access validation choices and reader options. If no card reader or keypad is configured in the Exit Reader tab, you do not need to select any options in this tab. Note: If the door is in the Lockdown state, the door is locked, and all exit option settings are ignored. The settings resume when the Lockdown state is cleared. Reader Enable Schedule Not implemented in this release. Department Point Browse for the InfinityNumeric point that holds the department number of the last person through the door. This number is taken from the Personnel object created when you add a person to the system. Timed Anti-Passback Minutes Enter the number of minutes during which an individual cannot enter through the same area again. Zone Number Not implemented in this release. Allow Entry on a Timed Anti-Passback Violation Allows re-entry to an area within the time in Timed Anti- Passback Minutes. Anti-Passback Protection Makes the controller check for individuals who have tailgated. A violation is logged when someone tries to gain access through this door without obtaining valid access through other doors to reach this door. This can occur if a person enters through a door that was opened for someone else who provided valid access credentials. Allow Entry on an Anti-Passback Violation Permits access even though it appears the individual has tailgated. This checkbox is available when the Anti-Passback Protection checkbox is selected. PIN Duress Lets personnel signal a duress situation by entering a special PIN when forced into an area by an unauthorized individual. Reverse Card Duress Lets personnel signal a duress situation when an access card is not swiped properly. An alarm can be set to go off if this occurs. Allow Entry on a Reverse Card Allows an entry when a card is swiped with the front of the card facing the building rather than away from it. (This does not work for proximity cards.)
- 481. Andover Continuum CyberStation Configurator’s Guide 469 Exit Status Tab – Door Editor The Exit Status tab lets you view the following information about the door’s exit status. Current Operating Mode Displays Card mode, Site mode and Card Mode, or PIN mode. Last Person Admitted Displays the name of the person associated with the last card number or access code used to go through the door. Time Admitted Displays the time the last person went through the door. Last Person’s Department Displays the last person's department number. Last Invalid Person Displays the name of the person who last attempted to enter but was not granted access. Last Invalid Time Displays the time of the last invalid attempt. Last Card Number Displays the number encoded in the last valid card swiped. Last Site Number Displays the site code encoded in the last card swiped. (Wiegand cards only, as the last card number for ABA cards is always 0) Exit Count Displays the total number of personnel that have entered through this door with valid access credentials. You can use a Plain English command to reset the door count. For example: Set DoorName EntryCount to 0. Alarms Tab – Door Editor Return to this tab to configure alarms after you have set other Door attributes and saved the object. Alarms are discussed in Chapter 10, Configuring Alarms. Access Events Tab – Door Editor Use the Access Events tab of the Door editor to review the access activities for this door. This tab is an event viewer for this door only, and shows access events as they occur.
- 482. TAC470 Event Class The type or class of access event that has occurred. Time Stamp The time at which the access event occurred. Person The name and path of the Personnel object for the person causing the event. Area The Area object associated with this event. Using Area Lockdown The area lockdown feature in the Area editor enables you to immediately prevent entry or exit through all doors to an area. When the Lockdown state is in effect, only personnel with executive privilege access to the area can enter or leave it. You can also lock down individual doors instead of an entire area. The lockdown feature is supported in NetController II (models 9680 and 9681) network controllers and ACX 57xx controllers. Area Lockdown must also be enabled in the CyberStation security key to use this feature. Issuing a lockdown message does not affect access through doors controlled by other controllers. More About Area Lockdown The area lockdown feature is intended to help you quickly control area access in emergencies: • You can issue a lockdown message to prevent access through all doors assigned to an area. • You can clear the Lockdown state to restore routine access to an area.
- 483. Andover Continuum CyberStation Configurator’s Guide 471 • You can lock down and restore access to individual doors in an area that is not locked down. • You can view the lockdown status of an area and of the doors assigned to an area. What Happens During Lockdown When an area is locked down, the Lockdown state overrides the following access control features, and doors to the area are locked: • Requests to exit, including pushing on crash bars • Use of valid cards or keypad entries • Schedules that unlock doors or allow access with valid cards or keypad entries • Attempts to force unlock a door in the Door editor, through a Pinpoint control, or using a Plain English program Only personnel who are assigned executive privilege access and are assigned access rights to the area can enter or exit through a door in the lockdown state. You select executive privilege access and assign area access rights in the Personnel object for each person that you want to have this access. For more information about executive privilege, see Chapter 19. When the Lockdown state is cleared from an area, routine access resumes at doors to the area (if adjacent areas are also not in the Lockdown state.) Locking down an Area Use this procedure to lock down all doors assigned to an Area object. This procedure describes how to lock down an area from the Area editor. Depending on how your CyberStation system is configured, you can also lock down areas using a Pinpoint area control, a Plain English program, or command line entry. 1. Open the Area object for the area that you want to lockdown. 2. In the General tab of the Area editor, click the Lockdown Area button. 3. To verify that all doors to the area are locked down, select the Doors to Area tab, and view the lockdown status of each door: • A door is locked down when the value for ForceLock is True. • A door is not locked down when the value for ForceLock is False. The value may be false because the controller for the door did not receive the lockdown message, or because the controller does not support the area lockdown feature. If a door could not respond to the lockdown message (for example, because its controller was temporarily offline), in the General tab you can click the Lockdown Area button to send the message again. 4. To remove the Lockdown state from the area, in the General tab, click the Clear Lockdown Area button. When you remove the Lockdown state, all doors to the area resume their normal states. A door that provides access to another area that is still locked down remains locked down until the Lockdown state is cleared from the other area.
- 484. TAC472 Locking down Individual Doors Use this procedure to lock down one or more doors that are assigned to an area that is not locked down. This procedure describes how to lock down doors from the Area editor. Depending on how your CyberStation system is configured, you can also lock down doors using a Pinpoint area control, a Plain English program, or command line entry. 1. Open the Area object for an area that is assigned the door that you want to lockdown. 2. Click the Doors to Area tab of the Area editor. 3. Select one or more doors, and click the Lockdown Selected Doors button. You can select multiple doors by holding down the Ctrl key or the Shift key while you select doors in the list. 4. To verify that all doors to the area are locked down, view the lockdown status of each door: • A door is locked down when the value for ForceLock is True. • A door is not locked down when the value for ForceLock is False. The value may be false because the controller for the door did not receive the lockdown message, or because the controller does not support the area lockdown feature. If a door could not respond to the lockdown message (for example, because its controller was temporarily offline), in the General tab you can click the Lockdown Selected Doors button to send the message again. 5. To remove the Lockdown state from doors, select one or more doors, and click the Clear Lockdown Selected Doors button. When you remove the Lockdown state, doors resume their normal states. A door that provides access to an area that is locked down remains locked down until the Lockdown state is cleared from the other area. Controlling Access with Condition Levels Several Andover Continuum controllers support a system variable named ConditionLevel: • NetController II 96xx models • NetController 99xx models • ACX 57xx models If this system variable is supported in your controllers and is also enabled in the CyberStation security key, you can use this variable to rapidly control area access in emergencies. A ConditionLevel value is stored at the controllers that manage access to the doors to each area. Typically, the controller condition level corresponds to security alert levels that your company has established for emergencies. You use controller condition levels with personnel clearance levels to control access during different categories of emergency. A value of 1 for a controller condition level is the most severe alert level. A value of 255 is the least severe.
- 485. Andover Continuum CyberStation Configurator’s Guide 473 You can quickly change the condition level at all controllers by sending a new value for ConditionLevel from the CyberStation workstation using the Global Condition Level dialog. This is a faster method of changing the values than manually changing the condition level at each controller. You can also restore the previous condition level at all controllers by selecting a ConditionLevel value of Local in this dialog. For more information about condition levels, see “Personnel Clearance Levels and Controller Condition Levels” in Chapter 19, Personnel. Sending a Condition Level Message to Controllers Use this procedure to send a new value for the ConditionLevel system variable to all controllers. All controllers that receive the message and support the ConditionLevel system variable update the value of the variable with the new condition level. CyberStation also saves each controller's original value for ConditionLevel in the DB Value field in the CyberStation database. 1. In the CyberStation tool tray, right click the Continuum task icon, and select Global Condition Level. 2. Select a new condition level for Change To. You can select Level_0 for the value if you do not want the controllers to use the condition level value when validating access. 3. Click Change. 4. When prompted to confirm the change, click Yes. 5. When prompted that the condition level is changed, click OK. Restoring Controller Condition Levels to Previous Levels Use this procedure to send the ConditionLevel value that was saved in the DB Value field for each controller to the controllers. This is the ConditionLevel value that was in effect at each controller before CyberStation sent the new ConditionLevel value. For example, if the value for ConditionLevel at Controller A was originally 4, the value at that controller is once again 4. 1. In the task bar, right click the Continuum task icon, and select Global Condition Level. 2. Select Local for Change To. 3. Click Change. 4. When prompted to confirm the change, click Yes. 5. When prompted that the condition level is changed, click OK.
- 486. TAC474 About Sending Condition Level Values to Individual Controllers Using the Global Condition Level dialog enables you to change the value for ConditionLevel at multiple controllers with one command. You can also change the value for individual controllers: • You can edit the ConditionLevel variable in the InfinitySystemVariable editor. • You can enter a command to change the value from the command line. • You can use a Plain English (PE) program to change the value. • You can use PE script attached to a Pinpoint control to change the value. When you use the command line or a PE program to send a value for this variable, you must use the numeric value that corresponds to the condition level that you want to set. Do not use a text string. For example, if you want to use the SET command to change the value for ConditionLevel to Level 5, use the following syntax: SET [pathname]ConditionLevel = 5
- 487. Andover Continuum CyberStation Configurator’s Guide 475 Personnel This chapter covers two major topics, the Personnel Manager and the Personnel Import Utility. The CyberStation Personnel Manager is a powerful and easy-to use tool for creating, viewing, and managing personnel records. The Personnel Import Utility allows you to import third-party personnel data that was created outside of an Andover Continuum system. It bridges the gap between other personnel databases and CyberStation personnel records by allowing you to import and upload personnel data in large amounts and save the imported data as CyberStation Personnel objects. Personnel Manager Use the CyberStation Personnel Manager for entering, viewing, and managing personnel data: • Security access information, such as card number and a list of the areas the person may enter. • Employee information, such as department name and number, supervisor name, and vehicle information. • Personal information, such as name, blood type, emergency contact, height, weight, and hair color. The data for each person is stored in a Personnel object. In the Personnel Manager, a Personnel object can also be referred to as a record, card, or badge because the data in the Personnel object may be associated with any of these. 19
- 488. TAC476 Search Capability In the Personnel Manager, you can quickly locate Personnel objects using the built-in search feature. You can search by criteria such as first and last names, card number, and employee number. You can enter full or partial information for the criteria. Search results can display thumbnail photos from employee badges, if available. Customizable Profiles for Viewing and Entering Personnel Data The Personnel Manager uses profiles to streamline the process of creating new Personnel objects by providing predefined lists of area access rights. You can also use profiles to determine the personnel data displayed when users view, edit, or create Personnel objects. Profiles enable you to limit user access to sensitive personnel data, such as Social Security numbers and home phone numbers. The Personnel Manager also supports the use of CyberStation personnel templates.
- 489. Andover Continuum CyberStation Configurator’s Guide 477 Simplified Area Assignment The Personnel Manager provides several methods for adding or editing the list of areas you assign to Personnel objects: • You can specify the areas in profiles. The areas are then assigned in any Personnel objects created from the profile. • You can replace the areas in a Personnel object with the areas from a profile or a personnel template. • You can add or remove individual areas as needed in Personnel objects. Regardless of the method that you use, schedule and clearance level information can be included with the areas you assign to Personnel objects. This enables you to customize the access rights for types of personnel (employee, contractor, visitor, etc.) or for individual personnel as needed in your facility. Personnel Enrollment from Card Reader The Personnel Manager can automatically create new Personnel objects using information from an access card that is read at a card reader that you designate. You can edit these Personnel objects to enter additional information at any time. You can also use this feature to identify the owner of an access card. Enabling the Personnel Manager The Personnel Manager is enabled by default at each CyberStation workstation. However, users can choose to enable the Personnel editor, a dialog similar to other CyberStation dialogs (used in earlier versions of CyberStation), instead of the Personnel Manager. If another user enabled the Personnel editor at your workstation, and you want to resume using the Personnel Manager, complete the following steps. 1. In Continuum Explorer, right click your workstation folder, and click Open. 2. Select the Preferences tab of the Device editor. 3. Scroll down to the preference setting, Use Personnel Manager, and select True. 4. Click OK. In Continuum Explorer, you can now double click a Personnel object to edit the object in the Personnel Manager. The Personnel Manager also opens when you create a new Personnel object from Continuum Explorer. Adding New Personnel Objects You can add a new object from Continuum Explorer or from the Personnel Manager. When you add an object from the Personnel Manager, CyberStation automatically generates the object ID and alias that are displayed when you view the list of Personnel objects in Continuum Explorer. Note: You can also use the Personal Import Utility to import personnel records from another application into CyberStation. Once imported, these records become Personnel objects that you can edit and manage in the Personnel Manager. For more information, see “Personnel Import Utility” later in this chapter.
- 490. TAC478 Perform the following steps to add a new Personnel object. 1. If the Personnel Manager is open at your workstation, click Add Record, select a profile from the popup menu, and proceed to step 4. When the Personnel Manager is open, you can add and save multiple Personnel objects without having to close and reopen the Personnel Manager each time. 2. If the Personnel Manager is not open, in Continuum Explorer, right click the folder that contains your Personnel objects. Select New from the popup menu, and then select Personnel. Proceed to step 3. 3. Enter a Personnel object name, and click the Create button. 4. In the Details tab, enter values for personnel attributes as needed. Values for attributes marked with an asterisk (*) are required. If you try to save the record without all required values, a warning message lists attributes that still require entries. If… Then… You want to add card information from an access card read at your enrollment card reader (requires a card read designated in the configuration settings) Swipe the card at the card designated reader. In the Personnel Manager, click the Read Card Info button. In the Card Information dialog, verify in the status line that the card is not assigned to any personnel record, and click the Insert Data button. In the Details tab, the Card Type, Site Code, and Card Number attributes are updated with the information read from the card.
- 491. Andover Continuum CyberStation Configurator’s Guide 479 If… Then… This person requires additional time to open and pass through doors Check the ADA checkbox. Use the Door editor to configure doors to allow extra time for entry for personnel with ADA access. This person is a visitor to your facility Check the Visitor checkbox. If the Personnel object is associated with a template, you cannot change attribute values inherited from that template. 5. Assign areas to this Personnel object, if needed. Any areas that are assigned in the profile you used to create the Personnel object are automatically assigned to the object. You can assign other areas to the object as needed. If you want to… Then… Replace the currently assigned areas (if any) with the areas from another profile Select the Profile radio button, select profile from the dropdown list, and click the Reset Access Rights button. When prompted, click Yes. Any areas previously assigned to this Personnel object are removed when you add the areas from the selected profile. Replace the currently assigned areas (if any) with the areas from a personnel template Select the Template radio button, select a template from the dropdown list, and click the Reset Access Rights button. When prompted, click Yes. Any areas previously assigned to this Personnel object are removed when you add the areas from the selected template.
- 492. TAC480 If you want to… Then… Assign individual areas Under Access Rights, expand UnAssigned, and check the checkbox next to each area you want to assign. You can click the Filter by Folder button, and select a folder, to view only the areas in that folder. You cannot filter by Root. Remove access to an area Under Access Rights, expand Assigned, and clear the checkbox next to each area you want to remove. 6. If you want to attach a schedule point to one or more areas, expand an area, and click the icon next to Add Schedule. The Add Schedules dialog is displayed. If needed, select the browse button next to Schedule Points Location, and locate the folder or container with the schedule point you want to add. Select a schedule point. Select the areas where you want to attach the schedule point, and click OK. 7. If you want to override this person's Default Clearance Level for an area, expand the area, and click the icon next to Clearance Level. In the Clearance Level dialog, enter a new value for the clearance level, and click OK. If the security key attached to the CyberStation workstation is not configured to view condition levels, condition level and clearance level attributes and values are not displayed or configurable in CyberStation. For more information about clearance levels, see “Personnel Clearance Levels and Controller Condition Levels” later in this chapter. 8. Click Apply. 9. If needed, click Add Record, select a profile, and repeat this procedure from step 4 to add another Personnel object. 10. Click OK to save changes and close the Personnel Manager. Editing a Personnel Object To open the Personnel Manager, double click any Personnel object in Continuum Explorer. When the Personnel Manager is open, you can use its powerful search feature to locate a Personnel object that you want to edit. In the Personnel Manager, changes to a Personnel object are not saved until you click Apply or OK. Searching for a Personnel Object You can search for personnel by any of the following criteria: first or last name, Social Security number, employee number, card number, department, and department code.
- 493. Andover Continuum CyberStation Configurator’s Guide 481 Note: You can also locate a Personnel object that you want to edit by scrolling through the list of Personnel objects in Continuum Explorer. You can then double click the object to open it in the Personnel Manager and edit it as described in this topic. Perform the following steps to search for a Personnel object. 1. In the Personnel Manager, click the New Search button, and enter search criteria. The Personnel Manager can search for exactly what you type if you put the entry in quotes. If you do not enter quotes, the Personnel Manager searches for records with attributes that begin with what you type. The following table provides an example of search criteria entered to locate a Personnel object by last name. Typing… Searches for… J Every last name that starts with the letter J “Johnson” Records of personnel whose last name is Johnson John Every last name that starts with John You can limit the number of records returned by entering a value between 1 and 50 for Maximum Results. If you do not enter a value, the Personnel Manager displays the first 50 records that match the search criteria that you entered. 2. Click the Find Now button. If not already checked, check the Show Thumbnails checkbox if you want to display photos in the search results. 3. Click a name in the search results to display the record details in the Personnel Manager. To return to your search results, click the Search Results tab. Assigning or Changing Access to Areas Any areas in the profile you used to create a Personnel object are automatically added to the object. If needed, you can assign other areas to the object, or remove areas, as described in the following procedure. 1. In the Personnel Manager, search for the Personnel object that you want to edit, and select the record from the search results. 2. Assign areas to this Personnel object. If you want to ... Then... Replace the currently assigned areas (if any) with the areas from another profile Select the Profile radio button, select a profile from the dropdown list, and click the Reset Access Rights button. When prompted, click Yes. Any areas previously assigned to this Personnel object are removed when you add the areas from the selected profile.
- 494. TAC482 If you want to ... Then... Replace the currently assigned areas (if any) with the areas from a personnel template Select the Template radio button, select a template from the dropdown list, and click the Reset Access Rights button. When prompted, click Yes. Any areas previously assigned to this Personnel object are removed when you add the areas from the selected template. Assign individual areas Under Access Rights, expand UnAssigned, and check the checkbox next to each area you want to assign. You can click the Filter by Folder button, and select a folder, to view only the areas in that folder. You cannot filter by Root. Remove access to an area Under Access Rights, expand Assigned, and clear the checkbox next to each area you want to remove. Disable access to an area without removing the area Under Access Rights, expand Assigned, and expand the area for which you want to disable access for this person. Clear the Enable Area checkbox. The checkbox next to the area name changes to . You can check the Enable Area checkbox to restore this person's access to the area. Note: Areas assigned from a profile or template using the Reset Access Rights button described below do not maintain their association with the profile or template they came from. If you later edit the profile or template, existing Personnel objects are not affected by the changes. 3. Click Apply. Attaching a Schedule Point to an Area Schedule points are associated with schedules that define specific time periods when a person can access that area. You can attach only one schedule point to an area. However, you can attach the same schedule point to multiple areas. For more information about schedules, see Chapter 15, Configuring Schedules and Calendars. Perform the following steps to attach a schedule point to an area assigned to a Personnel object. 1. In the Personnel Manager, search for the Personnel object that you want to edit, and select the record from the search results. 2. Under Access Rights, expand Assigned.
- 495. Andover Continuum CyberStation Configurator’s Guide 483 3. Expand the area that you wish to add a schedule point to. 4. Click the icon next to Add Schedule to display the Add Schedules dialog. 5. If needed, select the browse button next to Schedule Points Location, and locate the folder or container with the schedule point you want to add. 6. Select a schedule point. Select the areas where you want to attach the schedule point, and click OK. 7. Click Apply. Changing the Clearance Level of a Personnel Object The Clearance Level for areas enables you to provide different access privileges to different areas assigned to the same person. The clearance level you assign to an area in a Personnel object does not affect the access of other personnel with access to the same area. The Default Clearance Level applies to all areas that you assign to the person, unless you choose to override this value with different values for individual areas. (To change the Default Clearance Level, this attribute must be displayed in the profile assigned to the current user. For more information about profiles, see “Working with Personnel Profiles and Templates” later in this chapter.) Areas with a clearance level of zero use the value entered for the Default Clearance Level to determine access to the area for this person. For more information about how clearance levels control access to assigned areas, see “Personnel Clearance Levels and Controller Condition Levels” later in this chapter. Note: If the security key attached to the CyberStation workstation is not configured to view condition levels, condition level and clearance level attributes and values are not displayed or configurable in CyberStation.
- 496. TAC484 Changing the Default Clearance Level Perform the following steps to edit clearance levels for a Personnel object. Clearance level values are maintained in the Personnel object for each person: 1. In the Personnel Manager, search for the Personnel object that you want to edit, and select the record from the search results. 2. In the Details tab, enter a value for Default Clearance Level. Enter 0 if you do not want to assign a default clearance level to this person. 3. Click Apply. Changing the Clearance Level of Specific Areas The clearance level you enter for the area overrides the default clearance level for the Personnel object. Perform the following steps to change the clearance level of a specific area for a Personnel object. 1. In the Personnel Manager, search for the Personnel object that you want to edit, and select the record from the search results. 2. Under Access Rights, expand Assigned. 3. Expand the area for which you want to change the clearance level. 4. Click the icon next to Clearance Level. 5. In the Clearance Level dialog, enter a new value for Clearance Level, and click OK. 6. Click Apply. Assigning Executive Privilege to a Personnel Object When the Lockdown state is in effect, only personnel who are assigned executive privilege can enter and exit the areas to which they have access. All other personnel, regardless of the areas and access right assigned to them, are prevented from entering or leaving areas in the Lockdown state. For more information about the Lockdown state, see “Using Area Lockdown” in Chapter 18. Perform the following steps to assign executive privilege to a personnel object. 1. In the Personnel Manager, search for the Personnel object that you want to edit, and select the record from the search results. 2. In the Details tab, select True for Executive Privilege. 3. Click Apply.
- 497. Andover Continuum CyberStation Configurator’s Guide 485 Disabling or Enabling a Personnel Object When you disable a Personnel object, the access card for this person is no longer valid at any doors in areas to which the person is assigned. For example, you can disable the Personnel object for a contract employee who is not working for your company but may return in the future. You can enable a disabled Personnel object at any time. Perform the following steps to disable or enable a Personnel object. 1. In the Personnel Manager, search for the Personnel object that you want to edit, and select the record from the search results. 2. Disable or enable the object. To disable a Personnel object, clear the checkbox next to Card Enabled. The text turns red, indicating that person's card is disabled. To enable a Personnel object, check the checkbox next to Card Enabled. 3. Click Apply. Setting the Current Area CyberStation determines the current area from the last-door-entered information, if available. In systems set up to prevent or discourage tailgating, you may occasionally need to override the displayed current area if the person accessed a different area without using his/her card or entering a PIN and is now prevented from leaving an area. Perform the following steps to specify the current location of the card holder associated with a Personnel object. 1. In Continuum Explorer, open the folder that contains your Personnel objects. 2. Select the Personnel object that you want to edit, right click, and select Set Current Area from the popup menu. 3. In the Browse dialog, locate the area, and click the Select button. 4. When prompted, click OK. Making or Editing a Badge If you have already purchased the separately sold badging software product, Epibuilder, you can create a badge by setting up a location for badge layout files and default badge formats. See Appendix B for installation information. Setting up a Badge Location and Format Before you can create a badge, you must set up a location for badge layout files as well as a default badge format. 1. In Continuum Explorer, right click your workstation icon, and select Open from the popup menu. The Device editor appears. 2. Select the Preferences tab.
- 498. TAC486 4. Click inside the Value column of this setting: The location of the badge format files From the browse dialog, search for and assign a default path for the folder in which you want to store badge layout files. 5. Click inside the Value column of this setting: The default badge format Specify a default badge layout for the system to load when creating a new Personnel object. Note: This is unique to each user. For each user, repeat steps 4 and 5. 6. Click OK. 7. Assign and/or deny write privileges to users who will and won’t be making/editing badges. 8. Open the Security editor. Right click the Continuum task icon in the icon tray, and select Security from the popup menu. 9. Select the Actions tab, then scroll down to and expand the Personnel directory. 10. Scroll down to Edit Badge Layout, and assign or deny access privileges. 11. Assign a key symbol or a lock, respectively, to the appropriate user groups.
- 499. Andover Continuum CyberStation Configurator’s Guide 487 5. Click OK. Creating or Editing a Badge To create or modify a person’s badge, including layout photo, signature, and fingerprint, perform the following steps. 1. On the General tab of the Personnel editor, click the Make/Edit Badge button. (From the Personnel Manager, click the Create/Edit Badge button. 2. In the Badge Layout field, specify a badge layout file. Either accept the default or click the browse button to search for and select another layout. (The default layout must be assigned in the Preferences tab of the Device editor. EPIDesigner Compatible with Guard Draw: In Version 1.8 and higher, the EPIDesigner application replaces Guard Draw, which was the layout tool used in previous versions. Guard Draw files created in previous versions are compatible with EPIDesigner. The Badge Layout field accepts either an EPIDesigner layout (.dgn file) or a Guard Draw layout (.gdr file). You can easily open and save your existing Guard Draw layout in EPIDesigner. It is saved as a .dgn file. 3. Click the Edit Badge Layout button. The EPIDesigner application appears.
- 500. TAC488 4. Use EPIDesigner (and its graphical layout window) to design or change the design of this person’s badge layout. EPIDesigner Documentation: For complete instructions on how to use this EPIDesigner application, access its online help using the Help dropdown menu in the menu bar. Also consult the EPIDesigner 6.3 User’s Guide. This manual is available as .PDF file via your Windows Start menu. (Click Start, select Programs, select Continuum, and then select Documentation.) 5. From the Made/Edit Badge dialog, to capture a photo, signature, or fingerprint, as needed, double click inside the photo, signature, or fingerprint window, respectively.
- 501. Andover Continuum CyberStation Configurator’s Guide 489 As an alternative, you can also: Click the Capture Photo, Capture Signature, or Capture Fingerprint button, respectively. Use the Capture dropdown menu, and select Photo, Signature, or Fingerprint, respectively The Select Profile dialog appears. 6. From the Select Profile dialog, capture a source profile: Capturing source profile for the first time – When you perform the previous step, and the Select Profile dialog appears, you must capture the source. (If you have installed a video capture device, select Twain.) For further instructions, click the Help button in this Select Profile dialog, or see the EPIDesigner 6.3 User’s Guide. Changing an existing source profile – To change an existing source profile, from the Tools dropdown menu on the Make/Edit Badge dialog, select Set Photo Image Source, Set Signature Image Source, or Set Fingerprint Image Source, respectively. The Select Profile dialog appears. For further instructions, click the Help button in this Select Profile dialog, or see the EPIDesigner 6.3 User’s Guide. 7. From EPIDesigner (and its graphical layout window), you may bind a Personnel object’s attributes to graphic layout elements. Note: EPIDesigner imports all the attribute names from the Personnel object.
- 502. TAC490 To do so: In the graphical layout window, select an existing graphic element – or make a new one and select it. Select an attribute form the attribute dropdown menu, located next to Text dropdown menu on the bottom toolbar. The name of the attribute appears inside the selected graphic element. EPIDesigner Documentation: For complete instructions on how to use this EPIDesigner application, access its online help using the Help dropdown menu in the menu bar or consult the EPIDesigner 6.3 User’s Guide. Print the current card (or multiple cards) if you wish to do so. Printing a single card – To print the current card, from the File dropdown menu on the Make/Edit Badge dialog, select Print Card. (You may also click the Print Badge button.) To preview the current card before printing it, select Print Preview Card from the File dropdown menu. The Print Preview dialog appears, displaying the card you are about to print. When you print a card you are also “issuing” a card. Printing more than one card – To print all cards that have not already been printed – in other words, cards that have not yet been “issued” – select Batch Print Cards from the File dropdown menu. This prints, or “issues,” all the non-printed cards. To see all the cards that have not yet been issued, select Batch Preview Cards. The Print Preview dialog appears. Click the right-arrow button to scroll through all the cards, one by one, that you are about to print. Click the left-arrow button to scroll back. Note: At any given time, each card carries a status of Issued or Unprinted (non- issued). To find out how many cards have been issued, look at the Issued field on the Make/Edit Badge dialog. If you want to change the status of the current card from Issued to Unprinted, open the Tools dropdown menu, and select Set Card Unprinted. When you set an issued card to Unprinted, the number displayed in the Issued field is reduced by one, and that card is added to the list on non-issued card in the Print Preview dialog. 8. Set up external card encoding if you wish to do so. Configure your encoder settings by accessing the following dialogs: From the Tools dropdown menu on the Make/Edit Badge dialog, select External Card Encoder Setup. The External Encoders Setup dialog appears. From the File dropdown menu in EPIDesigner, select Layout Properties. From the Layout Properties dialog, select the General tab, and click the Encoding button. The Card Encoding dialog appears. Note: If you need instructions for configuring the settings on these dialogs, click the Help button to access extensive online documentation, or consult the EPIDesigner 6.3 User’s Guide. 9. Set up card encoding for a printer if you wish to do so.
- 503. Andover Continuum CyberStation Configurator’s Guide 491 Configure our encoder settings by accessing the following dialogs: From the Tools dropdown menu on the Make/Edit Badge dialog, select Printer Card Encoder Setup. The Card Printer Encoder Setup dialog appears. From the File dropdown menu in EPIDesigner, select Layout Properties. From the Layout Properties dialog, select the General tab, and click the Encoding button. The Card Encoding dialog appears. Note: If you need instructions for configuring the settings on these dialogs, click the Help button to access extensive online documentation, or consult the EPIDesigner 6.3 User’s Guide. Reading Card Information You can read card information in the Personnel Manager that you obtain by swiping access cards at a card reader designated in the configuration settings for the Personnel Manager. You may want to do this to look up the card holder of an unidentified access card. You can also do this to assign new cards to existing Personnel objects. Note: To assign card information from a swiped card when you create new Personnel objects, see “Adding New Personnel Objects,” earlier in this chapter. 1. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager. 2. Swipe the card at the designated card reader. 3. In the Personnel Manager, click the Read Card Info button to open the Card Information dialog. The Card Information dialog displays the values for the following attributes: Card Type, Site Code, and Card Number. A message in the status bar of the dialog indicates whether a record in the Personnel Manager matches the values for these attributes. If ... Then... The card information matches a personnel record, and you want to view the record Check the Load the personnel record that matches the criteria checkbox, and click Close. The personnel record associated with the access card is displayed in the Details tab of the Personnel Manager. You want to close the dialog without loading a personnel record Click Close.
- 504. TAC492 Replacing Card Information Use this procedure to replace the current card information in a Personnel object with information read from a new access card. Note: If you need to replace the access card information in a record because the card is misplaced or lost, you may want to assign new card information as described in “Issuing or Restoring a Temporary Card” or “Marking a Card as Lost,” later in this chapter. Using either of those procedures ensures that the card you are replacing cannot be used to access your facility. 1. In the Personnel Manager, search for the Personnel object you want to edit, and select the personnel record from the search results. 2. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager. 3. Swipe the card at the designated card reader. 4. In the Personnel Manager, click the Read Card Info button to open the Card Information dialog. The Card Information dialog displays the values for the following attributes: Card Type, Site Code, and Card Number. A message in the status bar of the dialog indicates whether a record in the Personnel Manager matches the values for these attributes. 5. Click the Insert Data button. In the Details tab of the Personnel Manager, the Card Type, Site Code, and Card Number attributes in the personnel record are updated with the values from the access card. 6. Click Apply. If you mistakenly assign card information already associated with a personnel record to a different personnel record, an error message is displayed when you click Apply, indicating that the card information duplicates the information in another record. The changes are not saved in the current record. Issuing or Restoring a Temporary Card Use this procedure to issue a temporary card. Issuing a temporary card saves the card holder's current information and temporarily assigns a new card number to the Personnel object. Issue a temporary card when you expect to reinstate the original card in the future. Unlike marking a card as lost, issuing a temporary card enables you to restore the original card. 1. In the Personnel Manager, search for the Personnel object for which you want to issue a temporary card, and select the record from the search results. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager.
- 505. Andover Continuum CyberStation Configurator’s Guide 493 2. Click the Issue Temp Card button, and enter a new card number when prompted. When clicked, the button label changes to Restore Temp Card. You can click the Restore Temp Card button to restore card information that was saved by issuing a temporary card. 3. Click Apply. Marking a Card as Lost Use this procedure to mark a card as lost. A new record is then created automatically with all of the same personnel information and access rights with the exception of the card number. A new card number is required. Note: You cannot restore a card that you mark as lost. 1. In the Personnel Manager, search for the Personnel object for the lost card, and select the record from the search results. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager. 2. Click the Mark Card as Lost button. When prompted, click Yes. 3. In the New Card Number dialog, enter a new card number, and click OK. The Personnel Manager renames the current record by appending ".Lost" to that Personnel object's name. For example, "John Smith" would be the new record, and "John Smith.Lost" would be the old record. You can delete the .Lost record if you do not want it in your database. Deleting Personnel Objects You may want to delete a Personnel object when it is no longer needed or valid (for example, when a person leaves your company). This permanently removes the Personnel object from CyberStation. Note: When you delete a Personnel object, it is marked for deletion, but is not removed from CyberStation until the Personnel object can be removed from all controllers that receive access distributions from CyberStation. If a controller cannot be contacted by CyberStation, the Personnel object remains in CyberStation until communication between the controller and CyberStation resumes. Deleting Personnel Objects in Continuum Explorer 1. In Continuum Explorer, open the folder that contains your Personnel objects. 2. Select the Personnel objects you want to delete. To select multiple objects, hold down the Ctrl or Shift key while you select Personnel objects. 3. Right click, and select Delete.
- 506. TAC494 4. When prompted to confirm deletion, click OK. Deleting Personnel Objects in the Personnel Manager 1. In the Personnel Manager, click the New Search button, and enter search criteria. The Personnel Manager can search for exactly what you type if you put the entry in quotes. If you do not enter quotes, the Personnel Manager searches for records with attributes that begin with what you type. The following table provides an example of search criteria entered to locate a Personnel object by last name. Typing… Searches for… J Every last name that starts with the letter J “Johnson” Records of personnel whose last name is Johnson John Every last name that starts with John You can limit the number of records returned by entering a value between 1 and 50 for Maximum Results. If you do not enter a value, the Personnel Manager displays the first 50 records that match the search criteria that you entered. 2. Click the Find Now button. If not already checked, check the Show Thumbnails checkbox if you want to display photos in the search results. 3. Click a name in the search results to display the record details in the Personnel Manager. To return to your search results, click the Search Results tab. 4. Click the Delete Record button. 5. When prompted to confirm deletion, click Yes. 6. To locate additional Personnel objects to delete, click the Search Results tab. Select another object to delete, or perform a new search. Working with Personnel Clearance Levels and Controller Condition Levels Clearance levels and condition levels are features of the Andover Continuum system that enable you to rapidly control area access in emergencies. Clearance and condition levels work with other security access features, such as the area lockdown feature and the access settings defined in Personnel objects. By configuring and managing this information in CyberStation, you can respond quickly to changing circumstances. Note: If the security key attached to the CyberStation workstation is not configured to view condition levels, condition level and clearance level attributes and values are not displayed or configurable in CyberStation.
- 507. Andover Continuum CyberStation Configurator’s Guide 495 Personnel Clearance Levels Clearance level values are maintained in the Personnel object for each person: • The Default Clearance Level applies to all areas that you assign to the person, unless you choose to override this value with different values for individual areas. • The Clearance Level for areas enables you to provide different access privileges to different areas assigned to the same person. The clearance level you assign to an area in a Personnel object does not affect the access of other personnel with access to the same area. Controller Condition Levels A value for Condition Level is stored at the controllers that manage access to the doors to each area. Controllers that support the Condition Level variable include: • NetController II • NetController, models CX99xx • ACX 57xx The Condition Level variable must be enabled in the security key in order for these controllers to use the variable and accept Condition Level values sent from CyberStation. Typically, the controller condition level corresponds to security alert levels that your company has established for emergencies. You use controller condition levels with personnel clearance levels to control access during different categories of emergency. A value of 1 for a controller condition level is the most severe alert level. A value of 255 is the least severe. A value of 0 indicates that no condition level is in effect. You can quickly change the condition level at all controllers by using the Global Condition Level dialog to send a new Condition Level value to the controllers from the CyberStation workstation. This is a faster method of changing the values than manually changing the condition level at each controller. You can also restore the previous condition level at all controllers using this feature. The following figure is an example of how a new Condition Level is sent from CyberStation changes condition levels at two controllers.
- 508. TAC496 How Clearance Levels and Condition Levels Work Together The condition level at a controller establishes the security alert level (sometimes called the "threat level") in effect at doors in areas managed by the controller. After verifying access card information (or keypad entry) and that the current area is assigned to a person requesting access, the controller compares its condition level to the clearance level of the person. For the controller to allow access, the value of the person's clearance level must be equal to or smaller than the condition level. The following figure is an example of how a controller uses clearance and condition levels to validate access.
- 509. Andover Continuum CyberStation Configurator’s Guide 497 Implementing Clearance Levels and Condition Levels The Andover Continuum system enables you to set up highly customized access that is tailored to the needs of your facility and the people who need access in normal and emergency situations. You can define up to 255 clearance levels and condition levels: • 1 is the clearance level that allows the most access. That is, when the condition level is 1 (most severe alert), only personnel with a clearance level of 1 who are assigned to the area will have access. • 255 is the clearance level that allows the least access. That is, the condition level must be 255 for personnel with a clearance level of 255 to be allowed access.
- 510. TAC498 You can use as many of these levels as you need. For example, a public facility in the United States might define condition levels that correspond to the five levels of the Department of Homeland Security (DHS) Advisory System, as shown in the following table. DHS Level DHS Color Condition Level Clearance Level Needed for Access Severe Red Level_01 1 High Orange Level_02 2 Elevated Yellow Level_03 3 Guarded Blue Level_04 4 Low Green Level_05 5 In Personnel objects, you can specify clearance levels that correspond to these condition levels. Configuring the Personnel Manager The Personnel Manager has default settings so that you can immediately create and view Personnel objects. However, you can configure settings to customize many features, enabling you to enter and manage personnel data more efficiently. Working with Personnel Profiles and Templates This topic contains information about using personnel profiles and templates to create, edit, and view data in Personnel objects. Using Personnel Profiles A personnel profile is a collection of settings that you use to create new Personnel objects and to view existing objects in the Personnel Manager. A personnel profile contains predefined settings and values for the following personnel information: • The attributes displayed when a user creates, edits, or views a Personnel objects, including attribute labels, whether attributes are required or are read only, and default values • The areas assigned to Personnel objects, which can also include schedule points attached to the areas, clearance levels for individual areas, and whether the area is enabled or disabled Profiles are similar to personnel templates. However, in addition to determining the personnel information that is predefined, profiles enable you to have more control over the personnel data that is entered, edited, and viewed in a Personnel object. For example, you can assign a profile that does not display sensitive information, such as Social Security numbers, to CyberStation users who do not need to see this information. Users who do require this information can be assigned a profile in which sensitive attributes are displayed. You can also specify whether attribute values are editable or read only.
- 511. Andover Continuum CyberStation Configurator’s Guide 499 The Personnel Manager provides four predefined profiles: Employee, Contractor, Temporary Employee, and Visitor. You can customize these profiles and create your own. To create a personnel profile, see “Creating a Personnel Profile” later in this chapter. How Profiles Are Applied When a user creates a Personnel object: The profile the user selects after clicking the Add Record button determines: • The areas that are initially assigned to the Personnel object • Any additional access rights associated with the areas, such as schedules and clearance levels The user can edit the area assignments and access rights as needed in the Personnel object. The profile assigned to the user determines: • The attributes displayed in the Details tab for the new object • Any predefined properties of the attributes, such as default entries and required entries • The folder where the Personnel object is saved When a user edits an existing Personnel object, the profile assigned to the user determines: • The attributes displayed in the Details tab • Any predefined properties of the attributes, such as read-only and required entries Using CyberStation Personnel Templates You can use a personnel template to create a Personnel object: • In Continuum Explorer, you can use the Configuration Wizard to create a Personnel object from a template that you select. You can also drag a personnel template to a folder containing your Personnel objects to create a new object. • In the Personnel Manager, you can create a Personnel object from a profile that has a template assigned to it, if you have customized a profile to include the Template attribute. In the profile, you can also specify the personnel template to use. When you edit the Personnel object, a message is displayed in the Personnel Manager status line indicating that a template is attached to the Personnel object. Any attribute values that are inherited from the template are read-only in the Personnel Manager. Attribute values copied (not inherited) from the template are editable. The profile assigned to the CyberStation user determines which attributes are displayed, regardless of the profile used to create the Personnel object. If you edit a template that is already assigned to Personnel objects, any changes to inherited attributes will automatically be changed in the Personnel objects using the template (Template content is displayed in the Personnel editor dialog rather than in the Personnel Manager.). Changes to attribute values that are copied (not inherited) from the template will not change in existing Personnel objects. New Personnel objects created
- 512. TAC500 from the edited template will include the updated values for both inherited and copied attributes. Assigning Areas from Personnel Profiles and Templates In the Personnel Manager, you can quickly assign areas specified in a profile or a template to a Personnel object. Any schedule points and clearance levels attached to the areas are also included in the Personnel object when you add the areas. Once in a Personnel object, you can edit the areas list as needed for the individual. Note: Area, schedule, and area clearance levels assigned to a Personnel object from a profile or template using the Reset Access Rights button in the Personnel Manager completely replace any area information already in the Personnel object. Creating a Personnel Profile Use this procedure to create a personnel profile that defines the information that is entered and displayed for Personnel objects in the Personnel Manager. Note: If you want Personnel objects created or edited using the profile to be associated with a personnel template, be sure to add the Template attribute to the Assigned Attributes list and select the template to use. For more information about creating templates, see Chapter 12, Templates. If you want to be able to attach a SecurityLevel object to Personnel objects, add the SecurityLevel attribute to the Assigned Attributes list in the profile. Store personnel templates in the Personnel Templates folder, which is a subfolder of the Templates folder. Personnel templates stored elsewhere within CyberStation cannot be attached to Personnel profiles or objects. Perform the following steps to create a personnel profile and specify its settings: 1. In the Personnel Manager, click the Configure button. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager. The Configure button is disabled unless a Personnel object is currently displayed in the Personnel Manager. 2. In the Configuration dialog, click the New button. 3. In the New Profile dialog, enter a new profile name and a description (optional), and then click OK. 4. In the Available Attributes list, select the attributes you want to include in your profile, and then click the add attributes button ( ) to add the selected attributes to the Assigned Attributes list. You can select one attribute at a time, or select more than one by pressing the Ctrl or Shift key while selecting. It is recommended that you always include First Name and Last Name in a profile, and make these attributes required entries.
- 513. Andover Continuum CyberStation Configurator’s Guide 501 5. Arrange the attributes in the Assigned Attributes list: To remove an attribute, select it and click the remove attributes button ( ). The selected attribute moves to the Available Attributes list. To arrange the sequence of attributes in the Assigned Attributes list, select an attribute, and click the up and down buttons ( , ) to move it within the list. The order you specify in this list determines the order in which the attributes are displayed in the Details tab when you add or edit a Personnel object using this profile. 6. Define the data entry properties of each attribute as needed. Property Description Required Check this checkbox to make an entry for this attribute required. Read Only Check this checkbox to make this attribute value read only; that is, not changeable. It is not recommended that an attribute be both required and read only. Default Enter a default value for this attribute. Users can edit the value in Personnel objects created from the profile if Read Only is not selected for the attribute and if the value is not inherited from a template. 7. Click the Assign Area button. 8. Expand UnAssigned, and check the checkbox next to each area that you want to assign.
- 514. TAC502 9. Click the browse button next to Path for New Personnel, and select the folder where you want to save Personnel objects created from this profile. Although it is not recommended, you can save Personnel objects in Root. If you selected a folder but want to select Root, click in the Path for New Personnel field, and press the Delete key or the Backspace key. Root is then displayed in the field. When you save the profile, you are prompted to confirm that you want to use Root. Click OK to continue. 10. Click OK. Creating a Profile from an Existing Profile Use this procedure to create a new profile by editing an existing profile and saving it with a new name: 1. In the Personnel Manager, click the Configure button. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager. The Configure button is disabled unless a Personnel object is currently displayed in the Personnel Manager. 2. In the Configuration dialog, select the profile that you want to edit. 3. Edit the profile as needed and click Save As. 4. In the New Profile dialog, enter a new profile name and description (optional), and then click OK. 5. Click OK. Assigning Areas, Schedules, and Clearance Levels to Profiles Use the following procedures to assign specific areas, schedule points, and clearance levels to a profile. When a new Personnel object is created from the profile, this information is automatically included in the new object. Existing objects are not affected by any changes to this information in the profile used to create the objects. Note: The Configure button is disabled unless a Personnel object is currently displayed in the Personnel Manager. Assigning Areas to Profiles Use this procedure to assign one or more areas to a profile. For example, you may want to assign only the lobby and cafeteria areas to the profile used to create Personnel objects for visitors. 1. In the Personnel Manager, click the Configure button. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager, and then click the Configure button. 2. In the Configuration dialog, select the profile that you want to edit. 3. Click the Assign Area button.
- 515. Andover Continuum CyberStation Configurator’s Guide 503 4. In the Assign Areas dialog, expand UnAssigned. 5. Check the checkboxes next to the areas that you want to assign. To remove access to an assigned area, clear the checkbox next to the area. 6. Click OK. 7. Click OK to save the profile. Attaching Schedule Points to Profiles Use this procedure to attach a schedule point to a specific area assigned to a profile. Schedule points are associated with schedules that define specific time periods when a person can access that area. For example, you may want to allow contractors into the building through the lobby only between the hours of 8 A.M. and 5 P.M. You can attach only one schedule point to an area. However, you can attach the same schedule point to multiple areas. 1. In the Personnel Manager, click the Configure button. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager, and then click the Configure button. 2. In the Configuration dialog, select the profile that you want to edit. 3. Click the Assign Area button. 4. In the Assign Areas dialog, expand Assigned. 5. Expand the area to which you want to attach a schedule point. 6. Click the icon next to Add Schedule to display the Add Schedules dialog. If needed, select the browse button next to Schedule Points Location, and locate the folder or container with the schedule point you want to add. 7. Select a schedule point. Select one or more areas where you want to attach this schedule point, and click OK.
- 516. TAC504 8. Click OK. 9. Click OK to save the profile. Changing an Area Clearance Level in a Profile Use this procedure to assign a clearance level to a specific area in a profile. When a new Personnel object is created from this profile, the clearance level for the area is included in the new object. The predefined value for Clearance Level for all areas is zero, indicating that the value entered for Default Clearance Level in the personnel attributes (shown on the Details tab) is the clearance level used for the area. If you want personnel to have access privileges for a certain area that are more or less restricted than the access provided by the person's default clearance level, you can specify a different clearance level for that area. If the security key attached to the CyberStation workstation is not configured to view condition levels, condition level and clearance level attributes and values are not displayed or configurable in CyberStation. For more information about clearance levels, see “Personnel Clearance Levels and Controller Condition Levels” earlier in this chapter. 1. In the Personnel Manager, click the Configure button. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager, and then click the Configure button. The Configure button is disabled unless a Personnel object is currently displayed in the Personnel Manager. 2. In the Configuration dialog, select the profile that you want to edit. 3. Click the Assign Area button. 4. In the Assign Areas dialog, expand Assigned.
- 517. Andover Continuum CyberStation Configurator’s Guide 505 5. Expand the area for which you want to change the clearance level. 6. Click the icon next to Clearance Level. 7. In the Clearance Level dialog, enter a new value, and click OK. 8. Click OK. 9. Click OK to save the profile. Assigning a Profile to a User Use this procedure to assign a profile to a specific user. The user sees only the attributes defined in the assigned profile when creating, editing, or viewing Personnel objects. Attributes that are not included in the assigned profile are not visible to the user. 1. In the Personnel Manager, click the Configure button. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager, and then click the Configure button. The Configure button is disabled unless a Personnel object is currently displayed in the Personnel Manager. 2. In the Configuration dialog, click the Assign Profile to User button. 3. In the User Profiles dialog, select a user from the Users list. Users are listed alphabetically. Click the Users column heading to sort the list in ascending or descending order. 4. Select a profile from the dropdown menu, and click OK. 5. Repeat steps 3 and 4 as needed to assign profiles to other users. 6. Click OK. Deleting a Personnel Profile Use this procedure to delete a profile from the Personnel Manager. 1. In the Personnel Manager, click the Configure button.
- 518. TAC506 If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager, and then click the Configuration button. The Configure button is disabled unless a Personnel object is currently displayed in the Personnel Manager. 2. In the Configuration dialog, select the profile that you want to delete. 3. Click the Delete button. 4. When prompted to confirm deletion, click Yes. 5. Click OK. If the profile you deleted was assigned to any users, assign another profile to the users as described in “Assigning a Profile to a User.” If you do not assign another profile, the profile selected in the configuration settings is used. Customizing Personnel Attributes Use this procedure to edit personnel attributes. You can change the attribute display name, limit the values that can be selected, and create or edit a list of allowable values for an attribute. The changes that you make to the attributes apply to all profiles and Personnel objects that use the attributes. The attributes Info1 through Info6 are user-definable. You can use them to capture personnel data that is specific to your company. For example, you can rename one of these attributes to First Responder with predefined values of Yes and No to identify employees to contact for assistance in emergencies. 1. In the Personnel Manager, click the Configure button. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager, and then click the Configure button. The Configure button is disabled unless a Personnel object is currently displayed in the Personnel Manager. 2. In the Configuration dialog, click the Customize Attributes button to display the Customize Attributes dialog.
- 519. Andover Continuum CyberStation Configurator’s Guide 507 3. In the Display Name column, edit attribute names as you want them to appear in the Personnel Manager. The Attribute column contains attribute names as they are defined in the CyberStation program. These names are not editable. 4. Check the corresponding Limit Allowable Values checkbox for each attribute whose values you want to limit. If you select this option, users must select a value for the attribute from a dropdown list whose entries you define. Users cannot enter values that are not in the list. For example, you can check the Limit Allowable Values checkbox for Department and then enter a list of the departments in your company. This option is available for attributes whose values are text strings. It is not available for attributes with numeric, date/time, or logical (True/False) values. 5. In the Edit Allowable Values column, click the blue button for the corresponding attribute to open the Edit Allowable Values dialog. Note: If you did not check Limit Allowable Values for the attribute, the dropdown list you create will not be displayed with the attribute when you create or edit a Personnel object using this attribute. 6. Click in the Attribute Values field and enter the value(s) you want in the dropdown list for this attribute.
- 520. TAC508 When you start typing a value, a new line appears under your value. To add another value, press the Enter key. To delete a value, check the Delete checkbox for that value. The value is deleted when you click OK. The value is not removed from any Personnel objects in which it is currently used. 7. Click OK to save the attribute values. 8. Click OK. 9. Click OK. Selecting Configuration Settings for the Personnel Manager Use this procedure to select the following settings for the Personnel Manager: • Whether thumbnail images of personnel are displayed with search results • The path for the card reader that you can use to read card information and display it in Personnel Manager • The default paths for schedule points and new Personnel objects • The profile that is used to display Personnel objects if no other profile is assigned to a user 1. In the Personnel Manager, click the Configure button. If the Personnel Manager is not open, you can double click any Personnel object in Continuum Explorer to open the Personnel Manager, and then click the Configure button. The Configure button is disabled unless a Personnel object is currently displayed in the Personnel Manager. 2. In the Configuration dialog, select the Settings tab.
- 521. Andover Continuum CyberStation Configurator’s Guide 509 3. To display thumbnail images of personnel by default with search results, check the Show Thumbnails on startup checkbox. You can also display or hide thumbnail images at any time in the Search Results tab. 4. To select a card reader that you can use to read card information in the Personnel Manager, check the Enrollment Reader checkbox and click the browse button. Select the Door object to which the reader is assigned, and click the Select button. Note: The enrollment reader does not need to be physically connected to a door. However, in CyberStation, you set up all card readers by entering their settings in Door objects. For information about setting up a card reader, see Chapter 18. 5. Click the browse button for Schedule Location. In the Select Schedule Location dialog, select the folder or controller that contains schedule points for determining when personnel can access specific areas, and click the Select button. When you attach schedule points to areas in a profile or Personnel object, you can select a different folder or controller, if needed. 6. Under Default Profile, select the profile that the Personnel Manager uses to display Personnel objects for any users who are not assigned another profile. The default assigned profile is Employee. A personnel profile is a collection of settings that you can use to view existing Personnel objects or to create new objects in the Personnel Manager. The profile determines what personnel data is visible to users. You can assign different profiles to different users as needed to prevent unauthorized access to sensitive personnel data. For more information, see “Assigning a Profile to a User.” 7. Click OK.
- 522. TAC510 Personnel Import Utility This topic provides an overview of the Personnel Import Utility, a table showing the entire step-by-step data importing process, and links to specific functions in this utility — configuring and mapping data, previewing data, transforming data, and importing/saving data. What is the Personnel Import Utility? In CyberStation, you have likely already used the Personnel Manager (or Personnel Editor) and related editors to create and modify personnel accounts. However, in some cases, you may need to import third-party personnel data outside of an Andover Continuum system. The Personnel Import Utility allows you do so. The Personnel Import Utility bridges the gap between other personnel databases and CyberStation personnel records by allowing you to import and upload personnel data in large amounts from outside the system. The Personnel Import Utility is also a conversion tool, as well as an import tool. It takes the "source" personnel attributes of non-CyberStation personnel records, and (via data filtering and special configuration files) converts them to CyberStation Personnel attributes. Personnel Import Utility is a CyberStation application based on Active Directory. Active Directory is a Microsoft Windows directory service that provides a unified view of complex networks. Active Directory is installed on a Microsoft Windows 2000 or Windows Server 2003 machine, known as the domain controller. CyberStation uses the Lightweight Directory Access Protocol (LDAP) to read and extract Active Directory user information. For more information on Active Directory and LDAP please see: What Is Active Directory? and What Is the LDAP Protocol?. Note: Your IT or system administrator is responsible for learning about and establishing the Microsoft Active Directory service on a domain server. You must have this Microsoft service in order to use the Personnel Import Utility. For more information on setting up Active Directory, please visit web sites such as these: • http://www.serverwatch.com/tutorials/article.php/1474461 • http://www.windowsnetworking.com/articles_tutorials/w2ksvrin.html • http://activedirectory.com Note: You do not need to install anything on CyberStation to accommodate Active Directory or LDAP; however the Personnel Import Utility is a separately purchased option, enabled via your CyberStation product key. It is launched from the Continuum task icon's popup menu, if you have a license. (See the import process below.) Note: Throughout these topics, references to the Continuum Personnel editor can also mean the Personnel Manager, depending on which one you are using.
- 523. Andover Continuum CyberStation Configurator’s Guide 511 What Can I do with the Personnel Import Utility? The Personal Import Utility has many powerful features. With this application, you can: • Define a folder location into which the transformed CyberStation Personnel objects will be placed. • Define an alias name and customize other attributes and constants. Note: An alias has a limit of 16 characters an is usually made up of the following: Any constant + FirstName FirstName + LastName + SSN • Add card types. • Add site codes. • Add personnel templates based on department. • Specify a personnel template name to associate with Personnel objects. • Add individual areas to a personnel record through a transformation file. • Specify the number of records to view to avoid alias conflictions. • View the Active Directory information before it is transformed. • View the transformed data (the CyberStation Personnel object attributes) before they are imported. • Find disabled records. • Use Windows Scheduler to define and schedule automatic personnel-record import operations. Import Process — the "Big Picture" The following procedure presents the major steps you would typically perform to import personnel data using the Personnel Import Utility — an overview of the entire process. 1. Launch the Personnel Import Utility. Right click on the Continuum icon in your tool tray, and select Personnel Import Utility from the popup menu. This runs the CyberStation application, PersonnelImportUtlity.exe, and the utility window appears. 2. Identify an Active Directory data source. Specify a new path of the Active Directory domain server. (You do this from the Data Source section of the Configuration tab.) In the Data Source section, you also enter your User Name and Password to gain access to the domain server. (See your IT or system administrator.) 3. Filter the number of personnel records you want to import. If you do not want to import all records, you must filter the records according to the specific criteria, such as record name, department, group, the time created or modified, and so on. (You do this from the Filter Data Source section of the Configuration tab.
- 524. TAC512 4. Map the Active Directory data source attributes to the Continuum Personnel editor attributes. When you lunch the Personnel Import Utility, attributes are automatically extracted from a configuration file and populated in the mapping window of the Configuration tab. In this mapping window, you can include, exclude, and add new attributes so that they appear or do not appear in the imported Personnel records. For more information on mapping attributes, see “Mapping Data Source Attributes to Continuum Personnel Attributes” later in this chapter. Note: When you launch the utility for the first time, data are extracted from a default configuration file, PersonnelImportUtility.exe.config. (You can enter your own configuration file name when you save all configuration settings.) For more information, see Step 8 below and the topic “Saving a Configuration and Importing Data into CyberStatioin.” 5. Edit your transformation file and specify the file name. Use the browse button in the Transformation File Name field on the Configuration tab to search for and edit the XSLT transformation file. When you do this for the first time, you can open the default file, PIUTransformation.xsl, which is located in: Program FilesContinuum or you may select your own XSLT file. The XSLT file, written in xsl tag code, provides additional instructions that define and customize personnel attributes in the transformation of personnel records. For example, in this file it is recommended that you define an Alias name and define (or accept the default for) the location of the folder into which imported personnel records are stored. Using this file, you can also modify mapped attributes, resulting in highly customized records. When finished, save your transformation file – either the default file or your own file. If you choose, you can also rename the file and place it another directory. 6. Retrieve and preview your mapped data-source and transformed data attributes. You must look at the data-source and transformed data – that is, all the Active Directory source attributes and the CyberStation Personnel attributes. (You do this using the Preview button on the Configuration tab. Source data attributes are displayed in the matrix on the Data Source Data tab. Transformed CyberStation Personnel attributes are displayed in the matrix on the Transformed Data tab.) Filter the number of records you want to preview using the Preview filters on the Configuration tab.
- 525. Andover Continuum CyberStation Configurator’s Guide 513 7. Re-edit and apply transformation file, as needed. If the transformed data in the preview are not to your satisfaction, repeat steps 5 and 6 until the attributes are the way you want them. Excluding the first time, every time you edit your data in the XSLT transformation file, you must click the Apply Transformation button to transform the data. 8. Save your configuration. When you are satisfied with the mapped data on the Data Source Data tab and Transformed Data tab, use the dropdown menu in the Configuration File Name field on the Configuration tab to select a configuration file, and then click the Save Config File button. Note: If you are configuring these settings for the first time, you must enter the name of a configuration file in the Configuration File Name field, so that it is saved to the database. Subsequently, when users create/save additional configuration files, they appear in this dropdown menu. When you perform a save, all the settings on the Configuration tab are saved to the CyberStation database. When you launch the utility again, following a save, these saved settings populate all the sections of the Configuration tab. 9. Import the transformed records. Only when you are satisfied with the entire Personnel Import Utility configuration, click the Import button at the bottom of the Configuration tab. A message box will prompt you to import. Clicking Yes will execute the import operation and place new and/or modified CyberStation Personnel records into the Personnel objects folder that you specified. 10. View the Error Log. After the import process is complete, you can view a CyberStation Error Log. This log is located in: Program Files Continuum PIUErrors290906161911 (this is PIUErrors + current date and time. Errors are also stored in the ErrorEvent table in the CyberStation database. 11. As an option, schedule automatic imports. As an option, you can use the Windows Scheduler to define and import automatic personnel-record import operations at specific predefined times. (For more information, see “Scheduling Automatic Personnel Object Updates.”) The following is a flow chart that diagrams this entire process. Use this chart as a quick reference to the import process procedure.
- 526. TAC514
- 527. Andover Continuum CyberStation Configurator’s Guide 515 Configuration Tab - Personnel Import Utility The Configuration tab is the first tab that appears when you open the Personnel Import Utility. From this tab, you perform all operations, including: • Filtering the records you want to import by different categories (name, department, group, or time) • Previewing the data being imported, as well as the source data • Creating and saving multiple configurations • Locating disabled personnel • Mapping data source attributes to CyberStation personnel attributes • Viewing the total number of filtered records and the total number of records that have successfully been imported • Transforming the data using the XSLT file (use the default or modify your own) to add or customize personnel attributes. The following table describes the attributes on the Configuration tab. Data Source Attributes Attribute Description Server Name The path of the Active Directory domain server, where the source personnel data to be imported resides. The default server name is LDAP://testDC=test,DC=com. The “test” next to “//” is the server name. The “test” in “DC=test” is the domain name. User Name Name of the user who can access the data source data on the Active Directory. Password The password that allows you to connect to the Active Directory domain server. Note: You will not be able to view or import your data unless you have entered a valid user name and password. See you system or IT administrator.
- 528. TAC516 Filter Data source Attributes Attribute Description All Records Select this radio button to get all the data source personnel records from the Active Directory domain server. Filtered Records Select this radio button when you want to filter the data and get records based on record name, department, group, disabled records, and/or time. By Record Name (Starts With) Check this checkbox, then select Starts With from the dropdown menu to find all the users that start(s) with a letter(s). In Active Directory, a name is stored “Firstname Lastname.” For example, to find “Tom Hanks,” type T or To or Tom. This option is only enabled with Filtered Records is checked. This is not case sensitive. By Record Name (Is Exactly) Check this checkbox, then select Is Exactly from the dropdown menu to find a user by typing her/her exact name. Exact name is “firstname space Lastname.” This is not case sensitive. This option is only enabled with Filtered Records is checked. By Department Check this checkbox and enter a department name to get all
- 529. Andover Continuum CyberStation Configurator’s Guide 517 Attribute Description the users under that specific department. This option is only enabled when Filtered Records is checked. By Group Check this checkbox and select a group from the dropdown menu to get all the users under that specific group. Group names are provided from the Active Directory data source. This option is only enabled when Filtered Records is checked. To access the dropdown menu, you must first click in the field. By Time Check this checkbox to get all the users created or modified during that specific time period. This option is only enabled when Filtered Records is checked. Created Select this radio button to get all the users created during the time interval you supply, or by using a filter such as “Last Hour,” “Last Week,” “Last Year,” “Last Month,” or “Last Run.” This selection works with the Time Filter dialog. See Time Filter below. This option is only enabled when Filtered Records is checked. The Last Run time is not updated until an import operation occurs. It is only for an existing configuration. “Last Run” is used for 2 cases: • It gets the value when the last import occurred with that configuration and the current time you are executing for the existing configurations. It searches within the time frame. • For new configuration or applications running without a configuration file, it takes the Start and End times as the current time and you will not see any records. Modified Select this radio button to get all the user modified during the time interval you supply, or by using a filter such as “Last Hour,” “Last Week,” “Last Year,” “Last Month,” or “Last Run.” This selection works with the Time Filter dialog. See Time Filter below. This option is only enabled when Filtered Records is checked. The Last Run time is not updated until an import operation occurs. It is only for an existing configuration. “Last Run” is used for 2 cases: • It gets the value when the last import occurred with that configuration and the current time you are executing for the existing configurations. It searches within the time frame. • For new configuration or applications running without a configuration file, it takes the Start and End times as the
- 530. TAC518 Attribute Description current time and you will not see any records. Time Filter After selecting Created or Modified, click this button to launch the Time Filter dialog and choose the time period in which personnel records were created or modified. Records are retrieved strictly during the time you set. All times are adjusted to UTC. Attribute Description Filter Select this radio button to select a time filter (such as “Last Hour”) from the corresponding dropdown menu. Time Interval Select this radio button to select a Start time and an End time from the corresponding dropdown calendars. Disabled Records Check this checkbox to exclude all enabled users in the data. This option is only enabled when Filtered Records is checked. Preview Attributes
- 531. Andover Continuum CyberStation Configurator’s Guide 519 Attribute Description All Select this radio button to preview all records to be imported. Some Select this radio button to preview only some of the users being imported. The default number is 100. Accept this number or enter your own number is the field provided. Preview Click this button to see the results on the Data Source Data tab and, after the transformation is over, in the Transformed Data tab. For more information on how to preview your data, see “Previewing Data” later in this chapter. Other Attributes Attribute Description Total Number of Filtered Records This field shows how many records are to be imported based on your filter settings. Total Number of Imported Records This field shows how many records have been imported after the import process is complete or after you click the Cancel button when an import operation is in progress. Transformation File Name This displays the path of the user-defined XSLT file after you have used the browse button to search for and select the file. This special file allows you to add and customize attributes for the imported CyberStation personnel records. When you do this for the first time, you can open the default file, PIUTransformation.xsl, which is located in: Program Files Continuum or open and edit your own file. For more information on transforming your data and using the XSLT file, see “Transforming Data Using the XSLT File” later in this chapter. Apply Transformation Click this button to apply the changes in the XSLT file and see the transformed data. For more information, see “Transforming Data Using the XSLT File” and the Transformed Data tab. Configuration File Name This is the configuration file (residing in the CyberStation database) that contains all the saved settings of all sections of the Configuration tab. For the first time, enter a name in this field; otherwise, use the dropdown menu to select one of the existing files in the database. For more information, see “Saving a Configuration and Importing Data into CyberStation.” Note: If you click this button without entering anything in
- 532. TAC520 Attribute Description the field, the Save Configuration dialog appears, asking you to specify a name for the configuration file. Map Data Source Attributes to Continuum Attributes In this window you see all the mapped data source attributes (Active Directory) and their corresponding CyberStation personnel record attributes. Mapping data source attributes to CyberStation attributes allows you to pick and choose attributes to be transformed. The information that populates this window is extracted from the default configuration file. For more information on manipulating attributes or adding more attributes, see “Mapping Data Source Attributes to CyberStation Personnel Attributes.” Import Click this button to import your personnel records in CyberStation, only when the configuration is filled out to your satisfaction. This is the last step to importing personnel. For more information on how to import your data, see “Saving a Configuration and Importing Data into CyberStation.” Cancel Click the button to cancel the operation at any time during the import/preview process. Help Click this button to launch the Continuum help. Mapping Data Source Attributes to CyberStation Personnel Attributes When you launch the Personnel Import Utility, it automatically extracts the attributes from the default configuration file and populates them on the Configuration tab in the window entitled Map Data Source Attributes to Continuum Personnel Attributes. Active Directory source attributes appear beneath the Data Source Attribute column, while their CyberStation Personnel object counterparts appear in the Continuum Personnel Attribute column. Note: If you are doing this for the first time, data are extracted from a default configuration file supplied with CyberStation. You must subsequently specify the name of a configuration file (or select the name of an existing one) when you save it. This mapping window allows you to choose which attributes you want to include or exclude in your transformed personnel records. To include an attribute, check the box in the Include column, in the row containing the attribute you want to include. To exclude an attribute, either leave the checkbox blank or, if the box is already checked, remove the check from the box.
- 533. Andover Continuum CyberStation Configurator’s Guide 521 For example, if you want to include a person's name, but not his/her office telephone number, check these boxes: givenname /First Name sn / Last Name but do not check this box: telephonenumber / Office Phone In this mapping window, you may also use the dropdown menu (embedded in entries within the Continuum Personnel Attribute column) to select another attribute to correspond with (or "map to") the data-source attribute. You do not need to accept the default mapping. Attributes in the dropdown menu represent those in CyberStation Personnel objects. You can further customize and add attributes by editing the XSLT file. For more information, please see “Transforming Data Using the XSLT File.” There are some rules to keep in mind when you’re mapping data source attributes to CyberStation personnel attributes:
- 534. TAC522 • A single Active Directory attribute should not be mapped to more than one CyberStation attribute. • A single CyberStation attribute should not be mapped to more than one Active Directory attribute. • A single CyberStation attribute should be populated either by mapping an Active Directory attribute or by specifying the attribute name as an XSLT tag, but not both. • CyberStation attributes that are mapped to Active Directory attributes must also appear in the XSLT file's "copy-of select" list. (See sample XSLT file section for more information.) • The XSLT file should reference CyberStation attributes and not reference any Active Directory attributes. • When specifying CyberStation attribute names in the XSLT file, be aware that CyberStation attribute names are case-sensitive (refer to table of Continuum attribute names for correct spelling). • Through the use of XSLT tags, it is possible to set the value of one CyberStation attribute to the value of a different CyberStation attribute. Attribute-mapping changes you make on the Configuration tab are saved with the configuration file. The following table is a sample listing of data-source (Active Directory) attributes with their corresponding CyberStation Personnel object attributes. These are extracted from the configuration file, but do not represent all the data-source attributes that reside on the Active Directory domain server. Note: When the Active Directory server is also a Microsoft Exchange Server, Active Directory stores 16 additional "extended" attributes that can map to Continuum Personnel attributes. Previewing Data Before importing transformed personnel records, you must preview your data via the Preview button, located on the Configuration tab. When previewing data, you can either preview all personnel by selecting the All radio button, or specify how many personnel records to preview by selecting Some. When Some is selected, the default number (100) is automatically filled in; however, you can enter another number. Clicking the Preview button displays the data on the Data Source Data tab and Transformed Data tab. It is important to view your data first because you want to make sure everything is mapped correctly before you import all the data. You should pay particular attention to the Alias attribute, since this attribute is the primary key to the CyberStation Personnel creation mechanism. You should verify that all aliases are unique and contain a value consistent with CyberStation naming conventions. • Aliases need to be a maximum of 16 characters. The first character cannot be numeric, and the remaining characters are alpha, numeric, or one of "." or "_". • The Personnel Import Utility will strip invalid characters and use the left-most sixteen characters when creating an alias. Records with empty Alias values will not be created.
- 535. Andover Continuum CyberStation Configurator’s Guide 523 If the aliases are not unique, subsequent records will be updated, rather than created. If the personnel information is incorrect or you want to change something, you can go back to the Configuration tab, change it, then preview it again. You should always preview your data before importing it. If you make more changes, you must click the Apply Transformation button again in order to display the changes. Personnel Import Utility will not make the changes automatically. Data Source Data Tab – Personnel Import Utility When you click the Preview button on the Configuration tab, personnel information from the data source is displayed on the Data Source Data tab and the Transformed Data tab. The Data Source Data tab contains a table showing the raw data taken directly from the Active Directory domain server. These are the data source attributes. Notice that these attributes are not the CyberStation attributes that you selected in the Map Data Source Attributes to CyberStation Attributes window on the Configuration tab. See “Mapping Data Source Attributes to CyberStation Personnel Attributes.” In order to see the CyberStation attributes that you mapped on the Configuration tab, look at the Transformed Data tab.
- 536. TAC524 Transforming Data Using the XSLT File The XSLT file is a special user-defined file containing information that allows you to transform data-source attributes into CyberStation personnel record attributes. It is recommended that this file, written in xsl tag language, define an Alias name. This file must define the folder location where the transformed imported CyberStation Personnel objects will reside. You can also use this file as a powerful data transformation tool, because you can add new attributes, as well as customize the existing attributes, so that they appear in the transformed Personnel records precisely the way you want them. On the Configuration tab, using the browse button in the Transformation File Name field, search for and select your XSLT file. When you do this for the first time, you can specify the default file that CyberStation provides — PIUTransformation.xsl, which is located in: Program FilesContinuum or open and edit your own file. Each time the file is changed, you must either apply the settings by clicking the Apply Transformation button, or preview your data again by clicking the Preview button. To view the updates, select the Transformed Data tab. Note: You must preview your data at least once before clicking the Apply Transformation button. Although the Apply Transformation button will be enabled before you preview, an error message will inform you that you must preview your data first. You can change this XSLT file using Notepad or other open-source tools, such as XRAY (http://www.download.com/xray-xml-editor/3000-72414-10166164.html) or Cook Top (http://xmlcooltop.com). Uses of the XSLT File You must use the XSLT file to: • Define an owner folder location into which imported personnel records are placed (as Continuum Personnel objects). • Add Area links (can be added only from the XSLT file) • Have the attribute "State" in the "copy-of-select" list You can also use this file to: • Define the Alias name, which is used later to find that person in the database. You shouldn't change this every time; it is a one-time process. • Modify and customize attributes, as needed. • Add attributes like Site Code, Card Name, and so on that may not be included in mapping, to supplement user information that comes from Active Directory. • Convert the state names into two-character State abbreviations. Refer to “Mapping Data Source Attributes to CyberStation Personnel Attributes” for a list of rules to keep in mind while mapping data source attributes to CyberStation personnel attributes.
- 537. Andover Continuum CyberStation Configurator’s Guide 525 Transformed Data Tab – Personnel Import Utility When you click the Preview button on the Configuration tab, personnel information from the data source (Active Directory) is displayed on the Data Source Data tab. Likewise, the Transformed Data tab displays a table containing personnel attributes that will appear in the transformed CyberStation personnel records. Note: If you specify another XSLT file, simply selecting a new file is not enough to transform the data; it does not transform automatically. You must click either the Apple Transformation button or Preview button again. The transformed data that appears on this tab represents the way you have: • Mapped data source attributes to CyberStation personnel attributes. • Filtered the records. • Modified and customized your XSLT transformation file. There are two important things to look for while viewing this tab: • Each alias must be unique. If the aliases are not unique, subsequent records will be updated with that record and a new record will not be created. (See “Saving a Configuration and Importing Data into CyberStation.”) To verify this, when previewing your data, make sure that every alias name under the "Alias" column is unique before importing.
- 538. TAC526 • Each person under the Owner Folder column must be assigned to a location. This attribute defines the folder where the record will reside in Continuum Explorer (for example, RootFloor 1, RootLobby, and so on). Remember, if you change the XSLT transformation file, you must click Apply Transformation or the Preview button to update the information on this tab. Saving a Configuration and Importing Data into CyberStation On the Configuration tab, after you have configured everything to your satisfaction, you can save all your configuration settings in a configuration file. For the first time, enter a name in the Configuration File Name field; otherwise, use the dropdown menu to select one of the existing files in the database. As users save configuration files, and the files accumulate in the database, the names of these files appear in the dropdown menu. Note: When you enter the name of a configuration file — no file extension is required — or select one from the menu and click the Save Config File button, you receive the following message: Do you want to read the Configuration of the Personnel Import Utility from the selected Configuration file? Click Yes. If you do not enter/select a filename, and click the Save Config File button, the Save Configuration dialog appears, asking you to enter a name in the field provided. Enter a name, and click OK. When you save a configuration, all settings on the Configuration tab are saved — the filtered data, server name, transformation file name, mapped attributes, and so on. (Remember, saving a configuration file does not save the information to the XSLT file — only to the configuration file.) Importing Personnel Records into CyberStation After clicking the Preview button, and only after being completely sure your data is correct, you should import your data into the CyberStation database as Personnel objects. To import data, click the Import button. When you click this button, a message box appears asking "Do you want to Import data into Continuum?" Click Yes. A message window appears, showing the import progress — specifically, how many personnel records have been imported and how many there are left to import. To stop this import process at any time, click the Cancel button. Canceling the import only stops the process from importing more records. The records that have already been imported are not erased from the database. For example, if you start to import 100 records, and click the Cancel button halfway through, only the first 50 are imported. On the Configuration tab, you are able to see the Total Number of Filtered Records (showing how many records to be imported based on your filter settings) and the Total
- 539. Andover Continuum CyberStation Configurator’s Guide 527 Number of Imported Records (showing how many records have been imported during and after the import process). Note: User accounts that are disabled in Active Directory will be disabled in CyberStation. Error Logs and Activity Logs After the import process completes, you can view a CyberStation Error Log. This log is located in: Program FilesContinuumPIUErrors290906161911.txt (this is PIUErrors + current date and time) Errors are also stored in the Error Event table in the CyberStation database. This lists the reasons why a record could not be imported. For example: • You were unable to connect to the server. • A duplicate alias was found. • Incorrect user name and/or password was provided. • An attribute was mapped incorrectly. (The log tells you the incorrect attribute.) Along with the Error Log, the CyberStation Activity Log (Activity Event table in the CyberStation database) automatically tracks all user activities and logs all Personnel Import Utility activities.
- 540. TAC528 Some Activity Log information that could appear are: • Personnel Import Utility started. • Personnel Import Utility search started. • Personnel Import Utility search ended. • Personnel Import Utility Import into Continuum started. • Personnel Import Utility Import into Continuum ended. • Personnel Import Utility ended.
- 541. Andover Continuum CyberStation Configurator’s Guide 529 Managing Personnel Distribution When personnel are assigned to areas and doors, their information is sent to the controller hardware, where the doors are located. The act of sending this information is called distribution. Several things can get in the way of a clean distribution: • The controller may be offline for some reason. • The network may be down. • There may be an error on the network during the distribution. • The telephone line connecting a remote site to the main controller may be busy. In all these cases, the distribution of a personnel object may not make it down to the proper controller immediately. Eventually, the distribution will go through, unless the memory capacity of the controller is exceeded. However, in the meantime, key personnel may not be able to obtain entrance to the area. Access Distribution View In CyberStation, you may open a new Continuum application, the Access Distribution View, to display all distribution tasks (also known as distribution-event transactions) and determine their current status – that is, whether they have succeeded, failed, or are “in process.” The Access Distribution View is similar to the Active Alarm View and Active Event View. Instead of active alarms and active events, the Access Distribution View lists active personnel-distribution tasks. The Access Distribution View is a powerful application. If necessary, you may immediately distribute a single personnel record, in any pending distribution transaction, to its proper controller. This is useful in urgent situations, when a personnel record must be sent to the controller but for some reason, such as those listed above, distribution is not happening. 20
- 542. TAC530 You may also designate multiple workstations to act as distribution servers. By having more than one workstation perform a distribution, there is less dependency on a single PC. The workstations work together to assure that they do not perform multiple distributions of the same personnel object. The Access Distribution View displays the workstation that is currently distributing or “handling” the distribution of any personnel object. Distribution is enabled for every workstation, by default. To disable a workstation's ability to distribute records to controllers, set preference 19 (Enable personnel distribution to controllers on the LAN) and/or 20 (Enable personnel distribution to RAS networks) to FALSE on the Preferences tab of the Device editor for any workstation that should not be a distributing workstation. (See Chapter 14 for a description of the settings on the Device editor’s Preferences tab.) Using Continuum’s General Preferences dialog, you may also set the number of concurrent personnel distributions sent to controllers on each field bus network, as well as set a time interval between these fieldbus distributions. This is done via General Preference settings 12 and 13, as follows: • Setting 12: Number of Concurrent Fieldbus Personnel Distributions — This setting is the number of concurrent personnel distributions that are sent from each workstation to controllers on each field bus network. The default (and minimum) value is 1. Maximum value is 4. This setting, which works in conjunction with setting 13, improves performance by preventing or large numbers of personnel records from flooding field bus controllers. • Time Interval Between Fieldbus Personnel Distributions — This General Preference setting is the amount of time (in milliseconds) that CyberStation waits before it sends another personnel distribution to controllers on the same fieldbus network. The default value is 30. Minimum value is 0. Maximum value is 15000 (15 seconds). This setting, which works in conjunction with setting 12, improves performance by preventing large numbers of records from flooding field bus controllers. It is also useful when there are many workstations performing access distribution. (That is, set it higher if there are many workstations.) For more information on General Preferences, see the Continuum online help and Chapter 13.
- 543. Andover Continuum CyberStation Configurator’s Guide 531 Launching and Populating the Access Distribution View To launch and populate the Access Distribution View, please follow this procedure. 1. Double click the Distribution server icon located in your tool tray. The Distribution Properties dialog appears. Note: For more information on the Distribution server, please see Chapter 2 or the Continuum online help. 2. Click the Access Distribution View button. The Access Distribution View Summary appears. The summary view, which appears initially by default, displays the total number of transactions for each destination network, controller, door, or area based on the status of each transaction. That is, the summary view's columns display total numbers of each transaction, according to status — total failed, total successful, total “in process,” and so on. (See Using Columns in Access Distribution View, later in this chapter.) Here is an example of the summary view: If you wish to switch from summary view to full view (where individual transactions are listed, instead of totals) go to step 3, and apply a filter. Note: In order to use the Distribute Now function, you must switch to full view and apply a filter. 3. Switch from summary view to full view. Select Edit filters from the Filters dropdown menu. The Filter dialog appears. 4. In the Filter dialog, remove the check from the Summary view checkbox, and apply a filter. (See Filtering Distribution Events in Access Distribution View, next.) Note: In summary view, Filter dialog attributes are not selectable, except two destinations, Network and Controller. 5. Click OK. The full Access Distribution View appears. 6. Select Refresh from the View menu, or click the refresh button icon in the toolbar. Note: Access Distribution View remembers your filter settings and launches in full view at your next session.
- 544. TAC532 Filtering Distribution Events in Access Distribution View From the Filters dropdown menu, select Edit Filters. Via the Filter dialog, you may select certain criteria based on destination, personnel, and status, to display specific types of distribution-event transactions in the Access Distribution View. For example, you may choose to see transactions for one person, for one area, for one controller, for failed transactions, and so on. Filtering the list greatly narrows your search for anomalies. Note: When you launch the Access Distribution View initially, the Access Distribution View Summary appears. To switch from summary view to full view, remove the check from the Summary view checkbox at the top of the Filter dialog. The summary view lists the total number of transactions for each destination, based on the status of each transaction. The full view lists the actual, individual transactions, instead of totals. You must apply a filter in order to use the Distribute Now feature. (See Launching and Populating the Access Distribution View, earlier in this chapter.) Access Distribution View remembers your filter settings. Therefore, these settings are applied in the full view in your next session. The Filter dialog has three general types of filters: • Destination • Personnel • Status Destination Filter Filter Description Network Select the Network radio button, and click the browse button in the Network field, to search for and select a Network object. This displays only the transactions occurring in the selected network. From the Browse dialog, use the dropdown menu in the Objects of type field to select Network. No other object class is selectable. Highlight the network you want, and its name appears in the Object name field. Click the Select button to select that network and dismiss the Browse dialog. The Network object name appears in the Network field. As an option, you can apply an area to the selected network. (See Area, below.)
- 545. Andover Continuum CyberStation Configurator’s Guide 533 Controller Select the Controller radio button, and click the browse button in the Controller field, to search for and select an InfinityController or InfinityInfinetCtlr object. This displays only the transactions that are controlled by the selected controller. From the Browse dialog, use the dropdown menu in the Objects of type field to select InfinityController to make just Infinity controllers selectable, select InfinityInfinetCtlr to make only Infinet controllers selectable, or select All classes to make them both selectable. Highlight the controller you want, and its name appears in the Object name field. Click the Select button to select that controller and dismiss the Browse dialog. The controller object name appears in the Controller field. As an option, you can apply an area to the selected controller. (See Area, below.) Door Select the Door radio button, and click the browse button in the Door field, to search for and select a Door object. This displays only the transactions occurring at the selected door. From the Browse dialog, use the dropdown menu in the Objects of type field to select Door. No other object class is selectable. Highlight the door you want, and its name appears in the Object name field. Click the Select button to select that door and dismiss the Browse dialog. The Door object name appears in the Door field. As an option, you can apply an area to the selected door. (See Area, below.) Note: You may deselect any and all radio buttons in the Destination filter section. You need not select any Destination radio button. Area Check the Area checkbox, and click the browse button in the Area field, to search for and select an Area object. This displays only the transactions that are happening in the selected area. Note: You may select an area as a sole destination, or you may select a network, controller, or door, and then select an area with which to associate it. In the Browse dialog, use the dropdown menu in the Objects of type to select Area. No other object class is selectable. Highlight the area you want, and its name appears in the Object name field. Click the Select button to select that area and dismiss the Browse dialog. The Area object name appears in the Area field. Personnel Filter Filter Description No Personnel Filter Select this radio button when you do not want to apply any personnel filter, thereby allowing any personnel record to appear in the list of transactions.
- 546. TAC534 Browse for Personnel Select this radio button, and click the browse button in this field, to search for one personnel record that you wish to appear in the list of transactions. This path of this person's personnel record object appears in this field. Use filters below Select this radio button when you want to apply a filter, rather than specifying a personnel record. You may apply a filter according to: First Name, Last Name, Department, and Card Number, described below. First Name Check the First Name checkbox, and enter the first name in the field. Select the Exact match radio button, and enter a complete first name, if you want to display transactions for all persons who have this first name. Select the Starts with radio button, and enter a string of characters, if you want to list transactions for all persons whose first names begin with these characters. For example, if you enter KE, the filter finds matches with persons named Kenneth, Kendra, Kelly, Kevin, and so on. Click OK to apply the filter. Last Name Check the Last Name checkbox, and enter the last name in the field. Select the Exact match radio button, and enter a complete last name, if you want to display transactions for all persons who have this last name. Select the Starts with radio button, and enter a string of characters, if you want to list transactions for all persons whose last names begin with these characters. For example, if you enter SIMON, the filter finds matches with persons with last names such as Simon, Simone, Simonson, Simonetti, and so on. Click OK to apply the filter. Department Check the Department checkbox, and enter the department name in the field. Select the Exact match radio button, and enter a complete department name, if you want to display transactions for all persons in this department. Select the Starts with radio button, and enter a string of characters, if you want to list transactions for all persons whose department names begin with these characters. Click OK to apply the filter. Card Number Check the Card Number checkbox, and enter the card number in the field, to display transactions for the person who holds this card number. Click OK to apply the filter.
- 547. Andover Continuum CyberStation Configurator’s Guide 535 Status Filter Filter Description Success Check this checkbox to display successful transactions. Failed Check this checkbox to display failed transactions. In Process Check this checkbox to display transactions that are locked by a workstation. Available Check this checkbox to display transactions that are waiting to be processed. Controller out of service Check this checkbox to display transactions that are ignored because the controller is out of service. Note: For each transaction listed in the Access Distribution View, the Status column displays an icon that indicates one of these status conditions. For a description of these icons, please see Using Columns in the Access Distribution View, next. Using Columns in the Access Distribution View Like the Active Alarm View and Active Event View, the Access Distribution View lists its information across many columns. As with the other views, you may add and hide these columns in the Access Distribution View. You may also rename, resize, move, and change the sort order of columns. Note: You cannot add/hide columns in the summary view. Use the following procedure to add or hide a full-view column. 1. In the full view, select Add/Remove Columns from the View menu. The Add/Hide Columns dialog appears, showing you all the columns that are available in the Access Distribution View. 2. Check the column's checkbox to show this column in the view. Remove the check to hide the column. 3. Click OK in the Add/Remove Columns dialog to apply the change and add/hide the column. Note: You may also right click a column heading and select Add or Hide from the popup menu. When you select Add, the Add/Hide Columns dialog appears. In this case, go to step 2. When you select Hide, the column over which you have right-clicked is immediately removed from the view. For information on how to rename, resize, move, and change the sort order of columns, please see Organizing Information in Chapter 10, Configuring Alarms, and apply that information to the Access Distribution View window. See also: Changing Alarm Sort Order in Chapter 10. In the Continuum online help, please see the following topics: Organizing Information in the Active Alarm View, as well as Changing the Sort Order, Understanding Sort Order, and Sorting in Ascending or Descending Order.
- 548. TAC536 Full View Columns The following table describes the information that appears in the columns of the full Access Distribution View. Here is an example of the full view:
- 549. Andover Continuum CyberStation Configurator’s Guide 537 Column Description Status Shows the current status of the distribution-event transaction. Status conditions that appear in this column (along with their status icons) can be one of the following: Status and Status Icon Description Success The transaction has completed successfully. Transactions can be personnel downloads, personnel deletes, or special transactions that set the controller out of "NoDatabase" mode after a reload. Failed The last attempt to process the transaction has failed. Transactions are degraded based on the number of consecutive failures, following a number of retries. This means transactions that continue to fail are retried less often. This is done by setting the Next Retry. In Process A workstation has "locked" the transaction and is processing it. The lock expires after a certain amount of time if the workstation has not unlocked the transaction. (The default is 5 minutes.) Workstations do not process transactions that are locked by other workstations. Available The transaction needs to be processed. This is the result of personnel modifications, controller reloads, door/area additions, and so on. Controller out of service The transaction is ignored because the controller is out of service. Destination Displays the path of the controller to which the information is being distributed. Area Displays the path of the area to which the person has access. Department Displays the department of the person. Door Displays the path of the door through which access is being attempted.
- 550. TAC538 Column Description Personnel Displays the name of the person whose personnel record is involved in the distribution transaction. Card Number Displays the card number of the person. Card Type Displays the type of card that was specified (via the Personnel editor when the personnel record object was established) for the person. Site Code Displays the site code that is encoded on the card belonging to the person. Last Error Displays the text of the system error occurring in the most recent (or current) transaction. If the most recent transaction is a success, then the word "Success" appears. Next Retry Displays the date and time of the next attempt to process the transaction. Each time a transaction fails, the failure count is incremented. The "next retry" time is based on the number of failures. The transaction is tried less and less frequently as this number of failures increases. For example, the Next Retry time is 10 minutes from the current time for the first failure, 20 minutes for the second failure, 40 minutes for the third failure, 80 minutes for the fourth failure, and so on. This ensures that reoccurring unsuccessful transactions do not have a negative impact on the system. Priority Displays either Low or High for the transaction. A Low priority denotes the "normal" operation of the distribution process. In an emergency situation (for example, when someone is waiting to get into a building) an administrator may click the Distribute Now button to elevate the priority to High. This does not necessarily distribute immediately, but high-priority transactions are processed before low-priority transactions. This is useful when a large distribution is occurring. Transaction Type Displays the current type of transaction, which can be one of the following: • Update — Indicates that a new or modified personnel record is being downloaded to the controller. See the status of this download transaction in the Status column. • Delete — Indicates that a personnel record is being deleted from the controller. See the status of this delete transaction in the Status column. • AccessModeNormal — Indicates that the controller has just completed the reload of its database, and personnel records
- 551. Andover Continuum CyberStation Configurator’s Guide 539 Column Description are being re-distributed to the controller, after its reload, to repopulate personnel in the controller. The transaction is responsible for setting the SystemStatus variable back to Normal. Number of Failures Displays an integer indicating the number of failed distribution attempts, including "retries." Locking Workstation Displays the workstation that is currently processing or "handling" the transaction, regardless of the status. If the locking workstation goes down, the lock on the transaction expires, allowing another workstation to process the transaction. Summary View Columns The summary view displays the total number of access-event transactions (an integer) for each destination — network, controller, door, or area, based on the status of each transaction. Summary view columns are: Destination Total Failed Total Available Total In Process Total Successful Total Out of Service
- 552. TAC540 Using Toolbar Buttons in Access Distribution View The following table describes the toolbar button icons in the Access Distribution View. Button Description Distribute Now Opens the Pending Access Distribution dialog, which allows immediate distribution. This resolves a person's attempt to access an area. (See Distributing Personnel Immediately –Distribute Now, next.) Refresh Refreshes the list so that information is up-to-date. (You may also select Refresh from the View menu.) Sort Enables the column sort function. (You may also select Sort from the View menu.) The sort function works like the sort function in the Active Alarm View and the Active Event View. (Please see Using Columns in the Access Distribution View, earlier in this chapter.) Help Opens the online help system. (You may also select Contents from the Help menu.) Right-arrow and left-arrow buttons Displays the next "page" in the view, when the list of transactions is longer than the length of the window. Note: The page status line at the bottom of the view (Page x of x) tells you what "page" you are currently viewing in a long list. Click the inner right-arrow button to move to the next page. Click the rightmost button to view the last page. Likewise, click the inner left- arrow button to view the previous page and the leftmost button to view the first page. Note: You may move the Distribute Now, Refresh, Sort, and Help buttons as one toolbar. Click and hold the left edge of the Distribute Now button, and drag the toolbar to the desired location. Click and drag the arrow buttons as one toolbar in the same way. Distributing Personnel Immediately — Distribute Now For any pending distribution-event transaction listed in the Access Distribution View, you may immediately distribute a personnel record (representing the person who has access an area) to a controller on the local area network (LAN) and/or a remote access services (RAS) network. Note: Distribution is enabled for every workstation by default. To disable a workstation's ability to distribute records to controllers, set preference 19 and/or 20 to FALSE on the Preferences tab of the Device editor for any workstation that should not be a
- 553. Andover Continuum CyberStation Configurator’s Guide 541 distributing workstation. (See Chapter 14 for a description of the settings on the Device editor’s Preferences tab.) Note: You cannot use this Distribute Now feature while in the summary view. To distribute personnel using Distribute Now, follow this procedure. 1. In the full Access Distribution View, highlight the pending transaction. 2. Click the Distribute Now button in the toolbar, or double click any transaction listed in the view. The Pending Access Distribution dialog appears. For example: Note: The Distribute Now button is enabled in the toolbar only when both the personnel and controller object IDs are present. Both are needed to perform the distribution. 3. In the Pending Access Distribution dialog, make sure the person that appears in the Personnel field is the one that you wish to distribute to the controller that appears in the Controller field. If this is not the right person or controller, click Cancel to dismiss this dialog. Make sure information in the Door and Area fields is also correct. 4. If this is the right person and controller, click the Distribute Now button. The personnel record is immediately distributed to the controller. 5. In the Access Distribution View, select Refresh from the View menu (or click the refresh button) to refresh the information in the window. In the Status column, the status icon of this event is changed.
- 554. TAC542
- 555. Andover Continuum CyberStation Configurator’s Guide 543 Managing Configuration Files Overview Continuum's file management system offers a powerful suite of features that manage configuration information for BACnet devices. You can automatically back up configuration information from the BACnet device to your database, as well as automatically restore it from the database to the device. The configuration information resides in a special configuration file, which is stored as an object — the BACnet class object, File. You can also archive it locally in a text file (ASCII dump .dmp file.) Backup Capabilities Specifically, file management backup features allow you to: • Back up the configuration information (stored in a special File object called ACCConfiguration in Andover Continuum) for a single BACnet controller and save it to your Continuum database. • Back up configuration information for multiple controllers (also stored in ACCConfiguration files, each in its respective controller) and save the information for multiple controllers to your Continuum database. • Back up configuration information from the database and archive it to a text • (ASCII dump) file. • Simultaneously back up a controller's configuration information to the database and copy (archive) it to a text (ASCII dump) file. Note: You perform these operations via either the right-click container popup menu in Continuum Explorer's navigation pane or the Backup/Restore tab in the Device editor for that controller. For detailed information on backup operations, please see Backing Up a Device's Configuration and the Device editor's Backup/Restore tab, Chapter 14. 21
- 556. TAC544 Restore Capabilities Specifically file management restore features allow you to: • Restore configuration information from your database to a single BACnet controller. • Restore configuration information from your database to multiple controllers. • Restore the archived configuration information (contained in the text ASCII-dump file) to your database. • Simultaneously restore the archived configuration information (contained in the text ASCII-dump .dmp file) to your database and to the controller. Note: You perform these operations via either the right-click container popup menu in Continuum Explorer's navigation pane or the Backup/Restore tab in the Device editor for that controller. For detailed information on restore operations, please see Restoring a Device's Configuration and the Device editor's Backup/Restore tab, Chapter 14. The File Object When a backup operation (or send-to-database operation) is performed for a BACnet device, a File object (a BACnet class object) is created. This object, which is stored in the File object class folder residing in its respective BACnet controller. It contains configuration information for objects residing on the controller. Note: The number and names of these files and file names are determined by individual BACnet devices (Andover Continuum vs. third-party). On Andover Continuum devices, the name of this file is ACCConfiguration. Because the BACnet File object is implemented in Continuum, this object has an object editor consisting of two tabs: General and SecurityLevel. The General tab displays information about the file properties of the ACCConfiguration file. General Tab The File editor's General tab displays information about the file properties of the ACCConfiguration file. Note: The General tab is read-only. You cannot change the values in its fields. The following table describes the read-only attributes of the General tab. For more information on these attributes, see the File object type section in the BACnet Standard. Editor Attribute Meaning Description This field is typically blank. However, if some third-party BACnet devices support the Description property for the File object, then the content of the description appears in this field. Last Changed Displays the date/time that the configuration file was last modified. Type Displays the class object type, File.
- 557. Andover Continuum CyberStation Configurator’s Guide 545 Editor Attribute Meaning Size Displays the size of the file. The size changes whenever the file is modified. Access Method Displays either Stream_Access or Record_Access. Record Count Displays the size of the file in records. This is displayed only when AccessMethod is Record_Access. Archive This box is checked if this is an archive file in the device. Read Only This box is checked by default. Backing Up a Device’s Configuration File-management backup operations, listed below, are performed via the container popup menu in Continuum Explorer's navigation pane and/or via the Backup/Restore tab in the Device editor for that controller: • Back up configuration information (stored in a special File object called ACCConfiguration) for a single BACnet controller and save it to your Continuum database. (See the procedures below.) • Back up configuration information for multiple controllers (also stored in ACCConfiguration files, each in its respective controller) and save the information for multiple controllers to your Continuum database. (See the procedures below.) • Back up configuration information from the database and archive it to a text (ASCII dump) file. (See Backup/Restore tab of the Device editor, Chapter 14.) • Simultaneously back up a controller's configuration information to the database and copy (archive) it to a text (ASCII dump) file. (See Backup/Restore tab of the Device editor, Chapter 14.) Note: Backup/restore operations are not supported in the context menu if the device does not support the BACnet property, AutomaticReadFile. Backup/restore operations are not supported on the Backup/Restore tab of Device editor if the device does not support the BACnet property BackupFailureTimeout. Procedures Backing up a single device — To back up a configuration for a single device, perform the following procedure: 1. On the BACnet side of Continuum Explorer's navigational pane, locate the controller whose configuration information you want to back up. 2. Right click over the device, and from the popup menu select Backup BACnet Device. For Andover Continuum BACnet controllers, the backup operation begins and the Distribution Properties dialog appears, showing the progress of and information about the operation. (For more information on the Distribution Server and the Distribution Properties dialog, see Chapter 2.)
- 558. TAC546 For some third-party BACnet controllers, you are first prompted to enter a password. If the password is accepted, the operation begins. Backing up multiple devices — To back up configurations for multiple devices, perform the following procedure: 1. On the BACnet side of Continuum Explorer's navigational pane, locate the controllers whose configuration information you want to back up. 2. In the navigational tree, click the parent container containing the desired devices, so that those controllers appear in the viewing pane. For example, the parent container could be BACnet Devices or any BACnet controller that contains sub-devices. 3. Highlight (select) two or more controllers in the viewing pane. 4. Right click over the highlighted controllers, and from the popup menu select Backup BACnet Device. For Andover Continuum BACnet controllers, the backup operation begins and the Distribution Properties dialog appears, showing progress messages about the status of the operations. For multiple controllers, information is backed up one controller at a time. The progress messages tell you when the backup operation finishes for one controller and begins for the next. (For more information on the Distribution Server and the Distribution Properties dialog, see Chapter 2.) For some third-party BACnet controllers, you are first prompted to enter a password. If the password is accepted, the operation begins. Backing up all devices on a BACnet Network — You can back up configurations for all devices residing in a BACnet network by right clicking over a BACnet Network folder: 1. On the BACnet side of Continuum Explorer's navigational pane, locate the blue BACnet Network folder that contains the devices whose configurations you want to back up. 2. To back up all the devices contained in the Network, right click over Network folder, and from the popup menu select Backup BACnet Device. To back up two or more controllers selectively (but not all of them), in the navigation tree, click the Network folder so that its controllers appear in the viewing pane. In the viewing pane, highlight (select) the controllers you want to back up. For Andover Continuum BACnet controllers, the backup operation begins and the Distribution Properties dialog appears, showing progress messages about the status of the operations. For multiple controllers, information is backed up one controller at a time. The progress messages tell you when the backup operation finishes for one controller and begins for the next. (For more information on the Distribution Server and the Distribution Properties dialog, see Chapter 2.) For some third-party BACnet controllers, you are first prompted to enter a password. If the password is accepted, the operation begins.
- 559. Andover Continuum CyberStation Configurator’s Guide 547 Restoring a Device’s Configuration File-management restore operations, listed below, are performed via the container popup menu in Continuum Explorer's navigation pane and/or via the Backup/Restore tab in the Device editor for that controller: Specifically file management restore features allow you to: • Restore all configuration information from your database to a single BACnet controller. (See the procedures below.) • Restore configuration information from your database to multiple controllers. (See the procedures below.) • Restore the archived configuration information (contained in the text ASCII-dump file) to your database. (See the Backup/Restore tab of the Device editor, Chapter 14.) • Simultaneously restore the archived configuration information (contained in the text ASCII-dump file) to your database and to the controller. (See the Backup/Restore tab of the Device editor, Chapter 14.) Note: Backup/restore operations are not supported in the context menu if the device does not support the BACnet property, AutomicReadFile. Backup/restore operations are not supported on the Backup/Restore tab of Device editor if the device does not support the BACnet property BackupFailureTimeout. Procedures Restoring to a single device — To restore a configuration to a single device, perform the following procedure: 1. On the BACnet side of Continuum Explorer's navigational pane, locate the controller whose configuration information you want to restore. 2. Right click over the device, and from the popup menu select Restore BACnet Device. For Andover Continuum BACnet controllers, the restore operation begins and the Distribution Properties dialog appears, showing the progress of and information about the operation. (For more information on the Distribution Server and the Distribution Properties dialog, see Chapter 2.) For some third-party BACnet controllers, you are first prompted to enter a password. If the password is accepted, the operation begins. Restoring to multiple devices — To restore configurations to multiple devices, perform the following procedure: 1. On the BACnet side of Continuum Explorer's navigational pane, locate the controllers whose configuration information you want to restore. 2. In the navigational tree, click the parent container containing the desired devices, so that those controllers appear in the viewing pane. For example, the parent container could be BACnet Devices or any BACnet controller that contains sub-devices.
- 560. TAC548 3. Highlight (select) two or more controllers in the viewing pane. 4. Right click over the highlighted controllers, and from the popup menu select Restore BACnet Device. For Andover Continuum BACnet controllers, the restore operation begins and the Distribution Properties dialog appears, showing progress messages about the status of the operations. For multiple controllers, information is restored one controller at a time. The progress messages tell you when the restore operation finishes for one controller and begins for the next. (For more information on the Distribution Server and the Distribution Properties dialog, see Chapter 2.) For some third-party BACnet controllers, you are first prompted to enter a password. If the password is accepted, the operation begins. Restoring to all devices on a Network — You can restore configurations to all devices residing in a BACnet network by right clicking over a BACnet Network folder: 1. On the BACnet side of Continuum Explorer's navigational pane, locate the blue BACnet Network folder that contains the devices whose configurations you want to restore. 2. To restore all the devices contained in the Network, right click over Network folder, and from the popup menu select Backup BACnet Device. To restore two or more controllers selectively (but not all of them), in the navigation tree, click the Network folder so that its controllers appear in the viewing pane. In the viewing pane, highlight (select) the controllers you want to restore. For Andover Continuum BACnet controllers, the restore operation begins and the Distribution Properties dialog appears, showing progress messages about the status of the operations. For multiple controllers, information is restored one controller at a time. The progress messages tell you when the restore operation finishes for one controller and begins for the next. (For more information on the Distribution Server and the Distribution Properties dialog, see Chapter 2.) For some third-party BACnet controllers, you are first prompted to enter a password. If the password is accepted, the operation begins.
- 561. Andover Continuum CyberStation Configurator’s Guide 549 Creating Groups What is a Group? A group is an object used to monitor other objects. Each group has its own list of objects known as “members.” Members can be objects from any class, and one group can have members from different classes. Typically, you’ll create a member list by adding objects that have something in common. For example, you could create a group that monitors all the objects stored on a particular controller. Similarly, you could use a group object to monitor all the objects pertaining to a particular function, such as air handling or security. Group objects provide three ways to monitor objects: • You can view a group’s member list. The member list displays the name, class, and value of every object in the member list. For groups that consist entirely of personnel objects, the member list displays the last name, first name and middle initial of the individual, the last known location of the individual, and personnel object name. • You can view a graph the group’s first 15 points. The graph plots logged values. • You can view a history of the object values. The history displays a list of all the points in the group, and the values logged for them over a particular period. When creating a group, you’ll work with the group editor to build or modify its member list, and you make choices that will configure the group’s graph and history views. 22
- 562. TAC550 What is a Graph? The graph view plots logged values for a point, or the first 15 points and/or system variables in a group’s member list. You’ll see a vertical scale to the left of the graph. Along the bottom, you’ll see a horizontal line delineated by time periods. In most cases, you’ll see a horizontal scroll bar that allows you to move left and right along the time line. The vertical scale and the horizontal time line are also known as the vertical axis and horizontal axis, respectively. The body of the graph displays one line for each point. To the right of the graph, you’ll see a legend. The legend lists the names of the points, each in different color. The color of the point name matches the color of its respective line in the graph. Reading Graphs Graphs differ from histories in that they depict trends as well as actual point values. For example, it’s easy to see whether temperatures tend to rise at noon. Simply find 12:00 PM in the horizontal time line, then look at the lines above its tick mark in the body of the graph. Do they spike up, or drop down? In a history view, you would have to compare all the point values in the 12:00 PM row against values in other rows to retrieve the same information. As with a history view, a graph view also provides specific point values for specific times. To locate a point’s value, find the time you want in the horizontal axis. Next, imagine a vertical line going from the time’s tick mark to the line that represents the point in which you are interested. Finally, imagine a horizontal line going from the line to the vertical axis. The value located where the horizontal line intersects the vertical axis is the value of the point for that particular time. Working With Multiple Scales A graph can be set up to use more than one scale. When points to be graphed use different units (Deg F, CFM, Square Meters, etc.) multiple scales allow one graph to plot the values for all. Graphs that use multiple scales display only one scale at a time. You’ll know that a graph uses multiple scales if the scale’s color matches the color of the first point in the legend. That means the graph is currently displaying the scale for that point. To switch to another scale, use one of these methods: • Click the scale to change its color and scale values. The scale will change to according to the order of the points in the legend. Keep clicking until the scale’s color matches the color of the point whose scale you would like to see. • Click a point name in the legend. This changes the scale color and the scale values to match the point on which you click.
- 563. Andover Continuum CyberStation Configurator’s Guide 551 What Are Automatic Logs? Automatic logs are record-keeping devices that can be set up for every kind of point except DateTime and String. There are four types of automatic logs: • LogInstantaneous – Continuum stores the current value of points at the beginning of every interval. • LogAverage – Continuum calculates average point values over every interval, using a weighted average algorithm. Average values are stored at the end of every interval. • LogMinimum – Continuum compares all values over an interval, and finds the minimum value. Minimum values are stored at the end of every interval. • LogMaximum – Continuum compares all values over an interval, and finds the maximum value. Maximum values are stored at the end of every interval. Log intervals determine how often to record the point value. These intervals are specified in the point’s editor, on the Logs tab. Logs store values in an array that group views use to create histories and graphs. Using the Group Editor The Group General Tab You use the General tab to set up data sampling parameters for the group you are configuring.
- 564. TAC552 Description The text you enter in this field appears as the title of the graph and history of your group. Default View Select the view of the group that you want to appear when you open the Group object with the SHOW command. Default Time Range Enter the Days, Hours or Minutes to specify what period of time your group graph or history will sample. For example, if you enter 1 hour, the group monitors group members for one hour. The time range selected on this tab does not affect the starting and stopping time for the group. These values are specified by you when you open a History or Graph view. Member List Refresh Rate This is the polling rate. Enter the interval in seconds at which you want the system to update values for your group. Members will only be refreshed when the Member List is shown. Personnel Only Member List Not implemented in this release. The Member List Tab The Member List tab lets you add objects to or delete them from the group. You click the Add button to browse for objects to add to the group. Remember, graph and history views display only point objects that have automatic logs set up for them. From this tab you can right-click any object in the list and select any of the following options: • Open • Edit • View History or View Graph • Send To Controller or Send To Text File • Rename • Properties Use the Member List tab to add and delete members. You can also look the properties for each member. Adding Members – To add a member, click the Add button. This displays a Browse dialog to help you locate the object you want. You can also add members by dragging the objects from the viewing pane of the Explorer into the open member list. After you have found the object you are looking for, select it, then click the Select button. When adding objects, keep these points in mind: • Graph and history views display only point objects that have automatic logs set up for them. • If you are creating a group consisting entirely of Personnel objects, select Personnel Members Only on the General tab to insure that the member list displays the appropriate attributes.
- 565. Andover Continuum CyberStation Configurator’s Guide 553 When you add folder, ListView, or group objects, all the objects contained by or listed in these objects are added to the group as well. Deleting Members – To delete a member, click it, then click the Delete button. Viewing Member Properties – To view a member’s properties, click it, then click the Properties button.
- 566. TAC554 The Graph Tab This is the tab you use to set up the parameters of the graph view of this group. Use the Graph tab to configure the scale that will be used to plot the first 15 point values in the member list. Note that only points with automatic logs set up for them will be graphed. To complete this tab, you’ll perform the following tasks: Scale of Vertical Axis Singular Scale: Use the Singular Scale option if all your points use the same units. Multiple Scale: Use the Multiple Scale option if you have a group of objects with different units. Vertical Axis Scale If you are using a single scale, you will need to define the vertical axis. The vertical axis displays a range for the point values in your member list. Top Enter the number that will show on the graph view as top of scale. Bottom Enter the number that will show on the graph view as bottom of scale. Units Enter the Unit nomenclature that will show as the label for the vertical axis, for example, Deg F.
- 567. Andover Continuum CyberStation Configurator’s Guide 555 The History Tab Use the History tab to configure how the automatic log data for the objects in the group will appear in the group view: Display History Values This view displays two types of values, actual and fill. Actual values are taken from automatic logs at the intervals defined for each log. Fill values occur at the interval defined by the Time Between Rows setting.
- 568. TAC556 Filling Type Select the option for filling in values between the logged values on the History chart. The history view displays two types of values: actual and interim. Actual values are taken from automatic logs at the intervals defined for each log. Interim values occur at the interval defined by the Time Between Rows setting. If the Time Between Rows setting matches the automatic log interval, all the values displayed are actual values. In most cases, however, the Time Between Rows setting is less than the log interval. For example, the time between rows could be set to 10 seconds, and the log interval could be one minute. In this case, the history view will display more rows than there are entries in the log. In fact, there will be 5 rows for every 1-log entry. To compensate for this, the history view uses interim values until it receives an actual value from the log. Interim values are either repeated actual values, or “sloped” to show the gradation between one actual value and the next. The Filling Type determines how the History view will display the interim values. Your Filling Type choices are as follows: None – This option displays only the values taken at each log interval. In other words, no interim values are displayed between rows. The following picture shows a history view using the None filling type: This filling type omits interim values from the history view. To achieve this effect, click None on the History tab.
- 569. Andover Continuum CyberStation Configurator’s Guide 557 Repeat Values Until Change – This option repeats the last value until the point value changes The following picture shows a history view using the Repeat filling type: This filing type repeats the last actual value until it changes. To achieve this effect, click Repeat Values Until Change on the History tab. Slope Between Values – This option displays gradations of values between the rows. Gradation calculations are based on the difference between row values, and the number of refresh rate values between rows.
- 570. TAC558 The following picture shows a history view using the Slope filling type: Notice that this filling type shows gradations of one actual value to the next. To achieve this effect, click Slope Between Values on the History tab. Time Between Rows Enter the Hours, Minutes, or Seconds that will be the interval between rows of values on the History chart. Dim Fill Values When this checkbox is selected, the fill values between logged values on the History chart are dimmed and appear gray instead of black.
- 571. Andover Continuum CyberStation Configurator’s Guide 559 The following picture shows a history view with its interim values dimmed: Notice that this filling type makes it easy to distinguish actual values from interim, or fill, values. To achieve this effect, click Dim Fill Values on the History tab. Opening a Log Viewer Once you have configured a Group object, you can review the activities of the objects in the group three different ways: • Log Viewer Member List • Log Viewer History • Log Viewer Graph To bring up any of these group views: 1. Select the Group object in Continuum Explorer 2. Right-click and select View then Member List, History or Graph from the popup menus Or, select View from the Object menu, then Member List, History or Graph. Editing a Group from the Log Viewer Do the following steps to open the Group editor for a Log Viewer: 1. Click the Edit Parent Object icon in the GroupView tool bar.
- 572. TAC560 2. You then can change an existing Group’s default settings or add members to its member list. If there is a check in the checkbox next to an object on a Member List, that object will appear in a history. 3. You can drag and drop objects from Continuum Explorer to the Member List tab.
- 573. Andover Continuum CyberStation Configurator’s Guide 561 Creating ListViews What is a ListView? A ListView is a Continuum object that displays information about a specific object class. ListView information is either live or retrieved from the Continuum database. The information that you see in a ListView depends on the columns of information displayed, how those columns have been configured, and whether or not qualifiers have been established to filter objects by specified criteria. You can view the contents of the ListView from the ListView object itself, from an HTML report, or from a printed document. ListViews provide features that allow you to display an HTML report, format and print the ListView contents, and even access the ListView editor itself. From the editor, you can add and configure columns, choose colors for various situations, and set up qualifiers to filter objects. Additionally, you can open the editor for any object shown in the ListView. About Creating a New ListView You create ListViews by typing information into text fields, making selections from dropdown menus, and browsing for objects. Once you have used the ListView editor to create a ListView, you will run the ListView then return to the editor if necessary. Using the ListView Editor The ListView General Tab Use the General tab to select an object class and specify where Continuum looks for objects of this class. You can also specify an HTML template for viewing your ListView data in an HTML report document. 23
- 574. TAC562 Description Enter a description of up to 32 characters (including spaces) to help others who need to test, modify or manipulate this ListView. Class Select an object class from the dropdown menu. This list of objects includes all the object classes that appear in the New object popup list in Continuum Explorer. Continuum also provides many specialized ListView classes you can use to track system events, such as AlarmInfo, DistributionBatch, EventLogControl and ImExportRef. About Class Default ListViews Continuum allows only one Class Default ListView per class. Database and Live qualifiers should not be used in a Class Default ListView. You can use sorting and background color choices when configuring the ListView columns to make items in the list stand out. For example, you can create an InfinityInfinetController Class Default ListView with three columns, Name, CommStatus and InfinetId. Make the CommStatus column Sort order be Primary and Sort direction be Ascending. Make the CommStatus column Background color red. Make the Name column Sort order Secondary. Selecting any path other than ClassDefault will not produce a Class Default ListView. Path Type Select from the dropdown menu. This helps Continuum decide where it looks for objects in the Class, such as Programs on a particular controller or BinaryValue points stored in a certain folder.
- 575. Andover Continuum CyberStation Configurator’s Guide 563 AllPaths Searches all possible paths on your system FolderOnly Searches the folder in the Path field FolderandBelow Searches the folder in the Path field and all its subfolders DeviceOnly Searches the device in the Path field DeviceandBelow Searches the device in the Path field all the objects attached (owned by) the device Prompt Displays a dialog that asks users for the ListView path ClassDefault Designates this ListView as the default view for the class you selected from the Class dropdown menu. Path Browse for and select the device or folder to insert in Path. Options Show Grid Lines: Use this option if you want your ListView to contain row and column markings. Live Data on Open: Use this option to make the ListView open with live data rather than data from the Continuum database. Options Live Data Refresh Rate: If your ListView contains live data, enter the refresh rate in seconds. Continuum refreshes the ListView display using the interval you specify here. Five (5) seconds is the fastest a list view is permitted to refresh. List Reload Rate: The rate that Continuum reloads the entire list in seconds. The time is measured from when the list finishes loading. For example if you set the reload rate to 20 seconds, the list will reload 20 seconds after it finishes loading, not 20 seconds from when it starts loading: load list, wait 20 seconds, reload list, wait 20 seconds, and so on. Zero (0) seconds disables this feature. A valid setting must be 5 or more seconds. Report Template Click the Browse button in the Report Template field to display the Open dialog:
- 576. TAC564 Browse to find the HTML report template file that you want to use for this ListView. The HTML file must be local to the workstation or be stored on the server. The HTML report templates provided for this course contain the fields that will accept ListView attribute data. When you view the HTML report, the ListView data that appears in the report fields is static. The values are not updated from the ListView. Creating HTML report templates is covered in the Continuum System Administration Course. The Columns Tab Use the Columns tab to add, remove and configure data columns in the ListView. You can configure the contents and appearance of each column you add.
- 577. Andover Continuum CyberStation Configurator’s Guide 565 Add Column Click the Add Column button once for every column you want in your ListView. For every column you add, a column template like the one shown below appears: See Configuring ListView Columns on the next tab for instructions on configuring columns after you create them. Configuring ListView Columns For each column you add to your ListView you select the attribute information that it displays and make several other choices regarding its appearance. To make these choices, you work with a column template like the one shown below Each column template begins with default values for every aspect of your data. To specify different values, click in the field containing the value you want to change (see diagram above). Depending on the value type, you can: 1. Type over the existing value 2. Choose a new value from a dropdown menu.
- 578. TAC566 3. Display a dialog that helps you select a new value. 4. Select a checkbox to indicate yes, or clear it to indicate no. The following table tells you how to use each field. Column Field How to Configure Attribute Select an attribute such as Name or Status from the dropdown menu. Type in the first letter of the attribute you want to make the list scroll to that letter. Heading By default, the ListView uses the attribute’s name as a heading. To use a different heading, type over the attribute name. Edit Select this checkbox to let users edit the attribute from the ListView. Clear the checkbox to disallow editing. Note: Not all attributes are editable. Font and Heading Font For each ListView column you can specify fonts for the column data and the column heading: Click in the Font or Heading Font field of your column. Click the button that appears to display the Font dialog. Select a font, font style and size from the scrollable lists. As you do so, the Sample box shows a text sample. In Effects, specify strikeout marks, underlines and font color. Click OK to save your font settings. Justification Select Right, Left, or Center from the dropdown menu. Source Select Database or Live from the dropdown menu. With Database, display the attribute’s database value. With Live, display the current attribute value of the object. Specify the refresh rate in Live Data Refresh Rate on the General tab. Sort See the section Sorting in ListViews later in this chapter for instructions on using the option. Width The number of pixels for the column width, such as 25. Show To include this column in the ListView, select the Show checkbox. To hide this column in the ListView, clear the checkbox. Columns that do not show in a ListView can appear in HTML and printed report formats.
- 579. Andover Continuum CyberStation Configurator’s Guide 567 Column Field How to Configure Background Color Click in the Background Color field of your column. Click the button that appears to display the Color dialog. Select a color from the palette or define your own custom colors. Click OK to save your color settings. Sorting in ListViews You can sort the data in your ListView by the values of up to three attributes. This is useful for ordering the rows of data to make them easier to read. Select the attributes used to sort the rows from the Columns tab. Because each column represents one attribute of the object class you are viewing, you can sort by Name, Value, or Status providing you have added and configured columns for those attributes. To Sort by Attribute Value Click the Sort field of the column of the attribute you wish to sort. This displays the dialog shown below: Select an Order number to help establish the sort order when you sort by more than one attribute. See Understanding Sort Order on the next tab. Select either Ascending or Descending from the dropdown menu. See the section, Sorting in Ascending or Descending Order on the next tab. Click OK to save your work, or click Cancel to exit the dialog without saving. For every attribute on which you base the sort order, specify if it’s the Primary, Secondary, or Tertiary sort order. The Order number defines what happens when Continuum finds two objects that have the same attribute value.
- 580. TAC568 For example, if the Primary sort attribute is Name, how does Continuum order two objects named RoomTemp1? Which does it list first? If another attribute has been set up as the Secondary sort attribute, Continuum uses its value to decide which object is listed first. The Tertiary sort attribute works the same way. If Continuum finds two objects with the same Primary and Secondary sort attributes, it uses the Tertiary sort attribute to decide how to list the objects. Sorting in Ascending or Descending Order For every attribute on which you base the sort order, specify either Ascending or Descending order: • Ascending order starts with the lowest value and ends with the highest value. • For text, ascending order is A to Z. • For numbers ascending order is 0 to the highest numeric value. • Descending order starts with the highest value and ends with the lowest value. • For text, descending value is Z to A. • For numbers, descending value is from the highest value to 0. Note: Values such as Active, Inactive, ON, OFF, Online, Offline, Enabled and Disabled are represented to Continuum by 1 and 0 respectively. These values are sorted just like numeric values. Sorting Example The following example shows Numeric objects sorted in Ascending order, with Name as the Primary sort attribute, Value as the Secondary and Device Name as the Tertiary: The first two objects are sorted by Device Name because they have the same name and value. The third object is sorted by Value because, although it has the same name as the first two, its value is higher. The last two objects are sorted by Name. The Qualifiers Tab Uses the Qualifiers tab to enter Plain English statements to further qualify the objects displayed in the ListView. While the General tab allows you to qualify objects by class and path, the Qualifiers tab lets you qualify and highlight objects depending on their attribute values. It is divided into
- 581. Andover Continuum CyberStation Configurator’s Guide 569 three main sections: Database, Live and Highlight. In addition, the Highlight Color field is used in conjunction with the Highlight section. The Qualifiers tab offers two methods of creating qualifying statements for ListView objects: 1. Type the statements directly into the appropriate text field. 2. Use the Query Wizard to build the statements. The method that you use is determined by the state of the "Advanced XXX Qualifiers checkbox. • If it is checked, the edit control is enabled and text can be entered into the text field. • If it is not checked, the Query Wizard button is enabled and selecting it will open the Query Wizard dialog (see below) which allows you to build an appropriate qualifier statement. Using the first (advanced) method, you are responsible for creating the qualifier statement correctly. With the second method, the Query Wizard assists you in building the statement and once it is built, it is returned to the appropriate text field in the Qualifier tab. If necessary, the statement can then be edited by checking the "Advanced XXX Qualifier checkbox Live versus Database Qualifiers The Qualifiers tab offers you the choice of constructing statements Live or from the Database. If you select Live, the Cyberstation retrieves the settings of the qualifier statement attributes directly from the controller. If you select Database the Cyberstation retrieves the attributes settings from Continuum's database.
- 582. TAC570 The choice between Live and Database depends on certain factors. By using Live, you are assured of getting the latest version of the qualifier attribute settings since they are retrieved directly from the controller. If you know the attribute doesn't change very often, you can retrieve it from the database, which is faster than going to the controller to get a live value. Using the Qualifiers Tab in the Advanced Mode To create your qualifier statements directly in the Qualifiers tab, proceed as follows: 1. Click the Advanced Database (or Live) Qualifier checkbox. 2. Type the Plain English qualifier statement/s in the Database (or Live) text field. For example: STATE = DISABLED OR OVERRIDE = TRUE 3. Click the Advanced Highlight Qualifier checkbox if you wish to highlight certain parts of the statement created in step 2. 4. Type the parts of the statement you want highlighted in the Highlight text field. For the example in Step 2, if you want to highlight only those objects with an Override value of TRUE, you would enter the following statement: 5. OVERRIDE = TRUE 6. Place the cursor in the Highlight Color text field and click the right mouse button: 7. Click Background Color to display the Color dialog: 8. Select the color you want and click the OK button. 9. Repeat steps 6 and 7 for the desired Text Color. Your color selections will be previewed in the Highlight Color field. 10. Return to the General tab and follow the "Test and Save" procedure at the end of this chapter to create the ListView.
- 583. Andover Continuum CyberStation Configurator’s Guide 571 Highlight Text and Color Example The following figure shows an example of a ListView where objects with a State attribute of Disabled have been highlighted: Using the Query Wizard To build your qualifier statements with the Query Wizard, proceed as follows: 1. Click the Query Wizard button in the Database (or Live) section of the Qualifier tab (the Advanced XXX Qualifier checkbox must unchecked) to display the Query Wizard dialog. 2. Click the down arrow in the Attribute list field and scroll through the list and select the attribute you want by clicking on it. 3. Click the down arrow in the Operator list field and select the operator you want by clicking on it. (See "Operator Selections" on the next page.) 4. Click the Value text field and type in the appropriate value for your qualifier statement (see "Value Selections" on the next page). 5. Click the Prompt checkbox if you want to be prompted for an alternate attribute value when the ListView appears. (See "Prompt for an Attribute Value" on the next page.) Note: The Prompt feature is only available for a Database qualifier. It is not available for object link attributes, such as owner ID or device ID. 6. If you have additional qualifying conditions to add to your statement move down to the next row of boxes on the Wizard.
- 584. TAC572 7. Fill in the Attribute, Operator and Value fields as described in steps 2, 3 and 4. 8. Click the left hand field to enter a joint and/or operator. (See "Compound Qualifiers" on the next page.) 9. Repeat steps 6, 7 and 8 if additional Compound Qualifiers are required. 10. Click the OK button. If the statement validates without any errors, it will re-appear in the appropriate text field of the Qualifier tab. If errors occur during validation, an error message will appear and must be corrected to complete the operation. (See "Error Messages" later in this chapter.) Operator Selections The operators that are selectable from the Operator dropdown menu include the following: > Is Is like >= Is not Is not like < Is between <= Is not between Refer to Chapter 3 of the Plain English Language Reference manual for explanations for each of these operators. The values to associate with these operators are discussed below. Value Selections The value that you select must be an appropriate one for the operator. The value requirements for certain operators are listed below. Operators Value Is Is not Number or expression that gives a number or a string. Also works with object links, for example "Ownerid is rootMyFolder". Is like Is not like An asterisk (*) for number of characters or a question mark (?) for any single character. Is between Is not between An expression that gives two numeric values, the lower one first, separated by an ampersand (&): number & number >, >= <, <= Number or expression that gives a number.
- 585. Andover Continuum CyberStation Configurator’s Guide 573 Compound Qualifiers Notice that an additional selection box appears to the left of the last three rows in the Query Wizard dialog. These boxes allow you to link multiple statements together with the and/or joining operators. An example might look like this: Attribute Operator Value Description Is like A* and Value is between 1 & 10 and Channel > 1 Prompt for an Attribute Value Notice that a Prompt checkbox is located at the right hand end of each row on the Query Wizard dialog. This is an optional feature that is only available for a Database qualifier. Activating the checkbox will cause a prompt to appear on the screen when the ListView is opened. The prompt will allow you to change the corresponding attribute value and thus change the contents of the ListView for that particular object. Error Messages The error messages that you may receive if the qualifier statement is invalid are listed below. Note: In the Error Message column, the words in italics represent the type of item that would be substituted in the actual message. Error Message Possible Cause "You must pick an operator for the expression" You selected an attribute but did not pick an operator to go with it. "You must join additional qualifiers with either an and or an or operator" You have more than one qualifier statement, but did not pick an AND/OR operator to join them. "The value AttritubeValue you entered for the attribute AttributeName is invalid. The value portion of the expression failed validation for some reason. For example "The value is not within the specified range". "You may only use the is, is not, is like and is not like operators on the attribute AttributeName. You have selected an operator that is not supported for the attribute. "The object ObjectName that you entered for the attribute AttributeName does not exist in the database. Do you wish to use this object anyway?" You have tried to enter a value for an object link attribute but the value you entered does not exist in the database. This message box will give you two choices, yes and no. If you select yes then the text you entered will be used anyway, if you select no then validation will fail and you can then change the text.
- 586. TAC574 Test and Save After you fill out the tabs of the ListView editor, return to the General tab. 1. Click the Apply button to create the new ListView. 2. Click the Run ListView button. Your new ListView will appear, covering the ListView editor window. 3. Review the elements of your new ListView. 4. To use the editor to modify the ListView, click its button in the Windows task bar at the bottom of the screen. 5. Use the ListView buttons in the Windows task bar to switch between the ListView and its editor. 6. Click OK in the editor to save the ListView. Creating a History or Graph of a ListView To create a history or graph of your ListView, follow these steps. Note: This procedure is performed the same (with the same screens) when a history or graph report for your ListView is required. The final output of your history or graph is different and both outputs are shown. 1. Highlight the ListView from which you want a history or graph. 2. From the ListView Object menu, select History or Graph.
- 587. Andover Continuum CyberStation Configurator’s Guide 575 3. You are presented with the following screen. Select the times you require in the Range fields and the Time Between Rows fields. Select the type of log you require and click OK or Now. 4. Depending on whether you selected History or Graph, you are presented one of the following screens depicting a history or a graph of your ListView. If you select History, the following appears: If you select Graph, the following appears:
- 588. TAC576
- 589. Andover Continuum CyberStation Configurator’s Guide577 Creating EventViews Overview An EventView object determines which access-related events will display in an Active Event View. You configure an EventView object using the EventView editor. Active Event Views are used to monitor access-related activities. These activities include the use of card readers and/or keypads to gain access through locked doors, or trouble situations such as a door left ajar, keypad tampering, or forced entry. Active Event Views also provide information such as who is using which door, when, and whether the door re-locks properly. Event views are called “active” because they receive and list access control events as they occur. Using the EventView editor, you specify the types of events and the doors you want to monitor. You can also specify sorting criteria for the events, and configure the font and color for each event. Once you have created an EventView object, users on any CyberStation workstation can monitor events as they occur in an Active Event View. 24
- 590. TAC578 Before Creating an EventView Prior to creating an EventView object, make sure the appropriate Access Events have been selected on the Options tab of your Door editor.
- 591. Andover Continuum CyberStation Configurator’s Guide579 Creating an EventView From the Continuum Explorer, right-click the Live Views folder, New, and select EventView. Type in a name for the new EventView (for example, DoorXXEventView) and press Enter. You will be presented with the following tabs. These tabs are discussed in the following sections. • General • Doors • Fonts and Colors
- 592. TAC580 The General Tab In the General tab, enter information about the Active Event View’s general appearance. Description Enter a description that explains which doors and event types will display in the Active Event View. (Adding this information is optional.) Maximum Number of Events Enter the maximum number of events you want the Active Event View to display at one time. When the number of events displayed reaches the maximum number, the bottommost event drops off the list as a new event displays. The order in which events display depends on the sort criteria you set up. Maximum Time in View Enter the number of seconds events will display in the Active Event View before expiring and dropping off the list. If this field is left blank, events don’t expire, they drop off the list based on the maximum number of events and the current sort order. Sort Criteria In the Sort Criteria area, you may sort events according to three columns. The Active Event View displays several columns of information for every event, according to the sort criteria you select here. Sorting is useful for grouping events to look for trends in, for example, the source of events, types of events, and which personnel are accessing which doors most often. From the Primary, Secondary, and Tertiary dropdown menus, select up to three columns. The columns you select establish the sort order that the Active Event View uses. Check the ascending checkbox to sort in ascending order, or clear it to sort by descending order and click OK to save your work.
- 593. Andover Continuum CyberStation Configurator’s Guide581 The Doors Tab In the Doors tab, select the doors and the event types to display in the Active Event View. These doors and event types you select are listed on this tab. Perform the following steps to add doors and/or event types. 1. Click the Add Door button. The Browse dialog appears. 2. Search the directories for, and select, a door to add to the list of doors to be displayed in the Active Event View. Note: As an alternative, you may select one or more doors from the desired directory, click and drag the doors to the Doors tab, and release the mouse button. 3. Click OK to return to the Doors tab. 4. For each door listed, check the checkbox for every event type that you want to include in the Active Event View. Use the horizontal scroll bar to see all the available event types. Note: As an alternative, select the event type you want to include in the Active Event View, and click Check Selected. 5. When you do not want to include an event type in the Active Event View, scroll to the event type you want to remove, and click the checkbox to remove the check. Note: As an alternative, select the event type you do not want to include, and click Uncheck Selected. Perform the following steps to remove doors. 1. In the list of doors on the Doors tab, select one or more doors you wish to remove.
- 594. TAC582 2. Click Remove Doors. The Fonts and Colors Tab In the Fonts and Colors tab, configure the font, text color, and background color for every event type. All event types are listed on this tab. For example, you could use a green background for valid access events, yellow for invalid attempts, and red for door ajar events. Configuring fonts in this way helps the operator quickly differentiate events. When you select a font and color for an event type, that event type is listed with its new font and new colors. Perform the following steps to configure fonts and colors. 1. On the Fonts and Colors tab, right click an event type. A popup menu appears. 2. Select Font to configure the font and font style. 3. Select Background Color or Text Color to configure colors for the background and text, respectively. The Security Level Tab For details in attaching or detaching Security Levels, see Chapter 4, Security.
- 595. Andover Continuum CyberStation Configurator’s Guide583 The Active Event View The Active Event View lists the events associated with the specified object (in this case the Lobby Area). Based on how your Administrator configured the active event view, it can show events for one door, a group of doors, all doors, or doors associated with a particular area. The events are shown in chronological order with the most recent event presented first. Each row displays columns of information related to a particular event. Event information can be displayed in a variety of colors to depict different categories of events. Parts of the Active Event View An Active Event View generally consists of the following types of components: • Active Event View menus • Quick pick options • Columns Menus The Active Event View has the following dropdown menus: Object, View, and Help. Object Menu Menu Selection Description Print Prints the current Active Event View. Print Preview Displays a full screen preview, showing how the current Active Event View will be formatted when printed. Print Setup Opens the Microsoft Print Options dialog for changing printers and setting print options. Clear All Events Exit Closes the Active Event View. Prompts to save data. View Menu Menu Selection Description Toolbar Prints the current Active Event View.
- 596. TAC584 Sort Displays a full screen preview, showing how the current Active Event View will be formatted when printed. Auto Sort Sorts all access events. Freeze Opens the Microsoft Print Options dialog for changing printers and setting print options. Add/Remove Columns Closes the Active Event View. Status Bar Hides or displays the status bar. Always on Top When selected, ensures that the Active Event View will stay on top of all other applications on your screen. Event View Object Opens the EventView object editor for this Active Event View. Door Opens the Door object editor. Area Opens the Area object editor. Person Opens the Personnel Manager. Help Menu Menu Selection Description Contents Opens Active Event View help topics. About Active Access Event View Displays program information, version number, and copyright information. Quick Picks As an alternative to the dropdown menus, you may use the these quick pick icons to save time: Click this … To … Print the current Active Event View. Start or stops the addition of new events. Open the EventView editor. Open the Personnel Manager or editor. Open the Door editor. Open the Area editor. Navigate to a video (brings up the VideoLayout editor) for an event. Enable the sort function.
- 597. Andover Continuum CyberStation Configurator’s Guide585 Click this … To … Open the Pending Access Distribution dialog, which allows immediate distribution. When you want to distribute a personnel record immediately to a controller, in order to resolve a pending request to access an area by that person, highlight the pending distribution-event transaction, and click this button. The Pending Access Distribution dialog appears. To perform an immediate distribution, click the Distribute Now button. For related information, please see Chapter 20, Managing Personnel Distribution. Open Active Event View help topics. Columns For every event, the Active Event View displays the following columns of information: Column Description Date/Time Date and time the event occurred Type Type of access event. Door Door at which the event occurred Person Personnel associated with the card reader or keypad event Area Area in which the event occurred Controller Full path to the controller that controls the door Message Not yet implemented Zone Code If the system is zone-based rather than area-based, the code number of the zone in which the event occurred Department Point Department point number of the person causing the event Card Number Access card number of the person causing the event Card Type Access card type, Wiegand, or ABA, of the person causing the event Site Code Access card site code number of the person causing the event Working in the Active Event View As mentioned previously, the Active Event View is a dynamically updating list. By default, the view lists all of the event details in columns. You use the scroll bars to access the information not displayed in the window.
- 598. TAC586 Two options are available for changing the way the information is presented in the view: • Resizing Columns – You can resize column widths by pointing on the vertical dividing line between two columns. When the cursor changes to a double arrow , then hold down the mouse button and drag the column boundary to the left or right. • Adding/Removing Columns from the View - You can modify the settings for the view to remove (or add) columns from the display. To accomplish this, choose the option Add/Remove Columns from the View dropdown menu. A dialog appears: Click the box to the left the columns you want removed from the view. The check mark is removed from the box indicating the column has been deselected. Click the OK button to save the changes and have the view updated to reflect the column removal. Conversely, if you want to add columns to the view, click in the box so a check mark does appear and then click OK to save the changes. Viewing Event Details Viewing the event information can be accomplished through the Active Event View or you can retrieve an Event Details View. The Details View conveniently displays all of the event information in one window that you may find easier to read the event information. Double click any event in the Active Event View to see the Details View of that event. The Details View shows you all the Active Event View column information in a single dialog.
- 599. Andover Continuum CyberStation Configurator’s Guide587 Right click any browsable field to open a popup menu of options. Field Description Type Indicates what type of event occurred. Date and Time Indicate when the event occurred. Message Displays a text string describing the event condition. Door Indicates at which door the event occurred. Personnel Shows the person associated with the card reader or keypad event. Area Shows what area the event occurred (where door is located). Controller Displays the name of the controller the access control device is attached. Department Point Indicates the department point number of the person causing the event (if one has been defined for the person). Zone Code Reflects the code number of the zone in which the event occurred, if your system uses zone rather than area based access control. Card # Shows the access card number of the person causing the event. Card Type Indicates the type of access control card used by the person causing the event. Site Code Displays the site code assigned to the person causing the event (if one has been defined for the person).
- 600. TAC588 Sorting Events You can sort events by the values of up to three columns. This is useful for grouping events to look for trends in, for example, the source of events, types of events, and which personnel are accessing which doors most often. Note: You may also sort events by columns, and establish sort criteria, via the General tab of the EventView editor. Perform the following steps to sort events by columns. 1. Select Sort from the View menu to display the Sort Criteria dialog. 2. From the Sort Criteria dialog, select up to three columns from the Primary, Secondary and Tertiary dropdown lists. The columns you select establish the sort order that the Active Event View uses. 3. Check the ascending checkbox to sort in ascending order, or clear it to sort by descending order. 4. Click OK. Rearranging Active Event View Columns Use the click and drag method to rearrange the columns in the Active Event View: 1. Click once on a column heading to highlight the column. 2. Click again anywhere in the column, and hold down the mouse button. A small box appears next to your cursor. This indicates you are ready to move the column. 3. Drag the cursor to the new location in the Active Alarm View, and release the mouse button.
- 601. Andover Continuum CyberStation Configurator’s Guide589 Adding and Hiding Columns Follow these procedures to add a column, hide two or more columns, and hide one column. To add a column: 1. Select Add/Hide Columns from the View menu. This opens the Add/Hide Columns dialog. 2. Select the checkboxes of the columns you want to add. To hide two or more columns: 1. Select Add/Hide Columns from the View menu. This opens the Add/Hide Columns dialog. 2. Clear the check boxes of the columns you want to hide. To hide one column: 1. Right click the column you want to hide. This opens the shortcut menu. 2. Click Hide. Accessing Events for a Specific Door To monitor the access control activities of a particular door, you open the Door editor window for the door through a listview. The steps to do this are as follows: 1. Click the All Doors listview button. The listview opens showing a list of all your doors. 2. Double-click the door whose activities you want to monitor. The Door editor window opens for the door (in this example, Lobby Door is the selected door.)
- 602. TAC590 To monitor the access control activities of a particular door, you open the Door editor window for the door through a listview. Follow this procedure: 1. Click the Access Events tab. The window updates to show the events recorded for this door, in chronological order.
- 603. Andover Continuum CyberStation Configurator’s Guide591 As you can see from the figure, the Access Events list displays: o The type of event (EventClass column) o Date and time the event occurred (TimeStamp column) o Person associated with the event (Person column) o Area associated with the event (Area column—not shown in this figure but accessible via the horizontal scroll bar) 2. Click the Refresh button to see the most recent access events. In addition to monitoring active events, you may need to review past event information that has been stored in the CyberStation database. To look at event history, ListViews are utilized. Event history is useful in diagnosing recurring problems. For example, your supervisor may ask you to research Door Ajar events for a particular door. Or, gather information about the number of personnel moving into or out of a specific area. An example event listview is shown below.
- 604. TAC592
- 605. Andover Continuum CyberStation Configurator’s Guide 593 Configuring and Viewing Video Version 1.7 and higher, CyberStation has two video object classes, VideoLayout and VideoServer, and video integration. Specifically, this chapter presents: • Overview of Video integration and configuration • Using the VideoServer editor • Using the VideoLayout editor Overview of Video Integration and Configuration Video integration comprises: • Two object classes: VideoLayout and VideoServer. A VideoLayout object is essentially CyberStation’s video surveillance monitor, through which you may view live and/or recorded video images. Each layout can display images from up to nine cameras. A VideoServer object identifies video servers for CyberStation, making it possible for CyberStation to communicate with each video server and its cameras. Note: It is assumed that the video servers (Integral brand) have already been configured, along with cameras and video presets. Therefore, to perform your configuration tasks, you should already know the video server names, user names, user passwords, and IP addresses for each Integral video server. • Various attributes for many existing object classes that have video associated with them — for example, graphics objects, Door objects, and points, such as InfinityInput and BinaryInput. • Active Alarm View features and Active Event View features that integrate video with individual alarms and access events, respectively 25
- 606. TAC594 The following procedure provides an overview of configuration tasks that you perform to achieve video solutions suited to your site. While completing these tasks, refer to the other sections in this chapter (Using the VideoServer Editor and Using the VideoLayout Editor) for more details. Also refer to other parts of this manual, where noted. 1. Create all VideoServer objects — Enter server names, user names, passwords, and IP addresses. Test each server's connection. (See Using the VideoServer Editor, later in this chapter.) Note: You must have already gathered this information from each video server, which should have already been configured, along with cameras and presets. (See your Integral video server documentation.) 2. Create all VideoLayout objects — When you create a VideoLayout object, you must associate cameras with (and assign them to) video control frames, or “windows,” where images are displayed. There are two ways to do this: • Manually assign cameras — You may manually assign a camera — that is, “hardwire” it — to each video frame in the VideoLayout object editor. You would typically “hardwire” a camera to view video that is not associated with alarms. For example, this method is useful during real-time surveillance and routine guard tours. (See Using the VideoLayout Editor, later in this chapter.) • Pre-assign cameras — You may pre-assign cameras in objects that associate video with alarms and access events. This method uses a new feature called video points. In the long run, video points save time and are easier to use because they populate the frames of VideoLayout objects dynamically and automatically. Up to four “video point” frame assignments are made in objects (such as a Door or InfinityInput) that generate alarms and access events. When the object goes into alarm, the VideoLayout associated with the object dynamically loads those camera assignments. Within the VideoLayout object, you must reference one of the four video points. (See Using the VideoLayout Editor, later in this chapter.) The actual assignment of video points in objects is addressed in Step 4. See Step 4 below, as well as the section, Using the Alarms/Advanced Alarms Tab of an Object Editor, in Chapter 10, Configuring Alarms.) 3. Make a list of objects to be associated with video — You do this whenever you have a need to view video images when those objects, such as doors and input points, go into alarm or have an access event. 4. Configure video points in the object editor — For each object in the list, configure video points using its object editor, and associate the object with a VideoLayout. Video points are video-server and camera references that are attached to Continuum objects. Video points also contain other video information, such as presets, record flags, and PTZ (pan, tilt, zoom) information. A VideoLayout can be attached to objects in exactly the same way a graphic can be attached to an object.
- 607. Andover Continuum CyberStation Configurator’s Guide 595 Note: If you launch (open) a VideoLayout from Continuum Explorer, from a graphic, from a ListView, and so on, and that layout references video points, then only the frames whose cameras have been “hardwired” display video. Open each object from the list in Step 3, select its editor’s Alarms tab or Advanced Alarms tab, and associate the video layout with the object. (See the section, Using the Alarms/Advanced Alarms Tab of an Object Editor, in Chapter 10, Configuring Alarms.) Configure video points 1 through 4 from the Video Points dialog. (See Chapter 10.) Repeat for each object in your list. 1. Configure EventNotifications to display video with alarms — If you are associating video with alarms, and you want to pop up a video layout when a new alarm comes in, then edit the EventNotifications associated with those alarms, and select Display Video on the Actions tab of the EventNotification editor. (See the section, The EventNotifcation Actions Tab, in Chapter 10.) 2. Configure graphics with video — Configure graphic controls to launch “hardwired” video layouts from buttons and other graphic controls. 3. Test the alarms and access events — Trigger an alarm with an associated video layout. Ensure the video pops up, if configured to do so. If you choose not to pop up video, you can launch the video layout using the new video button on the Active Alarm View. (See Active Alarm View in Chapter 10.) Repeat this process for access events, if necessary. Launch the video layout using the new video button on the Active Event View. (See Active Event View in Chapter 21.)
- 608. TAC596 Using the VideoServer Editor Using the VideoServer editor's General tab, you assign a physical video server to this VideoServer object. Any camera attached to this VideoServer object may be therefore assigned to (and its images viewed in) a video layout image frame or “window.” (See Using the VideoLayout Editor, later in this chapter.) General Tab In the General tab, you assign a physical video server to this VideoServer object: Any camera attached to this VideoServer object may therefore assigned to video image windows (video controls) in the VideoLayout editor. Editor Attribute Meaning Description Enter a text description of this VideoServer object. IP Address Enter the IP address of the physical video server that you wish to assign to this object. User Name Password Verify Password Enter the user name, and this user's password, that will be used to log onto the video server, when this VideoServer object is accessed. This user must exist on the actual video server to which you are connected. If the user does not exist on the server, this VideoServer object cannot be created for that user. Tip: To have two or more users log onto the same video server, create two or more VideoServer objects that connect to the same server, but with different user names and passwords. This is useful when you need to limit a Continuum user's access to Continuum video features. For example, a guard typically should not have the same access to video servers and layouts as an administrator.
- 609. Andover Continuum CyberStation Configurator’s Guide 597 Test Connection Click this button to test the network connection to the server whose IP address appears. If the test is successful, this message appears beneath the button: Connection successful If it is unsuccessful, this message appears: Error Connecting to Server Using the VideoLayout Editor A "video layout" is essentially the video surveillance monitor for CyberStation. You open a VideoLayout object either manually in Continuum Explorer, or automatically by attaching it to a point's alarm or to a graphical control, to view live video images from a single surveillance camera or from multiple cameras set up in a matrix of video image frames. (See also Overview of Video Integration and Configuration, earlier in this chapter.) Note: You may also open a video layout via the Plain English SHOW command, in the Continuum Command Line or via a Plain English program. Via the VideoLayout editor's General tab, you may also: • Assign, delete, and reassign cameras in the layout. • Play back a recorded video clip. • Capture a video image and save it to a file. • Freeze, reload/refresh, pan, tilt, zoom, and adjust the image resolution (contrast, brightness, and so on) Each image window in the layout is called a video control frame. Using a multiple-camera matrix, the VideoLayout editor allows you to assign (and view the images of) one, two, three, four, six, or nine cameras. Note: In order to assign a camera to a video control, at least one video server must have been configured so that its cameras are available to the VideoLayout. (See the first two sections in this chapter.) In Continuum Explorer, you may create a VideoLayout object from the Root directory or a folder. You may not create a VideoLayout object from a network, controller, workstation, or any other device.
- 610. TAC598 General Tab In the General tab, you configure a VideoLayout object, view video images, and perform basic video operations: The General tab displays one or more video controls — frames that display live or recorded images from one or more video cameras associated with one or more video servers. Using a multiple-camera matrix, you may assign (and view the images of) one, two, three, four, six, or nine cameras in the same layout. How to Access the Video Control Popup Menu — The video control popup menu allows you to assign and reassign cameras, view live video, play back recorded video clips, capture video images, adjust the image resolution, and perform other basic video operations. To access the video control popup menu:
- 611. Andover Continuum CyberStation Configurator’s Guide 599 1. Select (highlight) the video control frame with which you want to work. A red box appears around the selected frame. 2. Right click the selected frame. The popup menu appears. Video Control Popup Menu — The following table describes the choices in a video control popup menu, as well as the tasks you may perform via each selection. Menu Selection Description Live Video Select Live Video to display live (real time) images from the camera assigned to this video control frame. Note: Be sure to select Live Video again for any image that was previously frozen. (See Freeze Video, below.) Recorded Video Select Recorded Video to play back a video clip from the camera assigned to this video control frame. When Recorded Video is selected, a list of clips appears at the bottom of the video layout. Each clip in the list displays the camera name, the date the clip was recorded, the start time, the end time, and the number of frames. For example: Select the video clip that you want to play back. A black play button and stop button appear on the bottom of the frame. Click the play button to begin the playback. Click the stop button to stop playback. You may also use the slider control within the frame to move forward and backward in the recording. To search for available video clips, specify a start date/time and an end date/time in the Start and End fields, respectively. Then click the Search button. All video clips within that time frame appear in the list. In the date fields, click the down arrow to display a calendar. Then click a start or end date on the calendar. The selected date is highlighted in
- 612. TAC600 Menu Selection Description blue, while the current date appears in a red circle. As an alternative, you may highlight the month, day, or year field, and manually key-in the month, day, or year. In the time fields, use the up- and down-arrow buttons to select a time. As an alternative, you may highlight the hour, minute, second, or AM/PM field, and manually key-in the hour, minute, and second, and specify morning or afternoon/evening (AM or PM). Playback fps – Select the speed (number of frames per second) at which you want to play back the video clip. The current number of frames per second is displayed at the left of this field. Use the slider bar and right- and left-arrow buttons, as needed. Note: Video clips are stored on the video server, and not in the Continuum database. Freeze Video Select Freeze Video to freeze the moving image of this video control frame immediately. Delete Camera Assignment Select Delete Camera Assignment to remove the camera from this video control frame. When you delete a camera assignment, the camera images disappear and the frame goes black. To reassign a camera, select Change Camera. (See below.) PTZ Select PTZ when you need to pan, tilt, or zoom in and out of the video image in this video control frame. Note: The camera assigned to this video control frame must have PTZ capabilities in order to use this feature. At the bottom of the frame, PTZ displays the numbers 1...6, as well as the following letters: I O F N O C I — Click to zoom in. O — Click to zoom out. F — Click to focus the camera "far" or further out. N — Click to focus the camera "near" or further in. O — Click to open the iris and increase the amount of light streaming into the camera. C — Click to close the iris and decrease the amount of light streaming into the camera. The numbers 1...6 are the first six "preset" camera views. Although some cameras support up to 256 camera presets, only the first six are
- 613. Andover Continuum CyberStation Configurator’s Guide 601 Menu Selection Description supported here. Panning and tilting — To pan and tilt the camera, place your cursor inside the video control frame, and click once. A light blue thick arrow appears. You may pan/tilt up, down, left, right, and diagonally. The blue arrow changes direction, according to where you place it on the frame: Up arrow — Pan up. Click cursor at top-center. Down arrow — Pan down. Click cursor at bottom-center. Left arrow — Pan left. Click cursor at left-center. Right arrow — Pan right. Click cursor at right-center. Right diagonal up arrow — Pan diagonally to the upper right. Click cursor at top right corner. Left diagonal up arrow — Pan diagonally to the upper left. Click cursor at top left corner. Right diagonal down arrow — Pan diagonally to the lower right. Click cursor at bottom right corner. Left diagonal down arrow — Pan diagonally to the lower left. Click cursor at bottom left corner. Capture Image Select Capture Image to capture the image being displayed in this video control frame and to save it to a file. The Capture Video Image Save dialog appears. Browse for the directory in which you want to save the image file, specify the file name, specify the image file type (.BMP, .JPG, and so on), and click Save. Video Points Select Video Points to preconfigure a video control frame so that, when this VideoLayout is attached to an object and associated with an alarm, up to four cameras (known as "video points") can be automatically associated with the VideoLayout. When the alarm goes off, this VideoLayout is launched, displaying the video points associated with the object that went into alarm. These cameras are pre-assigned via the Video Points button (and the Video Points dialog) in the Alarms tab or Advanced Alarms tab of the AnalogInput, AnalogValue, BinaryInput, BinaryValue, Door, InfinityInput, InfinityNumeric, InfinitySystemVariable, MultistateInput, or MultistateValue editor. Note: See Overview of Video Integration and Configuration, earlier in this chapter, as well as the section, Using the Alarms/Advanced Alarms Tab of an Object Editor, in Chapter 10, Configuring Alarms.) Using the Video Points dialog (shown below) in these editors, you
- 614. TAC602 Menu Selection Description designate between one and four video points, whereby each numbered "video point" represents a frame in this VideoLayout's matrix. About the Video Points Dialog – Click the Video Points button on the Alarms or Advanced Alarms tab of the editors listed above to bring up the Video Points dialog. (See also Chapter 10, Configuring Alarms.) In this Video Points dialog, you may also configure a camera to record a video clip, for specified number of seconds, when the alarm goes off. Video Servers: Use the Video Servers dropdown menu to select a video server on which the camera is located. (A VideoServer object must be already configured and the server online. See VideoServer Editor earlier in this chapter.) Cameras: Use the Cameras dropdown menu to select a camera for the numbered video point. (The camera must be configured and enabled on the selected video server.) Rec: Check the Rec. checkbox to record a video clip from the selected camera. Recording begins at the moment the alarm goes off. Duration: In the Duration field, use the up and down arrows to select the number of seconds to record a video clip, once you check the Rec. checkbox. PTZ: In the PTZ field, select the number of the preset camera view. (This camera must have PTZ (pan, tilt, zoom) capabilities in order to use this feature.) See also the General tab of the VideoLayout editor.) After you preassign the video point cameras to the frames (Chapter 10) you reference a video point number here (in the General tab of the VideoLayout editor) that corresponds with each numbered frame you configured in the Video Points dialog. Right click over the frame, select Video Points, then select 1, 2, 3, or 4. For example, the camera you specified as "Video point 1" in the object editor is assigned to the frame you reference as "1" in this VideoLayout object. When the VideoLayout is launched, on an alarm associated with the
- 615. Andover Continuum CyberStation Configurator’s Guide 603 Menu Selection Description object, this preconfigured video control matrix is displayed. Change Camera Select Change Camera to assign or reassign a camera or "video source" to this video control frame. Select the name of a server in the popup menu of server names, next to Change Camera. Then, in the next popup menu, select the name of a camera — for example, it might be called "main lobby" or "loading dock" — belonging to that server. The camera is assigned to the video control, and the camera's images immediately appear in its frame. Note: If a server is not available for connection (not online) then its list of cameras does not appear in the popup menu. The server must be available for connection. Likewise, a server's cameras must be enabled. If a camera is disabled (via Integral video server software) it does not appear in the menu. In order to assign a camera to a video control, at least one video server must have been configured. (See the VideoServer editor.) Security considerations: Access to video servers may be restricted by Continuum's security system. Access to cameras on the video server may be restricted by the server's security system. That is, users see only the cameras to which they have been granted access. Repeat this procedure for every video control frame in the matrix. You may select another camera, or even the same camera, for other video control frames. When you select the same camera for two or more frames, then the same camera images are displayed in those frames. You may also select cameras from more than one video server. The following table describes other General tab video attributes and buttons, which allow you to adjust your video control images. Editor Attribute Meaning Text Overlay Check this checkbox to display the name of the camera, as well as the date and time, over each video control frame of the matrix. Click and remove the check to display no text. Top — Click this radio button to position the text at the top of each frame. Bottom — Click this radio button to position the text at the bottom of each frame.
- 616. TAC604 Editor Attribute Meaning Text Colors You may change the color of the text in the text overlay by clicking one of the six colors in the color key, located beneath the text overlay radio buttons. These colors are: Red White Blue Yellow Green Black Black is the default. Brightness Contrast Sharpness Use the slider control to increase and decrease brightness, contrast, or sharpness, respectively. Note: The slider control on the Brightness, Contrast, or Sharpness blinks at any given time to indicate which setting is currently selected. Reload Layout Click this button to reload and refresh all the video controls. Freeze All Video Click this button to freeze every video image in every video control frame. If you wish to freeze the image for just one video control, right click the control frame and select Freeze Video from the popup. (See the table above.) Capture Layout Click this button to capture the image being displayed (live or recorded) in the selected video control frame and save it to a file. The Capture Video Image Save dialog appears. Browse for the directory in which you want to save the image file, specify the file name, specify the image file type (.BMP, .JPG, and so on), and click Save. Matrix Selections To select or change the desired video-control matrix to display one, two, three, four, six, or nine video images in your layout, click one of these video control frame matrix buttons. The matrix changes immediately. Note: The three-frame and six-frame matrices display one frame larger than the others, as shown in these matrix buttons. A video-control frame remains black until you assign a camera by right-clicking on its frame and selecting Change Camera from the popup. (See the table above.)
- 617. Andover Continuum CyberStation Configurator’s Guide605 Graphics Panels Introduction The Pinpoint graphics application is used to produce dynamic virtual control panels right on your CyberStation workstation. CyberStation control panels are computer-generated representations of physical panels. They consist of a screen display of buttons, switches, animations and text, and other “controls” that control particular points, particular elements of log or array points, point attributes, system variables, or certain Continuum objects, such as areas and doors. Every control placed on a CyberStation control panel can be easily changed, deleted and re-assigned through software. Controls can be active or passive: • Active controls, such as a switch or button, can be manipulated by the user. For example, a switch control, when “turned,” might set a point value or setpoint. • Passive controls convey information, such as gauges and read-only text controls that display values. A text control might display the current room temperature. A control panel can have one or more controls, or not controls at all. Pinpoint supports a simple form of animation that uses multiple images of the same control. Because each image is slightly different, viewing them in a sequential order produces the effect of animation. The following example shows a Pinpoint graphics panel that monitors HVAC equipment on one floor of a building. 26
- 618. TAC606 Controls The following list identifies the type of controls available in the Pinpoint application. A library of predefined images for each control is provided with the application. You can also use bitmap images that you created in another application to represent controls. Switches Pinpoint switch controls allow you to control two-state (on-off) points. In addition to their control capabilities, they also can display a different image for each state. Clicking once activates the control and also automatically displays the control’s image associated with its activation. You choose the bitmap image set that defines the switch in each position. Buttons Buttons work in a similar manner to switches. They allow you to control two-state (on-off) points, launch applications, etc. Buttons can be any shape, but they do not change appearance. Active Animated Buttons Active or animated buttons can be any shape. They can change color when pressed.
- 619. Andover Continuum CyberStation Configurator’s Guide607 Bar Control A bar control shows the value of the point by rising or descending to a particular level as the value of the point changes. Both horizontal and vertical bar controls are available in the image library. Text Control A text control displays a textual representation of a point value. If the point is an input or output, it displays the point value in engineering units. For a numeric point, it displays the numeric value. For a string point, it displays the characters in the string. For a datetime point, it displays the date and time in the point. Door Control The door control provides a graphic display of a CyberStation door object. It illustrates the switch states of the door by using configurable animation. Images illustrate the states of the door, such as locked/unlocked, trouble, and alarm. When you right click a door control, a popup menu provides access to additional functions, such as locking or unlocking the door, and opening the Door editor. Area Control The area control provides a graphic display of an Area object and can indicate whether the area is in Lockdown state or its normal state. You can also use an area control to initiate or clear the Lockdown state. Popup menu options allow you to lockdown individual doors to the area, or to clear the Lockdown state as well as to access other area functions. For more information regarding area lockdown, see Chapter 18. Panel with Multiple Controls The following figure shows a complex graphics panel that monitors both access information and HVAC data. This panel uses several Pinpoint features: • Background image representing the controller and IOU module • Lines created with drawing tools • Text boxes to display and label values • Images associated with active components to current conditions for CyberStation points and other objects The table following the figure identifies how some of the controls are set up.
- 620. TAC608
- 621. Andover Continuum CyberStation Configurator’s Guide609 Text Controls Controller Time/Date This is a text control tied to the system clock. It displays the date and time. Power Fail This text control indicates whether the power fail condition is true or false. The other text controls are also tied to various points throughout the system and include such information as the amount of free system memory, which server is being accessed, alarm and error counts, etc. Bar Control Temperature Gauge This bar control is linked to a sensor and displays the temperature graphically. Switches Gate Switches Off On These switch controls operate security gates. When on, the indicator on the top of the switch turns red. Gate 4 This object indicates whether a gate in the building area is open (up) or closed (down) position.
- 622. TAC610 About Image Files Used in Panels Where you store your image files affects your system performance. Whether you access images from a central location, such as a server, or from the local drive of a workstation makes a difference. Using a central location may be appropriate if you are working with a large number of workstations. However, because the data must travel through a network, accessing them will be slower than if the data was retrieved locally. See Setting Up Pinpoint Options. When you create a graphic to become part of your panel, we suggest that you save the image in the lowest resolution possible, so that the resulting image file is small and requires little memory. The Pinpoint image library contains bitmap (*.bmp), JPEGs, Icon, and enhanced metafile (*.emf) files. We recommend that you use the metafile graphics wherever possible. Metafiles are significantly smaller than the other formats, they scale up or down without distortion, and they support transparency better than the other formats. In addition, the number of controls on a panel may affect how quickly the panel is updated when changes occur. Using large numbers of controls on a panel can affect the rate at which the controls react to changes. Creating a Pinpoint Panel 1. Click the hot spot on the CyberStation Main Menu. 2. Click the hot spot. 3. Select the File option on the Pinpoint menu bar, and then select New. 4. In the Create Graphic dialog, enter a name into the Object Name field, and click the Create button. A new blank Pinpoint panel appears. Selecting Graphics Locations Use this procedure to select the default folders to use for the following Pinpoint elements: • Pinpoint panels (.Pin) • Bitmap images that represent controls • Images that represent the background in a panel 1. From the System and Status menu page, open the Pinpoint graphics editor. 2. From the View menu, select Options.
- 623. Andover Continuum CyberStation Configurator’s Guide611 3. Enter (or browse to) the appropriate locations where you want your graphics, image, and background files stored. Location Description Graphics Folder Pinpoint panel files that you create or modify. Image Folder Images that you can use to represent controls. Background Folder Background image files. Setting Panel Options Although Pinpoint has default values for all options, you can change these options by performing the following steps: 1. From the System and Status menu page, open the Pinpoint graphics editor 2. From the View menu, select Options. 3. In the Options dialog, select the Misc tab. 4. Select options for working in the graphics editor. Option Description Warn Save Into Run Mode If selected, Pinpoint displays a message asking if you want to save the panel file before you enter Run Mode ; if not selected, Pinpoint automatically saves the panel file when you enter Run Mode. Make Backup Copy Panel File If selected, Pinpoint automatically makes a backup copy of a panel (.pin) file when that panel file is saved in the graphics folder. Backup files have the extension: *.bck. Home Panel Field Enter (or browse to) a Pinpoint graphic file to use as the Pinpoint application home panel. When you click the Home button of the Pinpoint Standard Toolbar, the selected home panel opens.
- 624. TAC612 Option Description No Change Opens the home panel with no change to the current panel state. Minimize Opens the home panel and minimizes the current panel. Close (default) Opens the home panel and closes the current panel. Default Paper Orientation Field Select the radio buttons to choose the default paper orientation (landscape or portrait). Units of Measure Select the units of measure for the size of your canvas. The default is inches. 5. Click OK. Drag and Drop Pinpoint supports drag and drop of points from any CyberStation source, such as Continuum Explorer. With drag and drop, you can create an active control that is automatically linked to the object it was dragged from. The drag and drop operation can be performed with either the left or right mouse button depending on what type of control you want to create on the Pinpoint canvas. Left Mouse Button When you drag and drop an object (other than a door or area) with the left mouse button, an active text control button is created. When you select a door or an area, a door or area control is created. To drag and drop an object with the left mouse button, proceed as follows: 1. Open the panel where you want to add a control. 2. Open Continuum Explorer and adjust its size so that the Pinpoint panel is visible to one side. 3. Place the cursor over the object in Continuum Explorer that you want to place on the panel. 4. Hold down the left mouse button while you drag the object onto the Pinpoint panel. 5. Release the mouse button. An active text control button for this object appears on the Pinpoint panel. Right Mouse Button When you drag and drop an object with the right mouse button, you can choose a control to be created from the object on the Pinpoint panel. To drag and drop an object with the right mouse button, proceed as follows: 1. Open the panel where you want to add a control. 2. Open Continuum Explore and adjust its size so that the Pinpoint panel is visible to one side.
- 625. Andover Continuum CyberStation Configurator’s Guide613 3. Place the cursor over the object in Continuum Explorer that you want to place on the panel. 4. Hold down the right mouse button while you drag the object onto the Pinpoint panel. 5. Release the mouse button. A popup menu appears listing the control types. 6. Select the type of control you want. The object will appear on the panel represented by the control you selected. Pinpoint Environment Pinpoint operates in two modes: Design and Run. • In Design Mode you create a panel, which allows you to draw, animate, and insert objects, attach points, etc. • In Run Mode the panel operates – showing assigned point values, opening/closing doors, etc.–as you designed it to do. Below are the basic components of the Pinpoint environment: Pinpoint Window Features Description Menu bar The Menu bar comprises the standard Windows program functions and Pinpoint-specific functions. Tool bars The tool bars provide editing functions in Pinpoint. When no applicable elements are open in the main window, the functions are grayed-out indicating their unavailability. Canvas The canvas represents the graphics panel. In Design Mode, you arrange controls and other components on the canvas as you want them to appear on the panel when it operates in Run Mode. Status bar The status bar along the bottom of the window indicates whether Pinpoint is in Design Mode or Run Mode, and at what magnification the panel is displaying. The status bar also provides you with useful prompts, and visual indication of the status of various keyboard functions. Drawing Pinpoint Components Components are objects that you place on the canvas (Pinpoint workspace) and manipulate. A component can be a simple shape (such as a rectangle or circle) or a complex collection of shapes or images. To start drawing a component, you select the toolbar button or menu command that corresponds to a particular shape.
- 626. TAC614 To … You can… Draw a component of equal proportions or at 90 degree angles Hold the SHIFT key while drawing a component. If you select a rectangle tool button and then clicked in an empty area on the canvas while holding the SHIFT key, the application draws a square. Resize a component from the center Hold the CTRL key while resizing a component. Draw a line Click the Line button and then click and hold the mouse button in an empty area on the canvas until the line is the desired length. Release the mouse button. Draw a polyline Click the Polyline button and then click in an empty area on the canvas. Click again to place an endpoint or corner. Double click to finish drawing the component. Click the right mouse button to cancel the action. Draw a polygon Click the Polygon button and then click in an empty area on the canvas. Click to place each endpoint or corner. Double click to finish drawing the polygon. Click the right mouse button to cancel the action. Draw a rectangle Click the Rectangle button and then click and hold the mouse button in an empty area on the canvas. Drag the pointer until the rectangle is the width and length you want. Draw a polycurve Click the Polycurve button and then click in an empty area on the canvas. Click to place an endpoint, two control points and another endpoint. Double click to finish drawing the curve. Draw a closed curve Click the Closed Curve button and then click in an empty area on the canvas. Click to place an endpoint, two control points and another endpoint. Double click to finish drawing or click the right mouse button to cancel. You can assign a fill color to a closed curve. Draw an ellipse Click the Ellipse button and then click and hold the mouse button in the canvas. Drag the pointer until the ellipse is the size you want. Add text Click the Text button and then click in an empty area on the canvas. Right click the text to edit.
- 627. Andover Continuum CyberStation Configurator’s Guide615 To … You can… Add an image Click the Image button to open a standard dialog from which you can select an image to insert on the canvas in the following formats: • .bmp • .ico • .jpg • .emf .dib Configuring a Pinpoint Panel 1. From the File menu, select Configuration to display the Graphics dialog for the panel you are editing. The General tab page of the Graphics dialog appears. 2. Enter the configuration information in the fields described below: Description General description of the panel, up to 32 letters. Graphic Panel File File created when the panel is saved. By default it takes the same name as the panel object. All files are saved to a specific location (shared in a multi-user environment) usually set at c:Program FilesContinuumNewGraphicsFiles. Graphic panel files have a “.pin” extension. Plain English Program to Run When the Panel is Opened Use this field to select a program or Infinity program when the panel is in Run Mode. Stop When Panel is Closed If selected and you have selected a Plain English program to run when the panel opens, the Plain English program stops running when you close the panel or put it into Design Mode. If not selected, the Plain English program continues to run when the panel is closed or put in Design Mode. Window Size Field Select whether the panel should be maximized or retain the position/size of the panel when it was last saved. Scroll Bars Check this checkbox to enable scroll bars in Run or Design Mode. Without scroll bars you can still view parts of a panel that do not initially appear onscreen, because the Pinpoint window can be resized by stretching the frame around the panel.
- 628. TAC616 Active Polling Rate Only Check this checkbox to enable the active polling. 3. Select the Canvas tab, and select preferences for the panel workspace, which is called the canvas. Background Color Select a background color for the panel from the drop down list. Background File Enter the location of the background image file displayed when the panel is loaded. If the background file changes, the panel reflects the latest change. If you choose a background file that is not located in the default background folder specified in the Options dialog, a copy of the file is placed in the default folder. If you choose a background file for your panel, it will override the background color. For example, if you have a gray background for your panel and then you add a graphic image to be the background, the image will show and the background color will not. A background file is optional. Canvas Width/ Height Enter the dimensions of the canvas. 4. Select the Object List tab to view the CyberStation objects attached to Pinpoint controls in the current panel.
- 629. Andover Continuum CyberStation Configurator’s Guide617 Object name Name and path of the CyberStation object Component name Name of the Pinpoint control that represents the object in this panel Polling Rate Polling rate in milliseconds, which determines how often the panel can be updated when object information changes. Delete Deletes the selected object. Go To Selects the active component in the panel and brings it to the center. Find Object Finds an object selected by the user. Replace With Replaces the object found in the Find Object field with an object selected by the user. Replace Object Replaces the selected object with the one specified by the user. Replace All Objects Replaces all selected objects with the one specified by the user. 6. If you want to attach a single object to this panel, click the Security Level tab and select a single object. 7. Click OK.
- 630. TAC618 Selecting Default Properties for Components Before adding components to a panel, you can set their default properties. The properties you select are common to all component types and are used as the initial settings for every component added to the panel. Your settings apply only to new object and do not apply to existing objects. 1. Right click the canvas, and select Default Properties from the pop up menu. 2. In the Line tab, define the default appearance of lines in a component: • Select line color, style, and width. Dashed or dotted lines can be used only when 0 Point is selected for line width. • If you do not want to display lines when the panel is in Run Mode, check the Transparent checkbox. 3. Select Fill tab to define component fill properties. A solid fill, a foreground color without hatching, is the most commonly used fill. A hatched fill with a background color can also be used. When Transparent Fill is selected, a component’s fill won’t show when the panel is in Run Mode. Selecting Transparent Fill locks out the use of the other options on this tab.
- 631. Andover Continuum CyberStation Configurator’s Guide619 4. Select the Font tab, and select font properties to define the appearance of text in a component. Because True Type fonts are the only fonts that support rotation, text is limited to True Type fonts. 5. Click OK. Creating an Active Text Component An active text control can display the text of any object attribute. You can also use a text box as a label for a value displayed in another text box or other active component. 1. From the Drawing tool bar, select the Text icon. Text 2. Click a location on the canvas to place the text box. Adjust the size, placement, and appearance of the component as needed. If you want to… Then… Resize the component Select any of the points on the border of the text box and drag the point to increase or decrease size.
- 632. TAC620 If you want to… Then… Move the component Hover the curser over the center of the text box until the cursor changes to , and then click and drag the box to a different location. You can also use your keyboard arrow keys or the nudge buttons to move the text box in small increments. Edit the display properties of the component Right click the text box, and select Display properties. Edit line, fill, font, and other properties, and click OK. 3. To make this text component an active component (tied to a point object ), select the text component, and click the Text icon from the Active Components toolbar. The Active Text tab page of the Active Text Object dialog is displayed. Object Enter or use the browse button to locate the path to the point object and attribute you want to attach to the component. Browse or type in the path to a Continuum point and attribute. User Entry Check this checkbox to change the value of the point in RunMode. If the checkbox is not selected, the value will be read only. High/Low Limit Enter the maximum and minimum values accepted for this point when user entry is enabled. 4. If the selected object is attached to alarm(s), select the Alarms tab, and use the colorwells attached to each alarm to select the color the text changes to in response to the alarm event. 5. Select the Misc tab. 6. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 7. Check the ToolTips checkbox if you want to display a tooltip when the cursor lovers over the text box, and then specify the tooltip content: • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 8. Click OK. 9. To save and test the component, click the Run Mode button in the Standard toolbar. Click the Design Mode button to return to editing the panel.
- 633. Andover Continuum CyberStation Configurator’s Guide621 Inserting Images To insert an image to use in a component, perform the following steps. You can insert predefined images from the image library or browse images created another application. 1. From the Insert menu, select Image Library. 2. In the PinPoint images dialog, expand folders to view the list of images, and select an image to display it in the preview area. 3. To insert a custom image, click the Browse button to locate the folder that contains the image. 4. Double click an image to insert it in the current panel. Continue inserting images as needed. 5. Click Close. Creating an Active Switch Control An active switch control always toggles between two discreet values, i.e., binary or digital values such as on and off. 1. Create two graphics to represent the two state of the switch control: • You can draw the graphics with the Pinpoint drawing tools. • You can insert bitmap images in the panel. 2. Place the graphic you created to symbolize the off state on top of the graphic you created to symbolize the on state, completely covering the on graphic. Do not group the graphic together. 3. Select the graphic object for the off state, and select Active Components/Switches, or select the Active Switch button from the Active Components toolbar. 4. In the Object field in the Active Switch tab page, enter the full path or click the browse button to locate the point, object, or object attribute that the switch controls. The object or attribute must have only two states (as a digital point does). For example, you can have the switch change the State of a program – ENABLED or DISABLED. 5. Select the User Entry checkbox if you want to allow users to toggle the state of the object or attribute (for example, to allow an operator to turn a light on and off). 6. Click OK. 7. To save and test the component, select the Run Mode, or select the Run Mode button from the Standard toolbar. This action saves the panel. Click the Design Mode button to return to editing the panel.
- 634. TAC622 Creating an Active Rotation Control An Active Rotation control can be any shape or combination of grouped shapes, but it is most useful in a circular style control. For example, you can draw a fan or pump with spokes inside the circular part of it, and define it as an Active Rotation Control. When the fan or pump is on, the spokes continuously rotate. 1. Create the graphic to represent the rotating object: • You can draw the graphic with the PinPoint drawing tools. Group the shapes that make the graphic as a single element. • You can insert a bitmap image in the panel. 2. Select the graphic object, and select the Active Rotation button from the Active Components toolbar. 3. In the Active Rotation dialog, select the point the control represents and the rotation properties of the control. Object Enter the full path or browse to the point the control represents. This is an option; you do not have to link the rotation to an object. It can be used simply for effect. Rotate when: Select when rotation occurs: • Always indicates that the object always rotates. There is no need to select a point. • Value is on indicates that the object rotates whenever the value of the point is not zero. You can use Value is on with analog (numeric) or digital (binary) points.
- 635. Andover Continuum CyberStation Configurator’s Guide 623 Direction Choose a clockwise or counterclockwise rotation. Rotation Rate Enter the rotation rate for the control. The valid range for this field is between 100 and 5000 milliseconds. Angle Enter the angle in degrees the control will rotate at each interval based on the Rotation Rate. The valid range for this field is between 1 and 180 degrees. Select Pivot Point By default, a component chosen to be an Active Rotation object will rotate about its center. To change the center of rotation, click the Select Pivot Point button. The Center of Rotation dialog appears. Either drag with the mouse or use the Nudge Pivot buttons to move the rotation selector to the desired center of rotation. Click OK. 4. Click OK. 5. To save and test the component, select the Run Mode, or select the Run Mode button from the Standard toolbar. This action saves the panel. Click the Design Mode button to return to editing the panel. Creating a Personnel Picture Control You can create personnel picture control to display a photo and information from Personnel objects in a graphics panel. For example, you can create a control that displays a photo name and access card number of a person who requests access at a specific door. 1. Click the Personnel Picture Control from the Active Components toolbar. 2. Specify the properties of the control.
- 636. TAC624 Person: Either type in or browse for the Personnel object of the person whose photo you want to display, or for an attribute that stores a personnel object. For example, any of the following door attributes may be used: • LastPersonEntered • LastPersonExited • LastInvalidEntry • LastInvalidEntryExit If you select one of these attributes, you can display the person’s photo when the person enters/exits through the door. Fade: Delay Time Enter the number of seconds you want to display a photo before it fades. If the delay is 0, the personnel photo will not fade. Fade: File Either type in or browse for the path to the personnel photo. User Entry Select this checkbox to change the control right from the panel in Run Mode. Beep When the Picture Changes Select this checkbox to hear a beep when a new photo appears. 3. Click OK. 4. To save and test the component, select the Run Mode, or select the Run Mode button from the Standard toolbar. This action saves the panel. Click the Design Mode button to return to editing the panel. Creating an Active Bar Control A bar control is similar to a thermometer. It fills as the value rises and empties as the value falls. You can change the value of the point object that the bar component is tied to. Users can click the left mouse button while in Run Mode, and an image of a calculator will appear. Users can then use the mouse to click the calculator buttons or use the keyboard to type in the new value, and click OK on the calculator to set the new value. 1. From the Drawing toolbar, select the rectangle icon. Rectangle 2. Draw a rectangle on the canvas by holding down the left mouse button and moving the mouse diagonally.
- 637. Andover Continuum CyberStation Configurator’s Guide 625 3. If you want to edit visual properties of the rectangle, such as color, right click and select Display Properties from the popup menu. Edit the properties and click OK. 6. Select the rectangle and select the Active Bar icon from the Active Components toolbar. 5. In the Active Bar Object dialog, select the object the bar represents and the properties of the bar. Object Enter or click the browse button for the point and attribute. User Entry Select the check box to allow users to change the value of the point from the panel. Top of Scale Enter the maximum value to represent a completely filled bar. Bottom of Scale Enter the minimum value to represent an empty bar. Direction Select the Horizontal or Vertical radio button to indicate which direction you want the bar to grow in proportion to the value. 6. Click OK. 7. To save and test the component, select the Run Mode, or select the Run Mode button from the Standard toolbar. This action saves the panel. Click the Design Mode button to return to editing the panel. Creating an Active Button Control You can create a button control to trigger one of the following events or actions: • Open an object • Open a panel • Replace a point • Run a Plain English program • Start a Windows program • Stop a Plain English program • Toggle the value of a point A button can be any shape or can be an image. For a button to change color when pressed, create an active animated button rather than a button. Buttons do not change appearance. 1. From the Drawing toolbar, select a shape or image button.
- 638. TAC626 2. Select a location in the canvas to place the shape. 3. If you want to edit visual properties of the component, right click and select Display Properties from the popup menu. Edit the properties, and click OK. 4. Click the Active Button toolbar icon to display the Active Button Object dialog. 5. Select an action from the Action dropdown list. After you select an action, the Active Button data entry fields change to reflect the information required for that action. The following table describes how to configure each option. If you select… Then… Open Object Enter or click the browse button to specify the full path name for the object the button opens. Open Panel Enter or click the browse button to specify the full path for the graphics panel the button opens. Under Current Window, select what happens to the display of the current panel (the panel containing the button) when the new panel is opened. Replace Point Enter or click the browse button to specify the full path name for the point that will be replaced when a user clicks the button. Note: When you go into Run Mode, click the replacement point you have selected to become an active button. You are prompted for the point you want to replace. Run Plain English Program Enter or click the browse button to specify the full path of the Plain English program that you want to run when a user clicks the button.
- 639. Andover Continuum CyberStation Configurator’s Guide 627 Start Windows Program (enables you to start any installed Windows applications, such as Notepad or Excel, or to create or edit CyberStation Objects) If you want to open another application, enter or click the browse button to specify the executable file (.exe) of the Windows program you want the button to launch. Enter any arguments, such as launching another application or opening a specific file that should be passed to the Windows program in the Command Line Arguments field (optional). If you want to create a button to create, edit, or open a CyberStation, click the Button Wizard button, and make selections from the wizard as prompted. Click Finish to close the wizard. The Windows Program and Command Line Arguments fields are populated with the values needed to create or edit the object you specified. Stop Plain English Program Enter or click the browse button to specify the full path of the Plain English program you want to stop when a user clicks the button. Toggle Value Enter or click the browse button to specify the full path for the point you want to turn on or off (or enable/disable, etc.) when a user clicks the button. Current Panel Under Current Window, select the desired state that the current window should be in after the Active Button is clicked. 3. To execute Plain English (PE) commands in addition to the button action you defined in step 5, select the Plain English script tab, and enter the PE script. Click the Check button to verify that the script has no syntax or other errors.
- 640. TAC628 PE scripts can execute any command-line command. PE scripts cannot have local variable declarations or labels. PE scripts are executed before the selected Active Button performs its action (i.e., open panel, open object, etc.). 4. Select the Misc tab. 5. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 6. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content: • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 7. Click OK. 8. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating an Active n-Stage Animation Control An active animation control displays a series of images that correspond to analog or digital values of a point that you specify. For example, you could use a sequence of propeller images to indicate a fan that is turned on.
- 641. Andover Continuum CyberStation Configurator’s Guide 629 1. Click the Active Animation toolbar icon to display the Active Animation dialog. 2. Select the animation type. The selection you make in the Animation Type field determines the appearance of the tab page. If you want to… Then… Create animation for analog points, allowing images to be shown on value ranges Select Analog Animation. Proceed to step 3. Create animation for digital (binary) points, allowing images to represent the two states of the point (enabled/disabled, on/off, etc.) Select Digital Animation. Proceed to step 4. 3. Select the point, images, and valid range for analog animation. C:Program FilesGraphicsGraphic File1 C:Program FilesGraphicsGraphic File2 C:Program FilesGraphicsGraphic File3 C:Program FilesGraphicsGraphic File4 Value Enter or click the browse button to specify the full path of to the analog value to be used to control which image is viewed for the animation. Image Ranges Value ranges for each chosen image file. The ranges are created from the low and high limit you enter.
- 642. TAC630 Image Files List of the images used for this animation. To create and organize the list of images, use the four icons above the preview area: Insert a new image – Click this icon image and type in the file name and path. Delete an image – Select the image to be deleted and click this icon. Move an image one up the list – Select the image to move and click this icon. Move an image one down the list - Select the image to move and click this icon. Also, to edit an existing image, double click the image and make the appropriate changes in the open edit box. Preview Click this button to preview the files in the Image Files field. High/Low Limit Enter maximum and minimum values. If you change either of these values, the ranges are automatically calculated when the edit boxes lose their focus. Change By default, the ranges are split evenly over the range limits entered in the High Limit and Low Limit fields. Use this button to change the high limit for a selected range (and as a result the low limit for the next higher range) in the Image Range field. Reset Click this button to reset all the ranges to their default ranges ({High limit – Low Limit}/ # of files in the image list). This is only applicable if you have made changes to the default range. Hide Animation if Above/Below Range Select this checkbox to hide the animation if the value of the point is outside the limits of the range. 8. Select the point, images, and animation properties for digital animation.
- 643. Andover Continuum CyberStation Configurator’s Guide 631 C:Program FilesGraphicsGraphic File1 C:Program FilesGraphicsGraphic File2 C:Program FilesGraphicsGraphic File3 C:Program FilesGraphicsGraphic File4 Value Enter or click the browse button to specify the full path of the binary value to be used to control which image is viewed for the animation. Image Files List of the images to be used for this animation. To create and organize the list of images, use the four icons above the preview area: Insert a new image – Click this icon and type in the file name and path in the edit box. Delete an image – Select the image to be deleted and click this icon. Move an image one up the list – Select the image to move and click this icon. Move an image one down the list - Select the image to move and click this icon. Also, to edit an existing image, double click the image and make the appropriate changes in the open edit box. Preview Click this button to preview the files in the Image Files field. Animate When On Select this checkbox for the animation to continue repeatedly when the value is on. Deselect this checkbox for the animation to continue repeatedly when the value is off. Animate only when Change of State If this checkbox is selected, the system runs through the image list one time for change of state on, and then in reverse order for change of state off. This cycle repeats for every change of state.
- 644. TAC632 Invisible When Off Select this checkbox to make the image invisible when it is not animating. (when value = off) Current Frame When Off When the animation is off and visible, select this checkbox for the current frame to appear. Leave this checkbox unselected for the first frame in the image list to appear. Image Rate Rate (in ms) the system cycles through the images selected in Image Files. 5. Select the Misc tab. 6. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 7. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content: • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 8. Click OK. 9. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating an Active Animated Button Control Like the active button, the animated button can be any shape. It also supports the same actions as an active button, but can change appearance when an event occurs. 1. From the Drawing toolbar, select a shape. You cannot use text or images as an active animated button. 2. Select a location in the canvas to place the shape. 3. Specify the shape, and click the Animated Button icon on the toolbar. 4. In the Active Animated Button dialog, specify trigger settings.
- 645. Andover Continuum CyberStation Configurator’s Guide 633 Trigger Enter or click the browse button to specify the full path to the object used to trigger the animated effects of the button. The trigger is the point or attribute that initiates (“fires”) an event. Trigger Options Select the event that triggers button animation: • On/Off • Alarm • Ranges Disable Action Select this checkbox to disable the trigger action on the button. Action Field Select an action from the Action dropdown list.
- 646. TAC634 Object Drop Menu If needed, enter or browse to the action object. Current Window Select the checkbox that indicates what will happen to the current window when the panel is launched. 5. Select the Options tab. The settings in this tab depend on the trigger option you selected in the Active Animation Button tab. Trigger Option Value The values in the Trigger Option Values list are determined by the selection you make in the Trigger Options in the Active Animated button tab. In the above example, the choices are On/Off. Use this tab to determine how the button appears in each state. Note: Both On and Off require separate configuration. Fill Select this checkbox to select Fill options for the state selected in the Trigger Option Value field. The Fill Properties dialog appears. Select fill settings for the button, and click OK. Visible Select this checkbox for the button to be visible in that state. Blink and Beep Select these checkboxes for the button to blink and/or beep in that state.
- 647. Andover Continuum CyberStation Configurator’s Guide 635 Display Value Not implemented in this release. 6. To execute Plain English (PE) commands in addition the button action you defined in step 5, select the Plain English script tab, and enter the PE script. Click the Check button to verify that the script has no syntax or other errors. PE scripts can execute any command-line command. PE scripts cannot have local variable declarations or labels. PE scripts are executed before the selected Active Button performs its action (i.e., open panel, open object, etc.). 7. Select the Misc tab. 8. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed.. 9. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content: • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 10. Click OK. 11. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel.
- 648. TAC636 Inserting a Scale A scale active component works with a gauge active component to display the value of a point object that you specify: • The scale provides the visual characteristics: upper and low limits, divisions and steps, and labels. Create the scale before you create the gauge. • The gauge provides the graphic element that represents the point value on the scale, such as the needed on a circular dial. To insert a scale, follow these steps: 1. From the Insert menu, select Scale. The Scale dialog appears with the default scale type as linear. 2. Select settings that define the appearance and labeling on the scale. Type Select linear or circular. Orientation If you selected Linear, select Horizontal or Vertical.
- 649. Andover Continuum CyberStation Configurator’s Guide 637 Start and Sweep Angle Fields Enter the number of degrees from vertical in a clockwise direction as the start angle. The default start angle is 90 degrees. The direction of the sweep angle is always clockwise. The default sweep is 180 degrees. Direction Radio Buttons Use these radio buttons to choose the direction that the numbers will appear on the scale. • Select Clockwise and the numbers appear clockwise from low to high. • Select Counterclockwise and the numbers appear counterclockwise from low to high. Scale Color Select a color for the scale using the Scale colorwell dropdown list. Limits Use these fields to set the high and low limits of the scale. The limits can be positive or negative (you can set the number of decimal places that appear in the Decimal Places field). The High limit is the largest number displayed on the scale. The Low Limit is the smallest number displayed on the scale. Subdivisions Use these fields to set the number of Subdivisions and Steps that appear on the scale. Subdivisions are the tiny tick marks between each Step (major tick mark). Show Units Use these fields to type in and select the color for a short text string usually used to display the units of scale. Select the color you desire from the colorwell, which opens like a drop down list. Show Numbers Select Show Numbers to display numbers on the scale. Type in or scroll to the number of decimal places you want to display in the Decimal Places field. Select the color you want the numbers to appear in Color field. Use the Position drop down list to enter where you want the numbers to appear. The options depend on the type of scale selected. 3. Click OK. Inserting a Gauge To insert a gauge, follow these steps: 1. Use the drawing toolbar to create the graphic representing the gauge reading on the scale you drew in the previous procedure.
- 650. TAC638 2. Position the graphic on the scale, and select the graphic (not the scale component). 3. From the Active Components toolbar, select Gauge. The Gauge dialog appears. 4. Select settings for the gauge. Object Browse for or enter the Continuum point that the gauge will indicate. Scale Enter the upper and low limits of values shown. Direction Select the direction in which the numbers will appear on the scale: • Selecting Clockwise causes the numbers to appear clockwise from high to low. • Selecting Counterclockwise causes the numbers to appear from low to high in a counterclockwise direction. Sweep Angle Enter the angle, in degrees, (the direction of the sweep angle is always clockwise) for the gauge. For example, a gauge with measurements that form a complete circle has a Sweep Angle of 360 degrees. The default sweep angle is 310 degrees. The example to the right shows the sweep angle of 180 degrees. Select Pivot Point Click this button to display the Select the Center of Rotation dialog. Use this graphic device to position the pivot point of the gauge. In the above example, the gauge appears in the default pivot position. 5. Click OK. The gauge is now capable of moving to the corresponding position on the scale when the value it represents changes.
- 651. Andover Continuum CyberStation Configurator’s Guide 639 Importing a Pinpoint Panel Use this procedure to import a Pinpoint panel file that was created in another CyberStation installation. For example, a TAC dealer could create custom panels for you on the dealer’s CyberStation system. 1. From the File menu, select Import Panel File. 2. In the Import Panel File dialog, select a panel, and click the Import button. A warning telling you that the imported file will completely replace the contents of the open panel appears. 3. Click OK. Creating Windows Controls Windows controls are graphics that visually represent common components on a control panel, such as buttons, sliders, and LED displays. Like active components, Windows controls are associated with CyberStation points. Two special Windows controls represent CyberStation area and door objects. Windows controls do not require you to create a graphic to represent the control. Each control has a predefined set of images that represent the control in its various states. Many controls include several image sets to choose from. Creating a Button Control Follow these steps to create a Windows button control. 1. From the Windows Controls toolbar, select the button control. The following control is created for you on your Pinpoint working area. 2. Click the button control to display the Active Button Object dialog. Note: The properties of this Window control are the same as the standard Pinpoint active button control. Refer to the section in this chapter called Creating an Active Button Control for detailed information about these properties.
- 652. TAC640 3. After you select the properties you require, click OK. Creating an Edit Box Control Follow these steps to create an edit box control. You can use an edit box control to display values or to accept user entry values. 1. From the Windows Controls toolbar, select the edit box control. The following control is created for you on your Pinpoint working area. 2. Select Edit from the menu bar, and click Object Properties. 3. In the Edit Box Object Properties dialog, select the properties you require. Object Enter or click the browse button to specify the path to a Continuum point and attribute. User Entry If selected, users can enter values into the edit control, just as they do for active text controls. If not selected, the content of the edit box is read only. 3D Border If selected, the control has a border. 4. Select the Misc tab. 5. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. • Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content.
- 653. Andover Continuum CyberStation Configurator’s Guide 641 • Select Attached Object if you want to display the name and path of the object attached to the text box. 6. Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 7. Click OK. 8. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating a Switch Control Follow these steps to create a Windows switch control. 1. From the Windows Controls toolbar, select the Switch Control. The following control is created for you on your Pinpoint working area. 2. Select Edit from the menu bar, and select Object Properties. 3. In the Switch Properties dialog, select the properties you require. Object Enter or click the browse button to specify the path to a Continuum point and attribute. Style Under Style, click the down arrow, and then select the switch graphic you want to use. User Entry If selected, users can click the switch to toggle the attached object value. 4. Select the Misc tab. 5. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 6. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content.
- 654. TAC642 • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 7. Click OK. 8. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating a Combo Box Control Follow these steps to create a Windows combo box control. 1. From the Window Controls toolbar, select the Combo Box Control. The following control is created for you on your Pinpoint working area. 2. Select Edit from the menu bar, and select Object Properties. 3. In the Combobox Object Properties dialog, select the properties you require. Object Enter or click the browse button to specify the path to a Continuum point and attribute. List Items The List Items are the possible values of the attached object that will be displayed in the dropdown list of the combo box control. Use the four icons at the top of the List Items field: Insert a new list item – Click this icon and type in the list item in the edit box. Delete a list item – Select the item to be deleted and click this icon. Move an item one up the list – Select the item to move and click this icon. Move an item one down the list - Select the item to move and click this icon. Also, to edit an existing list item, double click the item and make the appropriate changes in the edit box. Autofill Click this button to automatically insert the values of a selected object in the List Items field. Note: A message will appear informing you that the current list of items will be overwritten with the newly selected values.
- 655. Andover Continuum CyberStation Configurator’s Guide 643 4. Select the Misc tab. 5. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 6. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content. • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 7. Click OK. 8. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating a Slider Control Follow these steps to create a Windows slider control. 1. From the Window Controls toolbar, select the Slider Control. The following control is created for you on your Pinpoint working area. 2. Select Edit from the menu bar, and select Object Properties. 3. In the Slider dialog, select the properties you require.
- 656. TAC644 Object Enter or click the browse button to specify the path to a Continuum point and attribute. Top of Scale Enter the maximum value to represent a completely filled slider. Bottom of Scale Enter the minimum value to represent an empty slider. Integers Only Check this check box if you want the slider scale to be in whole numbers 4. Select the Misc tab. 5. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 6. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content. • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 7. Click OK. 8. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Create a Video Control A video control window is used to display a live or recorded video stream from a source video object – a surveillance camera or a file containing a recorded video – that you assign to the video control. Follow these steps to create a video control. 1. From the Window Controls toolbar, select the Video Control. A new video control window appears.
- 657. Andover Continuum CyberStation Configurator’s Guide 645 2. Right click the empty video control window, and select Display Properties from the popup menu. 3. Enter the name of the video control window. 4. Check the Preserve Original Video Aspect Ratio checkbox if you are going to resize the video control and want to preserve its original aspect ratio in the resize. That is, it prevents you from accidentally distorting the dimensions of the image. This box is not checked, by default. Note: This checkbox is for live video only. If you are using a video source file, this setting does not apply. 5. Click OK. 6. Right click the video control, and select Object Properties. In the Active Video tab, you must select either a video source file or a video source device (surveillance camera.)
- 658. TAC646 Note: If you wish to select a source object, it must be an object that has two states – something that can be on or off, enabled or disabled, set or cleared, and so on. Live or recorded video is displayed only when the object is an on/enabled state. It does not display when it is in an off/enabled state. If you do not select a source object, live images are displayed continuously, and recorded file video is played either once (by default) or continuously, via the Loop Forever checkbox (described in the following text). 7. If you select a source data object, click the browse button in the Play when object value is On field, search for, and select an object that has an on/off (or enabled/disabled) state, such as an alarm. 8. Click the Video Source Device radio button if you want to display live images from a surveillance camera. If you are selecting Video Source File, go to step 11. 9. If you clicked Video Source Device, select a video driver from the dropdown menu, and then go to step 12. Your system must be configured with video surveillance-camera software in order for video driver selections to appear in the dropdown menu. The following video hardware is recommended for use with the video control window: • CreativeLabs WebCamGo+ USB camera • Hauppage WinTVGo Model 190 • Any capture board with VGA/DirectX compatibility • Integral’s FlashBus cards
- 659. Andover Continuum CyberStation Configurator’s Guide 647 10. If you selected Video Source File, click the browse button in the Video Source File field to browse for a AVI, MOV, or MPG file whose video recording you want to play back. Use the four checkboxes to configure the file’s video display. Select… If you want… Loop Forever The recorded video in the file will play back continuously (over and over again). Remove the check from this box if you want the file’s recorded video to play back only once. Note: If you have selected a source data object, the video is played back (once or continuously) only when the object is on/enabled. If the object is turned off or becomes disabled during playback, the playback stops and the image disappears from the video control window. Show configuration menu Access to the video control window’s configuration popup menu – accessible in either deign mode or un mode. This menu allows you to modify the display in a number of ways, including speed and volume. Remove the check to deny access to the configuration menu – for example, if you don’t want security guards or certain other users to change the video display. Show Play Controls To display a play button, a menu button, and a playback slider control along the bottom of the video control window, as shown in step 12. Remove the check to hide these controls. Auto Play when panel loads The video control window to begin playback automatically, as soon as its panel loads on the screen. 11. Click OK. Live images – If you are viewing live video from a device (surveillance camera) the live image appears. For example:
- 660. TAC648 Recorded images – If you are viewing a recorded video file, the beginning of the recording appears (in a stopped state) in design mode in your video control window. For example: Note: Your video control window can play a video stream in either design mode or run mode . In the recorded video image above, notice the play controls along the bottom of the control window. Live images (from a video source device) do not display play controls. Play Controls – In run or design mode, the play controls function as follows: • Play button Click the play button to begin or resume the playback of a video. This button becomes a stop button when the video is playing. • Menu button Click the menu button (next to the play button) to bring up the configuration menu at any time, while the video is playing or stopped. • Playback slider control The length of the slider control represents the entire duration of the recorded video. The position of the slider control button represents the current spot in playback. For example, if the slider button is located in the middle of the slider, playback is 50 percent completed. Use the slider button to go to a specific spot in the recording. Click and drag the slider control button right to advance the recording forward, as well as all the way to the right to go to the end of the recording. Likewise, slide it left to go back to a previous spot in the recording, or all the way to the left to restart the entire recording. 12. Configure the size, sound, and speed of your video stream via the Configuration menu.
- 661. Andover Continuum CyberStation Configurator’s Guide 649 (You must have checked the Show configuration menu checkbox in the Video Properties dialog.) This menu also allows you to make a “still” copy of the image inside the video control window, open and close the window, and pause, stop, and resume playback. To use this menu, right click on the video control window in run or design mode. The Configuration popup menu appears. Select… To… View Select the size of the image from its popup menu, as shown above. • Half Size reduces the image by 50 percent • Double Size increases the image to twice its current size • Normal Size restores the image to its original (100 percent) size Volume Adjust the video’s sound (if the video has sound) using the volume slider control. Click and drag the slider button down to decrease volume. The integer inside the slider button indicates the percentage of full volume. Likewise, drag the slider up to increase volume. Speed Adjust the playback speed using the speed slider control. Click and drag the slider button down to decrease playback speed. The integer inside the slider button indicates the percentage of speed, where 100 percent is normal speed. Copy Make a still snapshot of the image currently inside the video control window. This is useful if you want to show a picture of something important happening at a precise moment during the course of a video recorded. This image can be pasted into documentation files, for example. Note: Copy copies the image only, not the video control window. 13. Select the Misc tab. 14. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 15. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content. • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip.
- 662. TAC650 16. Click OK. 17. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating a Check Box Control Follow these steps to create a Windows check box control. 1. From the Window Controls toolbar, select the Check Box Control. The following control is created for you on your Pinpoint working area. 2. Select Edit from the menu bar, and select Object Properties. 3. In the Check Box dialog, select the properties you require. Object Enter or click the browse button to specify the path to a Continuum point and attribute. User Entry When selected, users can click the control to check the checkbox or to the clear the check. 4. Select the Misc tab. 5. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 6. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content. • Select Attached Object if you want to display the name and path of the object attached to the text box.
- 663. Andover Continuum CyberStation Configurator’s Guide 651 • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 7. Click OK. 8. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating a Web Browser Control A web browser control allows you to show web pages inside a Pinpoint panel. This page can be either a URL address or a local HTML file. You control which web pages to display in a web browser control window, based on certain trigger conditions. When a point is on, one page is displayed; when the point is off, another web page is displayed. For example, you can display different web pages, depending on the current state of an alarm – that is, when an alarm is active, acknowledged, returned, and so on. This control can also host any type of active document, such as Microsoft Word or Excel. You may want to use the web browser control to display documentation, such as instructions for handling an active alarm. Note: Your web browser control window must be in run mode in order for the web source object to display in the window. To create a new web browser control: 1. Click the web browser (globe) icon in your Window Controls toolbar. An empty web browser control window appears. 2. Right click the control, and select Object Properties from the popup menu. The Web Browser Control Object Properties dialog appears. You must assign a trigger for the web browser control. The trigger comprises a string object (representing a URL address or an HTML file) and a trigger, which defines the condition under which your web page appears. 3. Click the browser button in the String Object field, and select a Continuum string object. 4. Select a Trigger Option from the dropdown menu. String URL By default, you may simply bring up a URL or HTML page in your web browser control window, every time the web browser window opens – that is, whenever the string object that you assigned is turned on. When you choose this String URL, the Options tab is therefore not selectable.
- 664. TAC652 On-Off Select this option when you want to launch two different web pages in your web browser control– one when the string object is turned on, and the other when it is turned off. When you select On-Off, the Options tab becomes selectable. From the On-Off Options tab, in the On field, enter a URL address, or click the browse button to specify an HTML file that you want to launch in your web browser control window when your string object is turned on. Likewise, in the Off field, enter a URL address, or click the browse button to specify an HTML file that you want to launch in your web browser control window when your string object is turned off. Alarms Select this option when you want to open different web pages according to a particular state of an alarm, when an alarm is triggered on you string object. For example, you can launch one URL or HTML file when an alarm is active, another when it is acknowledged, another when it is returned, and so on. When you select Alarms, the Options tab becomes selectable. In this Options tab, there are five fields; one field for each sate of an alarm. In each state’s respective field, enter a URL address or use the browse button to specify an HTML file. When your string object triggers an alarm, the web page that you specify will open according to the state of the alarm. 5. In the General tab, you can specify a home page for your web browser control window. To do, simply enter a URL address in the Home Page field, or click the browse button to browse for an HTML file to launch as a home page. When the web browser control is active, click the home icon at the top of the control to go to the specified home page. 6. From the General tab, you can select user entry mode and theater mode by checking the User entry URL and Theater Mode checkboxes, respectively. User entry URL This feature allows you to navigate in run mode with a manual entry. To do so, enter a URL address in the edit field at the top of the web browser control window. Theater Mode This feature displays the web browser control window without the navigational buttons and edit entry field. Using theater mode, you may create buttons that trigger certain conditions whereby a different web page appears based on which particular button you click. Each button would be labeled according to the web page that it retrieves. 7. Select the Misc tab. 8. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed.
- 665. Andover Continuum CyberStation Configurator’s Guide 653 9. Click OK. 10. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating a Progress Bar Control Follow these steps to create a Windows progress bar control. 1. From the Window Controls toolbar, select the Progress Bar Control. The following control is created for you on your Pinpoint working area. 2. Select Edit from the menu bar, and select Object Properties. 3. In the Progress Bar Object Properties dialog, select the properties you require. Object Enter or click the browse button to specify the path to a Continuum point and attribute. High/Low Limit Enter maximum and minimum values. If you change either of these values, the ranges are automatically implemented on the progress bar. Display Value Select to display the progress bar values. Units Select to display units with the value. Vertical Select to change the progress bar from horizontal to vertical. User Entry If selected, users can click the control to display a calculator that they can use to change the value associated with the control. 4. Click the Colors tab to view the Colors dialog. This screen allows you to select colors for: • Text • Background • Start • End 5. Select the Misc tab. 6. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 7. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content.
- 666. TAC654 • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 8. Click OK. 9. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating a Trend Control A trend control is used to display points of data, plotted on a trend graph from one or more sources (data objects) over a period of time. Data from the objects are displayed in user-customized formats on a graph within the trend control window. These can be line, point, or bar graphs. The trend window consists of four main areas: • Graph plot area, with optional grid (center of window) • Pen units scale (left side of window) • Time scale (bottom of window) • Pen labels area (beneath the time scale by default). This area lists the pens (a key to the data object sources) that are plotted on the graph. You may move the pen labels area to the right side of the trend control windows via the Graph Properties dialog, discussed later in this section. The trend window with its four main areas is shown below. In this example, the trend control has three pens, each of which is polling data for temperature, in degrees Fahrenheit: You may select the color and plot-point design of each pen, via the pen style properties.
- 667. Andover Continuum CyberStation Configurator’s Guide 655 Note: Your trend control window must be in run mode in order for Pinpoint to poll live data from the data source objects and plot it on the graph. Margin The area surrounding the entire trend control window is called the margin. You may change the margin color (as well as many other characteristics of the graph) via the Graph Properties dialog, discussed later in this chapter. Scrolling Pen scale units begin at 0 at the bottom of the graph, by default. You many scroll the pen units scale and the time scale by placing the cursor over one of the scales, holding down the left mouse button, and dragging the scale up or down (for the pen scaled) or from side to side (for the time scale). You may also scroll up the pen units scale to show negative unit values. Scrolling the scales is useful when you want to demarcate a certain area of plots on the graph. Zooming Your trend control allows you to zoom in and zoom out on the graph. The zoom features are contained in the graph’s run mode menu. About Pens All pens belonging to a trend control are displayed in the window’s pen labels areas. The list of pens in the pen labels area is scrollable if there are more pens than the area can display. In the pen labels area, each pen is listed as a pushbutton. Each label name appears on its respective button. You may select a pen as follows: • Click its pen button in the pen labels area. • Click its actual pen data plotted on the graph. When you select a pen, the active pen scale and active time scale change according to how that pen is configured. Once the pen labels area is created on the trend control window, you may access the Pen Properties dialog by moving the cursor over one of the pens in the pen labels area, right clicking, and selecting Pen Properties from the popup menu. Creating a New Trend Control Graph Follow these steps to create a Windows trend control. 1. From the Windows Controls toolbar, select the Trend Control. A new graph appears.
- 668. TAC656 The graph is empty, and it does not display the pen labels area because you have not yet created a pen. However, the active pen unit scale and the time scale appear at the left side and bottom of the graph, respectively. 2. Right click, and select Add New Pen from the popup menu. The Pen Properties dialog appears.
- 669. Andover Continuum CyberStation Configurator’s Guide 657 3. Click the browse button in the Pen Data Object field, and search for an object whose data you wish to poll, track, and plot. A data source is a real-time source (object attribute). The name of the pen data object becomes the pen label (i.e., the name of the pen). Pen labels appear in the pen labels area of the trend control window. 4. In the Scale area, enter maximum and minimum values for the data that is plotted on the graph. 5. In the Style area, customize the appearance of the trend line and data points. Style characteristics include pen color, what kind of line connects the data points, as well as the style of the data points themselves. Check the Hide this pen checkbox when you don’t want this pen to appear on the graph. The pen continues to record data from its source data object, but does not plot data on the graph. A gray screen covers the pen itself in the pen labels area. For example, the pen on the left is hidden: 6. Click OK. 7. Right click the trend control, and select Properties from the popup menu. 8. Select the Plot tab and specify properties of the graph. Margin Select the margin’s background color and size. From the Background color dropdown menu, select a color from the color palette. The default color is blue. Plot Select the graph’s background color as well as whether to show or hide the grid. From the Background Color dropdown menu, select a color from the color palette. The default color is gray. Check the Grid Marks checkbox if you want to show the grid. Remove the check if you want to hide the grid. The Grid Marks box is checked by default. Label In the label field, as an option, you may enter a name for the trend control window. This label appears above the graph. Click the Font button to select a typeface and font for the trend control label, as well as for the text throughout the entire trend control. Check the Show checkbox when you want to show the trend control label name. Remove the check in the Show checkbox when you want to hide the label name.
- 670. TAC658 Time Scale Check the Show Time Scale checkbox when you want to show the time scale on the trend control. Remove the check when you want to hide the time scale. The Show Time Scale box is checked by default. Check the Vertical Text checkbox when you want to display time scale text vertically, at a right angle. This box is not checked, and text is displayed horizontally, by default. When you check this box, text is displayed vertically. 9. Click the Pen Labels tab to show, hide, and position pen labels, as well as pen label units, on the trend control. Show Pen Labels Displays the pen labels on the trend control. Remove this check to hide all pen labels. Show at the Bottom Displays the pen labels along the bottom of the trend control, beneath the time scale. By default, this button is selected, and pen labels are displayed at the bottom. Show on the Right Displays the pen labels along the right side of the trend control. Show Pen Units Displays the pen units’ scale. Vertical Text Displays text in the pen scale vertically. 10. Select the Pens tab to add or delete a pen, as well as access the Pen Properties dialog, where you may view and/or modify a pen’s properties. 11. Select the Misc tab. 12. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 13. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content. • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 14. Click OK. 15. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Run Mode Menu Features of Trend Graphs The run mode popup menus for the graph and the pen labels enable you to control certain display characteristics of the plotted data.
- 671. Andover Continuum CyberStation Configurator’s Guide 659 Right click the graph to display the following options: Pause Select Pause to stop the plotting of new sample data on the graph. Restart Select Restart after a pause, to resume the plotting of data on the graph. Auto Scroll Select Auto Scroll when you want the graph to scroll to the left automatically whenever more data samples are plotted on the graph. This allows you to see the latest plotted data. Fit Time Select Fit Time to show all the plotted data on the graph at once, beginning with the time of the first plot in the leftmost part of the graph, and ending with the latest plot on the rightmost part of the graph. Time Zoom In Select Time Zoom In to zoom into the graph area (time axis) by 50 percent of its current size. Time Zoom Out Select Time Zoom Out to zoom out of the graph area (time axis) by 50 percent of its current size. Right click a pen to display the following options: Object Properties Select Object Properties to launch the object editor for the source data object whose data is being polled and plotted. Hide Select Hide to hide the selected pen. Fit Time Select Fit Time to show all the plotted data on the graph at once, beginning with the time of the first plot in the leftmost part of the graph, and ending with the latest plot on the rightmost part of the graph. Design Mode Menu Features of Trend Graphs Right click the graph to display the following options: Properties Select Properties to launch the Graph Properties dialog for the trend control. Add New Pen Select Add New Pen to launch the Pen Properties dialog, which allows you to add a new pen to the trend control window. See also Adding a New Pen. Auto Scroll Select Auto Scroll when you want the graph to scroll to the left automatically whenever more data samples are plotted on the graph. This allows you to see the latest plotted data. Fit Time Select Fit Time to show all the plotted data on the graph at once, beginning with the time of the first plot in the leftmost part of the graph, and ending with the latest plot on the rightmost part of the graph.
- 672. TAC660 Right click a pen, and select Pen Properties to launch the Pen Properties dialog containing all the settings for that particular pen. Creating an LED Number Control A light-emitting diode (LED) number control allows you to simulate a digital LED number display, based on numeric values it receives from a source data object that is assigned to the number control. The number control can be a multiple-digit integer, up to 10 digits. You may also display the digits in certain colors to indicate various states of an alarm, when your data object has triggers an alarm. To create a new LED number control: 1. Click the LED number control icon on the Windows Controls toolbar. A new, empty LED number control appears. By default, it has four digit places. 2. Right click the control, and select Object Properties from the popup menu. The LED Number Control Object Properties dialog appears. 3. In the General tab, click the browse button in the Object field, search for, and select an object whose numeric value you want to display. 4. Enter the number of digits to display. You may select a minimum of one digit and a maximum of 10 digits. 5. Check the User Entry checkbox if you want users to be able to manually change the integer value of the number control’s source object.
- 673. Andover Continuum CyberStation Configurator’s Guide 661 Users can click the control to display a calculator where they can specify a new value. Clear the checkbox to make the control read only. 6. Select the Alarms tab, and select a color for each state of an alarm. When your data object triggers an alarm, the integer in the LED number control appears in the specified color, depending on its current state. 7. Select the Misc tab. 8. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed. 9. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content. • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. Click OK. 10. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel. Creating a Door Control The Windows door control provides you with a graphic display of a Door object. It illustrates the switch states of the door by using configurable animation. Bitmap images illustrate the states of the door: • Alarm • Enabled/disabled • Locked/unlocked • Scheduled lock/unlock • Trouble • Timed unlock • Enabled/disabled keypad/reader access To make the control operational, you have the option of: • Using the default animation bitmap set. • Choosing from several supplied bitmap sets. • Using your own bitmap set. Follow these steps to create a door control: 1. From the Window Controls toolbar, select the door control. The following control is created for you on your Pinpoint working area.
- 674. TAC662 2. Right click the door control and select Object Properties to display the Door Control dialog. 3. In the General tab, select the properties you require. Object Enter or click the browse button to specify the path to a door object to attach to this control. Style Select a style of door graphics that you want to use from the drop down menu. User Entry If selected, users can right click the door control to display a popup menu with options for controlling to door. Switch Animation Check this box if you want the selected set of bitmaps in the Style combo box to reflect the state of the door switch or to represent the locked/unlocked state of the door. If the attached door is not configured for a switch (switch channel is zero), the switch animation checkbox is unchecked and disabled and the locked/unlocked state of the door is represented. Flat Appearance If not checked, the door control will have a raised edge (appearing like a button.) 4. Select the Advanced Alarms Images tab to display a specific image for a forced entry, door ajar, or custom alarm. Browsing to or entering an image file (in their respective edit boxes) and then specifying the alarm link (1 through 8) from the door editor’s alarm page. If the alarm enrollment associated with the alarm link is in the alarm stage, the specified bitmap is displayed. The custom alarm can be attached to any alarm link. Note: If advanced alarms are not required, make sure the Alarm Links values are set to zero. 5. Select the Custom Images tab if you wish to use your own door style images. 6. Browse to or enter the names of your custom set of bitmaps in the Open, Closed, Alarm, and Trouble edit boxes. Files must be entered for both the Open and Closed images; the Alarm and Trouble images are optional. If the Alarm and Trouble images are blank, the door control checks the door switch state and implements the appropriate Open or Closed image. Note: If you are not going to use custom images, ensure that the Open, Closed, Alarm, and Trouble edit boxes are blank.
- 675. Andover Continuum CyberStation Configurator’s Guide 663 7. Select the Personnel Data tab, to select up to four attributes to be displayed in the details dialog. You can select any personnel attributes listed to be displayed under the personnel picture of the last person to enter or to exit through the attached door. If the check box next to the attribute is checked, it is displayed in the dialog. 8. To execute Plain English (PE) commands in addition the button action you defined in step 5, select the Plain English Script tab, and enter the PE script. Click the Check button to verify that the script has no syntax or other errors. PE scripts can execute any command-line command. PE scripts cannot have local variable declarations or labels. PE scripts are executed before the selected Active Button performs its action (i.e., open panel, open object, etc.). 9. Select the Misc tab. 10. If you want to adjust the polling rate, enter a new value for Rate. The polling rate determines how often a point is queried per millisecond to see if its value has changed.. 11. Select the ToolTips checkbox if you want to display a tooltip when the curser hovers over the text box, and then specify the tooltip content: • Select Attached Object if you want to display the name and path of the object attached to the text box. • Select User Defined, and enter the appropriate text if you want to display custom text in the tooltip. 12. Click OK. 13. To save and test the component, click the Run Mode button in the standard toolbar. Click the Design Mode button to return to editing the panel.
- 676. TAC664 Controlling a Door You can use a door control to unlock the door assigned to the control, view door details and events, and perform other functions to control that door object. You cannot use a door control to lock down a door or to clear the Lockdown state from a door. Instead, use the area control for the Area object to which the door is assigned. Note: The User Entry checkbox must be checked in the Door Control dialog for the specific door control before you can control the door as described in the following table. For more information see, Creating a Door Control, earlier in this chapter. If you want to… Then… Prevent access at the card reader or keypad associated with the door Right click the door control, and select Disable Keypad/Reader Access from the popup menu. Unlock the door and allow it to remain unlocked Right click the door control, and select Permanent Unlock from the popup menu. If the door is in the Lockdown state, the message is ignored and door does not unlock. Unlock the door for a specified amount of time, and then relock it Right click the door control, select Timed Unlock, and then select the number of minutes to allow the door to remain unlocked. To enter a specific time, select Custom, enter the number of minutes (up to 105), and click OK. If the door is in the Lockdown state, the message is ignored and the door does not unlock. Relock an unlocked door Right click the door control, select Timed Unlock, and then select Relock. Obtain information about the card holder of the access card used (or PIN entered) most recently at this door (including the photo of the card holder, if available) Right click the door control, and select Door Details. View the list of access events that occurred at this door Right click the door control, and select Door Events. View or change values for door attributes Right click the door control, and select Edit Door to open the Door editor. View a video layout, if one is attached to the door object associated with the control Right click the door control, and select Video Layout. Run the Plain English script that is entered in the Door control dialog for this control Right click the door control, and select Run Script.
- 677. Andover Continuum CyberStation Configurator’s Guide 665 Creating an Area Control The area control provides a graphic display of a CyberStation Area object. The control illustrates whether the area is in the Lockdown state or in the Normal state, using either bitmap images or colors. You can create an Area control and attach a CyberStation Area object to the control, or you can drag an Area object from Continuum Explorer onto the Pinpoint canvas to create an area control for the selected area. In run mode, you can click the area control to initiate the Lockdown state at the controllers that manage doors for the area. You can also right click the area control and select Options from the popup menu to lock down or clear the Lockdown state for the area and at individual doors assigned to the area. Use the following procedure to create an area control and attach the control to an