Sei sulla pagina 1di 120

6/22/12

ONYXWorks

Workstation
Installation & Operation Manual

Document 52342
6/22/12
Rev:
P/N: 52342:F1

F1
ECN: 11-0426

Fire Alarm System Limitations


While a fire alarm system may lower insurance rates, it is not a substitute for fire insurance!
An automatic fire alarm systemtypically made up of smoke detec-

tors, heat detectors, manual pull stations, audible warning devices,


and a fire alarm control panel with remote notification capabilitycan
provide early warning of a developing fire. Such a system, however,
does not assure protection against property damage or loss of life
resulting from a fire.
The Manufacturer recommends that smoke and/or heat detectors be
located throughout a protected premise following the recommendations of the current edition of the National Fire Protection Association
Standard 72 (NFPA 72), manufacturer's recommendations, State and
local codes, and the recommendations contained in the Guide for
Proper Use of System Smoke Detectors, which is made available at
no charge to all installing dealers. These documents can be found at
http://www.systemsensor.com/html/applicat.html.
A study by the Federal Emergency Management Agency (an agency
of the United States government) indicated that smoke detectors may
not go off in as many as 35% of all fires. While fire alarm systems are
designed to provide early warning against fire, they do not guarantee
warning or protection against fire. A fire alarm system may not provide
timely or adequate warning, or simply may not function, for a variety
of reasons:

bedrooms), smoking in bed, and violent explosions (caused by escaping gas, improper storage of flammable materials, etc.).
Heat detectors do not sense particles of combustion and alarm only
when heat on their sensors increases at a predetermined rate or
reaches a predetermined level. Rate-of-rise heat detectors may be
subject to reduced sensitivity over time. For this reason, the rate-ofrise feature of each detector should be tested at least once per year
by a qualified fire protection specialist. Heat detectors are designed to
protect property, not life.
IMPORTANT! Smoke detectors must be installed in the same room

as the control panel and in rooms used by the system for the connection of alarm transmission wiring, communications, signaling, and/or
power. If detectors are not so located, a developing fire may damage
the alarm system, crippling its ability to report a fire.
Audible warning devices such as bells may not alert people if these

devices are located on the other side of closed or partly open doors or
are located on another floor of a building. Any warning device may fail
to alert people with a disability or those who have recently consumed
drugs, alcohol or medication. Please note that:

Strobes can, under certain circumstances, cause seizures in people


with conditions such as epilepsy.

Studies have shown that certain people, even when they hear a fire
alarm signal, do not respond or comprehend the meaning of the signal.
It is the property owner's responsibility to conduct fire drills and other
training exercise to make people aware of fire alarm signals and
instruct them on the proper reaction to alarm signals.

Particles of combustion or smoke from a developing fire may not


reach the sensing chambers of smoke detectors because:

In rare instances, the sounding of a warning device can cause temporary or permanent hearing loss.

Barriers such as closed or partially closed doors, walls, or chimneys


may inhibit particle or smoke flow.

A fire alarm system will not operate without any electrical power. If

Smoke particles may become cold, stratify, and not reach the ceiling
or upper walls where detectors are located.

Smoke particles may be blown away from detectors by air outlets.

Smoke particles may be drawn into air returns before reaching the
detector.

Smoke detectors may not sense fire where smoke cannot reach the

detectors such as in chimneys, in or behind walls, on roofs, or on the


other side of closed doors. Smoke detectors also may not sense a fire
on another level or floor of a building. A second-floor detector, for
example, may not sense a first-floor or basement fire.

AC power fails, the system will operate from standby batteries only for
a specified time and only if the batteries have been properly maintained and replaced regularly.
Equipment used in the system may not be technically compatible
with the control panel. It is essential to use only equipment listed for
service with your control panel.

The amount of smoke present may be insufficient to alarm smoke


detectors. Smoke detectors are designed to alarm at various levels of
smoke density. If such density levels are not created by a developing
fire at the location of detectors, the detectors will not go into alarm.

Telephone lines needed to transmit alarm signals from a premise to a

Smoke detectors, even when working properly, have sensing limitations. Detectors that have photo-electronic sensing chambers tend to
detect smoldering fires better than flaming fires, which have little visible smoke. Detectors that have ionizing-type sensing chambers tend
to detect fast-flaming fires better than smoldering fires. Because fires
develop in different ways and are often unpredictable in their growth,
neither type of detector is necessarily best and a given type of detector may not provide adequate warning of a fire.

The most common cause of fire alarm malfunction is inadequate

Smoke detectors cannot be expected to provide adequate warning of


fires caused by arson, children playing with matches (especially in

central monitoring station may be out of service or temporarily disabled. For added protection against telephone line failure, backup
radio transmission systems are recommended.
maintenance. To keep the entire fire alarm system in excellent working order, ongoing maintenance is required per the manufacturer's
recommendations, and UL and NFPA standards. At a minimum, the
requirements of NFPA 72 shall be followed. Environments with large
amounts of dust, dirt or high air velocity require more frequent maintenance. A maintenance agreement should be arranged through the
local manufacturer's representative. Maintenance should be scheduled monthly or as required by National and/or local fire codes and
should be performed by authorized professional fire alarm installers
only. Adequate written records of all inspections should be kept.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Installation Precautions
Adherence to the following will aid in problem-free installation with long-term reliability:
WARNING - Several different sources of power can be connected to
the fire alarm control panel. Disconnect all sources of power before

servicing. The control unit and associated equipment may be damaged by removing and/or inserting cards, modules, or interconnecting
cables while the unit is energized. Do not attempt to install, service,
or operate this unit until this manual is read and understood.
CAUTION - System Reacceptance Test after Software Changes. To

ensure proper system operation, this product must be tested in accordance with NFPA 72 after any programming operation or change in
site-specific software. Reacceptance testing is required after any
change, addition or deletion of system components, or after any modification, repair or adjustment to system hardware or wiring.
All components, circuits, system operations, or software functions
known to be affected by a change must be 100% tested. In addition,
to ensure that other operations are not inadvertently affected, at least
10% of initiating devices that are not directly affected by the change,
up to a maximum of 50 devices, must also be tested and proper system operation verified.
This system meets NFPA requirements for operation at 0C to 49C

(32F to 120F) and at a relative humidity 93% 2% RH (non-condensing) at 32C 2C (90F 3F). However, the useful life of the
system's standby batteries and the electronic components may be
adversely affected by extreme temperature ranges and humidity.
Therefore, it is recommended that this system and all peripherals be
installed in an environment with a nominal room temperature of 1527 C/60-80 F.
Verify that wire sizes are adequate for all initiating and indicating
device loops. Most devices cannot tolerate more than a 10% I.R.
drop from the specified device voltage.

Like all solid state electronic devices this system may operate erratically or can be damaged when subjected to lightning-induced transients. Although no system is completely immune from lightning
transients and interferences, proper grounding will reduce susceptibility. Overhead or outside aerial wiring is not recommended, due to an
increased susceptibility to nearby lightning strikes. Consult with the
Technical Services if any problems are anticipated or encountered.
Disconnect AC power and batteries prior to removing or inserting circuit boards. Failure to do so can damage circuits.
Remove all electronic assemblies prior to any drilling, filing, reaming,

or punching of the enclosure. When possible, make all cable entries


from the sides or rear. Before making modifications, verify that they
will not interfere with battery, transformer, and printed circuit board
location.
Do not tighten screw terminals more than 9 in-lbs. Over-tightening

may damage threads, resulting in reduced terminal contact pressure


and difficulty with screw terminal removal.
Though designed to last many years, system components can fail at
any time. This system contains static-sensitive components. Always
ground yourself with a proper wrist strap before handling any circuits
so that static charges are removed from the body. Use static-suppressive packaging to protect electronic assemblies removed from
the unit.
Follow the instructions in the installation, operating, and program-

ming manuals. These instructions must be followed to avoid damage


to the control panel and associated equipment. FACP operation and
reliability depend upon proper installation by authorized personnel.

FCC Warning
WARNING: This equipment generates, uses, and can radi-

ate radio frequency energy and if not installed and used in


accordance with the instruction manual, may cause interference to radio communications. It has been tested and
found to comply with the limits for class A computing
device pursuant to Subpart B of Part 15 of FCC Rules,
which is designed to provide reasonable protection against
such interference when operated in a commercial environment. Operation of this equipment in a residential area is
likely to cause interference, in which case the user will be
required to correct the interference at his own expense.

Canadian Requirements: This digital apparatus does not


exceed the Class A limits for radiation noise emissions
from digital apparatus set out in the Radio Interference
Regulations of the Canadian Department of Communications. This Class A digital apparatus complies with Canadian ICES-003.

Le present appareil numerique n'emet pas de bruits radioelectriques depassant les limites applicables aux appareils
numeriques de la classe A prescrites dans le Reglement
sur le brouillage radioelectrique edicte par le ministere des
Communications du Canada. Cet appareil numerique de la
classe A est conforme a la norme NMB-003 du Canada.

HARSH, NIS and NOTIFIRENET are all trademarks; and Acclimate Plus, FlashScan, NOTIFIER, ONYX, ONYXWorks, VeriFire and VIEW are all registered
trademarks of Honeywell International, Inc. ARCNET is a registered trademark of Datapoint Corporation. Microsoft and Windows are registered trademarks of the
Microsoft Corporation.
Copyright 2012

by Honeywell International, Inc. All rights reserved. Unauthorized use of this document is strictly prohibited.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Documentation Feedback
Your feedback helps us keep our documentation up-to-date and accurate. If you have any comments, you can email
us.
Please include the following information:

Product name and version number (if applicable)

Manual page number

Your comment

Send email messages to:


FireSystems.TechPubs@honeywell.com
Please note this email address is for documentation feedback only. If you have any technical issues, please contact
Technical Services.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Table of Contents
Section 1 Introduction .............................................................................................................. 9
1.1: ONYXWorks System Overview .................................................................................................................9
1.2: System Limits ................................................................................................................................................9
1.3: Agency Listings ...........................................................................................................................................10
1.3.1: Compliance........................................................................................................................................10
1.3.2: Installation .........................................................................................................................................10
1.4: Environmental Requirements ......................................................................................................................12
1.5: Related Documentation ...............................................................................................................................12
1.6: Upgrade Information ...................................................................................................................................12
1.7: VeriFire Tools Upgrades ..............................................................................................................................12
1.8: Manual Conventions ....................................................................................................................................13
1.8.1: Notes, Cautions, and Warnings .........................................................................................................13
1.8.2: Procedures .........................................................................................................................................13
1.8.3: Referencing Other Documents ..........................................................................................................13

Section 2 Hardware, Printer, and Power Connections ........................................................ 15


2.0.1: Wiring Restrictions ...........................................................................................................................15
2.1: Installation Overview...................................................................................................................................16
2.2: Connect the Workstation Components ........................................................................................................16
2.2.1: Workstation Component Connections...............................................................................................16
2.3: Workstation AC Power Connection Preparation .........................................................................................17
2.3.1: Primary and Secondary Power ..........................................................................................................17
2.3.2: Workstation AC Power Connection ..................................................................................................17
2.4: Make Printer Connections ...........................................................................................................................19
2.4.1: Connecting a Graphics Printer...........................................................................................................19
2.4.2: Local Event Printer Connection ........................................................................................................20
2.5: Uninterruptable Power Supply (UPS) Installation ......................................................................................21
2.5.1: Workstation UPS Supervision ...........................................................................................................22
2.5.2: Printer UPS Supervision....................................................................................................................22
2.6: Workstation Hardware/Software Application Connections.........................................................................23
2.6.1: WSSUP Board Description ...............................................................................................................23
2.7: Workstation Network (LAN) Connection....................................................................................................24
2.8: Workstation Power-up .................................................................................................................................25

Section 3 Windows Software Configuration...................................................................... 27


3.1: Start the Workstation PC..............................................................................................................................27
3.2: Install Computer Software ...........................................................................................................................27
3.2.1: Windows Installation.........................................................................................................................27
3.2.2: Workstation Software Application Installation .................................................................................27
3.2.3: Anti-Virus Software Installations......................................................................................................27
3.3: Windows Settings ........................................................................................................................................27
3.3.1: Changing the Windows Administrator Password..............................................................................28
3.4: Workstation Software Application Start and Exit Methods.........................................................................28
3.4.1: Workstation Software Starting Mode ................................................................................................28
3.4.2: Workstation Software Exit Mode ......................................................................................................28

Section 4 ONYXWorks Workstation System Connections ............................................... 29


4.1: Make ONYXWorks System Connections .................................................................................................29
4.2: Master User Login .......................................................................................................................................31
4.3: Add a Network Connection to the Workstation...........................................................................................31
4.3.1: Import Configuration Data ................................................................................................................31
4.3.2: Adding a New Network Connection .................................................................................................32
4.3.3: Adding a Redundant Gateway ..........................................................................................................33
4.4: Auto-Create Gateway Point IDs ..................................................................................................................35
4.4.1: About Auto-Creating Gateway Point IDs .........................................................................................35
ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Table of Contents

4.5: Workstation Database Modifications ...........................................................................................................36

Section 5 Workstation Software Configuration ................................................................... 37


5.1: Factory Defined User Profiles and their Passwords ....................................................................................37
5.2: Monitoring Profiles ......................................................................................................................................37
5.3: Workstation Software Application Options Configuration..........................................................................39
5.3.1: Output Configuration.........................................................................................................................39
5.3.2: Pager/Modem Configuration .............................................................................................................42
5.3.3: E-Mail Configuration.........................................................................................................................44
5.3.4: General Operation Configuration ......................................................................................................45
5.3.5: User Features Configuration..............................................................................................................49
5.4: Control Profiles Configuration ....................................................................................................................50
5.4.1: Control Profiles..................................................................................................................................50
5.4.2: Control Profile Activation Procedure ................................................................................................51
5.5: System Options Configuration.....................................................................................................................51
5.5.1: Icon Set ..............................................................................................................................................51
5.5.2: Operating Modes ...............................................................................................................................52
5.5.3: Time Server Settings..........................................................................................................................52
5.6: Macro Command Configuration ..................................................................................................................53
5.6.1: About Macro Commands...................................................................................................................53
5.6.2: Macro Creation and Management .....................................................................................................55
5.7: Color and Sound Configuration ...................................................................................................................56
5.7.1: About Color Configuration Settings ..................................................................................................56
5.7.2: About Sound Configuration Settings.................................................................................................57
5.8: Fan Monitor Configuration ..........................................................................................................................57
5.8.1: About Fan Monitoring .......................................................................................................................57
5.8.2: Monitor Fan Setup .............................................................................................................................57

Section 6 Workstation Screen Graphical User Interface Management ............................. 59


6.1: Auto-Creation of Workstation Screens, Nodes, and Points .........................................................................59
6.1.1: Description.........................................................................................................................................59
6.1.2: Manage the Auto-Creation Process ...................................................................................................60
6.2: Setup the Workstation Display Mode ..........................................................................................................61
6.2.1: View Workstation in Graphics Mode ................................................................................................61
6.2.2: View Workstation in Text Mode .......................................................................................................62

Section 7 ONYXWorks Workstation Data Management .................................................... 63


7.1: Database Management .................................................................................................................................63
7.2: History Manager ..........................................................................................................................................64
7.2.1: History Manager Menu Descriptions.................................................................................................65
7.2.2: History Manager Right Click Menu Descriptions .............................................................................70
7.3: System Explorer Searches............................................................................................................................71
7.3.1: Search for Device ..............................................................................................................................71
7.4: Key Upgrade Utility.....................................................................................................................................71
7.4.1: Key Upgrade Utility Overview..........................................................................................................71
7.4.2: Key Upgrade Procedure.....................................................................................................................71
7.4.3: Key Upgrade Utility Field Descriptions ............................................................................................72

Section 8 ONYXWorks System Architecture Descriptions............................................... 73


8.1: System Architecture.....................................................................................................................................73
8.2: Operating Modes..........................................................................................................................................76
8.3: Fire Command Center (FCC) Mode Overview (PPU) ................................................................................76
8.3.1: Architecture for FCC Mode...............................................................................................................76
8.3.2: Event Handling Overview for FCC Mode.........................................................................................77
8.3.3: FCC Mode Communications Requirements ......................................................................................78
8.3.4: FCC Mode Agency Approval ............................................................................................................78
8.3.5: ONYXWorks FCC Mode Ordering Information ............................................................................78
8.3.6: FCC Mode Example Life System Diagrams .....................................................................................79
6

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Table of Contents

8.4: Proprietary Supervising Station Mode Overview ........................................................................................81


8.4.1: Architecture For Supervising Station Mode......................................................................................81
8.4.2: Overview of Event Handling in Supervising Station Mode ..............................................................81
8.4.3: Supervising Mode Communications Requirements ..........................................................................82
8.4.4: Supervising Mode Agency Approval ................................................................................................82
8.4.5: ONYXWorks Supervising Mode Ordering Information.................................................................82
8.4.6: Supervising Mode Example Life System Diagrams..........................................................................83
8.5: Client Applications ......................................................................................................................................85
8.6: Printers .........................................................................................................................................................85
8.7: System Security ...........................................................................................................................................85
8.7.1: Hardware Security .............................................................................................................................85
8.7.2: Software Security ..............................................................................................................................85
8.8: Workstation Event Handling Basics ............................................................................................................86
8.9: Workstation Monitored Points .....................................................................................................................89
8.9.1: Workstation Points ............................................................................................................................89
8.9.2: Common Workstation Commands ....................................................................................................89

Appendix A: Glossary ............................................................................................................ 91


Appendix B: Details about Event Data.................................................................................. 95
B.1: Event Data...................................................................................................................................................95
B.2: Event Priority ..............................................................................................................................................95
B.2.1: Icon Recommendations.....................................................................................................................98
B.3: Printer Output Format ...............................................................................................................................101

Appendix C: ONYXWorks Workstation Users Guide...................................................... 103


C.1: Workstation Display Descriptions.............................................................................................................103
C.1.1: Displayed User................................................................................................................................104
C.1.2: Main Menu......................................................................................................................................104
C.1.3: Toolbar Menu..................................................................................................................................104
C.1.4: Taskbar Menu .................................................................................................................................104
C.1.5: Overview.........................................................................................................................................104
C.1.6: Workstation Floorplan Area ...........................................................................................................105
C.1.7: Graphic Elements Descriptions.......................................................................................................105
C.1.8: Navigation Tree ..............................................................................................................................106
C.1.9: New Event.......................................................................................................................................107
C.1.10: Acknowledged Events ..................................................................................................................107
C.1.11: Alarm Summary............................................................................................................................107
C.1.12: Event Annunciator Icon ................................................................................................................108
C.1.13: Other - Indicates input on, output on events. ................................................................................108
C.2: Daily Operation.........................................................................................................................................109
C.2.1: Logging into the Workstation .........................................................................................................109
C.2.2: Interpreting Events on the Workstations User Interface ...............................................................111
C.2.3: Managing Events ............................................................................................................................113
C.2.4: Acknowledge a New Event Procedures..........................................................................................114

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Table of Contents

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Section 1 Introduction
1.1 ONYXWorks System Overview
The ONYXWorks system is designed to provide clear and precise annunciation of life safety and
other building system events. The precision of that annunciation enables the responding personnel
to identify the location of a life safety event quickly and accurately. The status of the emergency
equipment or fire safety functions that might affect the safety of the occupants is also easily
identifiable.

1.2 System Limits


This table provides information about the maximum capacities of an ONYXWorks system. These
limits are well above what is generally needed for even large fire systems.

Table 1.1 ONYXWorks System Limits


Feature

Maximum Allowed

Physical Network Limit


Networks

50 total (100 gateways if


fully redundant; for more
information, refer to
Adding a Redundant
Gateway on page 33)

Logical Network & Screen Limits


Screens

1000

Devices

100,000

Macros

100

Macro Button

100

NavIcons

1000

Monitoring Profiles

100

Node Control Profiles

100

Audio Limits
Audio Groups

100

Points per Group

100

Zones per Group

100

Workstation limits
Output Formats

25 per Workstation

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Introduction

Agency Listings

Table 1.1 ONYXWorks System Limits


Feature

Maximum Allowed

Email Recipients

10 per Workstation

Pager Recipients

10 per Workstation

User Manager limits


Users

500

1.3 Agency Listings


NOTE:
UL 864, 9th EditionONYXWorks systems work with products that have been UL 864, 9th
Edition listed as well as products that have not received UL 864, 9th Edition certification.
Operation of systems that are comprised of equipment that is UL 864, 9th Edition listed together
with products that are not UL 864, 9th Edition listed requires the approval of the local Authority
Having Jurisdiction (AHJ).
CAN/ULC-S559-04, 1st EditionONYXWorks systems work with products that have been
CAN/ULC-S559-04, 1st Edition listed as well as products that have not received CAN/ULC-S55904, 1st Edition certification. Operation of systems that are comprised of equipment that is
CAN/ULC-S559-04, 1st Edition listed together with products that are not CAN/ULC-S559-04, 1st
Edition listed requires the approval of the local Authority Having Jurisdiction (AHJ).

1.3.1 Compliance
This product has been investigated to, and found to be in compliance with the following standards.

National Fire Protection Association

NFPA 72National Fire Alarm Code

Underwriters Laboratories

UL-294Access Control System Units, Fifth Edition

UL-864Control Units for Fire Alarm Systems, Ninth Edition

UL-1076Proprietary Burglar Alarm Units and Systems, Fifth Edition

UL-2017General-Purpose Signaling Devices and Systems, First Edition

Underwriters Laboratories Canada

CAN/ULC-S527-99Standard for Control Units for Fire Alarm Systems, Second Edition

CAN/ULC-S559-04Equipment for Fire Signal Receiving Centres and Systems, First


Edition

1.3.2 Installation
This product is intended to be installed in accordance with the following regulatory agencies.

Local

AHJAuthority Having Jurisdiction

National Fire Protection Association

10

NFPA 70National Electrical Code

NFPA 72National Fire Alarm Code

NFPA 101Life Safety Code


ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Agency Listings

Introduction

Underwriters Laboratories

UL-1076In certified applications, the unit shall be installed in accordance with Proprietary
Burglar Alarm Units and Systems, Fifth Edition

Underwriters Laboratories Canada

CAN/ULC-S524-06Standard for the Installation of Fire Alarm Systems, Fifth Edition

CAN/ULC-S561-03Installation and Services for Fire Signal Receiving Centres and


Systems, First Edition

Canada

CSA C22.1Canadian Electrical Code, Part I, Safety Standard for Electrical Installations

WARNING: Installation
Improper installation, maintenance, and lack of routine testing could result in system malfunction.

NOTICE TO USERS, INSTALLERS, AUTHORITIES HAVING JURISDICTION, AND OTHER INVOLVED PARTIES
This product incorporates field-programmable software. In order for the product to comply with the requirements in the Standard
for Control Units and Accessories for Fire Alarm Systems, UL 864, certain programming features or options must be limited to
specific values or not used at all as indicated below.
Program feature or option

Permitted in UL 864 (Y/N)

Possible Settings

Remote resetting and


silencing of a fire alarm
control unit from other than
the protected premises (ref:
NFPA 72-2007 6.8.2.8)

No

Security Levels
Administrator
User with Point Control
User with Client Control
Default User

Settings permitted in UL 864

90.23 effective October 1, 2005

Ethernet Network Installations


The ONYXWorks Workstation is a Proprietary Supervising Station that has a supervised client
server architecture that communicates over Ethernet (TCP/IP) networks. The IP network can be a
shared bandwidth system that operates over topologies such as an intranet, the Internet, or a frame
relay system. ULC does not allow operation over an Internet connection.
ONYXWorks clients, in the most basic system, can co-exist on one computer. For more powerful
systems, multiple computers can be networked together over the IP network running multiple
instances of the Workstation software application or other clients and gateways.
If the Workstation or gateway are sharing on-premises communications equipment, the shared
equipment shall be listed for the purpose. If on-premises communications equipment is not listed
for the purpose, the fire alarm transmitter shall be installed ahead of the unlisted communications
equipment.
Listed for the purpose has been formally interpreted by NFPA (Formal Interpretation 72-99-1)
for equipment on packet switched networks as being listed to the requirements applicable to
general purpose communications network equipment.
For ULC applications, the Internet cannot be used for either primary or ancillary functionality.
NOTE: The ONYXWorks Workstation uses active communications for monitoring of devices. In
Canada, infrastructure which involves LAN/WAN configurations may be monitored provided that a
dedicated T-1 is used and routers are battery backed with a power source capable of providing
backup power for a period of 24 hours.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

11

Introduction

Environmental Requirements

1.4 Environmental Requirements


This product must be installed in the following environmental conditions:

Temperature range of 0C to 49C (32F - 120F).

93% humidity non-condensing at 30C (86F).

1.5 Related Documentation


The following is a list of documentation resources related to the ONYXWorks system.

ONYXWorks NFN GW PC (PN 52307)

ONYXWorks Receivers Gateway (PN 52308)

ONYXWorks NetLogic (PN 52326)

ONYXWorks Routers-Repeaters (PN 52327)

ONYXWorks Workstation Manual (PN 52342)

ONYXWorks Configuration Tool (PN 53038)

ONYXWorks Upgrade Wizard (PN 53228)

NOTE: The contents of this manual are important and must be kept in close proximity of the
Workstation. If building ownership is changed, this manual including all other testing and
maintenance information must also be passed to the current owner of the facility. A copy of this
manual was shipped with the equipment and is also available from the manufacturer.

1.6 Upgrade Information


For more information about upgrading from a previous ONYXWorks version, refer to
ONYXWorks Upgrade Wizard Product Installation Document, P/N 53228.

Back Up System
Once you begin upgrading an ONYXWorks system from a previous version, you cannot
automatically restore the previous ONYXWorks version, whether the upgrade is successful or not.
Therefore, it is very important to make a backup of your ONYXWorks system before you begin
the upgrade process.

Manual Component Removal


Installing ONYXWorks 3.0 or later on an older system which ran ONYXWorks 2.0 does not
remove ONYXWorks Launcher from the Windows Start menu, nor does it remove other menu
items associated with ONYXWorks 2.0 applications. Follow these instructions to manually
remove ONYXWorks Launcher from the Windows Start menu:
Step 1. From the Windows taskbar, click Start >All Programs >Startup.
Step 2. Right-click ONYXWorks Launcher, and then click Delete in the menu that appears.

1.7 VeriFire Tools Upgrades


Uninstalling VeriFire Tools can remove software components required for ONYXWorks
Workstation. Since existing versions of VeriFire Tools are uninstalled automatically during the
VeriFire Tools upgrade process, upgrading VeriFire Tools may cause ONYXWorks Workstation to
stop functioning. If this happens, follow these steps to repair ONYXWorks Workstation:
Step 1. Connect the Workstation USB Software Key to an appropriate connector on the computer.

12

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Manual Conventions

Introduction

Step 2. Insert the Workstation software CD. If the InstallShield Wizard does not start
automatically, run the file setup.exe from the CD root directory.
Step 3. Click Run.
Step 4. Select the Repair option from the available choices. Follow the on-screen prompts to
complete the repair process.

1.8 Manual Conventions


NOTE: In this document, unless expressly written otherwise, when the term ONYXWorks
Workstation or Workstation is used those terms refer to the software application and the computer
it is installed on as one.

1.8.1 Notes, Cautions, and Warnings


This manual contains notes, cautions, and warnings to alert the reader as follows:
NOTE: Supplemental information for a topic, such as tips and references.

CAUTION: Summary in bold


Information about procedures that could cause programming errors, runtime errors, or equipment
damage.

WARNING: Summary in bold


Indicates information about procedures that could cause irreversible equipment damage, irreversible
loss of programming data or personal injury.

1.8.2 Procedures

Example Text: Main Menu select File >Print >Events


The graphic above is represented in the Example Text. All selections, fields, buttons, and screen
titles are spelled (upper/lower case) exactly as they appear on the display.

1.8.3 Referencing Other Documents


Example: Refer to the ONYXWorks Workstation manual
italic text is used to reference a document by its specific name.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

13

Introduction

14

Manual Conventions

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Section 2 Hardware, Printer, and Power Connections


NOTE: If you are not familiar with the Workstations graphical user interface, please refer to the
Appendix C on page 103 for information.

WARNING: Power Sources


Remove all power sources to equipment before connecting electrical components. The
Workstations computers main power switch must be in the OFF position until installation of the
entire ONYXWorks system is complete and ready for testing.

CAUTION: Life Safety System Notification


Before performing any work on a fire alarm system:
a) Notify the fire department and the central alarm receiving station if transmitting alarm conditions.
b) Notify the people occupying the facility about the impending test, the expected time period of the
test, and to disregard any alarm during the test period.
c) When appropriate, disable activation of alarm notification appliances and speakers to prevent
their sounding.
d) Always physically disable releasing devices before system tests to prevent accidental discharge.

NOTE: The Workstation can only be installed in an environment that meets these conditions:
- Temperature range of 0C 49C (32F 120F).
- 93% humidity non-condensing.

NOTE: Ground faults are annunciated at zero value.

2.0.1 Wiring Restrictions


NOTE: All wiring connections are supervised and power limited.

NOTE: In Canada, if the gateway is installed in a separate cabinet, the cabinet must be
connected to the Fire Alarm Control Panel (FACP) with a close nipple fitting.

NOTE: USB and NUP wiring connections to the HS-NCM must be located within 20 feet and
encased in conduit within the same room.

Ethernet

Line Impedance 100 ohm

Max Distance 100 meters

USB

Line Impedance 90 ohm 15%

Max Distance 40 meters

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

15

Hardware, Printer, and Power Connections

Installation Overview

2.1 Installation Overview


Installation of a UL listed ONYXWorks system must be performed by a factory-trained fire alarm
technician. The ONYXWorks Workstation computer is typically shipped with the required
networking cards and the software application already installed.

2.2 Connect the Workstation Components


All Workstations ship as a computer (PC), monitor, mouse, keyboard, network connection card, and
a configured USB Hardlock Key. Workstations ordered and shipped with more than one gateway
may have additional network cards installed.
The Workstation must be installed in accordance with local fire protection codes. The Workstation
can be rack-mounted or placed on a desk or table with the monitor, keyboard, and mouse.
The Workstation may be used with either a regular widescreen LCD monitor or a touchscreen
widescreen LCD monitor:
Table 2.1 Workstation LCD Monitor Part Numbers
Part Number

Description

MON-19LCDW

19 Widescreen LCD Monitor

MON-19LCDW-TS

Touchscreen 19 Widescreen LCD Monitor

MON-22LCDW

22 Widescreen LCD Monitor

MON-22LCDW-TS

Touchscreen 22 Widescreen LCD Monitor

Monitor electrical ratings: 120V, 50/60HZ.35 Amps for both models

NOTE: In Canada, all wiring connections to the monitor must be encased in conduit.

NOTE: To remain compliant with UL listing, the keyboard and mouse must be connected even
when using the touchscreen monitor.

2.2.1 Workstation Component Connections


Use the following steps and figure as guidelines to complete connecting the Workstations
components.
Step 1. Connect the factory supplied mouse/keyboard splitter cable to the KEY/MOUSE
connector.
Step 2. Connect the mouse and keyboard to the mouse/keyboard splitter cable.
Step 3. Connect the monitor cable to the VIDEO connector.
Step 4. Connect the monitor sound cable to the Audio In Connector on the sound card.
Step 5. Connect the USB Hardlock Key to one of the USB connectors.

16

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation AC Power Connection Preparation

Hardware, Printer, and Power Connections

Step 6. If applicable, refer to Make Printer Connections on page 19.


NOTE: The following figure is for information purposes, locate the appropriate connector using
the labels attached to the Workstations computer rear panel.

1-2

Figure 2.1 Computer Component Connections

2.3 Workstation AC Power Connection Preparation


The Workstation computers AC power cord must be connected in a permanent manner using the
factory supplied Power Cord Locking Bracket (PCLB) and it must be connected to a supervised
Uninterruptible Power Supply (UPS) that is regulated, UL 1481 listed, and power limited. For
Canada a CSA or ULC listed UPS is required.

2.3.1 Primary and Secondary Power


The ONYXWorks workstation requires connection to a separate dedicated primary AC fire alarm
circuit, which must be labeled "FIRE ALARM." This AC circuit must connect to the line side of
the main power feed of the protected premises. No other equipment can be powered from the fire
alarm circuit. The primary AC circuit must run continuously, without disconnect devices, from the
power source to the workstation. Overcurrent protection for this circuit must comply with Article
760 of the National Electrical Code as well as local codes. If available backup power for the
workstation must be supplied by the building emergency power source, a supervised
Uninterruptible Power Supply (UPS) is required to provide power continuity during the transition
period from the primary power source to the emergency power source. The UPS must be regulated,
UL 1481 listed, and power limited. Input voltage must be set to 115 VAC when using a UPS.
NOTE: In Canada, backup power for the workstation must be supplied by the building
emergency power source, a supervised Uninterruptible Power Supply (UPS) is required to
provide power continuity during the transition period from the primary power source to the
emergency power source. The UPS must be regulated, power limited and CSA or ULC listed.
Input voltage must be set to 115 VAC when using a UPS.

2.3.2 Workstation AC Power Connection


Use the following steps and the following figure as guidelines to complete connecting the
Workstations power connections.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

17

Hardware, Printer, and Power Connections

Workstation AC Power Connection Preparation

Step 1. Verify that the Workstation computers Voltage Selection Switch in the correct position.

Step 2. Verify that the Workstation computers rear-panel power switch is set to the ON (|)
position.

Step 3. Verify that the Workstation computers functional power switch, located behind the
locking front door, is set to the OFF (O) position.

Step 4. Remove the Workstation computers three mounting screws (keep them for mounting the
PCLB plate).

Step 5. Plug-in the factory supplied AC power cord to the Workstation computers AC power
receptacle DO NOT CONNECT THE POWER CORD TO AN AC POWER SOURCE
AT THIS TIME (Refer to Workstation Power-up on page 25.)

Step 6. Attach the PCLB Plate using the screws removed in the previous step.

18

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Make Printer Connections

Hardware, Printer, and Power Connections

Step 7. Connect an external power source the WSSUP PC board (verify location using labeling).
Refer to Workstation Hardware/Software Application Connections on page 23.
Step 8. Connect the Workstation AC power cord to a supervised UPS that is regulated, UL 1481
listed, and power limited which is rated to support the Workstation computers power
requirements (115 VAC, 7 Amps, 60Hz). For Canada a CSA or ULC listed UPS is
required. Refer to Uninterruptable Power Supply (UPS) Installation on page 21.
Step 9. Connect the network to the Workstation. Refer to Workstation Network (LAN)
Connection on page 24.

CAUTION: Possible Loss of Network Communication


Power management options must be disabled in the CPU BIOS and on the monitor, or loss of
network communication or alarm reporting may result.

2.4 Make Printer Connections


NOTE: The Print option appears in the File menu only if the Workstation detects that at least
one Windows printer has been installed. Once you initially add a printer in Windows, the
Workstation must be restarted so it can detect the printer.

The following figure is for information purposes, locate the appropriate connector using the labels
attached to the rear panel.

LPT-1
USB

COMM 1 and 2

Figure 2.2 Computer Connectors and Ports

2.4.1 Connecting a Graphics Printer


A graphics printer is a Windows compatible printer that prints what is currently displayed on the
Workstations monitor. A graphics printer is connected to the Workstations LPT-1 connector or a
USB connector.

Graphics Printer Configuration


When installing graphic printer drivers be sure to:

Disable bidirectional support.

Set the graphics mode to raster.

CAUTION: Bidirectional Communication on Parallel Port


With any graphic printer attached through the parallel port, always be sure to disable bidirectional
communication. Never connect bidirectional devices such as tape or disk drives to the Workstation
parallel port.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

19

Hardware, Printer, and Power Connections

Make Printer Connections

NOTE: When using an HP LaserJet 5, turn off Advanced Functions in the Parallel menu.

2.4.2 Local Event Printer Connection


NOTE: The NOTIFIER PRN-6 printer is a UL listed printer and can be used as a Local Event
Printer.

The Local Event Printer is a UL 864 listed Windows compatible dot-matrix printer that receives
and prints all messages received/sent from the Workstation it is connected to. Refer to Local
Event Printer Configuration on page 41 for local event printer information.
A default output format and monitoring profile are pre-configured for a Local Event Printer. It is
only necessary to enable the printer in Windows.

20

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Uninterruptable Power Supply (UPS) Installation

Hardware, Printer, and Power Connections

2.5 Uninterruptable Power Supply (UPS) Installation


Follow the manufacturers guidelines for UL regulated installations of UPS equipment.
The Workstation requires the use of a supervised 115 VAC, 7 Amps, 60 Hz Uninterruptible Power
Supply (UPS) that is regulated, UL 1481 listed, and power limited. For Canada, a CSA or ULC
listed UPS is required. You can also supervise a Printers UPS. Refer to the following figures for
wiring information to supervise the UPS and have the Workstation report an event when trouble
occurs with your UPS.
Use the table below to determine the total amount of power, in VA, that a UL listed UPS must be
able to supply to the ONYXWorks system.

Table 2.2 UPS Power Requirements


Device Type

Number of
Devices

Max Current
(Amps)

Total Power (VA)

ONYXWORKS-WSIFI-WS
(@115 VAC, 50/60 Hz)

7.0

ONYXWORKS-WSIFI-WS
(@230 VAC, 50/60 Hz)

4.0

MON-19-LCDW
(@100 - 240 VAC, 50/60 Hz)

0.8

MON-19-LCDW-TS
(@100 - 240 VAC, 50/60 Hz)

0.8

PRN-6
(@115 VAC, 50/60 Hz)

0.6

PRN-6
(@230 VAC, 50/60 Hz)

0.3

Total Power Required = VA

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

21

Hardware, Printer, and Power Connections

Uninterruptable Power Supply (UPS) Installation

2.5.1 Workstation UPS Supervision


UPS
From Utility Failure
connectors on UPS
Inverter

Gateway PC-W/F
(verify location)

Normally Closed
Comm

From AC Load
connector on
UPS Inverter
Outlet
From Low Current
connectors on UPS
Battery Charger

Workstation Computer

FMM-1

Figure 2.3 Workstation UPS Supervision with an NFN Gateway PC and an FMM-1

2.5.2 Printer UPS Supervision


UPS
From AC Load
connector on
UPS Inverter
From Low Current From Utility
connectors on
Failure connectors
UPS Battery
on UPS Inverter
Charger
NC

Outlet
Event Printer

Comm

FDM-1

Figure 2.4 Printers UPS Supervision with an FDM-1

22

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Hardware/Software Application Connections

Hardware, Printer, and Power Connections

2.6 Workstation Hardware/Software Application Connections


2.6.1 WSSUP Board Description
Pre-installed in your Workstation computer is the Workstation Supervisor PCI board (WSSUP
Board) that is designed to monitor the computer and software application. The board is installed in
the Workstation using an ISA slot and a standard mounting bracket. The board requires external
power to activate it.

1
2

}
}

3
GND
+24VDC
4
5
6

ON

S6 S5 S4 S3 S2 S1

Figure 2.5 The WSSUP Board


1.

Sounder emits a continuous audible noise if the CPU fails or the facilities monitoring software
application stops functioning (not Exited).

2.

Relay Output is used to enable annunciation by any external device, refer to "WSSUP Board
Relay Output Connection":
That uses power limited dry contacts.
Where a dedicated Workstation supervisor device is available that monitors its operation
through a direct connection with the motherboards bus.

3.

Power Connector, refer to "WSSUP Board Power Supply Connection".

4.

Acknowledge Button is used to silence the Sounder.

5.

Operation Alarm LED (3)Used for visual confirmation that product is functioning.

6.

DIP switchThe factory set DIP switch settings for the board are shown in Figure 2.5 (S2).
Switches S5 and S6 are not used. Be sure to use these default DIP switch setting unless
otherwise directed by a Technical Services Representative.

WSSUP Board Power Supply Connection


Power to the board MUST be provided by an external +24VDC source, power limited, and
regulated with battery backup which is UL/ULC listed (as appropriate for your area) for use with
fire protective signalling units. Maximum power use is 35mA @ +24VDC.

WSSUP Board Relay Output Connection


The common relay output is a contact circuit that is not supervised and is rated for 2A @ +30VDC.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

23

Hardware, Printer, and Power Connections

Workstation Network (LAN) Connection

2.7 Workstation Network (LAN) Connection


After your LAN network (TCP/IP) is connected to the RJ-45 connector (verify location using
labeling); read and accomplish the steps in Workstation Power-up on page 25.

Figure 2.6 Workstation LAN (Ethernet) Connection

24

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Power-up

Hardware, Printer, and Power Connections

2.8 Workstation Power-up


Workstation Chassis Console and USB Key
Being familiar with the layout of the Workstation chassis console, located behind the locking door,
will help you complete the steps in this section.
Table 2.3 Chassis Console Layout
Label

Function

Reset

Reboot the
computer.

PWR

Indicates Power

HDD

Indicates Hard
Disk Drive
activity

KB/ LK

Lock the
keyboard.

POWER

Power On/Off

USB1

USB Port

USB2

USB Port

Location

Rear View of Workstation Chassis

USB Key

CAUTION:
The USB Key must be
fully plugged in and
illuminated in order for the
Workstation to function
correctly.

Figure 2.7 Chassis Console and USB Key


ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

25

Hardware, Printer, and Power Connections

Workstation Power-up

Prerequisites
Before powering-up the Workstation the following sections should have been read and the steps
listed in them should have been accomplished, if you have not already done so.

Installation Overview on page 16.

Connect the Workstation Components on page 16.

Workstation AC Power Connection Preparation on page 17.

Procedure
Use the following steps as guidelines to apply power to the Workstation.
Step 1. Connect the Workstations computer and monitor power cables to the UPS.
Step 2. Apply power to the UPS.
Step 3. Turn-on the Workstation monitor.
Step 4. Turn-on the Workstation computer by setting the functional power switch located behind
the locking front door to the ON (|) position.
When you first start up the Workstation:

Microsoft Windows will start and display.

If you have the Workstation software application installed, the PC Monitors splash
screen temporary flashes because PC Monitor is in the Windows Startup folder.

PC Monitor displays a prompting window for you to select a system.

NOTE: This list displays available ONYXWorks system databases on the IP network. On a
single Workstation system no IP addresses display, but on multiple Workstation systems this list
will display all the IP addresses of other Workstations on the IP network.

NOTE: Do NOT select a system at this time if one is displayed in the list.

Step 5. You are now ready to perform Windows Software Configuration on page 27.

26

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Section 3 Windows Software Configuration


3.1 Start the Workstation PC
NOTE: The steps in Workstation Power-up on page 25 should be completed before
proceeding with these steps.

3.2 Install Computer Software


!

CAUTION: Workstation Computer Software Installations


Do NOT allow software that is NOT related to facilities monitoring, other than McAfee anti-virus
software, to be installed on the Workstations computer.

3.2.1 Windows Installation


The Workstation computer ships with the Windows operating environment already installed; no
installation tasks are required.

3.2.2 Workstation Software Application Installation


The Workstation computer ships with the ordered software applications installed; no installation
task are required.
Some of the software applications are configured to start automatically. Which application
programs are accessible is determined by your USB Hardlock Key and the Workstations installed
hardware. For example, PC Monitor was setup to start automatically and display in the Windows
System Tray after power is applied to the Workstation and Microsoft Windows starts.

3.2.3 Anti-Virus Software Installations


If it is absolutely necessary to use an anti-virus software application, it must be McAfee Enterprise.

WARNING: Anti-Virus Automatic Updates


Do NOT use a software update setting that will automatically restart the Workstation. The anti-virus
software application must be manually updated.

3.3 Windows Settings


!

CAUTION: Windows Settings


All Windows settings are setup at the factory and must remain as they are for the Facilities
Monitoring software application to function and display properly.

PC Requirements for ONYXWorks Workstation:

Windows 7 64-bit Professional required

Minimum 4GB RAM

Minimum resolution of 1280x1024 Landscape Mode

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

27

Windows Software Configuration

Workstation Software Application Start and Exit Methods

Critical Windows settings are set at the factory and the Workstation should function properly when
powered on. For example; to ensure that the Workstation annunciates every message; all power
management functions, like monitor sleep modes, are disabled. Only change Window settings with
the approval of your Technical Services Representative.

Automatic Updates
NOTE: Automatic Updates must be turned OFF for the Workstation to function correctly.

To verify automatic updates are turned off, follow the path: Start > Control Panel > Security Center
> Automatic Updates.
You may still update your Windows operating system manually. To manually update Windows,
open a web browser and go to http://www.update.microsoft.com/microsoftupdate/v6/default.aspx?.

3.3.1 Changing the Windows Administrator Password


The factory setup for the Windows Administrator has no password set. It is recommended that the
Admin User modify this password. Consult Windows information.

3.4 Workstation Software Application Start and Exit Methods


NOTE: The Workstation does not connect to configured gateways without the USB Hardlock
Key connected to the Workstations USB port. The message Hardlock Key Error in the graphics
area indicates the USB Hardlock Key is not detected as expected. Please refer to Connect the
Workstation Components on page 16 before starting to use Workstation software application, if
you have not already done so.

3.4.1 Workstation Software Starting Mode


PC Monitor automatically starts the Workstation when Windows starts. No ONYXWorks icons
should be placed in the Startup folder. If the Workstation is closed, it can be restarted by
right-clicking the PC Monitor icon from the Windows task bar, and then clicking
Launch Applications in the menu that appears. This launches any hardlock key-enabled
applications which are not already running.
To start the Workstation when PC Monitor is not running, from the Windows taskbar click
Start > Programs > Facilities Monitoring > Workstation.
The Workstation software application is displayed as an always-on-top, full-display window (no
Windows Taskbar or System Tray is visible).

3.4.2 Workstation Software Exit Mode


The master user (Admin) account has privileges to shut down the Workstation software
application or the Workstation computer. The master user can:
Step 1. Exit the Workstation software application. From the Workstation application, click
File > Exit.
Step 2. Shut down Windows. From the Windows taskbar, click Start > Shutdown.

28

CAUTION: Workstation Shut Down


Failure to exit the Workstation software application and Windows properly could corrupt your
software settings.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Section 4 ONYXWorks Workstation System


Connections
4.1 Make ONYXWorks System Connections
These figures illustrate example systems.

TCP/IP Network

Workstation

Workstation

Gateway
Embedded

NFN Network

FACP

FACP

FACP

Figure 4.1 Basic NFN Gateway Network

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

29

ONYXWorks Workstation System Connections

Make ONYXWorks System Connections

TCP/IP Network

Workstation

Workstation/Gateway PC

Gateway Embedded

Workstation/Gateway PC

NFN Network

FACP

FACP

NFN Network

FACP

FACP

FACP

FACP

Figure 4.2 Advanced NFN Gateway Network

30

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation System Connections

Master User Login

4.2 Master User Login


You must log into the Workstation before connecting or configuring networks. A user with the
privilege to change a password needs to log in to change an existing users password, or to add a
user and their password.

Login Procedure
Step 1. Start the Workstation if it is not already running. For more information, refer to
Workstation Software Application Start and Exit Methods on page 28.
Step 2. Click File > Login. The User Login dialogue appears.
NOTE: You may also log in by clicking the current user displayed in the upper right corner of the
Workstation display. This also opens the User Login dialogue.

Step 3. Click Admin.


Step 4. Type the password, and then click OK.

4.3 Add a Network Connection to the Workstation


As a master user, you can use two methods to establish a connection to your network if you are
adding the Workstation to an existing ONYXWorks system.

4.3.1 Import Configuration Data


This option copies network (and screen, etc.) configuration from another peer Workstation which
has already been configured. One Workstation on the network must be configured manually before
this information can be shared with other Workstations.

Existing Network Connection Procedure


Step 1. From the Windows taskbar, right-click PC Monitor, and then click
Import System Data... in the menu that appears. The Select System To Import From
dialogue appears.

Figure 4.3 Select System To Import From Dialogue


Step 2. Click an entry from the list of choices, and then click OK.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

31

ONYXWorks Workstation System Connections

Add a Network Connection to the Workstation

4.3.2 Adding a New Network Connection


The Admin User creates a Network name and then adds a gateway. Network names and gateway
connections are created using the Configuration Tool. The Configuration Tool is launched from the
Workstation main menu.

New Network Connection Procedure


Step 1. Start the Workstation if it is not already running. For more information, refer to
Workstation Software Application Start and Exit Methods on page 28.
Step 2. Log into the Workstation master user account (default password = admin)
Step 3. Launch the Configuration Tool from the Workstation main menu. Click
Configure > Launch Configuration Tool. The Configuration Tool window opens.
Step 4. Click Network Configuration. The Network Configuration Tool window opens.
Step 5. Click Network > Add Network. The Network Properties window opens.
Step 6. Type the network name into the Alias field.
Step 7. Select the network type from the Type drop menu.
Step 8. Click Add Gateway (

). The Gateway Properties window opens.

Step 9. Enter the Gateway IP Address, and then click OK to return to the Network Properties
window.
Step 10. Request nodes to be added to the Network
a. Expand the navigation Tree to display the gateways
b. Right click on the IP address and then select Request Nodes from the list of choices.
The tree will populate and display all the nodes configured on that network
Step 11. Click OK
Step 12. You must Exit the Configuration Tool and Save Changes to update the Workstation with
the information created in this procedure.

32

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation System Connections

Add a Network Connection to the Workstation

4.3.3 Adding a Redundant Gateway


A redundant gateway is a second gateway which communicates with an NFN. If the main gateway
cannot be reached, the system attempts to communicate with the network through the redundant
gateway.
Protected Premises Unit

NFN/ArcNet Network

NFN/ArcNet Network

Redundant Gateway

Gateway Embedded

*Ethernet Hub (TCP/IP)


UL 864 Listed Switch

*Ethernet Hub (TCP/IP)


UL 864 Listed Switch

Other Technologies
LAN/WAN/Internet/Intranet
(Dedicated Only)

Ethernet Hub (TCP/IP)


UL 864 Listed Switch (Not required
on dedicated Network)

Workstation

Figure 4.4 Redundant Gateway

Add Redundant Gateway Procedure


Step 1. Start the Workstation if it is not already running. For more information, refer to
Workstation Software Application Start and Exit Methods on page 28.
Step 2. Log into the Workstation master user account (default password = admin)
ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

33

ONYXWorks Workstation System Connections

Add a Network Connection to the Workstation

Step 3. Launch the Configuration Tool from the Workstation main menu. Click Configure >
Launch Configuration Tool. The Configuration Tool window opens.
Step 4. Click Network Configuration. The Network Configuration dialogue opens.
Step 5. Right-click the name of the network with which the redundant gateway will communicate,
and then click Properties in the menu that appears.
Step 6. In the Network Properties dialogue, click the menu arrow, and then click the Add Gateway
icon.
Step 7. Type in the Gateways IP Address.
Step 8. Click OK.
Step 9. You must exit the Configuration Tool and respond to the Save Changes prompt in order to
update the Workstation with the information created in this procedure.

34

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation System Connections

Auto-Create Gateway Point IDs

Add Network Right Click Commands


In the Navigation Tree you can right click on a Network name and select these commands from the
list of choices.
Add Node
Use this command to add a Node to your network. You will need to select the Node Type from a list
of choices and type in the IP address of that node.
Import Panel Database
Use this command to import a Verifire database. A Verifire database can be located and then
selected, any nodes and points that are in the database will be autocreated on the Network.
Rename
Use this operation to type in a new name for the Network which is the equivalent of replacing the
Network Alias on the Properties window.
Delete
Use this command to delete the Network, a confirmation prompt will display allowing you to
cancel the command.
Properties
Use to change the Network Alias name and IP Address of a gateway.

4.4 Auto-Create Gateway Point IDs


4.4.1 About Auto-Creating Gateway Point IDs
A gateways nodes and the nodes points can be manually added and defined with the
Configuration Tool, however it is highly recommended that the auto-creating method be used
instead. The auto-creating method captures the nodes exact point ID. It is highly recommended
that when initially configuring a facilities monitoring network that it be modified offline and not be
modified while the Workstation is monitoring the gateway.

Auto-Creation Procedure
Use this procedure as a guideline for creating your gateways icon for your gateways points.
Step 1. Make sure the connection between the respective networks and the monitoring
Workstation is made.
Step 2. Start the monitoring Workstation software application.
Step 3. If you have not already done so perform the steps in Add a Network Connection to the
Workstation on page 31.
Step 4. Work with others to initiate troubles in the gateway devices (points) that will be reported
as off normal events to the monitoring Workstation.

The troubles in those points will automatically create an icon on the monitoring
Workstation screen (64 icons per screen before another screen is automatically added).

Those icons will have the exact point ID.

When points are auto-created a system backup should be performed using the
monitoring Workstations PC Monitor.

Step 5. If applicable to your situation, you are now ready to Workstation Database
Modifications on page 36.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

35

ONYXWorks Workstation System Connections

Workstation Database Modifications

4.5 Workstation Database Modifications


We recommend making a backup copy of your screen database before making any modifications.
This ensures you dont lose any data if you make a mistake.
Backing Up The Fire System Database with PC Monitor
In this procedure you will create a backup copy of the database and then copy it to an external
storage device.
Step 1. From the Windows taskbar, right click the PC Monitor icon, and then click
Backup System Data... in the menu that appears.
The Save As dialogue opens.
Step 2. Browse to where you want to create a folder for the archived database. You may wish to
back up the system data directly to an external storage device, such as a USB flash drive.
Step 3. Create a new folder to hold the files and folders that will be generated.
Step 4. In the box labeled File name, Enter a file name for the backup database, and then click
Save.
NOTE: We highly recommend that you create a folder. This procedure creates several files and
subfolders in the target folder.

Modifying The Fire System Database

CAUTION: When configuring a Workstation for the first time, make sure the Workstation
application is not running before launching the Configuration Tool.Workstation Shut Down
.

Use the Configuration Tool to modify the database.


Step 1. Launch the Configuration Tool. From the Windows taskbar, click
Start > Programs > Facilities Monitoring > Configuration Tool.
Step 2. Click Screen Objects. The Screen Objects window opens.
Step 3. Edit the database. Refer to the ONYXWorks Configuration Tool Installation & Operation
Manual PN 53038 for information about editing a database.
Step 4. Click Exit to exit the Screen Objects window.
Step 5. Click Exit to exit the Configuration Tool.
Step 6. Click Yes to save your work and update the database.
Restoring A Backed-Up Database
Step 1. Shut down all fire system applications, including gateways, except for PC Monitor.
Step 2. From the Windows taskbar, right click the PC Monitor icon, and then click
Restore System Data... in the menu that appears.
The PC Monitor dialogue opens.
Step 3. Click Yes to verify all other applications have been closed.
The Open dialogue opens.
Step 4. Browse to the backed up database folder (created in Backing Up The Fire System
Database with PC Monitor on page 36) and click the data file *.dat to select it.
Step 5. Click Open.
Step 6. The backed up fire system database is restored.
Step 7. Verify the database was restored correctly.

36

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Section 5 Workstation Software Configuration


5.1 Factory Defined User Profiles and their Passwords
The Workstation must be logged into before any of its settings can be configured. A User that has
the Security Option to change a password needs to login to change an existing Users password or
to add a User and their password. The factory defined User Admin has such a Security Option.
The factory default Workstation software application Admin Users password is admin. The
factory defined Admin User profile can not be deleted.
It is highly recommended that the master user change the factory defined master account password
to secure the Workstation. Refer to the ONYXWorks Configuration Tool Installation & Operation
Manual PN 53038l Manual for further information.

5.2 Monitoring Profiles


NOTE: Monitoring Profiles must be configured before "Local Event Printer Configuration",
"Pager/Modem Configuration", or "E-Mail Configuration" can take place.

Figure 5.1 Monitoring Profiles Window


Monitoring Profiles allow the Admin User to select what nodes will be monitored by a
Workstation. The profile is defined for a specific network and/or node on a network. That profile
deter imines what events are displayed by the Workstation. By using Monitoring and Control
Profiles (see below), supervision of portions of the network is possible. Monitoring profiles are
configured using the Configuration Tool. Refer to the ONYXWorks Configuration Tool
Installation & Operation Manual PN 53038l Manual for further information. They are activated
through the Workstation

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

37

Workstation Software Configuration

Monitoring Profiles

Monitoring profiles are event annunciation filters that are set up to monitor or not monitor an event
location and its event type at the Workstation.
The factory defined monitoring profile Default is set to monitor all networks and nodes.
Therefore to hide any desired networks or nodes and the respective event types, you must create a
new monitoring profile using the Configuration tool.

Monitoring Profile Activation Procedure


To choose the Monitoring Profile to determine which event the Workstation will monitor, do the
following:
Step 1. Select Configure>Monitoring Profiles.
Step 2. Select a profile listed in the Monitoring Profile column of the window. The Default entry
may be the only one listed.
Step 3. Click Activate Profile
The Workstation now displays information only for the locations and event types specified in the
selected monitoring profile.

38

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Software Application Options Configuration

Workstation Software Configuration

5.3 Workstation Software Application Options Configuration


The Workstation Configure >Options command displays the Options window where these setup
tasks are performed.

Output Configuration on page 39

Local Event Printer Configuration on page 40

Pager/Modem Configuration on page 42

E-Mail Configuration on page 44

General Operation Configuration on page 45

User Features Configuration on page 49

5.3.1 Output Configuration


NOTE: Monitoring Profiles must be configured before "Local Event Printer Configuration",
"Pager/Modem Configuration", or "E-Mail Configuration" can take place.

Figure 5.2 Options Window - Output Configuration

About the Output Formats


An Output is the format of data that will be sent to a local event printer and/or email. individuals
with a pager and Once you have created and named an Output Format you will select it from the
list of choices on the windows where you will setup the local event printer, pagers, and or email.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

39

Workstation Software Configuration

Workstation Software Application Options Configuration

User Defined Messages


Although it can used with any Output format, it is highly recommended for a pager format you use
the Available Fields User Defined selection. That selection allows you to enter brief descriptions
for the User Defined Messages. Once User Defined is displayed in the Format Fields, the User
Defined Messages area is activated. Click in field adjacent to the User Defined Messages name
and type in a brief message that can be received on a pager.

Output Formats Configuration Procedure


Step 1. From the Workstation Main Menu select Configure >Options. The Option window
displays.
Step 2. Click on the Output tab.
Step 3. Click on the Add Format button. A window prompt with text already in the field displays.
Step 4. Replace the current text by typing in a unique name (duplicate names cannot be created)
and then click on the OK button.
Step 5. Select the types of information you want included in the Output Format from the list of
Available Fields. Once selected they will move and display in the Format Fields area of
the window. Several methods of selecting can be used:

Double click on the entry.

Click on an entry and then click on the right arrow button.

Click on several; chose first, then last in list (press and hold the shift key) and then
click on the right arrow button. Press and hold the Ctrl key to select them.

Step 6. Click on the Apply button when you have completed the choices. The Output Format is
now available for the printer, pager, and email setup.

Existing Output Format Management


Modify an Output Format
Step 1. Click on the Output Format fields down arrow and select an existing name from the list of
choices. The previous choices for the Output Format display in the Format Fields area of
the window.
Step 2. Select the types of information you want included or excluded in the Output Format from
the list of Available Fields/Format Fields (refer to "Output Formats Configuration
Procedure" for information about selecting, de-selecting is similar but done in reverse).
Step 3. Click on the Apply button when you have completed the choices.
Delete an Output Format
Step 1. Click on the Output Format fields down arrow and select an existing name from the list of
choices. The previous choices for the Output Format display in the Format Fields area of
the window.
Step 2. Click on the Delete Format button. An Output Format window prompt displays.
Step 3. Select the Yes button.

If the Output Format is NOT used in a printer, pager, modem, or email setup the
selected Output Format will be deleted.

If the Output Format is used in a printer, pager, modem, or email setup a window
prompt will display indicating you can not delete the Output Format. You must revise
the printer, pager, modem, or email setup to use another Output Format or delete that
printer, pager, modem, or email profile that uses the Output Format you want to delete.

Local Event Printer Configuration


NOTE: Workstation Software Application Options Configuration on page 39 and Output
Configuration on page 39 must be performed before this configuration can take place.

40

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Software Application Options Configuration

Workstation Software Configuration

Local Event Printer Configuration


Windows procedures and operation apply when installing a printers driver and setting it up.
Adding a printer and changing its printing preferences are standard Windows operation, consult
Windows information.
A local event printer must have a buffer size of at least 32K and be able to set to these settings:
Baud Rate: 9600

Parity: None

Data Bits: 1 Stop Bit

Stop Bits: 8 Bits

NOTE: The NOTIFIER PRN-6 printer is a UL listed printer and can be used as this Local Event
Printer.

Local Event Printer Configuration Procedure


NOTE: A Local Event Printer can only be setup after it has been connected, refer to Local Event
Printer Connection on page 20.

Step 1. Install the printers driver using Windows operations. You must name this Local Event
Printer Local Event Printer using Windows operations. Consult Windows information
for details about naming the printer.
Step 2. From the Workstation Main Menu select Configure >Options. The Option window
displays.
Step 3. Click the Printers tab.
Step 4. Make these settings:

Select Enable in the Enabled field.

Select a Monitoring Profile (refer to Workstation Software Application Options


Configuration on page 39).

Select a Output Profile (refer to Output Configuration on page 39).

Figure 5.3 Options Window - Printer Configuration


Step 5. Click Apply. The Sample Output displays according the Output Profile selected.

Existing Printer Configuration Management


An existing local event printer configuration can be modified. Set the Location to None when the
printer is physically disconnected from the Workstation. Change the Enable to Disable (stops
printing), change Monitoring Profile or Output Profile settings. After any modification, click
Apply.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

41

Workstation Software Configuration

Workstation Software Application Options Configuration

5.3.2 Pager/Modem Configuration


NOTE: Workstation Software Application Options Configuration on page 39 and Output
Configuration on page 39 must be performed before this configuration can take place.

About Pager/Modem Configuration


The Pager/Modem functions provide the capability to send system information via a modem that is
connected to a Workstations COMM port to a persons pager. This configuration uses Monitoring
Profiles and Output formats to determine the information that is sent. The modem needs to be
connected and configured before a pager is added.

Pager Modem Configuration Procedure


Step 1. From the Workstation Main Menu select Configure >Options. The Options window
displays.
Step 2. Click on the Pager/Modem tab.
Step 3. Make Modem settings.

Dialing Delay range: 10 to 30 seconds.

Retry Delay range: 10 to 30 seconds.

Number of Retries range: 0 to 3.

Time Out range: 45 to 300 seconds.

Figure 5.4 Options Window - Modem Configuration


Step 4. Click the Apply button.

42

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Software Application Options Configuration

Workstation Software Configuration

Pager User Configuration Procedure


Step 1. From the Workstation Main Menu select Configure >Options. The Options window
displays.
Step 2. Click on the Pager/Modem tab.
Step 3. Click on the Add Pager button. A window prompt with text already in the field displays.
Step 4. Replace the current text by typing in a unique name (duplicate names cannot be created)
and then click on the OK button.
Step 5. Make these settings:

Type in the pager phone number.

Type in the PIN.

Select Enable in the Enabled field.

Select Max C (Maximum Characters).

Select Monitoring times.

If Yes is selected, the message will be sent when it occurs according to the
parameters set in "Pager User Configuration Procedure".
If No is selected, you will need to set the Start and Stop times. You can select a
specific span of hours to send emails or pages by choosing a Start time and then a
Stop time. Then emails or pages will only be sent for events that occur during that
occur between the Start and Stop times.

Select a Monitoring Profile (refer to Workstation Software Application Options


Configuration on page 39).

Select a Output Profile (refer to Output Configuration on page 39)

Figure 5.5 Options Window - Pager Configuration


Step 6. Click the Apply button. The Sample Output displays according the Output Profile
selected.

Existing Pager Configuration Management


Delete a Pager
Step 1. Click on a name in the Pager field.
Step 2. Click on the Delete Pager button.
Step 3. Respond to the delete confirmation window prompt.
Modify a Pager
An existing pager configuration can be modified. Change any field using the steps in the "Pager
User Configuration Procedure". Disable the pager to keep the pager listed but to stop sending
pages to it.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

43

Workstation Software Configuration

Workstation Software Application Options Configuration

5.3.3 E-Mail Configuration


NOTE: Workstation Software Application Options Configuration on page 39 and Output
Configuration on page 39 must be performed before this configuration can take place.

About E-Mail Configuration


The E-Mail functions provide the capability to send system information via your email server to an
email account. This configuration uses Monitoring Profiles and Output formats to determine the
information that is sent. The server configuration should be done before an email account is added.
E-mail Function Parameters
These parameters govern the Workstation E-Mail functions.

The E-Mail server may be either on-site or provided by an Internet Service Provider (ISP).

The E-Mail functions support SMTP format only.

Individual ISP authentication (username/password) is not supported.

E-Mail Source Configuration Procedure


Step 1. Make sure you have an established connection between your email server and the
Workstation.
Step 2. From the Workstation Main Menu select Configure>Options. The Options window
displays.
Step 3. Click the E-Mail tab.
Step 4. Make E-Mail Source settings.

Type in the your mail server address in the SMTP Server field.

Type in the return address you want displayed for the email receiver.

Type in a Site name.

Figure 5.6 Options Window - Email Configuration


Step 5. Click the Apply button.

E-Mail User Configuration Procedure


Step 1. From the Workstation Main Menu select Configure >Options. The Options window
displays.
Step 2. Click on the E-Mail tab.
Step 3. Click on the Add E-Mail button. A window prompt with text already in the field displays.
Step 4. Replace the current text by typing in a unique name (duplicate names cannot be created)
and then click on the OK button.
Step 5. Make these settings:

Type in the email address.

Select Enable in the Enabled field.

Select Monitoring times.

44

If Yes is selected, the message will be sent at the time it occurs.


If No is selected, you will need to set the Start and Stop times.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Software Application Options Configuration

Workstation Software Configuration

Select a Monitoring Profile (refer to Workstation Software Application Options


Configuration on page 39).

Select an Output Profile (refer to Output Configuration on page 39)

Figure 5.7 Options Window - Email User Configuration


Step 6. Click the Apply button. The Sample Output displays according the Output Profile
selected.

Existing E-Mail Configuration Management


Delete a E-Mail
Step 1. Click on a name in the Name field.
Step 2. Click on the Delete E-Mail button.
Step 3. Respond to the delete confirmation window prompt.
Modify a E-Mail
An existing email configuration can be modified. Change any field using the steps in the "E-Mail
User Configuration Procedure". Disable the email name to keep the email account listed but to stop
sending email to it.
E-mail Only Off Normal Events
Check this if only off-normal events will be e-mailed to recipients. When checked, restoral
notifications will not be sent.

5.3.4 General Operation Configuration


The functions provided on this General tab window allow the Admin User to configure overall
settings for Workstation operations. This information is not written in procedural form because the
sequence in which you choose to enable options is not necessary.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

45

Workstation Software Configuration

Workstation Software Application Options Configuration

Figure 5.8 Option Window - General Configuration

Event Label Buttons


Event labels are brief descriptions of events, displayed in the New Events and Acknowledged
Events lists and in the expanded events box that appears when a device with events is selected. Use
the radio buttons on the General tab of the Options window to determine what network, node,
and point information, if any, appears in event labels.

46

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Software Application Options Configuration

Workstation Software Configuration

Figure 5.9 Event Labels


Network Alias
Display the name assigned to the network using the Configuration Tool.
None
Does not display the assigned name.

Node Label
Node Alias
Display the name assigned to the node using the Configuration Tool.
Node Number
Display the node number assigned to the node using the Configuration Tool.
None
Does not display the assigned name or number.

Point Label
Point Alias
Display the name assigned to the point using the Configuration Tool.
Point Number
Display the point number assigned to the node using the Configuration Tool.
None
Does not display the assigned number or name.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

47

Workstation Software Configuration

Workstation Software Application Options Configuration

Icon Label Field


Use this selection to display the icon label. This selection determines what is displayed on the
screen along with each icon: whether the event label, the description, or nothing.

Silence/Reset Configuration (FCC Mode only)


Select one of the radio buttons to determine the behavior of the Silence and Reset buttons in FCC
Mode.
Offnormals - Make this selection to Silence/Reset only Off-normal panels when Silence/Reset is
pressed.
All nodes - When Silence/Reset is pressed, all nodes will be Silenced/Reset.

Miscellaneous Check Boxes


Show Only Off Normal Devices
This selection will only display icons of points that are off normal (alarm, trouble, etc.). If there are
no current events on the system there will be no points visible in the graphics display.
Autoactivate Next Event After Acknowledge
With this setting, once any event in the New Events box is acknowledged, the next event
automatically activates. The Workstation plays any media files linked to the new event.
Automatically Navigate on Event
With this setting, once any even reaches the top of the New Events box, the Workstation
automatically displays the screen where an off-normal event is taking place. We recommend using
this setting, to ensure the highest level of response.Extract Descriptions From Panel
Use this selection to assign point descriptions as they are reported from the panel instead of using
the locally defined descriptions. This description is coupled with the Event Box Label and displays
the point description or properties.
Most control and alarm panels contain a description that is sent over the network with panel
messages. This option allows the Admin User to select whether these descriptions are used for each
node or if the descriptions are entered at the Workstation when points are assigned for the panel.
This feature applies only to nodes that have the capability to provide such a description.
Shut Down PC on Workstation Shut Down
Use this selection to have the Workstation software application automatically shut down the
computer hosting the Workstation when the application is closed normally (through File > Exit).
Suppress Automatic Device Icon Creation
Use this selection to hide automatically created device icons from all navigation window displays.
This selection also prevents the Workstation from automatically navigating to display off-normal
events on devices with automatically created icons (for more information, refer to Auto-Creation of
Workstation Screens, Nodes, and Points on page 59).
NOTE: The selection does not prevent device icons from being automatically created.
Automatically created device icons simply do not appear while this selection is checked.

Show Navigation Icon Labels


Use this selection to make Navigation Icon Labels visible.
Mic Supervision (Optional Feature)
Use this selection to enable monitoring of the Mic for operational status.

48

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Software Application Options Configuration

Workstation Software Configuration

Enable E-mails and Pagers


Use this selection to enable the Workstation to send out system information to pagers or through email. This selection is checked by default; e-mail and pager functions are disabled when it is
unchecked. For more information, refer to Pager/Modem Configuration on page 42 and E-Mail
Configuration on page 44.

History Backup Fields


Number of days before performing history backup: Is used to periodically capture the
local history file after the previous backup. The external backup file is named with the date:
YYYYMMDD.HIS.
Number of days to keep history following backup: Is used to periodically empty the local
history file of everything except a specified number of days data. The external backup file is
named with the date: YYYYMMDD.HIS.
If this option is not checked and number of days set, the history database will continue to increase
in size indefinitely, until it is backed up manually (refer to ONYXWorks Workstation Data
Management on page 63).

5.3.5 User Features Configuration

Figure 5.10 Options Window - User Feature Configuration

Unacknowledged Event Alarm Configuration


Unacknowledged event alarm configuration (Unacked Event Alarm Configuration) determines
how the Workstation supervises user acknowledgement of new events. In security circles, an
unacknowledged event alarm is also known as a dead man. When enabled, this function monitors
the New Event window status and activity.
Check the box beside Use Unacked Event Supervision to enable the unacknowledged event
alarm.
Unacknowledged Event Timeout (3-60 Minutes)
An event reaching the top of the New Events box starts a timer which runs for a user-defined time
(3 - 60 min.).

Acknowledging the event cancels the timer.

If the timer expires before an event is acknowledged, the current user is automatically logged
off the Workstation. If a macro is selected in the Macro Activated on Alarm box, the macro is
activated.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

49

Workstation Software Configuration

Control Profiles Configuration

When the box beside Use Unacked Event Supervision is checked, you can enter a timeout
between 3 and 60 minutes, and select a macro from the Macro Activated on Alarm drop box.
(For information about creating macros, refer to ONYXWorks Configuration Tool Installation
& Operation Manual, PN 53038.) Click Apply to save the new settings.

Subsequent events reaching the top of the New Event box restart the timer.

Macro Activated on Alarm Is used to select from Admin User defined macros. For more
details on defining macros, refer to Macro Command Configuration on page 53.

User Responses
Theses fields on this window allow the Admin User to modify the preset definitions that display for
an event into custom responses. The text in these fields is text that will be displayed on a User
response window as check-box options. When the Users makes a check-box selection it is recorded
in the history data file.

5.4 Control Profiles Configuration

Figure 5.11 Control Profiles Window

5.4.1 Control Profiles


Control profiles allow users with sufficient privileges to select what network and nodes will be
controlled by a Workstation. Control profiles enabled the right-click menu options (enabled,
disable, arm, disarm, etc.) on point icons and on events in the event boxes. A profile can be defined
for either a network or a single node.

50

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

System Options Configuration

Workstation Software Configuration

A remote node can only accept a command or acknowledgement from a Workstation which
controls it. When a user acknowledges an event from a Workstation that does not control the node
where the off-normal device resides, the event is acknowledged at that Workstation only.
Only one Workstation at a time may control a given node. Taking control of a node from one
Workstation automatically cancels control of that node at any other Workstation.
A fire network may be monitored by multiple Workstations, each of which control only a portion of
the nodes on the network. This is often the most feasible solution for monitoring large networks.

5.4.2 Control Profile Activation Procedure


Step 1. From the Workstation main menu, click Configure > Control Profiles. The Control
Profiles Configuration view appears.
Step 2. Click a profile listed in the Control Profile column of the window. The Default entry may
be the only one listed.
Step 3. Click Activate Profile to activate the selected profile.
The Workstation now controls the nodes specified in the control profile. The Control Profiles
Configuration view shows which nodes the Workstation controls.
NOTE: After a control profile is activated, a remote Workstation may take over control of a node
or nodes the local Workstation initially controlled. Any time this happens, the Control Profile
Configuration view changes to reflect the nodes that are no longer controlled locally. However, this
does not change any control profile. Reactivating a control profile still restores control of all its
initially controlled nodes.

5.5 System Options Configuration


NOTE: All Workstations have a System Options selection preset according to the type of
Workstation ordered.

This Workstation System Options selection is made using the Configuration Tool which is launched
from Workstations main menu; Configure >Launch Configuration Tool. Any selections made here
is saved when you exit the Configuration Tool and then respond to the Save Changes prompt with
the applicable button click.

5.5.1 Icon Set


Icon Set Selection
Step 1. Check the Update Icons checkbox to activate the Icon Set field.
Step 2. Click on the Icon Set fields down arrow to display a list of icon choices.
Step 3. Click on the OK button.
Step 4. You must Exit the Configuration Tool and then respond to the Save Changes prompt with
the applicable button click to update the Workstation with the information created in this
procedure.
NOTE: The previously selected Icon Set does not display in the Icon Set field. The default
IconSet3D displayed as grayed out.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

51

Workstation Software Configuration

System Options Configuration

Custom Icon Creation and Selection


If you create and then load a custom icon set and it is missing required icons (i.e. smoke detector)
then the points that require that type of icon will not be displayed. To avoid this undesirable
behavior, do the following.
Step 1. Create your custom icons with your graphic software application (256 x 256 PNG file
formats highly recommended).
Step 2. Auto-create your points on the Workstation (refer to Auto-Create Gateway Point IDs on
page 35).
Step 3. Copy and paste your custom icons into the appropriate
C:\FacilitiesMonitoring\Data\System folder on the Workstation:
Devices - for auto-created points
Buttons - for Macro Buttons
Images - for hazard, information icons, etc.
Step 4. Launch the Configuration Tool and then edit the data base (refer to Workstation Database
Modifications on page 36).
Step 5. Use the Configuration Tools spread sheet operation to find and select the existing icon
that will be replaced by your custom icon.
Step 6. Use the spread sheets Explorer function to locate and then select the custom icon from the
folder you pasted it into.
Step 7. Replace one of the existing icon names with the custom icon name.
Step 8. Copy the spread sheet cell and copy and paste it into the cells containing the name of the
existing icon.
Step 9. Save the spread sheet and close the window.
Step 10. You must Exit the Configuration Tool and then respond to the Save Changes prompt with
the applicable button click to update the Workstation with the information created in this
procedure.

5.5.2 Operating Modes


Supervising Station
This selection is described Proprietary Supervising Station Mode Overview on page 81.
FCC and FCC+DCC
These selection is described in Section 8.3, Fire Command Center (FCC) Mode Overview (PPU),
on page 76.
NOTE: You can only select the FCC and FCC+DCC modes if you only have one NFN gateway
connected to the Workstation. Those modes are not available with multiple NFN gateways or if
any other type of gateway is configured for your system.

5.5.3 Time Server Settings


These time server settings will apply to all applications running on any PC on the system,
Workstations, PC gateways, and pc monitors.
NOTE: Assigning a time server is optional. The IP Address fields for Time Server Settings are
empty by default. If these fields are not populated, the Workstation will operate without making
any attempt to synchronize its time with any server.

52

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Macro Command Configuration

Workstation Software Configuration

NOTE: If the Workstations Windows time zones or daylight saving settings are changed, all the
ONYXWorks applications must be restarted.

NOTE: If using a workstation as the SNTP server, the Windows time service must be disabled
on the PC.

This field is used to type in the IP address of the server that will used to dictate time for the
ONYXWorks system time.
Workstation
Embedded
Gateways

Workstations

External SNTP Server

Embedded
Gateways

Workstations

Figure 5.12 System Options Window

5.6 Macro Command Configuration


NOTE: Creating these settings is optional and they do not need to be made for the Workstation
to function properly.

5.6.1 About Macro Commands


Macro commands have interdependent relationship that is established by the Admin User. Macro
Commands are created using the Configuration Tool which is launched from Workstations main
menu; Configure >Launch Configuration Tool. Any selections made here are saved when you exit
the Configuration Tool and then respond to the Save Changes prompt with the applicable button
click.
Macro are created and edited on the Screen Objects window (Screen Objects icon). You access the
Marco Editor function in Tools menu; Tools >Macro Editor. A Macro command is created and
defined, then it is activated in one of two ways.

A macro icon may be created in the graphics display, when clicked on the associated macro
will activate.

The Workstation will display a Macros menu item when there are any configured macros on
the system and a User logged in has the Security Option and Point Control.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

53

Workstation Software Configuration

Macro Command Configuration

The Admin User creates a Macro command by naming it and assigning it a Macro command. That
Macro commands Menu list of choices will be contingent on the gateway type, point, and node
type that is selected.

54

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Macro Command Configuration

Workstation Software Configuration

5.6.2 Macro Creation and Management


The Macro List and Macro Options areas have icons (with mouse over hints) that are used to create
and or manage macros. Mouse over them to display the hint about which operation each performs.

Figure 5.13 Macro Editor Window

Figure 5.14 Macro Properties Windows

Macro Creation Procedure


Step 1. Click on the Add Macro icon (mouse over). The Macro Properties window displays.
Step 2. Type in a name in the Name field.
Step 3. Check the Confirmation field if applicable.
NOTE: This selection means a prompt will be displayed providing you the opportunity to cancel
activating the macro.

Step 4. Click on the OK button.


Step 5. Click on to add new option (mouse over) icon. The Macro Option Properties window
displays.
Step 6. Set up the Macros options
a. Select a Network.
b. Select a Node.
c. Select a Point.
d. Select an Action.
e. Click the OK button.
Step 7. Click on the Close button.
ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

55

Workstation Software Configuration

Color and Sound Configuration

Macro Button Procedure


Macro Buttons are created using the Configuration Tool which is launched from Workstations
main menu; Configure >Launch Configuration Tool.
Macro buttons are created and edited on the Screen Objects window (Screen Objects icon). You
access the Marco Button function in Objects menu; Add >Macro Button.

Figure 5.15 Macro Button Window


Step 1. Type in the text you want displayed for the button in the Caption field.
Step 2. Select a Macro to Execute from the list of macro previously defined using the fields down
arrow.
Step 3. Chose an icon to use for the Macro button.
a. Click on the Select Icon button. A Window Explorer window displays.
b. Select the icon from the Buttons folder.
c. Click on the Open button. The icon displays in the Icon area.
Step 4. Click on the OK button to complete the entry.
Step 5. You must Exit the Configuration Tool and then respond to the Save Changes prompt with
the applicable button click to update the Workstation with the information created in this
procedure.

5.7 Color and Sound Configuration


NOTE: Making these settings is optional and they do not need to be made for the Workstation to
function properly.

Custom colors and custom sounds for different event types are created using the Configuration Tool
Tools >Color and Sound Configuration command which is launched from Workstations main
menu; Configure >Launch Configuration Tool. Any selection made here are saved when you exit
the Configuration Tool and then respond to the Save Changes prompt with the applicable button
click.

5.7.1 About Color Configuration Settings


The color configuration function allows the point icons, alarm summary icons, and alarm indicator
in the navigation to display custom colors on all Workstation in the system not just the Workstation
where the color change was defined. The color configuration settings also change Navicon and the
History Manager too. Each event type may have a custom color assigned to it. The Workstation
will display that color on the point icon, alarm summary icon, and the alarm indicator on the left of
the Navigation Tree.

56

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Fan Monitor Configuration

Workstation Software Configuration

New Color for an Event Type Selection


Step 1. Double-click on the colored rectangle next to the event type. The Color window displays.
Step 2. Click one of the pre-defined basic colors or click the Define Custom Colors button to
select a customized color.
Step 3. Click OK when all colors choices have been made.
Step 4. Click the Save button on the Color and Sound Configuration window to update the
Workstation with the new colors
Step 5. You must Exit the Configuration Tool and then respond to the Save Changes prompt with
the applicable button click to update the Workstation with the information created in this
procedure.

5.7.2 About Sound Configuration Settings


Each event type may be configured to play a different sound and by default each event type will
have a different factory defined sound already. For example a fire alarm sound may be configured
so that it is distinctly different from the sound of a trouble event. The Color and Sound
Configuration tab displays the currently configured sound in the Wave File window.

Sound Changes
NOTE: To be able to define a sound for an event; a sound file in a *.wav format must be placed
into the Workstations C:\Facilities Monitoring 3.0\Data\System\Sounds folder.

Step 1. Click the inside the Wave File field An Open window will display.
Step 2. Select the desired wave file and click the Open button. The name of the newly selected
file will be displayed in the Wave File window.
Step 3. Click the Save button to update the Workstation software with the new sounds.

5.8 Fan Monitor Configuration


NOTE: Creating this setting is optional and it does not need to be made for the Workstation to
function properly.

5.8.1 About Fan Monitoring


PC Monitor is an application installed with the ONYXWorks Workstation software application. It
will automatically start, like Windows, when the Workstation computer is started. Its primary
function is to activate other applications as required, however it can used to monitor the
Workstation PC fan.
The PC Monitor choices are accessed by right clicking on its icon located in the Windows System
Tray. The icon is an arrow pointed diagonally upward.

5.8.2 Monitor Fan Setup


This selection toggles between fan monitoring active (checked) or fan monitoring disabled
(unchecked). When monitoring is enabled, the system keeps track of whether the computers fan is
working or not. A check appears next to the option if it is active.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

57

Workstation Software Configuration

58

Fan Monitor Configuration

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Section 6 Workstation Screen Graphical User Interface


Management
6.1 Auto-Creation of Workstation Screens, Nodes, and Points
NOTE: Every Addressable Device must be represented on a Workstation screen as a point icon.
If the ONYXWorks Workstation software application auto-create function has been disabled,
meaning the check box that controls the operation has been uncheck, or if a Addressable Device
has been deleted, then the first time the Addressable Device reports an event an Addressable
Device will be assigned to the default Workstation screen. Device icons generated in that manner
should be edited to ensure all information is complete and relocated to an appropriate
Workstation screen.

6.1.1 Description
The Admin User must determine how the systems navigation tree hierarchy will be organized and
displayed after any auto-creation process takes place. The auto-creation process takes place each
time a new point on the gateway is found through it reporting to Workstation with off-normal event.
Refer to Manage the Auto-Creation Process on page 60 for information.
The auto-creation process of the ONYXWorks Workstation software application does the
following.

A parent screen is created for the gateway, a child screen for the node, a child screen under that
for the points for that node.

It will place 64 point icons on a Workstation screen before it creates the next screen.

Figure 6.1 Example of Navigation Tree with Auto-Creation Process


An asterisk next to a entry indicates the entry and its name were auto-created. This also means the
entrys position in the tree has not been redefined by a user.
The Admin User can organize the Navigation Tree in such a manner it will aid the User with
locating a specific event in a campus (site) or building. The Navigation Tree can be arranged in a
parent-child hierarchical relationship so a User can, in a logical progression, drill-down from a
site view to the floor plan of a building on that site. The tree also shows at what level of the
hierarchy an event is occurring. When events occurs, boxes appear at the left side of the tree in the
color corresponding to the highest priority event.
NOTE: The navigation tree may be a maximum of five (5) levels deep.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

59

Workstation Screen Graphical User Interface Management

Auto-Creation of Workstation Screens, Nodes, and Points

6.1.2 Manage the Auto-Creation Process


Restructure the Navigation Tree After the Auto-Creation Process
Auto-created Workstation screens can:

Be renamed.

Be cut and copied below another Tree entry.

Be reordered, refer to Reordering Workstation Screens on page 60.

NOT be deleted if there are point icons on the screen. Cut and copy the point icons onto
another screen or just delete the points on the screen.

A Workstation screen may be recreated if the system finds a point that is not currently in the screen
database and a new addressable point needs to be auto-created.
Reordering Workstation Screens
The Configuration Tool is used to reorder screens. When the Configuration Tool is open you can
use a right-click on the screen in the Navigation Tree, then it can drag and drop screens to adjust the
hierarchical level (i.e. promote a screen from child to peer, or demote the screen from peer to
child). Dropping between screen levels will place the screen between those levels. After screens
are moved. Navicons maintain their link to the screen.
Reordering Workstation Screen Methods

60

Drag and drop a Workstation screen from/to any position in the list.

Use the Tab key to move a given screen down one level, and Shift >Tab to move the selected
screen up one level.

Right-click on a screen in the Navigation Tree and options display as in the following figure.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Setup the Workstation Display Mode

Workstation Screen Graphical User Interface Management

6.2 Setup the Workstation Display Mode


Transition from Graphics Mode to Text Mode and vice-versa is accomplished by accessing the
View menu. When the Workstation is in Graphics Mode, the View menu will display Text Mode.
When the Workstation is in Text Mode, the View menu will display Graphics Mode.

6.2.1 View Workstation in Graphics Mode


In Graphics Mode the Workstation displays an ONYXWorks system as floor plans, point icons,
and event information in tabular/list form.
The Admin User designs and implements the Floorplan Area concept in the Workstation and
used when the Workstation is in Graphic Setup mode.

A Floorplan Area is a drawing or imported file that is background layer of the Workstation
screen.

A Floorplan Area will serve as the primary source for visual feedback the location of an offnormal event in an ONYXWorks system, it serves as a visual representation of a points
location in a building.
The points types can include fire panels, fire protection points, security points, cameras, and
other equipment.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

61

Workstation Screen Graphical User Interface Management

Setup the Workstation Display Mode

6.2.2 View Workstation in Text Mode


The Text Mode view provides the functionality to expand the Workstations New Events and
Acknowledged Events areas across the entire Workstation screen. When in Text Mode events will
be dynamically updated as they occur. The Panel Ack column will be displayed with check-boxes
to indicate the event is known to be acknowledged at the panel.

Figure 6.2 Text Mode Displayed on the Workstation


The same color-coding used to reflect status is used in both modes.

62

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Section 7 ONYXWorks Workstation Data Management


7.1 Database Management
Several database management procedures are available for working with fire system data. Access
these procedures by right clicking the PC Monitor icon in the Windows taskbar, and then selecting
a procedure in the menu that appears.

Compact & Repair System Data

CAUTION: Data Loss


To avoid data loss, do not perform this operation unless instructed to do so by Technical Services.

This operation recovers dead space in the database, and reconstructs the index file.

Backup System Data

CAUTION: Data Loss


If a second backup is saved to an existing backup folder, both .DAT files remain, but the newer
backup overwrites the data for the existing one. Do not save back up system data to a folder
which contains existing backup data you wish to save.

Upon initiating this procedure, the user must select or create a folder
(C:\Facilities Monitoring 3.0\Backup is the default) and a .DAT file which is used to identify the
backup. In most situations, it is most practical to back up the fire system database to the default
folder, using the same .DAT file, after each editing session and then archive to CD. The
Workstation has a CD-RW drive.

Restore System Data


NOTE: This procedure is only available when all fire system applications, except PC Monitor, are
shut down.

This Workstation command provides the Admin User the options to restore a database created with
the Backup System Data command. The operation prompts for you to choose the location and
folder the system data is stored in.

Import System Data


This procedure updates the system data in the local Workstation to match the system data from
another workstation.

Export System Data To All Workstations


This procedure updates the system data on all networked Workstations to match the system data on
the local Workstation.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

63

ONYXWorks Workstation Data Management

History Manager

7.2 History Manager


The History Manager is an application program interface for viewing all of the events that are
currently stored in the history database of a network client application. It serves as a viewer that
can organize all events that pass through the Workstation software application.
The History Manager allows a set of filters to be applied to the events in order to view specific
event types, points, and events for specific dates. It can be accessed from the View...History menu
item within a network client (such as the Workstation), or it can be started stand-alone (called from
outside the application environment) from the Start >Programs >Facilities Monitoring >History
Manager.

Figure 7.1 History Manager Main Window


The information bar at the bottom of the window displays the number of entries in the database,
which events are being shown, the date and current time. At the top of the window are File, View
and Filter menus. Below that are the record viewer tabs (Event, Point, Screen and Statistics) if they
are enabled.
The lists of events:

64

Are displayed according to any applied filters.

Can be the current history file or an archived history file.

Displayed depends on what specific application provided the database.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation Data Management

History Manager

7.2.1 History Manager Menu Descriptions


File Menu
Open Database
Open a previously saved event history database.
Export to Delimited Text
Name and create a comma delimited (.csv) file listing the events in the history list.
Print Displayed Records
Opens a print dialogue which allows printing of the records displayed by the history manager.

CAUTION: Event Report Printouts


When you click the printer icon, a complete event report will be printed out. If no filters have been applied
to narrow the parameters for the report, this printout may be lengthy. To halt printing, right-click the
printer icon that appears of the Windows taskbar, then select Cancel Print Job, or go to the printer and
manually cancel the print job.

View Menu
Refresh
Refreshes the event list to include the most recent events received.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

65

ONYXWorks Workstation Data Management

History Manager

System...
This view shows how the events displayed by the history manager are distributed over the fire
system.

Figure 7.2 History Manager System View

NOTE: This view option is only available from the Event Grid... display.

66

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation Data Management

History Manager

Event Grid...
This menu option restores the initial event list after viewing the System... layout.

Figure 7.3 History Manager Event Grid (Main Window)

NOTE: This view option is only available from the System... display.

Select Columns To Show


Opens a dialog from which the user can check or clear boxes to select which informational columns
appear in the event list.
Show All Columns
Displays all columns. (Clicking the option also automatically checks all the boxes in the Select
Columns To Show dialog.)
Resize All Columns
Automatically resizes all displayed columns to the width of either the column heading or the
longest entry of any cell in the column, whichever is wider.
Record Viewer
Toggles display of the record viewer tabs. With the record viewer tabs displayed, click an item from
the event list to select it, and then click a record viewer tab (Event, Point, Screen or Statistics) to
view that type of additional information about the selected event.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

67

ONYXWorks Workstation Data Management

History Manager

Filters
Toggles display of the filter pane on the left side of the event list.
NOTE: Hiding the filter pane does not remove the active filters; therefore, the same events are
listed whether the filter pane is displayed or not. Hiding the filter pane provides more horizontal
space for the event list, so more columns, and/or wider columns, can be shown.

Display Labels
Select whether nodes displayed in the System... view are labeled with their alias or with their
network address.
Time
Select whether the times displayed are Received Time Local, Actual Time Local, or Actual Time
UTC (that is, Coordinated Universal Time). Choosing Time/Date constraints on the events
displayed (in the System... view) shows only events that fall within the specified time range as
calculated by the selected time scheme.

Filter Menu
NOTE: The Filter menu is not available while the System... view is displayed. However, the
options in the Event Type, Time/Date and View panes on the left side of the System... view, used
with the Update button below them, allow you to filter the events shown.

Save Current Query


Saves the current query for later use. The current query is shown under the Applied Filters heading
in the pane to the left of the event grid. The information shown there is a summary of the settings
chosen under the General and Location headings in the pane to the left of the event grid.
NOTE: To use an already-saved query, select the query name from the drop down list under the
Queries heading in the pane to the left of the event grid.

Clear All Filters


Removes all filters and shows all recorded events in the event grid.
Rename Selected Query
Delete Selected Query
Print
Displayed Events This command (or icon) prints the current event in History Manager
window. The printout is sent to the printer setup using the "Printer Setup" command.

CAUTION: Event Report Printouts


When you click the printer icon, a complete event report will be printed out. If no filters have been applied
to narrow the parameters for the report, this printout may be lengthy. To halt printing, right-click the
printer icon that appears in the bottom right of the PC desktop, then select Cancel Print Job, or go to the
printer and manually cancel the print job.

Printer Options This command displays the Printer Configuration window which allows the
Admin User to determine how the information displayed in the History manager window will be
printed in the context of font type, font size, page orientation, and options (show/hide grids/color)
to the printer set up using the "Printer Setup" command.
68

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

History Manager

ONYXWorks Workstation Data Management

Printer Setup This command displays Windows Print Setup window which allows the Admin
User to set up a Windows printer connected to the Workstation. Consult Windows information for
setup information.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

69

ONYXWorks Workstation Data Management

History Manager

7.2.2 History Manager Right Click Menu Descriptions


The commands displayed depend on which column the right-click is performed. List of choices
menus will display providing the option to sort and filter various events and/or columns. One of
two right click menus can be displayed; the "Filter Right-Click Options" or the "Header RightClick Options".

Filter Right-Click Options


The Filter list of choices can be accessed by right-clicking any row in the main body of the History
Manager window. The list of choices are:
Filter By Selection this command allows the Admin User to display all records according to the
event and column that was right-clicked on.
Filter Excluding Selection this command allows the Admin User to exclude displaying all
records according to the event and the column that was right-clicked on.
Filter For This command displays a History Manager window which allows the Admin User to
filter for a specific word or phrase using keywords and or wildcard characters.

Figure 7.4 Keyword/Wildcard Filter Window


Clear All Filters This command allows the Admin User to return the History Manager window
to the factory default filters. Once this option has been chosen, all filters are lost unless they where
saved using the "Save Current Query" command.
Show If Greater Than Or Equal To This command allows the Admin User to filter by
Received Time. The filtering is based on the events time and forward.
Show If Less Than Or Equal To This command allows the Admin User to filter by Received
Time. The filtering is based on the events time and backwards.

Header Right-Click Options


The Header list of choices can be accessed by right-clicking on any column header. This list of
choices applies to a column rather than specific row entries. The options are used to perform
commands that will organize the database columns for search clarity. The list of choices are:
Hide Column This command allows the Admin User to temporarily hide the selected data
column. The column itself is not deleted, only hidden.
Show Column This command allows the Admin User to select hidden data columns and set
them back to be displayed.
Show All Columns This command allows the Admin User to remove all data column filters
which were previously applied.
Sort ASCending Click a column heading to sort the data column in ascending or descending
order (numeric or alphabetical).
Sort DESCending Click a column heading to sort the data column in descending order (numeric
or alphabetical).

70

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation Data Management

System Explorer Searches

7.3 System Explorer Searches


7.3.1 Search for Device
The System Explorer can conduct a generic text search for ONYXWorks system devices.
Step 1. Click View >System. The System Explorer window opens.
Step 2. Enter the search text.
Step 3. Click Search. The results appear in the pane on the right.
Step 4. Click OK to close the System Explorer window.

Figure 7.5 System Explorer Search

7.4 Key Upgrade Utility


7.4.1 Key Upgrade Utility Overview
Every Workstation is shipped with a USB Hardlock Key. This key is programmed to allow features
of the network monitoring system to function on that Workstation.
A Hardlock Key upgrade is required when a new feature is desired. You must acquire an Upgrade
Code from Technical Services to update the key.

7.4.2 Key Upgrade Procedure


The USB Hardlock Key currently plugged into the Workstation is upgraded with this procedure.
Step 1. Shut down the Workstation software application.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

71

ONYXWorks Workstation Data Management

Key Upgrade Utility

Step 2. Select Start >Facilities Monitoring >Key Upgrade Utility. The Key Upgrade Utility
window displays.

Figure 7.6 Key Upgrade Window


Step 3. Type the code into the Upgrade Code field.
Step 4. Click on the Perform Upgrade button. Fields on the window update to reflect the Upgrade
Code.
Step 5. Click on the Done button to complete the upgrade and close the window.

7.4.3 Key Upgrade Utility Field Descriptions


Installation Name This is typically a factory defined site name. It is not recommended but the
name can be changed by typing into a new entry into field.
Registered This is typically a factory defined site name. It is not recommended but the name
can be changed by typing into a new entry into field.
Node License Shows how many node licenses are included with the current key configuration.
Serial # Displays the serial number of the Hardlock Key (different from the Authorization Code).

72

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Section 8 ONYXWorks System Architecture


Descriptions
8.1 System Architecture
ONYXWorks Workstations (Workstation) and gateways communicate over an Ethernet (TCP/IP)
network. Gateways also communicate with other panels and networks of fire alarm and protective
equipment. Each gateway relays Ethernet protocol messages from the monitored equipment using
the equipments native protocol to the Workstation. An ONYXWorks system supports 50
Networks, for a maximum of 100 gateways if fully redundant (for more information, refer to
Adding a Redundant Gateway on page 33). The minimum ONYXWorks system is one
Workstation and one gateway.
Several types of gateways are available, such as ONYXWorks NFN Gateway PC and Embedded.
An ONYXWorks NFN Gateway exists as a node on a NFN network.
The Workstation can be installed on a dedicated TCP/IP network, or part of a shared TCP/IP
network such as the Internet. It can be part of a customers enterprise (or corporate) TCP/IP
network. Canada installations require a dedicated TCP/IP network. Shared bandwidth TCP/IP
connectivity allows the ONYXWorks system design to be versatile and flexible for various
system requirements. Workstations, gateways, and other clients can be located in close proximity to
each other or separated by many miles. ONYXWorks system nodes can be controlled from any
Workstation located on the contiguous property being monitored. Clients that have monitoring
capabilities to non-contiguous properties may not control that property without the approval of
local Authority Having Jurisdiction (AHJ).

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

73

ONYXWorks System Architecture Descriptions

System Architecture

Example Systems
In simple systems, Workstations and gateways can co-exist on one computer. For larger systems,
multiple computers can be networked together over the TCP/IP network running up to a maximum
of 100 gateways if fully redundant (for more information, refer to Adding a Redundant Gateway
on page 33). The following figure shows a sample network diagram on which ONYXWorks
Gateways reside.

TCP/IP Network

Workstation

Workstation

Gateway
Embedded

NFN Network

FACP

FACP

FACP

Figure 8.1 Basic NFN Gateway Network

74

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks System Architecture Descriptions

System Architecture

TCP/IP Network

Workstation

Workstation/Gateway PC

Gateway Embedded

Workstation/Gateway PC

NFN Network

FACP

FACP

NFN Network

FACP

FACP

FACP

FACP

Figure 8.2 Advanced NFN Gateway Network

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

75

ONYXWorks System Architecture Descriptions

Operating Modes

8.2 Operating Modes

Supervising Station Mode - In this mode the ONYXWorks system supports multiple
gateways and Workstations.

Canada - Supervising Station Mode-Canada - Supervising Station mode meets ULC 559
requirements and otherwise runs exactly as Supervising Station Mode.

FCC (Fire Command Center) In this mode the Workstation is a peer of a panel it monitors;
actions taken at the panel register on the Workstation. FCC mode requires exactly one
Workstation and one NFN Gateway.

NOTE: NetLogic does not function with an ONYXWorks Workstation running in FCC mode.

Canada - FCCCanada -FCC mode meets ULC 559 requirements and otherwise runs exactly
as FCC mode.

Canada - FCC + DCC (Display and Command Center)Canada FCC + DCC mode meets
ULC 559 requirements, and also meets the Canadian requirements for control. Otherwise,
Canada FCC + DCC mode runs exactly as FCC mode.

8.3 Fire Command Center (FCC) Mode Overview (PPU)


8.3.1 Architecture for FCC Mode
An ONYXWorks system is an ideal solution for facility monitoring and control. The
ONYXWorks Workstation software application provides extensive control and monitoring
functions for fire, security, and building automation of local and remote sites. The software
application can be customized to adapt to a wide variety of monitoring and control situations. The
software application allows a User with the appropriate Security Option to allow/disallow access to
the application by adding other Users and creating security profiles for them. Those other Users
typically, when they are logged in, will be monitoring a portion of local and remote sites.
Workstation software applications in FCC mode comply with the requirements for UL and NFPA
for Protected Premises Units (PPU). The Workstation was designed to warn building monitoring
personnel of potential life safety situations so that they can take the necessary actions to evacuate
the premises.
In FCC mode, there is always one Workstation and one NFN gateway. The NFN gateway can be
installed on the same PC that is running the Workstation software application or an optionally
installed embedded NFN gateway. The choice of which gateway to use will be dependent on the
system layout.
NOTE: FCC mode is NOT supported when a gateway other than the PC version of the NFN
gateway is used, or if there is more than one gateway in the ONYXWorks system.

NOTE: Running this Workstation in FCC mode (PPU) ULC requires it be operated by trained
personnel.

NOTE: If multiple gateways are present or required, the Workstation software application must
run in Supervising Station mode.

76

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Fire Command Center (FCC) Mode Overview (PPU)

ONYXWorks System Architecture Descriptions

NOTE: FCC mode is to be used on a dedicated fire protective signalling network only.

8.3.2 Event Handling Overview for FCC Mode


The following features are provided by the Workstation when FCC mode is running.

Block Acknowledge of troubles, supervisory, and security events.

Always requires an individual acknowledgement of Fire Alarm and Hold-up events.

Display and Command Center (DCC).

Performance:
Annunciation of alarm signals at the Workstation in FCC mode (PPU) occurs within 10
seconds after the activation of an initiating point (device).
Trouble signals and their restoration to normal shall be indicated within 200 seconds.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

77

ONYXWorks System Architecture Descriptions

Fire Command Center (FCC) Mode Overview (PPU)

8.3.3 FCC Mode Communications Requirements

In FCC mode, in which the fire system is sharing bandwidth on an TCP/IP network with other
systems, a UL listed barrier gateway, integral with or attached to each control unit or group of
control units, as appropriate, shall be provided to prevent the other systems from interfering
with or controlling the fire alarm system. A barrier gateway is required on dedicated TCP/IP
networks.

All signal control and transport equipment (such as routers, servers) used with the
ONYXWorks system in FCC mode shall be listed for fire alarm service. For example:
Contemporary Control Systems Inc. (www.ctrlink.com) has several UL864 recognized
switching hubs that will meet the requirements of a barrier gateway.

NOTE: For ULC applications, the Internet cannot be used for either primary or ancillary
functionality. ULC does not allow operation over an Internet connection.

8.3.4 FCC Mode Agency Approval


In FCC Mode, ONYXWorks systems are classified as a Protected Premises Fire Alarm System
Unit and meet all the regulatory agencys requirements for a protected premises unit.
The ONYXWorks Workstation software application is approved, in compliance with the NFPA,
for the remote resetting and silencing of a fire alarm control unit from other than the protected
premises provided the authority having jurisdiction approves it.

8.3.5 ONYXWorks FCC Mode Ordering Information


Use the following table to verify your life safety application needs.

Table 8.1 FCC Mode Ordering Information


Part Number

Description

ONYXWORKS-WS

78

ONYXWorks computer with Workstation GUI software


Call Customer Service to choose specific components to be installed and
included
FCC Mode Workstation by default
FCC Mode: Order NFN-GW-PC-W/F, NFN-GW-EM, NFN-GW-PCHNW/HNSF/HNMF, or NFN-GW-EM-3 only.

Gateways

Description

NFN-GW-EM-3

Embedded NFN Gateway-3


Additional required parts ordered separately
ONYXWORKS-WS
Cabinet for NFN Gateway
HS-NCM-W, HS-NCM-SF, HS-NCM-MF, NCM-W or NCM-F for connections
to NFN

NFN-GW-PC-HNW

NFN PC Gateway-3 card (wire connections)

NFN-GW-PC-HNSF

NFN PC Gateway-3 card (single mode fiber connections)

NFN-GW-PC-HNMF

NFN PC Gateway-3 card (multi mode fiber connections)

NFN-GW-EM

Embedded NFN Gateway


Additional required parts ordered separately
ONYXWORKS-WS
Cabinet for NFN Gateway
NCM-W or NCM-F for connections to NFN

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Fire Command Center (FCC) Mode Overview (PPU)

ONYXWorks System Architecture Descriptions

Table 8.1 FCC Mode Ordering Information


NFN-GW-PC-W

NFN PC Gateway card (wire connections)

NFN-GW-PC-F

NFN PC Gateway card (fiber connections)

8.3.6 FCC Mode Example Life System Diagrams


Protected Premises Unit

NFN/ArcNet Network

NFN/ArcNet Network

Embedded Gateway

*Ethernet Hub (TCP/IP)


UL 864 Listed Switch

Other Technologies
LAN/WAN/Internet/Intranet
(Dedicated Only)

Ethernet Hub (TCP/IP)


UL 864 Listed Switch (Not required
on dedicated Network)

Workstation

Figure 8.3 ONYXWorks FCC Mode Example 1

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

79

ONYXWorks System Architecture Descriptions

Fire Command Center (FCC) Mode Overview (PPU)

Protected Premises Unit

NFN Network

Workstation

Figure 8.4 ONYXWorks FCC Mode Example 2

80

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Proprietary Supervising Station Mode Overview

ONYXWorks System Architecture Descriptions

8.4 Proprietary Supervising Station Mode Overview


8.4.1 Architecture For Supervising Station Mode
Proprietary supervising station fire alarm systems monitor the life safety systems of the protected
premises that is under the same ownership. The supervising station can be located at the protected
premises or at multiple protected properties. Properties may consist of a single building, such as a
high-rise building, or several buildings, such as a campus where multiple separate buildings report
to a proprietary supervising station owned and operated by the campus. The property may be
contiguous or non-contiguous. If it is non-contiguous, it may consist of protected properties at
remote locations. Codes do not limit the geographic distance that may exist between noncontiguous properties. This permits an owner to oversee protection features at geographically
diverse locations from a single proprietary supervising station.
The ONYXWorks system is a Proprietary Supervising Station Fire Alarm System and may serve
contiguous and non-contiguous properties, under one ownership. Monitoring is typically
performed from a proprietary supervising station located at the protected property, or at one of
multiple non-contiguous protected properties, at which trained, competent personnel are in constant
attendance. Monitoring may include, but is not limited to, the proprietary supervising station;
power supplies, signal-initiating points, initiating point circuits, signal notification appliances,
equipment for the automatic, permanent visual recording of signals; and equipment for initiating
the operation of emergency building control services. ONYXWorks systems are permitted to be
interconnected with other systems intended to make the premises safer.
In Supervising Station mode, the ONYXWorks system supports 50 Networks, for a maximum of
100 gateways if fully redundant (for more information, refer to Adding a Redundant Gateway on
page 33). Multiple NFN and Receiver gateways are supported simultaneously and can be
constantly supervised and communicating with the same Workstation. They can also span the
TCP/IP network and exist on multiple Workstations or embedded hardware. The choice of which
gateways to use and where they should be located is application specific and should be analyzed by
a trained individual.

8.4.2 Overview of Event Handling in Supervising Station Mode


ONYXWorks Workstation, in Supervising Station mode complies with NFPA-72 2002 and UL for
Supervising Stations.
The following features are provided by the Workstation software application when Supervising
Mode is running.

Each change of state must be individually acknowledged.

Performance:
The maximum duration between the initiation of an alarm signal at the protected premises,
transmission of the signal, and subsequent display and recording of the alarm signal at the
Workstation shall not exceed 90 seconds.
Display rate of subsequent alarms at the Workstation shall be at a rate no slower than one
complete signal every 10 seconds.
Trouble signals and their restoration to normal shall be indicated within 200 seconds.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

81

ONYXWorks System Architecture Descriptions

Proprietary Supervising Station Mode Overview

8.4.3 Supervising Mode Communications Requirements

If the Workstation or gateway is sharing on-premises communications equipment, the shared


equipment shall be listed for the purpose. If on-premises communications equipment is not
listed for the purpose, the fire alarm transmitter shall be installed ahead of the unlisted
communications equipment.
Listed for the purpose has been formally interpreted by NFPA (Formal Interpretation 72-991) for equipment on packet switched networks as being listed to the requirements applicable to
general purpose communications network equipment.

NOTE: For ULC applications, the Internet cannot be used for either primary or ancillary
functionality.

8.4.4 Supervising Mode Agency Approval


In Supervising Station mode, Workstations are classified as a Proprietary Supervising Station and
meet all the agency requirements for supervising station fire alarm systems. The local Authority
Having Jurisdiction (AHJ) must approve remote control of a fire alarm control unit.

8.4.5 ONYXWorks Supervising Mode Ordering Information


Use the following information to verify your life safety application needs.

Table 8.2 Supervising Mode Configuration Information


Part Number

Description

ONYXWORKS-WS

82

ONYXWorks computer with Workstation GUI software


Call Customer Service to choose specific components to be installed and
included
FCC Mode Workstation by default
Change To Supervising Station via option in Workstation
Supervising Station Mode: Order up to 200 gateways (see below)

Gateways

Description

NFN-GW-EM-3

Embedded NFN Gateway-3


Additional required parts ordered separately
ONYXWORKS-WS
HS-NCM-W, HS-NCM-SF, HS-NCM-MF, NCM-W or NCM-F for connections to
NFN

NFN-GW-PC-HNW

NFN PC Gateway-3 card (wire connections)

NFN-GW-PC-HNSF

NFN PC Gateway-3 card (single mode fiber connections)

NFN-GW-PC-HNMF

NFN PC Gateway-3 card (multi mode fiber connections)

NFN-GW-EM

Embedded NFN Gateway


Additional required parts ordered separately
ONYXWORKS-WS
Cabinet for NFN Gateway
NCM-W or NCM-F for connections to NFN

NFN-GW-PC-W

NFN PC Gateway card (wire connections)

NFN-GW-PC-F

NFN PC Gateway card (fiber connections)

DACR-GW

Digital Alarm Communicator Receiver Gateway

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks System Architecture Descriptions

Proprietary Supervising Station Mode Overview

8.4.6 Supervising Mode Example Life System Diagrams

Supervising Station Transmission and


Communications Path

Workstation/
PC Gateway

Protected Premises Unit

NFN Network
Workstation/
Gateway PC

Embedded
Gateway

Workstation

NFN Network
Other Technologies
LAN/WAN/Internet/Intranet
(Shared or Dedicated)

Workstation

Figure 8.5 ONYXWorks Supervising Station Mode Example 1

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

83

ONYXWorks System Architecture Descriptions

Proprietary Supervising Station Mode Overview

Supervising Station Transmission and Communications Path

Protected Premises Unit

Digital Alarm
Communicator Receiver

NFN Network
RS-232

Workstation/
PC Gateway/
Receiver Gateway

Figure 8.6 ONYXWorks Supervising Station Mode Example 2

84

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks System Architecture Descriptions

Client Applications

8.5 Client Applications


The main client application in an ONYXWorks system is the ONYXWorks Workstation
software application which provides:

An interface for the entire ONYXWorks system.

The functions that are necessary to create the visual look of the ONYXWorks system.

The controls to respond to off-normal events from the ONYXWorks system.

The functions to create security, monitoring, and control profiles, and complete history
tracking.

The capability to expand life safety system with the expansion of the protected premises.

The support for an NFN networks full Control-By-Event functionality as a node capable of
configuring and controlling formulas for system-wide automated response.

8.6 Printers
ONYXWorks Workstation software application supports graphics printing and event printing.
Windows-compatible printers are required.

To print screens, floor plans, history reports, etc., connect a graphics printer (laserjet) directly
to the LPT port or a USB port on the Workstation PC.

To print a record of every annunciated Workstation event an event printer (dot matrix) directly
to the COM port on the Workstation PC.
Refer to Make Printer Connections on page 19 and Local Event Printer Configuration on
page 40 for more printer information.

8.7 System Security


The Workstation software application uses security controls to ensure that the computer is not
disabled by unauthorized personnel. Hardware protections and software protections are both used.

8.7.1 Hardware Security


The Workstations power connection must be secured with special hardware. The rear power switch
must be covered with the power cord shield, while the chassis console access door must be locked
to secure the front power switch. The Workstation must be protected from power failures with
proper line current surge protection and a regulated, UL 1481 listed, power limited Uninterruptible
Power Supply (UPS).
Refer to the following for more information:

Workstation AC Power Connection Preparation on page 17.

Uninterruptable Power Supply (UPS) Installation on page 21.

8.7.2 Software Security


NOTE: The Workstation must be logged into before any of its settings can be configured. A
User that has the Security Option to configure settings needs to login to change an existing
setting. The factory defined User Admin has such a Security Option. Information in this
document is written assuming that a User with the equivalent Security Option of the Admin User
will be performing the procedures in this document.

The methods of Workstation software security are:

Secure Windows (Control/Command Key Lockouts)

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

85

ONYXWorks System Architecture Descriptions

Workstation Event Handling Basics

This type of lockout disables the Workstations keyboard keys that are used to access Windows
programs that are not part of the Workstation software applications. For example, keyboard
key combinations can be used to shut-down or restart the Workstation and for switching
between software applications. The PC Monitors Secure Windows selection disables those
types of operations.

User Security Options


User accounts can be created with differing levels of access to the ONYXWorks system. The
Users Security Option choice determines which functions are visible or selectable. For
example, some User accounts may not have permission to exit the Workstation software
application. Refer to ONYXWorks Configuration Tool Installation & Operation Manual PN
53038 for information.

8.8 Workstation Event Handling Basics


Trouble in the life safety system is detected by Workstation software application and reported as
off-normal events. When off-normal events that are received from a fire alarm panel and points are
reported to the Workstation and if the Workstation is in Graphics Mode these display changes will
take place if Autonavigate has been selected (refer to Automatically Navigate on Event on
page 48).
1.

When an event(s) occur(s) the Workstation navigates to the location of the event(s) in the
system and displays the highest-priority unacknowledged event by a flashing its respective
icon in the Workstation screen.
If there are multiple events and all unacknowledged events are taking place in the same
ONYXWorks system location, all unacknowledged event icons will be flashing on the
Workstation screen.

2.

There could be multiple highest-priority unacknowledged events and the following will reveal
them for acknowledging.
a. Read the list of events in the New Events window.
b. The Navigation area will display colored boxes next to the affected Navigation Tree
entry.
To determine multiple highest-priority unacknowledged events use with the following
colors if they have not been changed from the factory default settings.
Red: alarm.
Yellow: trouble and supervisory.
Blue: disable and security.
c. Read the incremental list in the Alarm Summary window.
d. The corresponding event icon(s) will display in the Event Annunciator Icon window.
e. When an event is acknowledged the icon stops flashing but displays the off normal
color.

86

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Event Handling Basics

ONYXWorks System Architecture Descriptions

1
2

2a

2c

2d

Figure 8.7 Troubles Reported


FCC Mode or Supervising Mode Event Handling Comparison
Events are displayed the same way whether the Workstation is running in Fire Control Center
(FCC) mode or Supervising Station mode. Such as:

If the event is acknowledged at the panel Acked will be displayed prefixing the event in the
New Events list.

If the Workstation has node control of the point a colored box will display to the left of the
event in the Navigation Tree.

If the event is unreliable (meaning it was reported while a gateway or node was in fault) an *
will be displayed prefixing the event in the New Events list.

However the Workstation handles return-to-normal conditions and acknowledgements in a


significantly different way, depending on operating mode.
Table 8.3 FCC Mode and Supervising Mode Comparison
FCC
Mode

Supervising
Mode

If an event is acknowledged at the Fire Alarm Control Panel (FACP) it is


acknowledged at the Workstation

YES

NO

If an event is acknowledged at the Workstation it is acknowledged at the Fire


Alarm Control Panel (FACP)

YES*

YES*

When an event returns to a normal state it is removed from the New Event
listing

YES

NO

When an event returns to a normal state it is acknowledged at the FACP

YES

NO

Action

* If the logged in User has the Security Profile to do so.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

87

ONYXWorks System Architecture Descriptions

Workstation Event Handling Basics

For more information, refer to Appendix B, Details about Event Data, on page 95.

88

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Monitored Points

ONYXWorks System Architecture Descriptions

8.9 Workstation Monitored Points


8.9.1 Workstation Points
Commands may be sent from the Workstation through the gateway to nodes and their points on a
network. Command choices vary by node/point types. There are common commands but not all
common commands are relative to all nodes/points. The common commands are displayed when
you right click on a node/point icon that is on the Workstations screen.

8.9.2 Common Workstation Commands


The Workstation monitors a node (panel) and can be used to perform control commands for that
nodes points. When a right click is performed on a node/points icon a list of commands is
displayed. Those commands are sent from the Workstation to or through the nodes to the nodes
points.
These right click commands are common to all nodes and points.
Enter User Response This Workstation command allows you to select a choice from a list of
factory default or User created responses. These choices provide the logged in User the means to
report various conditions and operations related to a node/point.

Dispatched Personnel To Investigate

Response Personnel on Scene

Device Undergoing Test

Device Testing Completed

Contacted System Contractor

Faulty Device

Replaced Device

Preventative Maintenance

History Of Device This Workstation command only displays the history information in the
History Manager window for the selected node/point.
Linked Media This Workstation command will access any media that has been created and then
assigned to the node/point. Several types of media files may be linked to the node/point. One of
each type can be used.

A text file to give specific information or instructions to the User (.TXT).

A raster image type graphic can be linked (.BMP).

A sound file may be linked giving audible information or instructions (.WAV).

A video file may be linked (.AVI).

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

89

ONYXWorks System Architecture Descriptions

90

Workstation Monitored Points

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Appendix A: Glossary
Absolute Address Network ID + SubNode ID +
Point ID.

Event Printer An event printer is a dot matrix printer


that connects to ONYXWorks Workstation and prints
all events that are annunciated at the Workstation.

Bitmap (.BMP) Graphic file format. Basic image


data is stored in the form of a grid of pixels, each with a
certain color. Bitmaps are the standard method of
importing and transporting image type information.
Bitmap files each have a specific size in pixels.
Because of this, they may degrade in quality if they are
zoomed or re-sized. Files are identified with the
extension *.BMP.

Fire Alarm Event Event issued by fire protection


devices such as pull-stations, smoke detectors, and
sprinkler systems.
Floorplan Area The Floorplan Area provides the
primary source of the Workstation visual feedback and
interaction with the ONYXWorks system.
Functional Buttons Refer to Macro Buttons.

C
Child Screen Refer to Parent Screen.
Control Profiles Control profiles determine what
addressable devices the Workstation is currently
supervising. If a Workstation does not have control of a
point, the Workstation cannot command the point at all.
In order to affect a device on the network, the User must
have control of that addressable device.
D
Digital Alarm Receiver An addressable device
connected to a network in a ONYXWorks system; the
receiver routes incoming calls from dialers connected to
remote panels and directs resulting messages to the
ONYXWorks Workstation.
Discrete Devices Discrete addressable devices are
monitored nodes, points, and panels with defined
(discrete) states or conditions. These conditions are
annunciated at the Workstation. For example, a pullstation either reports a normal state, an alarm state, or a
trouble state. Normal state indicates normal operation,
Alarm state shows that the pull-station has been
activated, and a Trouble state indicates a functional
problem with the device.
E
Ethernet Network communication standard using the
TCP/IP protocol. Connects gateways in the
ONYXWorks system.
Event An Event is any change in the status of an
addressable device or a transfer of information between
a device and either the Workstation or another device.
Some of these events are considered background and
housekeeping events, and are not seen by the User. The
events that are of primary concern to the User are those
identified as off-normal events.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

91

Glossary

G
ONYXWorks

Gateway Gateways connect the


Workstation to a specific fire alarm network, and to
other ONYXWorks Workstation all of which make up
an ONYXWorks system. A Gateway may be installed
in the Workstation or an independent wall-mounted unit.
Graphics Printer The graphics printer is attached to
the Workstation using the parallel port and is configured
through the standard Windows printer interface. A
Graphics printer can be used to print various reports,
floor plans, and lists from the Workstation.
H
Hardlock Key The Hardlock Key attaches to the USB
port of a Workstation and provides authorization and
feature information to the Workstation. A Hardlock
Key is needed for each Workstation running the
software.

Macro Buttons Macro Buttons are added to the


Workstation screen to perform macro functions that
have been previously defined by the Admin User.
These are sometimes referred to as Functional Buttons.
Member database Refer to User Database.
Monitoring Profiles Monitoring profiles allow the
User to select exactly what events are seen by the
Workstation, organized based on selecting specific
nodes, sub-nodes and devices. Monitoring assignments
are the job of the Admin User, who creates a number of
profiles that can be selected by the User. Usually these
profiles are created around a physical or operational
structure, such as by building or by work shift.
Mouse-over Window A window that pops-up a
window with additional information about something on
the Workstation screen when the mouse pointer is
position over it.

History Database Maintains a record of all events


and actions that take place in the ONYXWorks
system. The history database can become the largest of
all the database files.

HVAC Heating, Ventilation, and Air Conditioning.

Navigational Buttons Refer to Navicons

Node Number A node number is the ID for any given


node on a network.

Information Labels An information label hyperlinks


to text, pictures, video, and/or sound, to provide details
about locations monitored by the ONYXWorks
system. These are not physical devices; they are
clicked-on to display important information for the User
or for emergency responders. Suggested pop-ups are
pictures of hazardous materials storage areas; special
warnings and instructions for hazardous materials;
construction area designations; and locations of
emergency exits.

Navicons User-defined icons on the Workstations


screen that provides a shortcut to another Workstation
screen. Function is similar to hyperlinks on a web page.

O
Off-Normal Event An off-normal event is an event
which indicates activity or change in a condition that
requires the attention and/or response of an User.
Overview The Overview provides either an overview
of the currently displayed Workstation screen (without
devices, buttons, or other objects).

IP Address An IP address is a unique identifier that


represents a connection of a TCP/IP network. IP
addresses are used to address individual workstations
and servers on the ONYXWorks system.
L
Linked Information Any addressable device or
information label on the floor plan can have linked
information. Linked information can be text, video,
bitmaps, and sound. To access the linked information
on a device (either addressable or an information label),
right-click-on the icon to display the pop-up menu and
then make the appropriate selection.
M
Macro Macros are used to define custom commands
for communication with particular devices on the
network. Macros can be defined to perform a variety of
different commands (dependent on the point type), to
one or more specified devices.
92

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Glossary

P
Paired Event Events which, after acknowledgment,
still require another event to return the associated device
to its original state. This second event may be initiated
by the User (as in the case of sending a reset to a device
or panel), or the original device itself (such as an alarm
server which originally went off-line and is coming back
on-line). Devices can send more than one off-normal
event before the related return state event is sent, for
example a fire panel may have more than one alarm
state, and these will not clear until all events have
cleared and the panel reports an all clear state.
Panel A panel is a central gateway that connects a
number of related devices together. For example, a fire
panel might have smoke detectors, pull-stations,
sprinkler systems, and sirens all connected at the panel.
This also allows the Workstation to communicate
directly with the panel instead of the individual device.
Parent Screen In the Navigation Trees outline view,
the highest level is the Title Screen. The Gateways,
nodes, and devices that branch off of it are its Child
Screens. A parent screen can have zero or many child
screens. The highest level is the Title Screen; it cannot
be a child.
Plug-In A Plug-In can be in one of two forms, either
an *.EXE application or a *.CFG configuration file.
Plug-In Applets are independently operating software
applications. They interface with the Workstation at the
local level. Configuration files act to create new menu
options by defining macro commands or sequences of
information for communicating with specific devices.
Configuration files may or may not launch independent
applications.
Point Icons An Admin User defined graphic element
on a Workstation screen. Each represents a physical
addressable device on the network.

Pull-station A pull-station is a fire related device


which, when activated (generally by pulling a lever or
switch) triggers an alarm at the panel, activating audible
alarms and other pre-configured devices.
R
Receivers Gateway Acts as a bridge between the
supported digital alarm receivers and the ONYXWorks
system.
S
Screen Screens are the fundamental visual interface
between gateways and the User. Screens are displayed
in the Floor Plan Area of the main display. Each system
can contain numerous screens, and screens can contain
floor plans, graphics, and/or devices.
Screen Database The Screen Database holds
information for the backgrounds, devices, buttons, etc.
for all of the Workstation screens and gateways on the
ONYXWorks system.
Security Alarm Event An event issued by security
related devices such as motion detectors, glass break
detectors, and door contacts.
Security Options User functionality and activity are
controlled by the assignment of security profiles. Each
User and Admin User is assigned a security profile with
their system member record. Security profiles contain a
list of all Workstation functions to which anyone
assigned to that profile is allowed access.
Single Ended Event An event that, once it is
received, leaves the sending device in the same
condition that it was in originally.
Site A site is the physical location being protected by
an ONYXWorks system installation, i.e. the building
itself. (Refer to the Gateway definition for the buildings
virtual organization within the network.)

Point ID The point identification (ID) is the eight


character alphanumeric address suffix for the monitored
point reported by the node. The Point ID for each
device must match the point ID reported by the node.
The point ID makes up the last 8 characters of a devices
absolute address.

Supervisory Alarm Event A Supervisory alarm is a


special alarm to indicate action that has functionally
disabled a key device (for either fire protection or
security). An example of this is the event generated if
the water valve is shut off for a sprinkler system.

Pop-Up Menu Pop-Up Menus provide the User with


device specific information and controls. The device
pop-up menu is activated by right-clicking-on any
addressable device. The menu that appears depends on
the point type, situation, and the access permissions of
the User. Some options are common to all addressable
devices, while others have functions that are point type
specific.

Taskbar This area of the Workstation screen displays


Admin User configured command buttons and openwindow tabs. The Taskbar is located between the
Navigation Tree and the Workstations Toolbar.

TCP/IP The protocol used by the Workstation level of


the ONYXWorks network that provides
communication among workstations, and gateways.
Title Screen Refer to Parent Screen.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

93

Glossary

Toolbar The area of the Workstation screen directly


below the Main Menu, providing icons for commonly
used functions.
Trouble Event A Trouble Event indicates a
functional problem with a addressable device on the
network. Examples of trouble events include a device
or Workstation going off-line, a battery low or no power
event, a dirty head on a smoke detector, etc.
U
UPS Uninterrupted Power Supply. A UPS is used
between the buildings power source and the
Workstation and provides battery backup. A UPS will
allow the Workstation to continue to operate as usual for
a period of time determined by the UPSs rating.
User Database The User Database holds all of the
information pertaining to members of the
ONYXWorks system. This includes Users and Admin
Users with access to the monitored gateways.
V
Vector Graphics Vector Graphics are based on lines,
boxes, curves, and fills between discrete points in two
dimensional space. Because all objects are described as
sets of points, lines, curves, and fills that can be
recreated at any scale, vector drawings are freely
scalable over an unlimited range with no loss of
resolution. This makes vector drawings ideal for floor
plan layouts and detailed design work.
W
Windows MetaFile (.WMF) Graphic files that hold
vector drawing information, discrete points, lines, and
curves. *.WMF files are used in the Workstation
predominately for importing floor plans. Because the
*.WMF format is vector-based, the information in WMF
files can be re-sized without loss of resolution and
quality. When dealing with floor plans in the
Workstation, this is very important as it allows the floor
plan to be zoomed in without degrading resolution of
the lines. Files are identified with the extension
*.WMF.
Workstation Workstation is the standard name for a
computer running the Workstation software application.
It is possible for a Workstation PC to also run Gateway
software if the appropriate network card is also
installed.

94

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Appendix B: Details about Event Data


B.1 Event Data
NOTE: All data is current as of publication however, new events may be added in the future.

Each event within the ONYXWorks system has its own unique properties. These properties
include normal and off-normal conditions, abbreviations for the event, color codes, and the priority
of the event. Included in this index are tables that provide the information in a simplified format.

B.2 Event Priority


Priority is the most important of the event specific information because it affects which events are
annunciated by the Workstation first. Knowing the priority of events provides an understanding
about the severity of various events, and how events interrelate.
Priority is ordered in groups as defined by UL/ULC. Each event within a group has equal priority.
These groups are (from highest to lowest) Fire Alarm and Process Alarm, Supervisory and Fire
Trouble Signals, Holdup and Burglar Alarms, and Other Signals.
Each event within the ONYXWorks system has a corresponding color. This color coding is used
when displaying the event on-screen, when viewing events in history manager, and various other
applications throughout the software.
Table B.2, Event Color Coding shows each event type and its corresponding color. Keep in mind
that this lists off-normal events only. Each off-normal event has a corresponding normal event.
Every Normal discrete event within the Workstation is displayed with the color gray when in
Graphic Mode.
NOTE: Workstation default color codes are discussed here. Admin Users can customize these
color choices if required by their Authority Having Jurisdiction. Always document custom color
schemes for future reference.

Table B.1 Events By Priority (Highest Priority First)


UL Category

Off-Normal Condition

Normal Condition

Fire Alarms and Process Alarms


Alarm

Alarm Restored

Fire Alarm

Fire Alarm Restored

Fire Alarm (Non-latching)

Fire Alarm Restored

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

95

Details about Event Data

Event Priority

Table B.1 Events By Priority (Highest Priority First) (Continued)


UL Category

Off-Normal Condition

Supervisory and Fire Trouble Signals

Holdup and Burglar Alarms


(Not UL Listed)

Other Signals

96

Normal Condition

Audibles Silenced

Audibles Re-activated

Supervisory Alarm

Supervisory Normal

Pre-Alarm

Pre-Alarm Restored

Verifying for Fire Alarm

No Longer Verifying

Alert Condition

Alert Condition Restored

Fault Condition

Fault Condition Resolved

Zone Trouble

Zone Trouble Restored

Trouble

Trouble Restored

Off-Normal Condition

Returned to Normal

Loop Trouble

Loop Trouble Restored

Bad Address

Bad Address Resolved

Device Non-monitoring

Device Returned to Monitoring

Security Alarm

Security Alarm Restored

Tamper Switch Activated

Tamper Switch Restored

Door Ajar

Door Ajar Restored

Forced Entry

Forced Entry Restored

Panic Alarm

Panic Alarm Restored

Agent Release

Agent Release Off

Agent Release Abort

Agent Release Abort Off

Recent Alarm

N/A

Point Inactive

Point Active

Temperature Alarm

Temperature Normal

Ground Fault

Ground Fault Restored

AC Power Failure

AC Power Restored

Extremely Low Value

N/A

Extremely High Value

N/A

Very Low Value

N/A

Very High Value

N/A

High Value

N/A

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Event Priority

Details about Event Data

Table B.1 Events By Priority (Highest Priority First) (Continued)


UL Category
Other Signals (continued)

Off-Normal Condition

Normal Condition

Low Value

N/A

Cover Open

Cover Replaced

Out of Paper

Paper Restored

Offline

Offline Restored

Transmission Trouble

Transmission Normal

Fuse Failure

Fuse Failure Restored

Short Circuit

Circuit Restored

Open Circuit

Circuit Restored

Position Alarm

Position OK

Video Signal Loss

Video Signal Restored

Device Disabled

Device Re-enabled

Unlock

Locked

Addressable Input On

Addressable Input Off

Armed

N/A

Disarmed

N/A

Armed Away Mode

N/A

Armed Stay Mode

N/A

Program Entry

N/A

Program Exit

N/A

Armed Instant

N/A

Armed Maximum

N/A

Test Mode Activated

Test Mode Terminated

Restart

N/A

Manual Disable

Manual Enable

Schedule Disable

Schedule Enable

Manual Output On

Manual Output Off

Schedule Output On

Schedule Output Off

Reset

N/A

Panel Normal

N/A

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

97

Details about Event Data

Event Priority

Table B.2 Event Color Coding


OffNormal

Yellow

Gray

Off-Normal Event

Pre-Alarm
Verifying for Fire Alarm
Alert Condition
Soft Anti-Passback Warning
Point Inactive
Fault Condition
Temperature Alarm
Zone Trouble
Ground Fault
AC Power Failure
Trouble
Loop Trouble
Very Low Value
Very High Value
High Value
Low Value
Cover Open
Out of Paper
Transmission Trouble
Fuse Failure
Short Circuit
Open Circuit
Position Alarm
Video Signal Loss
Unlock
Program Entry
Program Exit

Offline

Off-Normal Event

OffNormal
Color
Red

Fire Alarm (Non Latching)


Alarm
Agent Release
Tamper Switch Activated
Agent Release Abort
Door Ajar
Forced Entry
Recent Alarm
Panic Alarm
Supervisory Alarm
Extremely Low Value
Extremely High Value
Addressable Input On
Restart

Blue

Security Alarm
Audibles Silenced
Off-Normal Condition
Bad Address
Device Disabled
Addressable Output On
Device Non-Monitoring
Armed
Disarmed
Armed Away Mode
Armed Stay Mode
Armed Instant
Armed Maximum
Test Mode Activated
Manual Disable
Schedule Disable
Manual Output On
Schedule Output On

B.2.1 Icon Recommendations


These guidelines will help you create custom icons with optimal appearance.

Recommended Icon

98

32 bit PNG FileWorks best for the color tinting used in alarm reporting.

256 x 256 pixels, squareImage files larger than this recommendation will require more
memory and may degrade system operation.

Gray scaleGray scale images work best, as images with color interfere with the color tinting
used in alarm reporting.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Event Priority

Details about Event Data

Table B.3 Effects of Different Icons on Alarm Reporting


Recommended Icon

Normal Status

Alarm

Trouble

Alarm

Trouble

Alarm

Trouble

Original Icon Too Dark

Normal Status
Original Icon with Color

Normal Status

Original Icon with Alarm Color

Normal Status

Alarm

Trouble

Table B.4 Effect of Non-PNG Icon File on Background


PNG File

Visible Background

Non-PNG File

Background blocked by square

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

99

Details about Event Data

Event Priority

Table B.5 Supported Image Types


File type

Comments

PNG

Recommended file type

GIF
BMP

Transparent = Magenta (Red: 255, Green: 0, Blue: 255)

WMF/EMF

Background = Magenta (Red: 255, Green: 0, Blue: 255)


Transparent = Cyan(Red:0, Green: 255, Blue:255)

Animated GIF

100

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Printer Output Format

Details about Event Data

B.3 Printer Output Format


The event printer port of the Workstation outputs each event as it is annunciated at the
Workstation. Event printer output format is determined by the output format configured in
Workstation >Options. Your event printer output could be different than the one shown below.
This example annunciation output is five lines per event. There are four lines containing device
information and status. The lines are not padded with spaces at the end, but are padded internally
for columnar separation. The fifth line is a separation bar comprised of 79 asterisks. A format
description and an example printer output is provided below.
2

3
6
4
8

5
7

Figure B.1 Printer Output Format Example


1.

Time of Alarm The time that the alarm occurred. On a local area network, this will be the
same as the reported time. On a wide area network, this time is the time the alarm occurred and
was received at the remote communications device (but not the time it was reported to the
Workstation). (40 characters padded with spaces).

2.

Time Alarm Was Reported This field reports the time at which the event was annunciated
at the Workstation. On a local area network, this time will usually be the same as the Time of
Alarm field. (40 characters not padded with spaces).

3.

Gateway This field is the Gateway ID of the gateway with the off-normal device.
(20 characters padded with spaces).

4.

Device This field is the point ID of the off-normal event.

5.

Point Type This field reports one of the standard point types. This field is 30 characters in
length. (40 characters not padded with spaces).

6.

Status Name This field reports a standard device status. For information on each different
device status. (30 characters padded with spaces).

7.

Value What this field reports according to the type of device. For example, a discrete input
will report to this field with a Value the appropriate current condition. An analog input will
list the value and units for the analog input. (50 characters not padded with spaces).

8.

Device Description This is the description of the device as defined within the Workstation.
This description is normally comprised of a 40 character device description and a 40 character
zone description that is extracted from the panel when a device reports. (80 characters not
padded with spaces).

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

101

Details about Event Data

102

Printer Output Format

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Appendix C: ONYXWorks Workstation Users Guide


The Admin User should print this information and have the copy near the Workstation so the
person who typically monitors the Workstation can refer to it.

C.1 Workstation Display Descriptions


Operating the Workstation in Text Mode displays the graphical user interface in tabular form.
Typically a Admin User does not use the Text Mode view as your monitoring interface. For more
information refer to Text Mode View on page 108.
1.

Displayed User on page 104.

2.

Main Menu on page 104.

3.

Toolbar Menu on page 104.

4.

Taskbar Menu on page 104.

5.

Overview on page 104

6.

Workstation Floorplan Area on page 105

7.

Graphic Elements Descriptions on page 105

8.

Navigation Tree on page 106.

9.

New Event on page 107

10. Acknowledged Events on page 107


11. Alarm Summary on page 107
12. Event Annunciator Icon on page 108
1
2
3
4
5

6
7
8

10

11

12

Figure C.1 Workstation Display

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

103

ONYXWorks Workstation Users Guide

Workstation Display Descriptions

C.1.1 Displayed User


The Admin User sets Security Options for you which determines your level of access to the
Workstation. For example, some accounts may not have permission to exit the Workstation or
some Main Menu selections maybe grayed out.

C.1.2 Main Menu


The Workstation software applications Main Menu when selected displays drop-down a list of
choices. If after the choice an ellipse (...) is present, then the choice will display another window
where additional action is required if you are to continue.

C.1.3 Toolbar Menu


You can identify these icons by placing the mouses cursor over the icon and reading the hint that is
displayed. The icons are used to perform the following common functions.

Previous Screen - Displays floorplan that was viewed before the current displayed floorplan.

Next Screen - Displays the next floorplan below the current floorplan in the Navigation Tree
hierarchy.

Up one level - Displays the next floorplan above the current floorplan in the Navigation Tree
hierarchy.

Print Current Screen Prints the floorplan display to the currently selected printer.

Zoom In One Level - Increases the zoom of the floor plan display by 50% (ranges from 100%
to 3700%)

Zoom Out One Level Decreases the zoom of the floor plan display by 50% (ranges from
100% to 3700%).

Zoom Full Image - Display current displayed floorplan at 100%

Show Floorplan Brings the floorplan display to the foreground, replacing any other open
dialogues.

C.1.4 Taskbar Menu


The Taskbar displays custom command icons and or an icon that corresponds to an open
Workstation software application window. The Admin User defines these custom command
buttons. Taskbar buttons display from left to right.

C.1.5 Overview
The Overview window allows you to determine their location on the currently displayed
Workstation floorplan area. It displays and indicates where on the Workstation floorplan area the
you are viewing by encompassing that viewed area in a red rectangle. The red rectangle is clicked
and dragged for repositioning the viewing area, helpful when a zoom in scale is selected for the
Workstation floorplan area. The Overview window does not display the graphic elements within it.

104

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Workstation Display Descriptions

ONYXWorks Workstation Users Guide

C.1.6 Workstation Floorplan Area


The Workstation floorplan area title identifies which area of an ONYXWorks system that is
currently being displayed on the Workstations display. The Workstation floorplan area usually has
a building floor plan that is background layer and serves as the primary source for visual feedback
the location of an off-normal event in an ONYXWorks system which corresponds to the points
(device) location in a building. The point types can be a fire alarm control panel, fire protection
devices, cameras and security devices.

C.1.7 Graphic Elements Descriptions


Point Icons
These graphic elements represent a physical addressable device on the system. Examples of point
icons are fire panels and fire protection devices. A name of the point displays above the icon and at
times its status is displayed below it. If the points status becomes off-normal, its icon will flash
and information about its status will be displayed below it.
Clicking on an icon displays a box with detailed information across the bottom of the Workstation
screen. The information reflects the current state of the associated icon.

Navicons
These graphic elements represent a method to navigate between Workstation floorplan areas to find
points or an event. They are used exclusively to find an event if in the Autonavigate feature has not
been set to autonavigate to an off-normal event.
Each Workstation floorplan area (parent) has one Navicon that hyper-links to each of its respective
subordinate (child screen) Workstation floorplan areas (refer to the Navigation Tree hierarchy).
Navicons change color to match the off-normal event that is reported to the Workstation. They are
used to locate an event on parent or child screen; follow the same colored Navicon to find an event.

Information Labels
These graphic elements represent important information for the you during monitoring. That
information can be a photograph, a text document, a video, or a sound clip. Information Labels use
an asterisk to identify them as such. One suggested use is to provide firefighters with an image of
hazardous materials stored on-site.
Factory defined and Admin User assigned control commands are available for all point icons,
navicons, and information labels. Those commands are accessed with right-clicks on its Navigation
Tree entry or right-clicks on its icon.
NOTE: Control commands are available only when you have a node control and security profile
that allows it.

NOTE: Only one Workstation can control any single system device at a given time. Taking
control of a device removes control from the previous supervisor of that device.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

105

ONYXWorks Workstation Users Guide

Workstation Display Descriptions

C.1.8 Navigation Tree


The Navigation Tree:

Has an user interface similar to Microsofts Windows Explorer.

Displays the ONYXWorks system in a structured hierarchy form.

Navigation Tree Descriptions


1.

Device screen name that is currently displayed.

2.

used to collapse Navigation Tree (Tree) and hide child screens.

3.

Node on a Workstation floorplan area; double-click-on the name of a device to display the
node and the Workstation floorplan area it is located on.

4.

+ used to expand Tree and view child screens.

5.

Pane boundary; click and hold, then drag on the boundary point to change the panes size (refer
to , "Window Pane View Changes").
1

2
3
4
5

Figure C.2 Navigation Tree Overview

106

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation Users Guide

Workstation Display Descriptions

Window Pane View Changes


1.

The Navigation, New Events, and Acknowledged Events areas can be expanded or collapsed
by clicking and holding-on and then dragging the boundaries between sections.

2.

The Overview and Alarm Summary windows can be expanded and collapsed with a click on
the arrows in its title bar.

Figure C.3 Expanding Event Areas for Viewing

C.1.9 New Event


When an event is reported to a Workstation, the Workstation will display the event information in
the New Events area and sound an audible alarm at the station. The Workstation will autonavigate to the Workstation floorplan area that has the highest priority event.
New Events are events that have been reported to and received by the Workstation but not yet
acknowledged by you. Once you acknowledge an event, the event moves to the Acknowledged
Events list.
New Events are displayed in this manner:

If the event is acknowledged at the panel Acked will be displayed prefixing the event in the
New Events list.

If the Workstation has node control of the point a colored box will display to the left of the
event in the Navigation Tree.

If the event is unreliable (meaning it was reported while a gateway or node was in fault) an *
will be displayed prefixing the event in the New Events list.

C.1.10 Acknowledged Events


Once you acknowledges an event, the event is added to the Acknowledged Events listing. The
Acknowledged Events listing only displays events that have been received by the Workstation and
have been acknowledged by you.

C.1.11 Alarm Summary


The Alarm Summary window will display a list that is a running total of new and acknowledged
events by type; they are listed in order of priority. The Alarm Summary window by default is
hidden and is revealed by clicking on the arrows adjacent to the Alarm Summary title. Clicking on
the alarm summary icons displays a list of all the points currently in that state.
Click the Print button to print alarm summaries.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

107

ONYXWorks Workstation Users Guide

Workstation Display Descriptions

C.1.12 Event Annunciator Icon


Event Annunciation Icons display in a highlighted priority related-color when an event is reported
to the Workstation. They are always visible and remain in a highlighted priority related-color until
all off-normal conditions have been resolved.
You can identify these icons by placing the mouses cursor over the icon and reading the hint that is
displayed. The following describes the types of events that are reported.

Fire - Events issued by fire protection related devices such as pull-stations, smoke detectors,
and sprinkler systems.

PreAlarm - Events that indicate that a point is close to declaring an alarm, giving the facility
manager opportunity to address the problem before an emergency develops.

Security - Events issued by security related devices such as motion detectors, glass break
detectors, and door contacts.

Supervisory - Alarms that are special alarms to indicate action that has functionally disabled a
key device (for either fire protection or security). An example of this is the event generated if
the water valve is shut off for a sprinkler system.

Troubles - Events that indicate a functional problem with a device on the network. Examples
of trouble events include a device or Workstation going off-line, a battery low or no power
event, a dirty head on a smoke detector, etc.

Advise - A condition that is an administrative event, internal to the ONYXWorks system.


This is not a life-safety or security event, but an internal warning of a condition that may need
attention, such as the history file reaching 100,000 entries.

Disabled - Indicates all disabled points on the system.

C.1.13 Other - Indicates input on, output on events.


Workstation Display Options
The Admin User setups how the Workstation graphical user interface usually is displayed.
Typically you do not require the feature of toggling between Graphics Mode and Text Mode. The
Admin User may have not allowed you access to this Main Menu choice.

Graphics Mode View


In Graphics Mode the Workstation displays an ONYXWorks system as floor plans, point icons,
and the systems event information in window pane form.

Text Mode View


The Text Mode view expands the Workstations New Events and Acknowledged Events
information in tabular form across the entire Workstation display. The Detailed Events/IM/IRM
are displayed. Just like in Graphics mode, when in Text Mode events will be dynamically updated
as they occur. The Panel Ack column will be displayed with check-boxes to indicate the event is
known to be acknowledged at the panel.

108

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation Users Guide

Daily Operation

Figure C.4 Text Mode Displayed on the Workstation


Transition from Graphics Mode to Text Mode and vice-versa is accomplished by accessing the
View menu. When the Workstation is in Graphics Mode, the View menu will display Text Mode.
When the Workstation is in Text Mode, the View menu will display Graphics Mode. In addition
there is a Disabled icon.
The same color-coding used to reflect status is used in both modes. The colors will correspond to
status class:

C.2 Daily Operation


C.2.1 Logging into the Workstation
The Admin User must have created your profile that will allow you to log into the Workstation.
When you log in, the Workstation software automatically logs out the previous User.

User Login Procedure


Step 1. On the Workstation software applications Main Menu select File >Login. The User
Login window displays.
Step 2. Click-on to highlight the desired User name in the list of Available Users.
Step 3. Type the Users password.
ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

109

ONYXWorks Workstation Users Guide

Daily Operation

Step 4. Click-on OK button. The name of the current User appears at the top right of the
Workstation floorplan area.

User Log Out Procedure


Step 1. On the Workstation software applications Main Menu select File >Login.
Step 2. On the User Login window, click-on the <current Users name> in the list of Available
Users.
Step 3. Click-on Logout button. The Workstation will login the internal logged out account which
has no permissions other than allowing someone to log in. This login change ensures the
ONYXWorks system will continue to be monitored.

110

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation Users Guide

Daily Operation

C.2.2 Interpreting Events on the Workstations User Interface


What Happens When a New Event Occurs
When an event occurs in the ONYXWorks system a Workstation receives information about the
event and the following occurs at the Workstation:
1.

In the New Events window, the event is added to a list.

2.

In the Navigation Tree, a colored box will display adjacent to the level(s) with the event(s).
Priority of the event(s) is displayed by color (red for fire, blue for security, yellow for trouble,
etc.).

3.

The auto-navigate feature will display the Workstation floorplan area and the addressable
devices icon experiencing the event and display it as a priority color. The software will
attempt to center the point icon in the window. An animated box around an icon indicates this
is the highest priority event.

4.

In the Alarm Summary window the alarm will be added to its list.

5.

The corresponding Alarm Summary Icon will be displayed as a priority color.

6.

A sound is emitted indicating the event(s).

Figure C.5 Event Windows

Point Icon Selection


Clicking a points icon will display a window across the bottom of the screen display that has
details about the point. The windows title bar will be colored coded based on the current state of
the associated icon.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

111

ONYXWorks Workstation Users Guide

Daily Operation

What Happens When New Events are Acknowledged


When a paired event is acknowledged at the Workstation the following occurs:

Fire Control Center Mode: In the New Events window, the acknowledged event moves to the
list in the Acknowledged Events window.
If and when a new event is acknowledged at the FACP, the FACP acknowledged event will
automatically move from list to list at the Workstation.

Supervisor Station Mode: In the New Events window, the acknowledged event moves to the
list in the Acknowledged Events window.

On the Workstation floorplan area, the point icon will stop flashing but remain in its
appropriate off-normal priority color.

The sound indicating the new event will stop playing, but only if there are no other new events
in the New Events box. Sound continues to be emitted until all events in the New Events box
have been acknowledged at the Workstation.

NOTE: If an event is acknowledged at a FACP and the Workstation is in Activate Graphics Mode
as a Supervising Station, Acked will be added to the beginning of the status, but the event will
remain in the New Events window. The event will still need to be acknowledged at the
Workstation. Once acknowledged at the Workstation the acknowledged event will move from the
New Events window to the Acknowledged Events window and remain there until it returns to
normal. Acked will remain at the beginning of the status.

112

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation Users Guide

Daily Operation

What Happens When Acknowledged New Events Return to Normal


When the event returns to normal the following occurs on the Workstation.

Fire Control Mode only: In the New Events window, The off normal event vanishes from the
list.

Supervisor Station Mode: In the New Events window, the return to normal event remains in the
list.

In the Workstation floorplan area, the point icon returns to its normal condition color.

In the Alarm Summary window, the Alarm Counter list will decrement.

The corresponding Alarm Summary Icon returns to its normal condition color, provided there
are no other off-normal events of that type on the system.

In the Navigation Tree, the adjacent colored box will vanish, provided there are no other offnormal conditions on those Workstation floorplan areas.

The sound should not be sounding from the Workstation. If a sound is still being emitted then
more events are present in the system.

FCC Mode or Supervising Mode Event Handling Comparison


Events are displayed the same way whether the Workstation is running in Fire Control Center
(FCC) mode or Supervising Station mode. For example:

If the event is acknowledged at the panel Acked will be displayed prefixing the event in the
New Events list.

If the Workstation has node control of the point, a colored box appears to the left of the event
in the Navigation Tree.

If the event is unreliable (meaning it was reported while a gateway or node was in fault) an
asterisk(*) will be displayed prefixing the event in the New Events list.

However the Workstation handles return-to-normal conditions and acknowledgements in a


significantly different way, depending on operating mode.

Table C.1 FCC Mode and Supervising Mode Comparison


FCC
Mode

Supervising
Mode

If an event is acknowledged at the Fire Alarm Control Panel (FACP) it is


acknowledged at the Workstation

YES

NO

If an event is acknowledged at the Workstation it is acknowledged at the Fire


Alarm Control Panel (FACP)

YES*

YES*

When an event returns to a normal state it is removed from the New Event
listing

YES

NO

When an event returns to a normal state it is acknowledged at the FACP

YES

NO

Action

* If the logged in User has the Security Profile to do so.

C.2.3 Managing Events


An event is defined as any change in the status of a device or a transfer of information between a
device and the Workstation or between two devices. Some of these events are considered
background and housekeeping events and are not seen by you on the Workstations display. Those
background and housekeeping events can be viewed with the View >Background Activation
command. The View >Armed/Disarmed Points command may be used to view events also.
ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

113

ONYXWorks Workstation Users Guide

Daily Operation

The events that are of primary concern to you are off-normal events. An off-normal event indicates
activity or change that requires your attention and/or response. Refer to Appendix B, Details
about Event Data for information about events.

New Events Priority Rating


In the New Events window, new events are listed according to the date and time that they occurred
and they are further defined by the highest to lowest priority of the event.
For example:

A fire alarm event with the same time and date as a trouble event will display higher in the
list.

A fire alarm event with the more recent date and time will be listed above a fire alarm
event with older date and time.

Off-Normal Events

A change in condition or activation of a monitoring device (Motion Detectors, Smoke Alarms,


etc.).

A door is ajar.

A node becomes disconnected from the network.

A Monitoring device is disconnected from its monitoring node.

Single Off-Normal Events


A single event that, once it is received, leaves the sending device in the same condition that it was
in originally. Single events do not represent a lasting change of condition. A single event is
removed from the Acknowledged Events list after it is acknowledged.
Paired Off-Normal Events
If a single event is paired with another event, one event can move to the Acknowledged Events list
after it is acknowledged, but it remains in the Acknowledged Events list until its paired event is
acknowledged. Once an acknowledge to the related pair events is performed, both events are
removed from New Events and added to the Acknowledged Events list.
Fire alarms actually latch a FACP and require that the panel be reset. Therefore, alarm states will
remain in the New Event list until the fire alarm control panel (FACP) associated with the alarm
states it is reset. Alarm-off states that have been acknowledged will clear once the panel is reset
and all the panels devices have returned to a normal condition.

C.2.4 Acknowledge a New Event Procedures


Acknowledge an Event in the New Events
To acknowledge events, highlight the event in the Navigation Tree and then click-on the
appropriate New Events icon (i.e. ().
NOTE: Supervision Station Mode Only. When an event is acknowledged at a Workstation the
event is only acknowledged locally. That acknowledgement does not affect the event status or
device on other Workstations on the network unless the acknowledging Workstation has control
of that device.

Block Acknowledge Events (FCC Control Mode Only)


To acknowledge multiple events, highlight the events in the Navigation Tree and then click-on the
appropriate New Events icon (i.e. ().
Troubles, supervisory, and security events can be block-acknowledged through a NFN Gateway.
Fire Alarm and Hold-up events require individual acknowledgement.
114

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

ONYXWorks Workstation Users Guide

Daily Operation

Point Right Click Choices to Respond to Events


Addressable Devices have right-click menus that provide you with a list of choices that are device
specific information and used to control a device. The choices that appear in menu depends on the
type of device, the situation, and your Security Option permissions. The following descriptions are
provided for an overview of some right-click menus options:

<Point Description> Selecting the top line Device Description displays window which
shows the devices provided description. This description may have been entered by the
Admin User or the description was read from a panel on the system.

Enter User Response This choice displays a window with predefined User responses for
reporting various conditions and operations related to the device. There is also a custom field
for text-entry if a unique situation occurs. The selected response is logged to the history file.

History of Device Opens the History Manager window that displays the history information
relating to the selected device.

View or Play: Text, Bitmap, Video, Audio Only if the device has an asterisk displayed
adjacent to a choice, it has linked media and an choice will also display in the list of choices.

Zoom This choice allow the selection of various zoom levels and a return to the previous
zoom level choice. When a zoom is selected, the zoom will center on the current mouse
pointer location.

An asterisk next to a choice indicates that another Workstation has control of the device; a
Workstation must have control of a device to perform a command for the device.

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

115

ONYXWorks Workstation Users Guide

116

Daily Operation

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Index
A
About 57
About Events 87
Acknowledged Events 107
How to 114
Add Node 35
Admin 85
Advise Events 108
Alarm Summary 107
Automatically Backup History 49

C
Canada - FCC 76
Canada - FCC + DCC 76
Canada - Supervising Station Mode 76
color-coding 109
Control Profiles
Defining, 39
Current Operator Button 31
Custom 56

Extract Descriptions From Panel 48

F
FCC 76
Fire Alarm 108

G
gateway
redundant 33
Graphic Elements 105
Graphics Mode 86, 108
Guidance Text 89

H
Hardware Security 85
History Backup 49
History Manager 64
History of Device 89, 115

I
D
Database Management 63
Delete 35

E
Enable E-mails and Pagers 49
Enter Operator Response 89, 115
Ethernet
Line Impedance 15
Max Distance 15
Ethernet Network
about 11
Event Annunciator Icon 108
Event Data 95
Event Handling 87
Event Monitoring Profiles 39
Event Priority 95
Event Types 87
Advise Events 108
Fire Alarms 87, 108
PreAlarm 108
Security Alarms 87, 108
Supervisory Alarms 87, 108
Trouble Alarms 108
Events
Paired 114
Single 114
Events By Priority 95
Events Priority Rating 114
Exit Workstation 28

Icon Label 48
Import Database 35
Information Labels 105
Installation
Environmental Conditions 12

L
Line Impedance 15
listed for the purpose 11
Login 31
Logout 110

M
Macro Activated on Alarm 50
Main Screen 103
Max Distance 15

N
Navicons 105
Navigation 106
New Event 107
NFN Gateway
Advanced System Architecture 30

O
Overview window 104

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

117

Index

User Response 49

Paired Events 114


Play Audio 115
Play Text 115
Point Description 115
Point Icons 105
Point Label 47
PreAlarm 108
Printer Output Format 101
Printer Setup 19, 41
Event, 20
Screen/Report, 19, 41
Windows, 20
Properties 35
Proprietary Supervising Station 11

V
VeriFire Tools upgrade issue 12
View
Graphics Mode 108
Text Mode 108
View Bitmap 115
View Graphics Mode 61
View Video 115

W
Workstation Screen 105

Z
R

Zoom 115

Redundant Gateway 33
Rename 35
Reordering Device Screens 60
Repairing Workstation software 12

S
Security 108
Security Options 104
Software Security 85
Shut Down PC on Workstation Shutdown 48
Single Events 114
Software Security 85
Supervising Station Mode 76
Supervisory 108
Suppress Automatic Device Icon Creation 48

T
Terminology 91, 92, 93
Text Mode 62, 103, 108
Troubles 108
Troubleshooting
Repairing Workstation software 12
VeriFire Tools upgrades 12

U
ULC 11
Unacked Event Supervision Configuration 49
Unacked Event Timeout 49
Unacknowledging Events 86
Uninterrupted Power Supply 21
Upgrades
VeriFire Tools upgrade issue 12
UPS Supervision 21
USB
Line Impedance 15
Max Distance 15
User Login 31, 109
118

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

Manufacturer Warranties and Limitation of Liability


Manufacturer Warranties. Subject to the limitations set forth herein,
Manufacturer warrants that the Products manufactured by it in its
Northford, Connecticut facility and sold by it to its authorized
Distributors shall be free, under normal use and service, from defects
in material and workmanship for a period of thirty six months (36)
months from the date of manufacture (effective Jan. 1, 2009). The
Products manufactured and sold by Manufacturer are date stamped at
the time of production. Manufacturer does not warrant Products that
are not manufactured by it in its Northford, Connecticut facility but
assigns to its Distributor, to the extent possible, any warranty offered
by the manufacturer of such product. This warranty shall be void if a
Product is altered, serviced or repaired by anyone other than
Manufacturer or its authorized Distributors. This warranty shall also
be void if there is a failure to maintain the Products and the systems in
which they operate in proper working conditions.
MANUFACTURER MAKES NO FURTHER WARRANTIES, AND
DISCLAIMS ANY AND ALL OTHER WARRANTIES, EITHER
EXPRESSED OR IMPLIED, WITH RESPECT TO THE PRODUCTS,
TRADEMARKS, PROGRAMS AND SERVICES RENDERED BY
MANUFACTURER
INCLUDING
WITHOUT
LIMITATION,
INFRINGEMENT, TITLE, MERCHANTABILITY, OR FITNESS FOR
ANY PARTICULAR PURPOSE. MANUFACTURER SHALL NOT BE
LIABLE FOR ANY PERSONAL INJURY OR DEATH WHICH MAY
ARISE IN THE COURSE OF, OR AS A RESULT OF, PERSONAL,
COMMERCIAL OR INDUSTRIAL USES OF ITS PRODUCTS.
This document constitutes the only warranty made by Manufacturer
with respect to its products and replaces all previous warranties and is
the only warranty made by Manufacturer. No increase or alteration,
written or verbal, of the obligation of this warranty is authorized.
Manufacturer does not represent that its products will prevent any loss
by fire or otherwise.
Warranty Claims.
Manufacturer shall replace or repair, at
Manufacturer's discretion, each part returned by its authorized
Distributor and acknowledged by Manufacturer to be defective,
provided that such part shall have been returned to Manufacturer with
all charges prepaid and the authorized Distributor has completed
Manufacturer's Return Material Authorization form. The replacement
part shall come from Manufacturer's stock and may be new or
refurbished. THE FOREGOING IS DISTRIBUTOR'S SOLE AND
EXCLUSIVE REMEDY IN THE EVENT OF A WARRANTY CLAIM.

Warn-HL-08-2009.fm

ONYXWorks Workstation Installation & Operation Manual - P/N: 52342:Rev: F1 6/22/12

119

World Headquarters
12 Clintonville Road
Northford, CT 06472-1610 USA
203-484-7161
fax 203-484-7118
www.notifier.com

Potrebbero piacerti anche