Configurator

Configurator
WIN-911 Configurator
Table of Contents
Introduction ................................................................................................................................ 1
Getting Started ....................................................................................................................... 1
What is WIN-911? ............................................................................................................... 1
What's New ......................................................................................................................... 2
Hardware Requirements ..................................................................................................... 3
Licensing Options ................................................................................................................... 6
Standard Products .............................................................................................................. 6
Feature Upgrades ............................................................................................................... 8
Installation .............................................................................................................................10
Installing WIN-911 V7 ........................................................................................................10
Installing WIN-911 Premium Voice .....................................................................................13
Installing WEB-911 Services ..............................................................................................14
Installing WEB-911 XTools Client ......................................................................................17
Installing Mobile-911 ..........................................................................................................20
Upgrading WIN-911 ...............................................................................................................24
Upgrading to a New Version ..............................................................................................24
Adding Feature Upgrades ..................................................................................................25
WIN-911 Licensing and CopyShield Administration ...............................................................26
Request a License .............................................................................................................26
Import a License ................................................................................................................30
WIN-911 Overview ....................................................................................................................33
System Architecture ..............................................................................................................33
What is the Direct Connect?...............................................................................................33
System Components ..........................................................................................................34
Remote Alarm Notification .....................................................................................................45
The Sound Clips ................................................................................................................45
Sound Source ....................................................................................................................47
Hardware ...........................................................................................................................48
iii
WIN-911 Configurator
Notification Methods ..........................................................................................................51
Configurator Basics ...................................................................................................................61
The WIN-911 Configuration Window .....................................................................................61
Common Dialog Boxes ..........................................................................................................62
Definition Dialog Boxes .........................................................................................................63
Sound Button.........................................................................................................................64
Sound Button .....................................................................................................................64
Save Runtime Text String ..................................................................................................65
Convert Text to Wave File ..................................................................................................66
Edit Wave File Dialog .........................................................................................................68
Configurator Menu ....................................................................................................................69
File ........................................................................................................................................69
Mode .....................................................................................................................................73
Global ....................................................................................................................................76
Tools .....................................................................................................................................78
Help .......................................................................................................................................82
Global Menus ............................................................................................................................85
Global Menu ..........................................................................................................................85
Common Sounds ...................................................................................................................86
Common Sounds ...............................................................................................................86
Common ............................................................................................................................88
911 Only ............................................................................................................................90
411 Only ............................................................................................................................92
411 Numbers .....................................................................................................................94
Conditions ..........................................................................................................................95
Prefixes ..............................................................................................................................97
States ................................................................................................................................98
Controls .............................................................................................................................99
Monitor Definition ................................................................................................................103
iv
Table of Contents
Monitor Definition .............................................................................................................103
Appearance .....................................................................................................................104
Acknowledge ...................................................................................................................106
Colors ..............................................................................................................................109
Format .............................................................................................................................110
Printer Definition ..................................................................................................................113
Printer Definition ..............................................................................................................113
Port ..................................................................................................................................114
Format .............................................................................................................................115
Pager Definition ...................................................................................................................118
Pager Definition ...............................................................................................................118
Ports ................................................................................................................................119
Commands ......................................................................................................................121
Connect ...........................................................................................................................123
Failed ...............................................................................................................................124
Format .............................................................................................................................125
Voice Card Definition ...........................................................................................................129
Voice Card Definition .......................................................................................................129
Voice................................................................................................................................130
Timing ..............................................................................................................................131
Control .............................................................................................................................132
SMS Definition.....................................................................................................................133
SMS Definition .................................................................................................................133
Port ..................................................................................................................................134
Message Format ..............................................................................................................137
Ack Format ......................................................................................................................142
E-Mail Definition ..................................................................................................................147
E-Mail Definition ...............................................................................................................147
SMTP Account .................................................................................................................148
v
WIN-911 Configurator
Authentication ..................................................................................................................150
Format .............................................................................................................................152
Logger Definition .................................................................................................................156
Logger Definition ..............................................................................................................156
Daily TXT .........................................................................................................................157
Monthly MDB ...................................................................................................................161
Data Poke Definition ............................................................................................................163
Data Poke Definition ........................................................................................................163
System Health .................................................................................................................164
Voice Health ....................................................................................................................165
Pager Health ....................................................................................................................167
Group...............................................................................................................................169
Format .............................................................................................................................170
IP Definition .........................................................................................................................173
IP Definition .....................................................................................................................173
Connection Settings .........................................................................................................174
Protocol ...........................................................................................................................177
Format .............................................................................................................................179
Options ................................................................................................................................184
Options ............................................................................................................................184
Paths ...............................................................................................................................185
Timing ..............................................................................................................................186
411...................................................................................................................................188
Initialization ......................................................................................................................190
Advanced .........................................................................................................................192
FIX ...................................................................................................................................195
RSView SE ......................................................................................................................197
Wonderware ....................................................................................................................199
Configuration Menus ...............................................................................................................201
vi
Table of Contents
Configure Menu ...................................................................................................................201
Schedule Definitions ............................................................................................................202
Phonebook ..........................................................................................................................203
Phonebook.......................................................................................................................203
Phonebook Entry to Edit ..................................................................................................204
Name Definition ...............................................................................................................205
Connection Definition .......................................................................................................207
Data Source Definitions .......................................................................................................210
Group Definitions .................................................................................................................212
Group Definitions .............................................................................................................212
Base Definition .................................................................................................................214
Contact List ......................................................................................................................216
Contact Delays ................................................................................................................217
Group Poke......................................................................................................................219
Sound ..............................................................................................................................222
Filter Definitions...................................................................................................................224
Filter Definition .................................................................................................................224
Base Definition .................................................................................................................226
Setup ...............................................................................................................................228
Tag Sound .......................................................................................................................230
Digital Sound ...................................................................................................................231
Analog Sound ..................................................................................................................232
Digital Definitions .................................................................................................................233
Digital Definition ...............................................................................................................233
Base Definition .................................................................................................................235
Alarm Conditions..............................................................................................................237
Sounds ............................................................................................................................239
Changeable .....................................................................................................................240
Analog Definitions ...............................................................................................................241
vii
WIN-911 Configurator
Analog Definition ..............................................................................................................241
Base Definition .................................................................................................................243
Conversion.......................................................................................................................245
Alarm Limits .....................................................................................................................248
Sounds ............................................................................................................................250
Changeable .....................................................................................................................252
Watchdog Timer Definitions.................................................................................................253
Watchdog Timer Definition ...............................................................................................253
Base Definition .................................................................................................................255
Alarm Conditions..............................................................................................................256
Sounds ............................................................................................................................258
WIN-411 Reports .................................................................................................................259
Overview ..........................................................................................................................259
Prerequisites ....................................................................................................................260
The Audio ........................................................................................................................262
411 Options .....................................................................................................................263
Voice Report Definitions...................................................................................................264
SMS Report Definitions ....................................................................................................269
WIN-911 Runtime ...................................................................................................................273
Scan & Alarm Operation ......................................................................................................273
Startup.................................................................................................................................275
Shutdown ............................................................................................................................276
Bypassing Alarms ................................................................................................................277
Dialout Override ..................................................................................................................279
The WIN-911 Alarm Monitor ................................................................................................281
Manual Messenger ..............................................................................................................286
Alarm Logger .......................................................................................................................288
Alarm Log Manager .............................................................................................................289
viii
Introduction
Getting Started
What is WIN-911?
WIN-911 is the most proven and advanced alarm notification software suite available for
the automation industry. Capable of using standard telephone lines, cellular networks and
Internet systems, WIN-911 can reach you wherever you are. After an alarm is detected
from your automated process, WIN-911 will notify a list of users about the alarm condition
with an SMS, e-mail, page or voice call. In addition to simple notification, WIN-911 allows
users to interact with your SCADA/HMI by accepting alarm acknowledgements and
requests for report data. WIN-911 interfaces with OPC DA, DDE servers as well as with
GE's iFIX, FactoryTalk View ME, FactoryTalk View A&E, RSView SE, RSView32,
Wonderware's InTouch or Archestra System Platform.
WIN-911 has three standard package offerings: Pro, Basic, and Lite. WIN-911 Lite allows
users to configure 24 digital alarms and notify users through a single notification method.
The Basic version allows users to send e-mails, pages and one-way text messages. It has
no limit on the number of configurable alarms and supports unlimited ME Direct Connect
alarms. WIN-911 Pro supports all of the features of the Basic version in addition to twoway text messages and voice calls. See the Standard Products section for details.
1
WIN-911 Configurator
What's New
Specter Instruments is pleased to introduce the following Additions to WIN-911:
2
•
FactoryTalk View ME Direct Connect
•
Mobile-911 View
•
911Heath
WIN-911 Overview
Hardware Requirements
A system with at least a Pentium 4 processor running at 2.1 GHz and with 2 GB of
memory is recommended. A display resolution of 800x600 or greater is required. Your
system may require additional memory if other programs are to be run simultaneously.
One gigabyte of free disk space is required. Be aware that wave files require 11 to 44
kilobytes of storage per second of playtime.
The following operating systems are supported by our products.
Product
Windows
2003 SP1
Windows
2008
Windows
XP SP2
Windows
7
Windows
CE
WIN-911
Yes
Yes
Yes
Yes
No
WEB-911
Services
Yes
Yes
Yes*1
Yes
No
WEB-911
XTools
Yes
Yes
Yes
Yes
No
Mobile911
Server
Yes
Yes
Yes
Yes
No
WIN-911
ME
Alarming
Yes
Yes
Yes
Yes
No
WIN-911
ME
Alarming
CE
No
No
No
No
Yes
1. XP Home is not supported.
Dial-out paging requires a dedicated data modem and phone line. Voice calls require
either a compatible TAPI modem or a Dialogic Telephonic Card and a dedicated analog
voice line. When doing paging and voice notifications on the same system, two dedicated
lines are strongly recommended. Failure to place each piece of hardware on a dedicated
line may delay or prevent notification.
SMS notification requires a compatible GSM or CDMA modem with a text messaging
plan.
If alarm history printing is desired, a dedicated printer port and printer are required. A
simple printer should suffice since no graphics are used. Specter Instruments
recommends that a dot matrix printer be used, or similar such device capable of printing a
"line-at-a-time" as opposed to one that requires an entire page be defined before it will
begin to print (such as lasers and ink-jets).
3
WIN-911 Configurator
Note: When the WIN-911 Alarm Printer owns a printer, no other task can access it. The
Alarm Printer does not use the Windows device drivers for printing; printing is done
through standard ASCII output. Other Printing tasks require a separate printer port and
printer.
WEB-911 XTools require Microsoft .NET 4.0 and Internet Information Services to be on
the WIN-911 server machine. Microsoft .NET 4.0 must be installed on all WEB-911
XTools client machines. See, “Installing WEB-911 Services.”
Mobile-911 Server requires Microsoft .NET 4.0 and may require Internet Information
Services if installing Mobile View. Mobile-911 Server is not required to be installed on the
same machine as WIN-911. Mobile-911 Server may also require an Internet connection.
4
WIN-911 Overview
Software Maintenance and Support
Registered users are given a Software Maintenance and Support number when the
software is unlocked. This Software Maintenance number is required to receive
telephone and email support.
For telephone support call Specter Instruments at 512-326-1011 x3 or toll free in the US
and Canada at 1-800-331-8740 x3, and have your Software Maintenance number ready.
Support hours are Monday through Friday, 8:00 AM to 5:00 PM (GMT -06:00) Central
Time.
Telephone support, email support and relocks after the expiration of the support program
will require renewing your Software Maintenance agreement. Email support will be
directed through your Software Maintenance and Support page at:
www.specterinstruments.com menu option Support | Software Maintenance.
Installation guides, informational documentation, as well as solutions to common
problems can be found in the Knowledgebase under the Support menu option.
In addition to technical support, participants are entitled to software version upgrades as
they become available, relocks, as well as software newsletters with updates.
To renew your Software Maintenance and Support agreement call Specter Instruments
Sales at 512- 326-1011 x2 or toll free in the US and Canada at 1-800-331-8740 x2.
5
WIN-911 Configurator
Licensing Options
Standard Products
The WIN-911 software package can be licensed to any one of the three Standard
Products listed below. See the 'WIN-911 V7 Price Sheet' for details.
WIN-911/Basic
WIN-911 Alarm Software for 1-way alarm notification will allow you to:
•
•
•
•
•
•
•
•
•
•
•
Complement and enhance any Windows 7, Server 2008, XP, Server 2003, or
2000 compliant application program by giving it alarm and reporting capabilities.
Notify personnel using e-mail, Paging and 1-way SMS.
Utilize the Windows multimedia capability to alert users of out-of-tolerance
conditions.
Easily create both sound and visual messages and associate these with values
found in your HMI/SCADA package and/or Windows OPC and DDE.
Report alarms on screen with audio alert sounds (including speech) and through
e-mail, pages, and SMS messages.
Group and classify alarms (including priority levels), allowing different action
responses as your needs dictate.
Alert users if servers or source of data becomes disconnected or inoperable.
Sort and view alarm data by any field (date, priority, group, tag name, etc.) at
runtime with the Alarm Log Manager formatted alarm logger.
Alert HMI and/or other applications of WIN-911's operational status by serving a
constantly changing “heartbeat” via WIN-911's System Health Poke.
Alert HMI and/or other applications of WIN-911's paging modules operational
status.
Supports the unlimited ME Direct Connect option.
WIN-911/PRO
WIN-911 Alarm Software for 1-way and 2-way alarm notification will also allow you to:
•
•
•
•
•
•
•
Notify and acknowledge alarms by telephone/voice dial-up.
Acknowledge alarms by replying with an SMS text message.
Modify existing WIN-911 configurations on the fly from a networked location.
Change the current state of WIN-911 from a networked location.
Offers professional sounding voices as an alternative to the standard Microsoft
choices.
Inquire of other plant conditions using WIN-411 after WIN-911 has reported an
out-of-tolerance alarm.
Call the computer at any time from a touch-tone telephone to check on current
operating conditions.
6
WIN-911 Overview
•
•
•
Change any digital or analog value from a touch-tone telephone. (Changes are
only possible if the configuration allows.) The following security is available for
selecting a point to change:
1. Special Access Code for changes per user.
2. Selection of a numeric password for each point to change.
3. High/Low limits for analog changes for individual points.
4. Confirmation of intended change of value prior to the actual change.
5. Watchdogs that can prevent access to reports on data source loss.
Supports state-of-the-art performance in voice technology for alarm and report
annunciation. Variable rate and pitch control allows fine-tuning of the audio to
match exact user needs.
Supports the unlimited ME Direct Connect option.
WIN-911/L
WIN-911 Lite will allow you WIN-911 PRO functionality with the following restrictions:
•
•
•
•
•
•
Alarms can accommodate a total of 24 digital and unlimited watchdog alarms.
Filter and Analog alarms are not supported in Lite Mode.
User can select a single type of remote notification, such as: Voice Telephony, 2way SMS, Numeric or Alphanumeric pagers, Voice Pagers, or E-Mail.
Lite mode does not include WIN-411 reporting capability, but users can
acknowledge alarms from the voice telephony or the 2-way SMS connection.
The computer/voice telephony interface must be a TAPI Voice Modem.
Premium Voice is not included.
XTools are not supported.
7
WIN-911 Configurator
Feature Upgrades
The following Feature Upgrades may be purchased and licensed in addition to some of
the Standard Products. See the 'WIN-911 V7 Price Sheet' for details.
WIN-911/FT
WIN-911 FactoryTalk Alarm and Events Client offers a seamless connection to
FactoryTalk's Alarm & Event servers:
•
Subscribes to FactoryTalk Alarm and Events based on a user defined filter criteria.
•
Alarm properties and configuration are maintained at the PLC level, instead of in
WIN-911.
WIN-911/ME
WIN-911 ME Direct Connect offers a seamless connection to FactoryTalk View ME and
PanelView Plus CE.
•
Subscribes WIN-911 to WIN-911 ME Alarming Control ActiveX Object.
•
WIN=911 can be deployed on a local ME platform or on a remotely located
platform with network access to the ME platform.
•
Alarm properties are maintained at within ME Station level, instead of in WIN-911.
WIN-911/PV
WIN-911 Premium Voice offers both male and female professional sounding voices as an
alternative to the standard Microsoft choices:
•
The Premium Voice package includes three new text-to-speech engines: Cepstral
Diane, Cepstral David, and Cepstral Callie.
•
The Premium Voice package also allows the user to adjust the Rate and Pitch of
the premium voice.
•
SAPI 5.0 or SAPI 5.1 speech engine can be used with WIN-911's Text-to-Speech.
WEB-911 XTools
WEB-911 XTools is a suite of ActiveX controls that allow you to modify existing WIN-911
configurations on the fly including:
8
•
A networked solution to edit Contacts, Schedules, and Notification Methods by
leveraging Microsoft .NET and Internet Information Services.
•
A networked solution for switching WIN-911 between an Active and Standby state.
WIN-911 Overview
•
The capability to install the XTools client in any ActiveX container, including most
SCADA nodes. The XTools client also supports Windows Vista and Windows
Server 2008.
Mobile-911 V2
Mobile-911v2 is a smart phone application that allows for powerful organization of multiple
alarm messages and provides a convenient way to acknowledge each alarm back to
WIN-911.
•
Mobile-911v2 is compatible with Apple iOS, Google Android and a version is
planned for Blackberry devices.
•
Mobile-911v2 pushes alarms to your mobile device over Apple’s Push Notification
service or Google’s Cloud to Device Messaging Service.
•
An Internet connection is required on both your Mobile-911 Server machine and
your mobile device.
•
MobileView displays alarms in an alarm summary accessed through a web
browser using a secure log in. This allows the user to access and acknowledge
alarms from anywhere that has an Internet connection.
9
WIN-911 Configurator
Installation
Installing WIN-911 V7
Insert the WIN-911 V7 Alarm Notification Software CD.
Select WIN-911.
Click, Next. If prompted to install .NET 4.0 follow the on screen instructions. Then
continue through the License Agreement and Customer Information.
10
WIN-911 Overview
Select Typical to run the default installation. This will install to the default location
C:\Program Files\Specter Instruments\WIN-911 V7. The following program features will
be installed: WIN-911 V7, Tools, and Application Demos.
11
WIN-911 Configurator
Select *LITE* Mode to run the default installation with LITE mode limitations.
Select Custom to change any of the default installation settings, such as the WIN-911
install path.
Select Next, click Install, then Finish.
Note: WIN-911 V7 is fully functional for a 30-day DEMO period from the time of
installation. After the DEMO period expires WIN-911 must be licensed. See, 'WIN-911
Licensing and CopyShield Administration' for details.
12
WIN-911 Overview
Installing WIN-911 Premium Voice
Insert the Cepstral Version 4.1.4 Premium Voice Install CD. This disk should be included
with your WIN-911 V7 package.
To install the voice for Callie, browse the CD and run the install named:
\Callie\Cepstral_Callie_windows_4.1.4.msi
To install the voice for David, browse the CD and run the install named:
\David\Cepstral_David_windows_4.1.4.msi
To install the voice for Diane, browse the CD and run the install named:
\Diane\Cepstral_Diane_windows_4.1.4.msi
Note: WIN-911 Premium Voices are operational during the DEMO period. After the WIN911 DEMO period expires the WIN-911 Premium Voices must be licensed. See, 'WIN-911
Feature Upgrade' for details.
13
WIN-911 Configurator
Installing WEB-911 Services
WEB-911 Services requires WIN-911 Version 7.13.00 to be installed first. It also requires
Internet Information Services (IIS) and Microsoft Framework .NET 4.0.
IIS must be installed prior to installing WEB-911 Services. IIS can be found in
Administrative Tools. If IIS is not installed, run the IIS install from Add or Remove
Programs -> Add/Remove Windows Components. The operating system install disk is
required to complete the IIS installation.
Microsoft Framework .NET 4.0, if installed, can be found in Add or Remove Programs. If
.NET 4.0 is not installed, WEB-911 Services will install it for you.
Insert the WIN-911 V7 Alarm Notification Software CD.
Select WEB-911 Services. If prompted to install .NET 4.0 follow the on screen
instructions.
14
WIN-911 Overview
Click, Next. Continue through the License Agreement.
15
WIN-911 Configurator
Click Next to continue with the default path. Select Change… if you would like to use a
custom path, and then click Next.
Click Install, then Finish.
Note: WEB-911 Services will run in a 30-day DEMO period from the time it is installed.
After the WEB-911 Service DEMO period expires WEB-911 Services must be licensed.
See, 'WIN-911 Feature Upgrade' for details.
16
WIN-911 Overview
Installing WEB-911 XTools Client
The WEB-911 XTools Client requires Microsoft Framework .NET 4.0. If installed, it can
be found in Add or Remove Programs. If .NET 4.0 Framework is not installed, WEB-911
XTools Client will direct you to the install
The WEB-911 XTools Client can be installed on any machine on the network. The
XTools controls can be inserted into any ActiveX container.
Insert the WIN-911 V7 Alarm Notification Software CD.
Select XTools Client. If prompted to install .NET 4.0 click Yes.
17
WIN-911 Configurator
Click Next. Continue through the License Agreement.
18
WIN-911 Overview
Click Next to continue with the default path. Select Change… if you would like to use a
custom path, and then click Next.
Click Install.
The WEB-911 XTools Options window allows the user to configure the location of the
server. Click Save Changes and Exit to apply your changes. Then click Finish
Note: WEB-911 Services will run in a 30-day DEMO period from the time it is installed.
After the WEB-911 Service DEMO period expires WEB-911 Services must be licensed.
See, 'WIN-911 Feature Upgrade' for details.
19
WIN-911 Configurator
Installing Mobile-911
Mobile-911 requires Microsoft Framework .NET 4.0. If installed, it can be found in Add or
Remove Programs. If .NET 4.0 Framework is not installed, Mobile-911 will direct you to
the install. The Mobile-911 server also requires Internet Information Systems if the
MobileView option is selected to be installed.
The Mobile-911 Server can be installed either on the same machine as WIN-911 or
another machine with a networked connection to the WIN-911 computer. The Mobile-911
Server machine must have access to the internet. Setup instructions can be accessed
electronically after the Mobile-911 installation is complete.
Server setup instructions can also be found on our website: www.specterinstruments.com
under Support | Knowledgebase.
Select Mobile-911. If prompted to install .NET 4.0 follow the on screen instructions.
20
WIN-911 Overview
Click, Next. Continue through the License Agreement.
21
WIN-911 Configurator
Click Next to continue with the Complete install. Select Custom if you would like to use
a custom path and or would like to disable the MobileView Server install. Then click Next.
The Mobile-911 View Server requires IIS. If you only plan to use the Mobile-911 smart
phone applications and do not want to install IIS, you must disable the Mobile-911 View
Server feature.
Click Next to continue with the selected features and custom path.
Click Install, then Finish.
Installing Mobile-911v2 on Apple iOS
Mobile-911 is available in Apple’s App Store for any iOS 4. and iOS 6 device. Download
and install the application directly from your Apple device. Future updates will be available
from the App Store as well.
Once installed, important setup information is included in the application’s help section
Installing Mobile-911v2 for Android
22
WIN-911 Overview
Mobile-911 for Android is available for Android 2.2 and up. At the time of this writing, the
latest version of Android is 4.1. Because we cannot anticipate future changes in the OS,
we cannot guarantee that all future versions will be supported.
Mobile-911v2 requires Google Play and a touch screen.
Mobile-911v2 is available on Google Play. Future versions will be released through Play
as well.
Once installed, important setup information is included in the application’s help section.
23
WIN-911 Configurator
Upgrading WIN-911
Upgrading to a New Version
Any version upgrade from a previous version to the latest version of WIN-911 will require
a Software Maintenance Number to install. If you cannot locate your Software
Maintenance information, it is available online at www.specterinstruments.com or by
phone, fax, or e-mail. If you do not have a Software Maintenance Number contact Specter
Instruments at 512-326-1011 x2 or toll free in the US and Canada at 1-800-331-8740 x2.
Enter the Software Maintenance Number and click the Next button to upgrade the WIN911 version. Then the install will proceed.
Note: A version upgrade to 7.14.00 PRO from a 7.09 or older PRO or TEP version will
include new features such as Premium Voice and WEB-911 XTools. You will need to
obtain a new license file to actually enable those features during runtime. Email a new
license request file to [email protected] or call at 512-326-1011 or toll free
in the US and Canada at 1-800-331-8740 to obtain a new license file.
24
WIN-911 Overview
Adding Feature Upgrades
Once your system has been licensed it can be upgraded to support more features
(perhaps by adding Telephony,Mobile-911 v2, FactoryTalk Alarm & Event, Premium
Voice, 2-way SMS Messaging, or even WEB-911 XTools) with a newer license. Start
Scan & Alarm with the Shift or Ctrl key depressed. This will cause the CopyShield
Administrator to appear. Contact Specter Instruments Sales Department at 512-326-1011
x2 or toll free in the US and Canada at 1-800-331-8740 x2, with the original CD Tracking
Number (and Purchase Order number or Credit Card) to retrieve a subsequent license to
enable more features for your WIN-911 system. The CD Tracking Number is viewable in
the WIN-911 Configurator | Help | About.
Note: A version upgrade to 7.14.00 PRO from a 7.09 or older PRO or TEP version will
include new features such as Premium Voice and WEB-911 XTools. Both the PRO and
BASIC license support unlimited ME Direct Connect but you will need to obtain a new
license file to actually enable this and the previously mentioned features during runtime.
Email a new license request file to [email protected] or call at 512-3261011 or toll free in the US and Canada at 1-800-331-8740 to obtain a new license file.
25
WIN-911 Configurator
WIN-911 Licensing and CopyShield Administration
Request a License
In order to receive your permanent license, WIN-911 must be registered with Specter
Instruments. Unlicensed installations will run under a 30 day demo period.
Requesting a License
The first time Scan & Alarm is started and until it is licensed the CopyShield Administrator
dialog appears. Click Request a License and complete the following form that will provide
Specter Instruments with the data necessary to generate a license file for your computer.
Click Request a License.
26
WIN-911 Overview
Fill out the appropriate fields including the CD Tracking Number located on the install CD.
Click Next.
From the pull-down menu select the type of license you wish to request. A Permanent
license will remove restriction on running Scan & Alarm on this machine. Evaluation will
extend the demo to some point beyond the normal 30-day limit. Click Next.
27
WIN-911 Configurator
Enter the CD tracking number found on the CD in this text entry box. If you don’t have an
install CD, contact Specter Instruments for a CD tracking number. Note that a CD
Tracking Number is not required for an Evaluation extension, only a Permanent license.
Click Next.
From the pull-down menu, select the Machine ID for your license. Specter recommends
selecting the Hard Disk Drive since Windows creates virtual Network Adapters whose ID's
can change on a reboot. Click Next.
28
WIN-911 Overview
The license file location is printed at the top of the window. Be sure to make note of it.
Click OK and email the *.CSR file to [email protected]
29
WIN-911 Configurator
Import a License
After receiving your license file via e-mail from Specter Instruments, copy the *.CSL file
into the C:\Program Files\Specter Instruments\WIN-911 V7\License folder.
Start WIN-911 Scan & Alarm so that the CopyShield Administrator splash screen
appears.
From the CopyShield Administrator click Install a License.
Click Import a License File.
30
WIN-911 Overview
Select the license file and click Open.
Confirm that the license was properly installed, as indicated by the status field.
31
WIN-911 Configurator
32
WIN-911 Overview
System Architecture
What is the Direct Connect?
The Direct Connect option provides a means of bypassing Windows DDE/OPC and
connecting directly to FIX®, Wonderware®, FactoryTalk View®, and RSView32®. Unlike
the DDE/OPC option (which is a generic data exchange medium), the Direct Connect is a
custom data source developed with the use of toolkits provided by the perspective HMI
developers. FIX/Wonderware InTouch/Wonderware Archestra//RSView32/RSView
SE//FactoryTalk View Alarm & Event/FactoryTalk ME/viewLinc users will find this option
time saving during configuration because WIN-911 does not require the re-entry of
redundant information. Instead, WIN-911 references much of the information required for
a configuration directly from the HMI. More importantly, the user will find this mode of
operation delivers superior performance in the following areas: 1) Speed of connection
and data point updates; 2) Data security and integrity; 3) Setpoints and alarm limits can
be changed dynamically at the source.
A configuration can be run in the Direct Connect mode exclusively or simultaneously with
DDE/OPC connections. It is important to note, however, that some of the terms
(Application, Topic, and Item name) are components of Microsoft's DDE or OPC
Foundation's OPC address nomenclature. In a Direct Connect Data Source, Application
and Topic Names are replaced with an invocation string that sets the mode of operation.
When a Direct Connect mode is selected, the appropriate strings are automatically
appended.
33
WIN-911 Configurator
System Components
Applications
WIN-911 is comprised of three applications used to configure, view history, and run Scan
& Alarm.
WIN-911 Configurator
The WIN-911 Configurator is a comprehensive, yet easy to use tool which will allow the
user to develop his WIN-91 application with confidence and efficiency. The result of the
configuration process is a configuration Microsoft database (*.MDB) and initialization file:
WIN-911.ini.
Scan & Alarm
The Scan & Alarm (TeleDAC.exe) module is the engine that connects the WIN-911
functions with the outside world. It is the OPC/DDE/Direct Connect Client connection that
performs logical functions such as: comparing current values with alarm limits or
conditions, keeping track of acknowledgments, and updating the alarm history log files. It
will read the *.MDB and WIN-911.ini file and automatically start or stop the associated
modules which are required for the application. In summary, Scan & Alarm:
1.
2.
3.
4.
5.
6.
7.
8.
Selects the modules required for the run-time application
Automatically starts each module selected in the proper sequence
Attaches to all OPC, DDE, and Direct Connect Servers
Bypasses and restores data points from the active callout list
Overrides and restores names from the contact lists
Shows and hides the Status Display for startup summary information
Monitors data points for alarm conditions
Automatically shuts down each module
The Scan & Alarm system can be started by the Run program, double clicking on the
TeleDAC.exe, Restart.exe, or using the Windows Startup program or a third party's
startup program. To shutdown Scan & Alarm, right-click on the thumbnail icon and leftclick Exit WIN-911 or run the Shutdown.exe applet. A confirmation-of-intent will appear
requiring the operator to select Exit before the program will shutdown.
Alarm Log Manager
34
Configurator Basics
The Alarm Log Manager can display archived alarming data, sort the data by any column
and append comments to individual events. To use this application, WIN-911 must be
configured with the Monthly MDB log file format.
35
WIN-911 Configurator
Service
WIN-911 as a Service
WIN-911 can run as a service under the local system account when launched by the
service wrapper. The service wrapper, or 911SRV, will launch WIN-911 automatically
when configured to do so in the Global Options\Initialization tab of the WIN-911
Configurator.
A few limitations include the following:
1. DDE data sources are not supported.
2. Network OPC is not supported (only local).
3. RSView SE Direct Connect data sources are not supported.
4. RSView32 Direct Connect data sources are not supported.
5. WIN-911 must be shutdown by the service control manager, shutdown.exe or
restart.exe
6. Bypass and override must be accessed through bypass.exe and override.exe
7. The Alarm Monitor Window and TeleDAC screen will not be displayed on
Windows Vista and above.
8. Desktop interaction must be enabled on 911SRV for the Alarm Monitor Window
and TeleDAC to be displayed.
36
Configurator Basics
Modules
WIN-911 is composed of a combination of the following modules which run independently
while working seamlessly together:
WIN911 Alarm Monitor
The WIN911 Alarm Monitor is optional and is only used when the user wishes to see a
visual display of either the entire history of alarms and errors, or just a summary of current
alarms. It is also required if the user needs the capability to acknowledge alarms by an
operator at the computer and send manual e-mail, SMS (via e-mail) and pages.
WIN911 Dialout Pager & WIN911 Local Dialout Pager
Two modules, WIN911 Dialout Pager and WIN911 Local Pager, are optional and started
when the user configures pager connections. They communicate with the Scan & Alarm
module and manage all paging activity. This includes managing pager connections and
their schedules.
WIN911 Dialout Pager processes alphanumeric and/or numeric paging that requires a
commercial paging service.
WIN911 Local Pager processes alphanumeric and/or numeric paging that connects
directly to a paging transmitter via a serial COM port and does not require a paging
service interface.
WIN911 Voice & WIN911 TAPI
Two modules, WIN911 Voice and WIN911 TAPI are optional and are only used when
voice connections (Voice, Voice Pager, and Dialout Announcer or 411 Reports) are
configured. Both communicate with the Scan & Alarm module and manage all voice dialout, dial-in, and call progress duties such as assembling the voice messages and
recognizing touch-tone security codes.
WIN911 Announcer
The WIN911 Announcer is optional and is only used when the user has selected the local
sound option. A computer sound card is required for this option and should not be
confused with the telephony card that is required for the voice functions.
37
WIN-911 Configurator
WIN911 Alarm Printer
The WIN911 Alarm Printer is optional and is only required when the user has selected the
alarm printer option. A local LPT port and dedicated printer are required.
WIN911 IP
The WIN911 IP is optional and is only required when the user has selected the IP option.
Either a RAS connection or IP Address must be defined.
WIN911 SMS
The WIN911 SMS is optional and only required when SMS connections have been
assigned to phonebook entries that have group assignments. It communicates with the
Scan & Alarm module and manages communications to cell devices via GSM modem.
WIN911 Alarm Logger
The WIN911 Alarm Logger is optional and only required when the user wishes to archive
an alarm group's events on a daily/monthly log of any alarm activity, error messages,
phone and pager activity, and diagnostic logging.
WIN911 E Mail
The WIN911 E Mail is optional and is only required when e-mail connections have been
assigned to phonebook entries that have group assignments. It communicates with the
Scan & Alarm module and manages communications to the SMTP/POP3 server.
Mobile-911
Mobile-911 is optional and is only required when Mobile-911 connections have been
assigned to phonebook entries. It communicates with the Mobile-911 Server to send
38
Configurator Basics
messages to applications running on smart devices such as cell phones or tablets. The
Mobile-911 Server also sends and receives messages to and from Mobile View.
39
WIN-911 Configurator
Applets
WIN-911 Version 7 includes six small application programs (applets) that interact with the
main Scan & Alarm executable to modify the program on the fly or shut it down altogether.
These can be used with scripting to better control WIN-911 from a SCADA application.
Standby
The Standby applet (yellow icon) acts in a global manner to disable all WIN-911
monitored data points from active callout consideration. This modifies the program
operation without having to shutdown Scan & Alarm to modify the configuration. Hence,
no loss of alarm coverage.
Warning: This applet can be configured not to require a user Ack code for execution. If
you do not wish to use this function please delete it to avoid unauthorized manipulation of
the alarm system.
Warning: If 911SRV.exe Service wrapper is controlling TeleDAC.exe, “Interact with
Desktop” must be enabled for the Standby applet to function.
Activate
The Activate applet (green icon) restores WIN-911 from Standby mode. Notifications for
unacknowledged alarms will be triggered when WIN-911 goes into active mode.
Warning: This applet can be configured not to require a user Ack code for execution. If
you do not wish to use this function please delete it to avoid unauthorized manipulation of
the alarm system.
Warning: If 911SRV.exe Service wrapper is controlling TeleDAC.exe, “Interact with
Desktop” must be enabled for the Activate applet to function.
Bypass
The Bypass applet (green and yellow icon) suppresses selected alarms from being
notified. This modifies the program operation without having to shutdown Scan & Alarm to
modify the configuration. Hence, no loss of alarm coverage.
Warning: This applet can be configured not to require a user Ack code for execution. If
you do not wish to use this function please delete it to avoid unauthorized manipulation of
the alarm system.
Warning: If 911SRV.exe Service wrapper is controlling TeleDAC.exe, “Interact with
Desktop” must be enabled for the Bypass applet to function.
40
Configurator Basics
Override
The Override applet (blue and yellow icon) suppresses selected individuals in a group
phone list from being called in the event of an alarm. This modifies the program operation
without having to shutdown Scan & Alarm to modify the configuration. Hence, no loss of
alarm coverage.
Warning: This applet can be configured not to require a user Ack code for execution. If
you do not wish to use this function please delete it to avoid unauthorized manipulation of
the alarm system.
Warning: If 911SRV.exe Service wrapper is controlling TeleDAC.exe, “Interact with
Desktop” must be enabled for the Override applet to function.
Shutdown
The Shutdown applet (red icon) allows other applications to shutdown Scan & Alarm so
that start/stop operations can be completely automated. By default, Scan & Alarm
requires confirmation before it will perform a shutdown, but this applet shuts down Scan &
Alarm in a single step.
Warning: This applet can be configured not to require a user Ack code for execution. If
you do not wish to use this function please delete it to avoid unauthorized manipulation of
the alarm system.
Warning: If 911SRV.exe Service wrapper is controlling TeleDAC.exe, “Interact with
Desktop” must be enabled for the Shutdown applet to function.
Restart
The Restart applet (red and green icon) allows the user to silently shutdown and restart
WIN-911 Scan & Alarm through the execution of a single applet. The shutdown and
restart (or start if Scan & Alarm is not running during execution) is "silent," meaning that it
occurs with minimal GUI activity. The only events that will be visible will occur as a result
of errors during the restart phase. Otherwise, the shutdown and restart cycle will be
invisible to the user.
Restart also has the ability to start Scan & Alarm with a particular configuration file. This
can be done by running a command line for Restart.exe. For example, /OPC Demo.mdb.
Note: The Restart applet will function even when Scan & Alarm is controlled by the
911SRV Service Wrapper.
41
WIN-911 Configurator
Warning: This applet can be configured not to require a user Ack code for execution. If
you do not wish to use this function please delete it to avoid unauthorized manipulation of
the alarm system.
42
Configurator Basics
Tools
WIN-911 Version 7 includes four applications that make managing the WIN-911 system
easy and intuitive
Product Component Versions
The Product Components Version is a valuable trouble-shooting device for determining
the version of every Specter software component and support software on the system.
This program is particularly useful when updating a system from a previous version. If
different versions of the components are co-mingled WIN-911 may not run properly.
DDE Client
The DDE Client is a tool for trouble shooting DDE servers. It can connect to a server, read
and write a DDE value. This tool can verify syntax, display current values, and determine
value format.
WIN-911 User File Backup/Restore
Backing up or restoring your WIN-911 system has never been easier with the WIN-911
User File Backup/Restore tool. With a click of the mouse all of the files needed to
preserve your configuration for backing up and/or reinstalling your WIN-911 software are
stored in the default location. The same program can both backup and restore usergenerated files with the two icons provided.
XP & Server 2003
C:\Documents and Settings\User Name\Local Settings\Temp\911
Windows 7 & Server 2008
C:\Users\User name\AppData\Local\Temp\911
The same program can both backup and restore user-generated files with the two icons
provided.
911Health
43
WIN-911 Configurator
The functionality of several WIN911 components is made verifiable through the use of the
911Heath program. The modules TeleDAC (Scan & Alarm), Mobile-911, WIN911 SMS,
and WIN911 IP each write a status message to the registry. 911Health reads the registry
message and serves it to an OPC Server that the user configures. These status
messages can be used to alert users and other programs of problems WIN-911 may
experiencing. Such problems include the operation and successful processing of
configured tasks for TeleDAC, Mobile-911, WIN911 SMS, and WIN911 IP.
44
Configurator Basics
Remote Alarm Notification
The Sound Clips
Note: WIN-911 provides two options for voice sources, Wave files pre-generated with
Text-to-Speech and/or human voice recording, or 2) Runtime Voice Synthesis. Those
using the Runtime Voice Synthesis do not need to manage sound files because there are
none. With this option all speech is generated during runtime as it is needed.
WIN-911 uses Microsoft's multimedia feature to offer sound to enhance your alarm
reporting needs. If you are not familiar with this capability, a review of the Windows
documentation is advisable. In Windows the Sound Recorder icon is generally found
under the "Accessories" folder. The "Help" information found here is usually all that is
needed for review. Text-to-Speech may also be used with the WIN-911 Configurator to
generate the "*.wav" files. Third party sound software tools are available which will allow
even more editing features.
In using voice to alert users of an alarm condition, WIN-911 has strived to conserve as
much disk space as possible, considering the large memory appetite of sound clips (*.wav
files.) The typical example of a verbal alarm message might be: "AREA 3," "The Oven
Temperature," "Is," "Above the High Limit." Each message within quotations is a
separately recorded sound clip.
The "Is" and "Was" sounds are used in most common alarm messages, although they can
be turned off. Continuing the above example: If the temperature decreased into the
normal range and the alarm was unacknowledged, the verbal message would be: "AREA
3," "The Oven Temperature," "Was," "Above the High Limit." Upon the operator
acknowledging the alarm via a telephone, the message would be: "AREA 3," "The Oven
Temperature," "Is," "Normal." If the alarm is acknowledged via the personal computer
keyboard, then the acknowledgment is silent. Using "Is" and "Was" as global sound clips
greatly reduces the need for additional custom messages.
The sound clips (*.wav files) furnished with this package are a sampling of miscellaneous
industrial sounds such as Bells, Sirens, Alert Horns, and Whistles. These sounds are
recorded in an 8-bit format. These .wav files are located on the install CD in
\Support\Sound Effects and must be manually copied into the C:\Program
Files\Specter Instruments\WIN-911 V7\Sound Files for use. It may be helpful at this
time to play back a sampling of these clips, to verify your sound card is operational and
the WIN-911/411 sound files are installed properly.
Note: Users of the Dialogic card and TAPI voice telephony can only play uniformly
formatted "*.WAV" files that conform to the following parameters: PCM, 11 kHz or 8 kHz
sample rate (one or the other but NOT both), 8 bit, and Mono. Check each of the existing
files with Sound Check and convert them as needed.
Note: Runtime Voice Synthesis does not play pre-recorded sound files that require format
management.
One of the strong benefits of the WIN-911/411 offering is the ability for you to customize
the alarm sounds to fit your exact application. Use of a microphone and the sound card
recording options are all that is necessary.
45
WIN-911 Configurator
Helpful Hints:
1. Don't try to record sound clips for your application until you are familiar with the
WIN-911/411 requirements. Use the demo clips furnished to learn.
2. Typically, you will have a "pause" or "dead space" at the beginning and at the
end of each sound clip. WIN-911/411 patches several clips together to form a
message, and the dead spaces will not allow a smooth speech pattern. To cure
this, use the sound recorder's edit features to cut out the dead space found at
both ends of the sound clip.
3. Using higher sample rates will use more disk space and use more system
resources, but it will offer better quality. The recommended setting is to use
"Telephone Quality" in Windows XP, Server 2003, and 2000.
4. Just as with the sound card, a higher quality microphone produces better sound
clips.
46
Configurator Basics
Sound Source
WIN-911 Version 7 infuses Text-to-Speech (TTS) technology for generating sound files
quickly and concisely. The TTS engine reads ASCII text strings and generates voice
messages to verbalize the contents of the string. Scan & Alarm gives the option to use
one of three sound sources to best fit his/her needs: Wave Files Only, Text To Speech
Wave Files, and Runtime Voice Synthesis.
Wave Files Only
When this option is selected, WIN-911's original and default mode of playing voice
announcements and telephony, Scan & Alarm uses only pre-recorded wave files. Wave
Files Only allows the user to use wave files created outside of WIN-911.
Text To Speech Wave Files
When this option is selected, TTS technology is invoked. It will be used by the
configurator to generate sound files for use by Scan & Alarm. This option provides the
developer with two ways to generate wave files. One way is automated and can be done
with the “Sound Build” button or is part of the Configurator shutdown. The other is
manually, using the “Convert Text to Wave” dialog.
Runtime Voice Synthesis
When this option is selected TTS technology is invoked at runtime. It can be used directly
by Scan & Alarm to generate the speech as it is needed without the requirement of sound
files.
47
WIN-911 Configurator
Hardware
Pager Modem Selection
A data modem is necessary to use the pager option of WIN-911. Due to the current state
of typical pager services, most modem connections are still at 1200 or 2400 baud. Any
Hayes compatible modem capable of operating at the baud rate of your pager service will
be sufficient. If a higher speed modem is used, an appropriate setup may be needed to
facilitate communications at lower baud rates.
Note: As a general rule, the more complex the modem, the more difficult the modem
setup may become!
Note: The data modem used for paging is separate hardware from either the TAPI
modem or Dialogic card that will perform your voice calls. Paging and voice functions are
independent of each other and require separate phone lines and hardware.
48
Configurator Basics
Voice Dialout Card Selection
A special Microsoft compatible card capable of playing voice messages over the
telephone line is needed for the voice dial-out and dial-in options to function. There are
two hardware options for conducting telephony calls: 1) any TAPI compliant modem
capable of passing the TAPI Compatibility Tester (Windows XP, Server 2003, and 2000)
or, 2) a Dialogic Telephonic card (Windows XP, Server 2003, and 2000). Refer to
www.specterinstruments.com -> Support -> Knowledgebase -> Dialogic Card Installation 060001, for details about the Dialogic voice board.
Voice Telephony Option One: TAPI
This option requires a TAPI voice modem and driver. To ensure the modem in the target
system is TAPI compliant, please run the TAPI Compatibility Tester located in the WIN911 Tools startup. For a list of recommended modems see, www.specterinstruments.com
-> Support -> Knowledgebase -> Recommended Voice Modem List - 060014.
Note: Some TAPI modems may require a sound device.
Voice Telephony Option Two: Dialogic
This option requires a Dialogic card and Dialogic software. For information on the Dialogic
cards, see www.specterinstruments.com -> Support -> Knowledgebase -> Dialogic Card
Information Sheet - 080002.
49
WIN-911 Configurator
Sound Card Selection
WIN-911 is designed to support standard, commercially available sound cards, which are
made to support Microsoft Windows XP, Server 2003, and 2000 multimedia functionality.
All Sound Blaster® compatible sound cards are provided with Windows drivers. Higher
quality cards will produce better quality sounds and tend to give you better performance in
harsh industrial environments.
Note: If you are using the Telephone Dial-Out option, you must adhere to specific sound
file formats. See, 'Playing with Sound' for details.
WIN-911 uses a sound card/chipset to perform "Local Audio" annunciation as well as
previewing speech during development. If local sounds are not required, the sound card is
not needed in the runtime mode.
50
Configurator Basics
Notification Methods
Voice
Voice
This option requires a voice card. Alarms will be dialed out to a telephone number. When
the line is answered, WIN-911 will ask for the contact's Access Code. Once a valid
Access Code has been entered, WIN-911 will announce the current alarms with the
option to repeat if necessary. When the contact continues, WIN-911 will then ask for an
Acknowledgement Code. Finally, when the correct Acknowledgment Code is received, the
current alarms will be acknowledged and the line will be placed on hook.
Voice Pager
This option requires a voice card. Alarms will be dialed out to a telephone number. When
the line is answered, WIN-911 will announce the current alarms and hang up.
Dialout Announcer
This option requires a voice card. Alarms will be dialed out to a telephone number or
intercom extension, then the alarms will be announced and the line placed back on hook.
This connection type differs from the Voice Pager in that it does not require a dial tone or
answer indication before alarms will be announced. It is designed for use with internal
phone systems' public address extensions that do not provide a standard answer
indication like a ring cadence break or voice menu.
51
WIN-911 Configurator
Pager
Dial-out Alphanumeric
The pager option is designed to work with all alphanumeric pager units such as the units
manufactured by NEC and Motorola. These units are typically capable of displaying 2 to 4
lines of 20 characters each. WIN-911's maximum message size is 199 characters.
A pager service is required that supports the TAP protocol, or private pager hardware that
will allow messages to be sent via a personal computer. Examples of such service
providers are Metrocall Corporation, Arch Wireless, or Motorola's People Finder. WIN-911
supports alphanumeric pager services through Motorola's TAP protocol (Telocator
Alphanumeric Protocol). The standard TAP protocol, as implemented in the United States
specifies communication parameters of seven bit ASCII with even parity. If the pager
service or paging equipment does not support the TAP protocol, the WIN-911
alphanumeric paging option may require special setup.
Dial-out Numeric
Any standard numeric pager, which requires a phone number to be called, and then a
numeric message keyed on any touch-tone telephone, will work.
Local Alpha and Numeric
WIN-911 supports local alphanumeric and numeric pagers via serial port connection to a
transmitter. Pages are processed using the TAP or COMP2 protocols.
WIN-911 supports alphanumeric pager hardware through Motorola's TAP (Telocator
Alphanumeric Protocol) and COMP2 protocol. Only one protocol can be selected for use.
If the default TAP protocol is selected, the communication parameters are specified by
default to be 7 data bits, even parity, and one stop bit. If COMP2 is selected the
parameters are specified to be 8 data bits, even parity, and one stop bit.
Note: Numeric pagers are a class of pager manufactured by various vendors and capable
of displaying up to 20 digits. This type of pager will not support alpha characters in its
message stream.
52
Configurator Basics
SMS
The SMS option requires a GSM modem with an active cellular account. The user is
responsible for activating the modem with a GSM wireless service provider. An unlimited
SMS messaging plan is recommended. Some SMS messaging features will need to be
licensed. The WIN-911/Basic package will support 1-way SMS alarm messages as well
as status checks sent via SMS. The WIN-911/Pro package supports everything the WIN911/Basic package does and also includes 2-way messaging. The 2-way messaging
feature gives the user the ability to acknowledge an alarm with a specifically formatted
SMS message. The acknowledgement criteria, health status criteria, and the alarm
request criteria are discussed below. For information explaining SMS message
configuration and formatting see the SMS Definition section under WIN-911 Global
Menus.
Note: The SMS option is only compatible with GSM and CDMA modems and their
networks. For a list of recommended modems see, www.specterinstruments.com ->
Support -> Knowledgebase -> Recommended GSM Modem List - 080007.
Acknowledgement Message
WIN-911 can be licensed to accept incoming acknowledgement message. This allows
users to singularly ack alarm message via SMS. In order for WIN-911 to understand and
accept the alarm acknowledgement, the sender and the message must meet a few
requirements:
•
The sender's phone number must be configured in the 'Phone Book' with an 'SMS'
connection.
•
The sender's name must be in the 'Selected Name List' in the Group for that
particular alarm.
•
The first 6 characters of the acknowledgement message MUST be the 'ticket
number' associated with that alarm. The 'ticket number' is the 6-digit number found
at the beginning of the SMS alarm message.
•
The numeric 'Ack' code must be the last characters in the message. An 'Ack" code
can be anywhere from 1-15 digits.
•
The 'Ack' code and the phone number configured in WIN-911 must match the 'Ack'
code sent in the SMS acknowledgement message and the phone number it was
sent from must match the 'Ack' code and phone number configured in the 'Phone
Book' in WIN-911.
Note: Some users may be able to use the Reply or Forward function to automatically
enter the 6-digit ticket number. This would then only require the user to enter in their
acknowledgement code at the end of the message. Make sure when using Reply or
Forward that no extra characters are placed in front of the alarm message (e.g. RE: or
FW:). Once the acknowledgement is received and accepted by WIN-911 all contacts in
the Group's 'Selected Name List' for that alarm should receive a confirmation that the
alarm has been acknowledged. If WIN-911 rejects the acknowledgement, the user who
sent the acknowledgement should receive a failed acknowledgement message back.
53
WIN-911 Configurator
Health Status Message
The 'Health Status' message feature allows all configured SMS users to check the health
of WIN-911 by simply sending the required message. This feature is supported by both 1way and 2-way SMS licenses. In order for WIN-911 to understand and accept the 'Health
Status' message, the sender and the message must meet a few requirements:
•
The sender's phone number must be configured in the 'Phone Book' with an 'SMS'
connection.
•
The sender's name must be in a 'Selected Name List' for at least one Group.
•
The SMS message needs to have the text STATUS and only the text STATUS in
the message. This string is not case sensitive.
Once the status message is received WIN-911 will reply back to the sender with the
message OK if WIN-911 is running or STANDBY if WIN-911 is in Standby mode. WIN911 will reply with the message INVALID/MANUAL SMS RECEIVED if the sender did not
send the proper message. No response, may be a result of one or more of the following:
•
The sender did not meet the required criteria listed above.
•
The computer is not running or is non-responsive.
•
GSM modem is not functioning properly.
•
The GSM cellular network is not functioning properly.
•
WIN-911 is not running.
•
The SMS DLL is not functioning properly.
Alarm Request Message
The 'Alarm Request' message allows all configured SMS users to request alarm
information at any given time. This feature is ONLY supported with a 2-way SMS license.
In order for WIN-911 to understand and accept the 'Alarm Request', the sender and the
message must meet a few requirements:
54
•
The sender's phone number must be configured in the 'Phone Book' with an 'SMS'
connection.
•
The sender's name must be in a 'Selected Name List' for at least one Group.
•
The SMS message needs to only contain one of the following text strings:
•
REQUEST ACTIVE ACKED
•
REQUEST ACTIVE UNACKED
•
REQUEST INACTIVE UNACKED
•
REQUEST UNACKED
•
REQUESTACTIVE
Configurator Basics
•
REQUEST ALL
Once the request message is received and all three criteria are met, WIN-911 will reply
back to the sender with one SMS message per alarm that meets the request.
If no response is received, there may not be alarm messages that meet the request. To
confirm WIN-911 is still healthy send a Health Status message (described in the previous
section).
If WIN-911 replies with the message INVALID/MANUAL SMS RECEIVED then the sender
did not send one of the six messages described above. Double check the sent text for
errors.
If WIN-911 replies with the message EVENT REQUEST REJECTED PER LICENSE then
the sender met all the criteria described above, but the sender is not licensed for 2-way
SMS messaging.
55
WIN-911 Configurator
E-Mail
The e-mail option requires an e-mail account and connection via a LAN (or WAN)
connection. Messages can be sent directly to the account of a recipient or to a paging
company that will in turn send a page or fax.
Note: In an effort to reduce the number of phone lines WIN-911 needs to accomplish its
alarm notification, users who wish to implement both dialout paging and e-mail should use
their e-mail account to deliver messages to the page provider or be sure the e-mail
connection is via LAN/WAN.
56
Configurator Basics
IP
The WIN-911 IP connection is designed to send alarm messages over a network through
a TCP socket. It is compatible with RAS and Ethernet connections. In order to utilize this
feature, users must develop their own application to accept alarm messages and handle
them accordingly. The user's application can also monitor health status information that
WIN-911 stores in the registry. The WIN-911 IP connection adds a tremendous amount of
extensibility to WIN-911.
Alarm Messages
Alarm messages are sent through the IP connection on a per group basis. To enable IP
for a group, open a group definition and select Send alarms to IP. With this option
selected, all alarms in the selected group will be sent through the IP feature to a remote
computer.
When an alarm is received, it is sent as an ASCII string through the TCP port specified in
your WIN-911 IP settings. This connection can be made through RAS, LAN or WAN. If
utilizing a RAS connection, you must specify the name of the RAS connection you have
set up in Windows. If you are using a LAN or WAN, then you must configure WIN-911
with the remote computer's IP address. For reliability, configure all remote computers as
well as the local computer with static IP addresses. If you must use DHCP, reserve an IP
address for each machine. WIN-911 cannot resolve hostnames with WINS or DNS.
The beauty of the WIN-911 IP connection is that it is highly configurable. When an alarm
is received it is formatted and then sent over the network as ASCII text. Each message
starts with a configurable message prefix and ends with a configurable suffix. The
contents of the message can contain any number of fields. These fields may be labeled
with their field names and are also delimited by a user defined delimiter. When developing
your application, determine which fields are required and use the message format settings
to properly parse alarms.
57
WIN-911 Configurator
Acknowledgements/Expected Responses
Once an alarm message is sent, WIN-911 can be configured to await a response from the
remote computer to confirm that the message was delivered. WIN-911 can also
acknowledge alarms based on whether or not the Expected Response was received.
Primary/Secondary Remote Computers
The WIN-911 IP connection has redundancy features built into it. In addition to a primary
remote machine, you may configure a secondary remote machine. When a configurable
amount of failures has been reached, WIN-911 will attempt to use the secondary
connection. A failure constitutes a failure to establish a TCP socket connection or other
type of failure associated with TCP. Also, if you've enabled WIN-911 to wait for an
Expected Response, then a failure occurs when that response is not received for an
alarm. Once WIN-911 fails over to the secondary connection, it will send alarms to that
secondary connection until the connection is closed. When a new connection is
attempted, WIN-911 will first attempt the primary remote computer.
Health Status
Health status information can be monitored by the user's application to monitor the health
of both WIN-911 and the hardware being used to send alarm messages via IP. Two
values need to be monitored and compared in the registry to understand the current
health of WIN-911:
•
HKLM\SOFTWARE\Specter Instruments\WIN911 IP\Health
•
HKLM\SOFTWARE\Specter Instruments\WIN911 IP\Time
Health stores the most current state of WIN-911. Time stores the time stamp of the most
current state stored in the Health. The Health value should be updated approximately
once a second. If the Time value is more than a few seconds old, the application should
assume the Health value is bad. The three possible Health values and the format for the
Time value are described below:
Health:
•
OK - Healthy. WIN-911 and its hardware is functioning properly.
•
FAIL - All message attempts have failed for a particular alarm. This included
attempts made to the secondary remote machine if configured.
•
STOP - The WIN911 IP DLL has been stopped by the shutdown of WIN-911.
•
YEAR:DAYOFYEAR:HOUR:MINUTE:SECOND - For example:,
2009:033:14:30:25 (Feb 2, 2009 2:30:25 PM GMT)
Time:
58
Configurator Basics
Data Poke
The ASCII OPC/DDE Poke feature is an easy to use function enabling the WIN-911
software modules to be integrated into other Microsoft Windows application programs.
This standard option will allow the TEXT Alarm Messages to be displayed within other
programs, and it will allow these programs to "Acknowledge" the WIN-911 alarms. Pager
and voice operational status can be monitored by other programs through the use of the
Pager, Voice, and System Health. An example of the Pager Health poke might include a
situation where a digital OPC/DDE tag belonging to an HMI package is poked a zero (0)
when the pager applet is functional. If the modem stops responding, a failure is generated
and a digital one (1) is poked, replacing the zero and indicating the loss of functionality.
59
Configurator Basics
The WIN-911 Configuration Window
In the WIN-911 folder, or in the Start Menu, click the WIN-911 Configurator icon. The
WIN-911 Configurator window now appears, ready for you to begin work. This is the
configuration utility for both WIN-911 and WIN-411 options. Note the WIN-911
Configurator saves the position when the program is exited and will return to the last
saved position when it is re-selected.
Note: Double quotes (“) are illegal characters and are not to be used in any WIN-911
configuration.
The WIN-911 Configurator Window consists of several distinct areas: Title Bar, Menu Bar,
Toolbars, and the Status area.
The Title Bar displays the configuration name, Min/Max, and exit controls only.
The Menu Bar provides access to the various configuration menus from the mouse or
keyboard. The Mode menu provides toggling between special modes of operation. The
Global menu provides configuration options for items that are global to the system. The
Configure menu provides configuration options that are specific to a single configuration.
The Tools menu provides miscellaneous development and security aids. The Help menu
provides help access.
The Tool Bars present the menu options as graphic buttons for easy access. Buttons are
grouped in the same order as the menu commands for intuitive use. Note: Some controls
are not supported with all data sources. This will be depicted by a control being disabled
or a message box when clicked.
A text description of the button will appear as the mouse cursor is parked over the button
of interest.
The WIN-911 configuration utility is a true Windows based application. It follows the
Microsoft Windows conventions for getting around the screen and working with windows,
menus, dialog boxes, and the Windows Clipboard. Refer to your Microsoft Windows
documentation for an explanation of Windows basics.
61
WIN-911 Configurator
Common Dialog Boxes
During configuration, you will be using some custom WIN-911 dialog boxes. The dialog
boxes are designed to be consistent in entries and formats. Many of these dialog boxes
will appear to be almost identical other than the content. Generally, the first dialog box is
the summary listing of the subject button selected. The title bar identifies the dialog
summary with a numeric indication of the total number of listings and the specific listing
highlighted. If more items are listed than can be shown in the space selected, a vertical
slider bar will appear to the right of the dialog box
.
At the bottom of the above form, you will notice several selection buttons:
OK
The OK button is the only way to exit WIN-911 dialog list forms. It returns you to the last
WIN-911 dialog form or main Window.
New
Clicking the New button will bring up a blank configuration dialog form for a fresh entry.
Copy
The use of the Copy button is a great time saver if you are configuring several similar
users, groups, or alarms/points. Select (highlight) the item with the cursor, and then select
Copy. An exact copy is made of the selected configuration item. Make just the changes
necessary to the copy, and save by selecting the OK button.
Delete
Highlight an item in the list and click Delete to remove it from the list.
Edit
Highlight an item in the list an click Edit to make changes. Alternatively, you may also
double click an item to modify it.
62
Configurator Menu
Definition Dialog Boxes
Once you have selected from the summary list box (either to edit an existing definition or
to create a new definition), the definition dialog box will appear. The following example is
a common definition dialog box. The box shows all currently defined entries and a variety
of tabs.
Selection Tabs
If the definition dialog box has multiple options, or configuration steps, they may be
accessed by selection tabs located across the top of the dialog box.
Check Boxes or List Boxes
Configuring a WIN-911 application is a combination of selecting options and entering text
messages for each alarm. Most of the choices are made with simple check boxes, radio
buttons, or pull down list boxes.
63
WIN-911 Configurator
Sound Button
Sound Button
The sounds used throughout the system are selected through a common sound dialog
box. The only way to get to the “Select Sound File” or the "Save Runtime Text String" is to
select the sound buttons found throughout the WIN-911 Configurator. Such a button is
shown below:
The Green arrow at the right of the sound button is a "preview speech" play-button that
will play the sound that will be used for that section of the audio message.
64
Configurator Menu
Save Runtime Text String
Runtime Voice Synthesis users need to specify the text that will be read to synthesize the
speech used during a telephony call or local annunciation. Clicking the sound button will
present the Save Runtime Text String dialog
.
Disable
The “Disable Sound”button is used to select silence instead of a sound. It will return a
blank to the sound selection button.
Preview
If a sound card is installed the “Preview”button will cause the system to output the text-tospeech sound. This can be useful when you are uncertain which annunciation is
appropriate.
OK
The "OK" button return you to the previous configuration step and the Sound Selection
button will show the text that will be verbalized
.
Cancel
The “Cancel”button will exit from the dialog box without saving any of the changes.
65
WIN-911 Configurator
Convert Text to Wave File
If you are not using Runtime Voice Synthesis then the voice messages are pieced
together from a selection of pre-existing sound files which are maintained in the Sound
Files sub-folder of your WIN-911 V7 folder. Clicking on one of these buttons will bring you
to the “Select Sound File”list box.
From the Select Sound File list box highlight the desired sound file or click New to create
the desired sound file.
File List Box
This box shows all of the “*.WAV” files in the defined sound directory. The selection of the
WIN-911 sound directory is found in the Global selections. If there are more files than the
display area can show, a scroll bar will appear. The dialog box is exited by either: Double
clicking on the desired sound file, or Selecting the “Disable Sound” or the “OK” Button.
Disable
The “Disable Sound” button is used to select silence instead of a sound. It will return a
blank to the sound selection button.
New
The “New” will create a new sound file and associate that sound with this segment of the
message string. The dialog box listed below will allow you to name the file, enter the text
of the file to be converted and select the voice with which the file is to be created.
Note: Text to Speech must be both installed and enabled to use this feature.
Test
If “Wave Files Only” or "Text To Speech Wave Files" within Common Sounds, Controls is
enabled, this button allows the selected “*.wav” file to be tested for compatibility with WIN911.
Preview
66
Configurator Menu
If a sound card is installed the “Preview” button will cause the system to output the
selected sound. This can be useful when you are uncertain which file is appropriate when
two or more filenames are similar.
OK
The “OK” button will select the highlighted sound file for the selected sound button which
is being defined. This action will return you to the previous configuration step and the
sound selection button will show the name of the sound file just selected.
Cancel
The “Cancel” button will exit from the dialog box without saving any of the changes.
67
WIN-911 Configurator
Edit Wave File Dialog
The Convert Text To Wave File dialog is accessed by clicking the New button on the
Select Sound File dialog.
Disable
The “Disable Sound” button is used to select silence instead of a sound. It will return a
blank to the sound selection button.
Preview
If a sound card is installed the “Preview” button will cause the system to output the
selected sound. This can be useful when you are uncertain which file is appropriate when
two or more filenames are similar.
OK
The “OK” button will close the text box, ending the text string edit. This action will return
you to the previous configuration step and the Sound Selection button will show you the
name of the sound file created.
Cancel
The “Cancel”button will exit from the dialog box without saving any of the changes.
68
Configurator Menu
File
The File menu contains a set of commands that are used for creating, opening, and
saving configurations. Access to the configuration file is made through filenames that
have an extension of "*.MDB". The global configuration information is saved in unique
".MDB" files and the "WIN-911.ini" file which will be used by all WIN-911 programs.
This pull-down menu also contains the WIN-911 Printer Configuration which is used to
specify a local or shared network printer and its properties. This printer is to be used by
the configurator to print out the users configuration (*.MDB) file as well as the global
settings from the "WIN-911.ini" file. This is not to be confused with the alarm printer,
which is not shared with a network or Windows, but slaved to the local system on which
WIN-911 is installed.
New
Use this command to create a new WIN-911 configuration for alarming and reporting. No
dialog box is brought up when this is selected.
Note: If the current changes have not been saved when you attempt to create a new
configuration or attempt to exit the Configurator, a dialog box will pop up and ask if you
want to save the changes.
Open
Use this command to open an existing configuration for editing. This uses the common
open file dialog box as shown below.
Note: If the current changes have not been saved when you attempt to open another
configuration, a dialog box will pop up and ask if you want to save the changes.
69
WIN-911 Configurator
Select the directory in the "Look In:" pull down. Select the desired .MDB file by clicking on
it. The selected file should be indicated in the "File Name" list box. Clicking on "Open" will
start up the Configuration Utility with the selected "*.MDB" database.
Import
WIN-911 Import function makes the configuration process fast and easy. FIX, OPC,
RSView SE, RSView32, Wonderware InTouch, and ME Direct Connect users can use this
tool to browse large databases, custom select data or alarms to monitor and import it into
a WIN-911 configuration.
Note: If you do not want to import more data sources and tags into your currently open
configuration, be sure to select "File" and "New" from the menu to create a configuration
that only contains data from the import.
Special Note for Lite Mode Users: Block import is disabled. The Lite Mode User may only
select one tag at a time during import.
70
Global Menus
Save
Use this command to save the currently loaded configuration under the existing file name.
No dialog box will pop up when this option is selected. Note: To see the name of the
current "*.MDB" file configuration, look at the title bar of the window or go to "Options"
button and the "Paths" tab.
Save As
Use this command to save the currently loaded configuration under a new name.
Print
Use this command to invoke a dialog box which provides the user with the option of
printing the current configuration ("*.MDB") file and the global settings contained in the
"WIN-911.ini" file.
Use the Print Item Selection dialog to select the fields of interest then click OK.
Note: In Lite mode Analogs and Reports will not be selectable.
71
WIN-911 Configurator
This dialog box allows the user to select the appropriate network printer, Properties, Print
Range, and number of copies.
Note: This printer should be a local or shared network printer and not be confused with
the optional alarm printer which is not shared on a network or the operating system.
Exit
Use this command to exit from the WIN-911 Configurator.
Note: If the current changes have not been saved when you attempt to exit, a dialog box
will pop up and ask if you want to save the changes.
72
Global Menus
Mode
The "Mode " menu contains a set of options - Lite and Audit Modifications.
Validate Lite Mode
This button verifies that the current configuration is valid for Lite mode and returns a list of
issues that must be modified if it is not.
WIN-911 Lite is a mode of operation which allows you the standard WIN-911 functionality
with the following restrictions:
•
•
•
•
Alarms can accommodate a total of 24 digital and unlimited watchdog alarms.
Analog and Filter alarms are not supported in Lite Mode.
User can select a single type of dial-out connection, such as: Voice Telephony,
Numeric or Alphanumeric Pagers, Voice Pagers, E-Mail, or SMS.
Lite mode does not include WIN-411 reporting capability, but users can
acknowledge alarms from the voice telephony connection.
The computer/voice telephony interface must be a TAPI Voice Modem.
Audit Modifications
All modifications made to the WIN-911 Configuration and WIN-911.ini files are archived in
text files located in the same folder as the log files. These files are in a daily text file
format and are titled CYYDAY, where YY is the last two digits of the year and DAY is the
three digit Julian day of the year. For example May 9, 2005 would be C05129.txt.
73
WIN-911 Configurator
The Configure menu defines the specific configuration information for a single application
(either WIN-911 or WIN-411). This configuration information is stored in the "*.MDB" file.
For details on each one of the Configure settings see, WIN-911 Configuration. For details
on Report Definitions settings see, WIN-411 Configuration.
Schedule Definitions
The Schedule Definition allows the user to view and configure duty schedules.
Phone Book Definitions
The Phone Book Definition allows the user to view and configure contacts. It also allows
the user to assign access and acknowledge codes, connections, and duty schedules.
Data Source Definitions
The Data Source Definition allows the user to view and configure a data source
connection.
Group Definitions
Group Definitions allows the user to build Groups. Groups are used to associate
information with a specific set of contacts.
Filter Definitions
Filter Definitions allows the user to configure all filter points. Filter tags are different from
statically configured tags in that no import is necessary. Filter tags subscribe to alarms on
the fly, depending on the criteria configured. Not all data sources support Filter
Definitions.
Digital Definitions
Digital Definitions allows the user to configure all digital points. Not all data sources
support Digital Definitions.
Analog Definitions
Analog Definitions allows the user to configure all analog points. Not all data sources
support Analog Definitions.
Watchdog Timer Definitions
74
Global Menus
Watchdog Timer Definitions allows the user to configure all watchdog timers.
Report Definitions
Report Definitions allows the user to configure WIN-411 reports. Not all data sources
support Report Definitions.
75
WIN-911 Configurator
Global
The Global menu provides commands that are used to define the global configuration
information such as common sounds, alarm message formats, and hardware
assignments. For details on each one of the Global settings see, WIN-911 Global Menus.
Common Sounds
The Common Sounds defines all global sounds. It also allows the user to select the sound
source, wave format, default voice, and toggle the local announcer options.
Monitor Display
The Monitor Display defines the message format for the Monitor (both the alarm history
and alarm summary.) It also allows the user to select the acknowledgement options,
security display options, and the alarm message color choices.
Printer
The Printer Definition defines specific hardware and alignment definitions used by the
alarm printer. The definitions are for printer parallel port assignment and alarm text
formatting.
Pager
The Pager defines the alphanumeric and numeric pager settings, as well as the message
format.
Voice Card
The Voice Card defines the parameters associated with voice telephony. It allows the
user to define the type of telephony hardware, timing parameters, and volume.
SMS
76
Global Menus
SMS defines the parameters associated with SMS messaging. It allows the user to define
SMS device settings, message formats and acknowledgement formats.
E-mail
E-mail defines the e-mail parameters. It allows the user to configure SMTP settings,
including authentication. It also allows the user to define the e-mail format.
Mobile-911
Mobile-911 defines the parameters associated with Mobile-911 messaging. It allows the
user to configure WIN-911 settings for communicating with the Mobile-911 Server, and
alarm and acknowledgment message formatting.
Logger
The Logger defines the types of historical logging and their format for archiving.
Data Pokes
Data Pokes define group acknowledgement messages for OPC/DDE and heartbeat
pokes. The hearbeat monitors system health, pager health and voice health.
WIN-911 IP
WIN-911 IP defines the parameters associated with an IP message/acknowledgement
connection. It allows the user to define the IP connection settings, protocol, and message
formats.
Options
Options allows the user to customize and tune WIN-911and WIN-411 to meet various
application or performance needs.
77
WIN-911 Configurator
Tools
The Tools pull-down menu provides the user with extensive trouble shooting resources as
well as password protection for the Configurator and Scan & Alarm shutdown.
Diagnostic Logging
When any of the following options are checked, extensive diagnostic information is logged
to the Scan & Alarm status window and History view of the Alarm Monitor during runtime.
The log files are also populated with extensive information. Since this can put a strain on
the PC, Specter recommends only enabling Diagnostic Logging to help troubleshoot
known issues.
System
Turns on all Diagnostic logging.
Data Source
Logs data source messages to Scan & Alarm and displays them in Status display, the
Monitor display and the log files. This tool is very useful in trouble shooting
communication problems between WIN-911 and the data server or SCADA. Specter
recommends that you make a single tag test configuration that focuses on a tag at a time
for diagnosis due to the amount of information that this tool will generate.
Announcer
78
Global Menus
Logs announcer module messages to Scan & Alarm. Intercepts Announcer module
shutdowns.
Monitor
Logs monitor module messages to Scan & Alarm. Intercepts Monitor module shutdowns.
Printer
Logs printer module messages to Scan & Alarm. Intercepts Printer module shutdowns.
Dialout Pager
Logs Dialout Pager module messages to Scan & Alarm and displays them in the Monitor.
This tool is very useful in trouble shooting communication problems with the pager service
provider. With this you can monitor the conversation between the WIN-911 modem and
the pager service modem. Intercepts Dialout Pager module shutdowns.
Local Pager
Logs local pager messages to Scan & Alarm and displays them in the Monitor. Intercepts
Local Pager module shutdowns.
Voice Connections
Logs voice module messages to Scan & Alarm and displays them in the Monitor. Will also
show failed attempts to play audio. Intercepts Voice module shutdowns.
SMS
Logs SMS module messages to Scan & Alarm and displays them in the Monitor.
Intercepts SMS module shutdowns.
E-Mail
Logs e-mail module communications between itself and the e-mail service provider to
Scan & Alarm. Diagnostic messages from the e-mail server that are usually transparent to
the user can be extracted using this tool. Intercepts E-Mail module shutdowns.
Mobile-911
Logs Mobile-911 messages between WIN-911 and the Mobile-911 server and displays
them in the Alarm Monitor (History view) and Logger. Intercepts Mobile-911 module
shutdown.
Logger
Logs logger module messages to Scan & Alarm. Intercepts Logger module shutdowns.
WIN-911 IP
Logs WIN-911 IP module messages to Scan & Alarm. Intercepts IP module shutdowns.
79
WIN-911 Configurator
Password
WIN-911 security can be enhanced with the use of a user/administrator defined password
that will be required to start the WIN-911 Configurator or shutdown Scan & Alarm. If the
user wishes to require a Password to shutdown WIN-911 they must enable this option in
the Monitor Definition.
To set and remove a password the user/administrator must enter and confirm the
password from within the Configurator's Tools menu.
Sound Check
Voice telephony requires a standard sound file ("*.wav") format to ensure smooth
operation if Runtime Voice Synthesis is not enabled. The formats that are acceptable are
PCM format, 11025 Hz or 8000 Hz sample rate, 8 bit, and mono for Dialogic or any format
for TAPI. Because the sound files can be developed independently and with different
voices, both sample rates can end up in the Sound Files folder. Such a mixing of sample
rates can degrade the WIN-911 voice module so Specter requires that you standardize on
one sample rate.
To help in this portion of the development if Runtime Voice Synthesis is disabled, the
Sound Check tool can be invoked for a global sound file scan or a single file-at-a-time
spot check.
The global sound check is performed during WIN-911 Configurator shutdown or via the
'Sound Check' button in Sound Controls. This tool will check the format of each sound file
and produce a comprehensive list of offending "*.wav" files. This list is placed in the WIN911 V7 folder in the form of a text file titled "TeleDAC Sound Check.txt". This can be
viewed and printed out using Notepad.
A single file spot check is available in any Select Sound File dialog. If Sound Check is
turned on, the Test button is enabled, and when depressed will scan the highlighted
sound file.
Any incorrectly formatted or unlicensed premium voice file will be detected.
Note: Runtime Voice Synthesis does not play pre-recorded sound file that require format
management.
Sound Purge
80
Global Menus
WARNING! The Sound Purge option on the tools menu or the Sound Purge button in
Sound Controls deletes all .wav files in the current sound file directory. This can be used
to fix corrupted wave files by deleting them, and then allowing WIN-911 to rebuild the
.wav files with the correct format automatically, during shut down or with the Sound Build
button. Sound Purge may also be used to modify properly working wave files with, for
instance, a different voice.
81
WIN-911 Configurator
Help
The Help menu contains a set of options - Help Topics and Help About
Help Topics
Help Topics will bring up the Configurator's help file, WIN911 Configurator.CHM. This is
the main help file containing all WIN-911's generic help. Any help files specific to a
particular data source are accessed through the Data Source Definition help button.
Help Library
The help library contains all support documentation for WIN-911.
Help About
Help | About will bring up the Configurator's Help About window. Here the user can view
the WIN-911 Program and Configurator version number and the type of license installed.
Below describes how the license can be interpreted:
The fourth line in Help About represents the license installed. The first part will always
read 'WIN-911/'. What follows the WIN-911/..... reveals the license installed. Multiple
licenses can be installed on one WIN-911 machine.
82
•
DEMO: Thirty day, fully functional demo
•
*LITE*: Lite Mode
•
Basic: E-mail & Paging
•
Pro: Telephony, E-mail & Paging
Global Menus
•
V: Premium Voice
•
X: X-Tools
•
R: FactoryTalk
•
M(10-100): Mobile-911, the number specified indicates the number of authorized
Mobile-911 clients.
•
ME(1-xx): ME Direct Connect
The software release version, as well as the version number of each component, may be
found by clicking the "Versions" button.
83
WIN-911 Configurator
84
Global Menus
Global Menu
The "Global" menu provides settings that are used to define the global configuration
information such as common sounds, alarm message formats, and hardware
assignments. The Options selection allows customizing such things as: Initialization
Adjustments, Path Selections, and Timing Adjustments. All changes made to Global
configuration information is stored in the WIN-911.INI file.
85
WIN-911 Configurator
Common Sounds
Common Sounds
This button is used to select all global sounds. The "Is" and "Was" sounds are used on
most alarm announcements. The other sounds are used for verbal phone dial-ups and for
the verbalization of analog values. At the end of each selection process, you may select
from the following action buttons:
Help
The "Help" button will bring up help information for the currently active tab.
OK
The "OK" button is used to accept and store the changes.
Cancel
The "Cancel" button is used to ignore all changes made in this dialog box.
Sequence of a Typical WIN-911 Alarm Dial-Out
Alarm detected, dial first phone number:
Sequence of sounds:
1. "Hello,......", from Common Sounds
2. "Phone Book Name Sound", from Phone Definition (if defined)
3. "Please enter your access code followed by the pound key", from Common
Sounds
User enters access code.
Sequence of sounds:
1. The Alarm Sounds, from Group and Alarm Definition and/or Data Source
Definition.
2. "Press star to repeat message,....", from Common Sounds
3. "Enter your Alarm Acknowledgment Code", from "911 Only" Sounds tab
User enters acknowledgment code.
86
Configuration Menus
1. "Alarms acknowledged", from "911 Only" Sounds
2. "Thank You, Good-bye", from Common Sounds
87
WIN-911 Configurator
Common
"Hello, this is (Company Name)"
The "Hello, this is (Company Name)" sound should identify the monitoring system to the
person receiving or making the call. A typical message is "This is the Acme Water District
Monitoring System". This message will be followed by the Phone Book Name sound (if
defined) for a dial-out alarm announcement. A typical Name message might say "A
message for Mr. Jones."
"Please enter your access code followed by the pound key"
The "Please enter your access code followed by the pound key" sound asks the user to
enter his/her unique access code. A typical message is "Please enter your access code
followed by the pound key...". Note: For Voice Page or Dialout Announcer applications,
this sound does not apply.
"Invalid Entry"
The "Invalid Entry" sound is used to inform the caller that he has entered an invalid code
or out-of-range data entry. This message is normally "Invalid Entry...".
Note: For Voice Page or Dialout Announcer applications, this sound does not apply.
"Thank You, Goodbye"
88
Configuration Menus
The "Thank You, Goodbye" sound is given right before the system disconnects. A typical
message is "...thank you...goodbye". Note: For Voice Page or Dialout Announcer
applications, this sound is ignored.
"...Is..."
The Is sound is used when reporting an active alarm. It is placed between the Tagname
and the alarm condition.
"Press star to repeat message, any other key to continue"
The "Press star to repeat message, any other key to continue" sound is used to offer the
user the ability to repeat the verbalized message or skip ahead to the next user entry.
This message is normally "Press star to repeat message, any other key to continue........
".
"In the" [Group]
The "In the" sound is the prepositional phrase relating the Group name with the rest of the
message. This sound is undefined by default.
"the" [Tag]
The sound "the" is the article pointing to the tag which follows in the verbalization of the
message. This sound is undefined by default.
89
WIN-911 Configurator
911 Only
"...was..."
The Was sound is used when an alarm has returned to a normal state, and is not
acknowledged. It is placed between the Tagname and the alarm condition.
"There are no unacknowledged alarms to report at this time"
The "There are no unacknowledged alarms to report at this time" sound is used to inform
the caller that there are no reported alarms that have not been acknowledged for the
group(s) which he is authorized to hear. This message is normally, "There are no
unacknowledged alarms to report at this time."
"Enter your alarm acknowledgment code followed by the pound key"
The "Enter your alarm acknowledgment code followed by the pound key" sound is used to
request the alarm acknowledgment code. This message is normally "Enter your alarm
acknowledgment code followed by the pound key..."
"Alarms acknowledged"
90
Configuration Menus
The "Alarms acknowledged" sound is used to inform the user that a successful
acknowledgment code was entered and that all alarms heard in their entirety were
acknowledged. This message is normally "Alarms acknowledged..."
91
WIN-911 Configurator
411 Only
Note: WIN-411 Reports are not available in Lite mode or with the RSView SE Direct
Connect, Factory Talk Alarms and Events, RSView32 Direct Connect, or the ArchestrA
Direct Connect.
"Select the desired report number followed by the pound key"
The "Select the desired report number followed by the pound key" sound is used to
request the user to select a pre-configured report number. This message is normally
"Select the desired report number followed by the pound key..."
"Select the point to change"
The "Select the point to change" sound is used to request the user to select a numerical
password to enable a point to be changed. This message is normally "Select the point to
change....."
"You have selected"
The "You have selected" sound is used to verbally confirm a user selection of a report
number. This message is normally "You have selected...."
"Enter new value"
92
Configuration Menus
The "Enter new value" sound is used to advise the user to key in the new value to be
changed. This message is normally "Enter new value".
"The new value will be set to"
The "The new value will be set to" sound is used to verbally confirm the new value, prior
to actually making the change. This message is normally "The new value will be set to...."
"Press the pound key to accept"
The "Press the pound key to accept" sound is used to confirm a selection or entered
value at various stages of the WIN-411 processing sequence. This message is normally
"Press the pound key to accept....."
"...and..."
The "and" sound is used to add two messages together. An example would be: "The level
is 45 feet, and is above the high level".
"Please enter your authorization code followed by the pound key"
The "Please enter your authorization code followed by the pound key" sound is used to
request the operators' authorization code before changing any values in the WIN-411
system. This is a security feature used to protect the process. This message is normally
"Please enter your authorization code followed by the pound key."
93
WIN-911 Configurator
411 Numbers
Note: WIN-411 Reports are not available in Lite mode, RSView SE Direct Connect,
Factory Talk Alarms and Events, or RSView32 Direct Connect.
In reporting an analog value, WIN-411 must be able to verbalize a numeric value. This is
done by recording a sound clip of each digit. A value of "-2.33" would be reported as
"Minus two point three three".
94
Configuration Menus
Conditions
"I/O failure"
The "I/O failure" sound is used to warn the user that the particular I/O point is in failure.
This message is normally "I O failure..."
"Communication failure"
The "Communication failure" sound is used to warn the user that the communication with
the I/O hardware is in failure. This message is normally "Communication failure..."
"Without current data"
The "Without current data" sound is used to inform the user that the data is not current for
a particular I/O point. This message is normally "Without current data..."
"Exceeded the deviation setpoint"
The "Exceeded the deviation setpoint" sound is used in deviation alarm annunciations to
explain that an alarm has occurred by way of the value increasing above the deviation
setpoint. This message is normally, "Exceeded the deviation setpoint".
"Exceeded the rate of change setpoint"
95
WIN-911 Configurator
The "Exceeded the rate of change setpoint" sound is used in rate of change alarm
annunciations to explain that an alarm has occurred by way of the value changing from
one value to another. This message is normally, "Exceeded the rate of change setpoint".
96
Configuration Menus
Prefixes
"Above"
The "Above" sound is used in analog alarm annunciations to explain that an alarm
threshold has been exceeded by way of the value increasing above a specified limit. This
message is normally, "Above".
"Below"
The "Below" sound is used in analog alarm annunciations to explain that an alarm
threshold has been exceeded by way of the value decreasing below a specified limit. This
message is normally, "Below".
"...in Alarm Condition..."
The "...in Alarm Condition..." sound is used in digital alarm annunciations, as a prefix, to
help describe the alarm condition message defined in the data source. This sound is
undefined by default.
97
WIN-911 Configurator
States
"...is in alarm"
The "...is in alarm" sound is used to inform the user that the alarm is in the active state.
This message is normally, "...is in alarm".
"...is no longer in alarm"
The "is no longer in alarm" sound is used to inform the user that the alarm is now in the
inactive state. This message is normally, "...Is no longer in Alarm".
"And is acknowledged"
The "And is acknowledged" sound is used to inform the user that the alarm has been
acknowledged. This message is normally, "...And is acknowledged".
"But is not yet acknowledged"
The "But is not yet acknowledged" sound is used to inform the user that the alarm is still
unacknowledged. This message is normally, "...But is not yet acknowledged".
98
Configuration Menus
Controls
Sound Order
The Sound Order stack determines the sequence in which segments of the alarm
message are to be verbalized. The top segment is the first to be verbalized. To change
the order of the message, highlight the segment to be moved and click the Move Up or
Move Down button.
The Group Sound is configured in the Group Definition. The Tag Sound is defined in the
Analog, Digital, Watchdog, or Filter Definition. The Is/Was Sound, Condition Sound,
Active State Sound, and the Acknowledge State Sound are all defined in Common
Sounds.
Sound Purge
WARNING! The Sound Purge button deletes all wave files in the current sound file
directory. This can be used to fix corrupted wave files by deleting them, and then allowing
WIN-911 to rebuild the wave files with the correct format automatically, during shut down
or with the Sound Build button. Sound Purge may also be used to modify properly working
wave files with for instance a different voice. The Sound Purge option can also be found
in the Tools menu at the top of the WIN-911 Configurator.
Sound Build
99
WIN-911 Configurator
The Sound Build button rebuilds all missing wave files with the selected format and voice.
If using Premium Voice, Sound Build rebuilds the wave files with the rate and pitch as well
as the selected format and voice. This button functions the same as when the
Configurator is shutdown.
Sound Check
Voice telephony requires a standard sound file ("*.WAV") format to ensure smooth
operation. The formats that are acceptable are PCM format, 11025 Hz or 8000 Hz sample
rate, 8 bit, and mono for both Dialogic and TAPI. Because the sound files can be
developed independently and with different voices, both sample rates can end up in the
Sound Files folder. Such a mixing of sample rates or wave formats can cause the voice
module and hardware to malfunction. Specter requires that you standardize on one
sample rate.
To help in this portion of the development if Runtime Voice Synthesis is disabled, the
Sound Check tool can be invoked for a global sound file scan on the spot. This button will
check the format of each sound file and produce a comprehensive list of offending
"*.WAV" files. This list is placed in the WIN-911 V7 folder in the form of a text file titled
"TeleDAC Sound Check.txt". This can be viewed and printed out using Notepad.
The sound check button works very similarly to the Sound Check option in the Tools
menu, except the global sound file scan happens on the spot instead of at shutdown.
More can be read about the Sound Check options in the Tools menu in Chapter 14.
Wave Format
The wave file format can be specified with this pull-down, giving the user the ability to
directly control the sample rate, number of bits, and audio quality.
Note: Users of the Dialogic card or TAPI modem can only play uniformly formatted
"*.WAV" files that conform to the following parameters: PCM, 11 kHz or 8 kHz sample rate
(one or the other but NOT both), 8 bit, and Mono. Check each of the existing files with
Sound Check and convert them as needed.
Note: Runtime Voice Synthesis generates audio streams using the selected Wave
Format.
Wave Files Only
WIN-911 will use only pre-generated wave files when "Wave Files Only" is selected. This
selection is what you would use if you created your wave files externally and put them
onto your system. For users using earlier versions or upgrading, this will be the selection
you would probably prefer.
Text To Speech Wave Files
WIN-911 can use Text To Speech technology to generate audio announcements for use
by the WIN-911 Announcer and Voice/TAPI modules. To do this you must select "Text To
Speech Wave Files". When this radio button is selected TTS technology is invoked. It can
be used by the Configurator to develop sound files for use by Scan & Alarm.
100
Configuration Menus
The sound file option (WIN-911's original and default mode of playing voice
announcements and telephony) provides the developer with two ways to generate wave
files. One way which is automated and part of the WIN-911 Configurator shutdown
routine. The other is manual, using a "Convert Text to Wave" dialog or the "Sound Build"
button.
The automated shutdown routine generates sound files based on available text located in
the associated sound buttons. This is a time saving function that can generate large
numbers of wave files quickly. The drawback to this feature is that the text located in the
associated text box may be insufficient for human consumption. A Tagname may be
"Lift22_em_gen" and require a sound file with some more elaborate speech like "Lift
Station Number 22, Emergency Generator". When this situation arises, simply click on the
Tagname sound button and click "New" and then the "Convert Text to Wave File" dialog
will allow you to specify the exact text you want WIN-911 to annunciate for that field.
Runtime Voice Synthesis
WIN-911 Voice, TAPI, and Announcer modules will play speech that is generated during
runtime by reading appropriate text fields as opposed to playing wave files. This is a
space saving feature for the hard drive because it doesn't need to save any sound files in
the Sound Files folder. This also guarantees that all of the audio will be uniformed, since it
uses the Wave Format configured above.
When using Runtime Voice Synthesis the sound buttons become text boxes that contain
the text that will be "read" by Scan & Alarm during voice annunciations of the WIN-911
Announcer, Voice, and TAPI modules. When one of these buttons is selected the dialog
that will appear is titled "Save Runtime Text String." Rather than associating a sound file
from the Sound Files folder, the Configurator saves the defined text string. The "Convert
Text to Wave File" dialog does not appear in this mode.
Default Voice
This pull down menu selects the default voice to be used by the Text-To-Speech engine
during the generation of speech. Both Text To Speech wave files and Runtime Voice
Synthesis are effected by the default voice.
Rate
The Rate slider bar varies the pace at which the premium voice engine annunciates the
messages (premium voices only).
Note: The Rate slider is only active when a Premium Voice is selected.
Pitch
The Pitch slider bar varies the pitch that the premium voice engine annunciates the
messages (premium voices only).
Note: The Pitch slider is only active when a Premium Voice is selected.
Announce Active Unacknowledged Alarms
101
WIN-911 Configurator
This checkbox determines whether local audio will include/exclude announcements for
"active" alarms that are "unacknowledged".
Announce Inactive Acknowledged Alarms
This checkbox determines whether local audio will include/exclude announcements for
"inactive" alarms that are "acknowledged".
Announce Inactive Unacknowledged Alarms
This checkbox determines whether local audio will include/exclude announcements for
"inactive" alarms that are "unacknowledged".
Announce Active Acknowledged Alarms
This checkbox determines whether local audio will include/exclude announcements for
"active" alarms that are "acknowledged".
102
Configuration Menus
Monitor Definition
Monitor Definition
This button defines the message format for the Monitor window (both the alarm history
and alarm summary). It also selects the acknowledgment options, the security display
options, and the alarm message color choices.
103
WIN-911 Configurator
Appearance
These options allow the developer to customize the attributes and the contents of the
alarm monitor window.
Show title bar
Selecting this check box will make the title bar visible on the alarm monitor window.
Leaving the check box blank will hide the title bar. With the title bar hidden the user
cannot modify (drag) the location of the window nor can the user minimize/maximize the
window. The user still has the ability to resize the window.
Note: Selection of this option will override Show systems menu and Show
Minimize/Maximize selections.
Show systems menu
Selecting this check box will make the Minimize/Maximize controls and the Windows Exit
control visible. Leaving the check box blank will hide all three system menu controls.
Note: Selection of this option will override Show Minimize/Maximize selections.
Show Minimize/Maximize
Selecting this check box will make the Windows Minimize/Maximize controls visible.
Leaving the check box blank will hide the controls.
104
Configuration Menus
Show manual button
Selecting this check box will make the Manual Message button visible on the alarm
monitor. This control can be used to manually send e-mails and pages. Leaving this
check box blank will hide the button.
Note: There must be at least one e-mail, SMS, or Pager notification configured for the
Manual Message button to be visible.
Enable Resizing
Selecting this check box will allow the window to be re-sized by dragging the edges
vertically, horizontally, or diagonally. Leaving the box unchecked will put the window in a
state that cannot be re-sized.
Present history upon critical system events
Selecting this check box will cause the Alarm Monitor to switch its presentation mode from
Summary to History in the event of any critical system events.
Note: The Display Lock button will override this behavior anytime it is engaged.
Present history upon operator change of value
Selecting this check box will cause the Alarm Monitor to switch its presentation mode from
Summary to History in the event of an operator change of value via WIN-411.
Note: The Display Lock button will override this behavior anytime it is engaged.
Maximum History Display
Use this spinner-box to limit the number of lines (records) that will appear when the Alarm
Monitor is running in history mode (maximum is 10,000).
105
WIN-911 Configurator
Acknowledge
These options select different acknowledgment choices available in the runtime Alarm
Monitor. These options affect local system acknowledgments only. It does not affect dialin acknowledgments or acknowledgments made from the HMI/SCADA software. The
selections may be used in any combination.
Enable Total Acknowledge
The user may acknowledge all current alarms at one time by using the "Acknowledge"
button on the monitor dialog. Selecting this check box will make the "Acknowledge" button
visible, leaving this box unchecked will hide the button.
Enable Single Acknowledge
Some applications require individual acknowledgments on an alarm by alarm basis.
Selecting this check box will allow this option. An alarm is acknowledged by double
clicking the displayed alarm message in the monitor's summary view. Leaving this box
unchecked will disable single acknowledgments.
Require Ack Code to Acknowledge
If security and/or enhanced historical alarm record keeping are needed, the user may use
this option to require an operator to enter his/her name and acknowledgment code in
order to have access to local alarm acknowledgments. Selecting this box will activate this
feature. The user also may acknowledge more than one alarm at a time by extending the
106
Configuration Menus
"Relock Time". "Relock Acknowledge in" is used to control how long access is allowed in
minutes before the Ack Code is required to be entered again. If the user selects this
option and selects two minutes for relock, the user may acknowledge as many alarms as
he wishes, without re-entering his code, for up to 2 minutes. In this example, if two
minutes elapses after his last acknowledgment, the system will relock and require his/her
user information to be re-entered to acknowledge the next alarm. A selection of "0"
minutes for relock would require re-entering the code for each alarm. Leaving this box
unchecked will disable password protection.
If the check box is selected, you will notice a button entitled "Lock" which becomes visible
during the relock time described above. Clicking on the button will abort the timer and
automatically relock the acknowledgment sequence, thus requiring re-entry of the
acknowledgment code to acknowledge the next alarm.
Require Ack Code to Exit WIN-911 System
This security feature is provided to restrict unauthorized personnel from shutting down
WIN-911 Scan & Alarm. When selected, a valid "User Name" or "Access Code" and the
matching "Ack Code" is required before WIN-911 will shutdown.
Note: The "Shutdown.exe" and "Restart.exe" command applet ignores this setting and will
shutdown Scan & Alarm automatically. You must enable "Require Ack Code to Shutdown
WIN-911 System" and "Require Ack Code to Restart System" for WIN-911 to require an
ack code for both applets.
Require Global Password to Exit WIN-911 System
This security feature is provided to restrict unauthorized personnel from shutting down
WIN-911 Scan & Alarm. When selected, the global password is required to shutdown
Scan & Alarm.
A Password must be configured in order to have this option enabled. The password is
configured in the Tools menu of the Configurator. See, "WIN911 Configurator.CHM ->
WIN-911 Configurator Menu -> Tools -> Password" for further details.
Require Ack Code to Bypass Alarms
This security feature is provided to restrict unauthorized personnel from bypassing
alarms. When selected, a valid "User Name" or "Access Code" and the matching "Ack
Code" is required before the user can bypass alarms.
Require Ack Code to Override Schedules
This security feature is provided to restrict unauthorized personnel from overriding dialout
schedules. When selected, a valid "User Name" or "Access Code" and the matching "Ack
Code" is required before the user can override dialout schedules.
Require Ack Code for WIN-911 System Standby
This security feature is provided to restrict unauthorized personnel placing WIN-911 in
Standby mode using the Standby applet. When selected, a valid "User Name" or "Access
107
WIN-911 Configurator
Code" and the matching "Ack Code" is required before the user can change the WIN-911
system from Active to Standby.
Require Ack Code to Activate WIN-911 System
This security feature is provided to restrict unauthorized personnel placing WIN-911 in
Active mode using the Activate applet. When selected, a valid "User Name" or "Access
Code" and the matching "Ack Code" is required before the user can change the WIN-911
system from Standby to Active.
Require Ack Code to Shutdown WIN-911 System
This security feature is provided to restrict unauthorized personnel from shutting down
WIN-911 using the Shutdown applet. When selected, a valid "User Name" or "Access
Code" and the matching "Ack Code" is required before the user can shut down the WIN911 system.
Require Ack Code to Restart WIN-911 System
This security feature is provided to restrict unauthorized personnel from restarting WIN911 using the Restart applet. When selected, a valid "User Name" or "Access Code" and
the matching "Ack Code" is required before the user can restart the WIN-911 system.
Note: If WEB-911 is installed alongside your WIN-911 installation, the XStandby,
XActivate, and XApply XTools will allow standby, activate, and restart (respectively)
without an Ack Code. WEB-911 provides its own security.
108
Configuration Menus
Colors
Both the Font Size selection and the Color selection are only applicable for the Alarm
Monitor and the Alarm Log Manager.
Notice that the user has complete selection of foreground and background colors for both
"Unacknowledged" and "Acknowledged" alarms for each of the WIN-911 alarm types.
BG
The BG column is used to select the background color. The selection will then be
displayed to the right of the control.
FG
The FG column is used to select the foreground color. The selection will then be
displayed to the left of the control.
Change Font
The Change Font button brings up the default Windows font selection window. The user
has the ability to select Font, Font Style and Size.
109
WIN-911 Configurator
Format
Each of the items listed on this page is automatically saved as an individual column
listing. You may change or move the appearance (or order) of each column as it is
displayed on the monitor. If, for example, you are not interested in displaying the Priority
(as you have configured all alarms with the same priority), you may move its column
position to the last, and modify the width of the column to a width of zero. To do this,
highlight "Priority" in the list box and "Move Down" to the bottom. You must wait until
runtime to adjust the width of the column.
Date
This field is used to select the desired date format in the alarm messages. The options
provided through a pull down list box are:
None
MM/DD
MMM DD
MM/DD/YY
MMM DD YYYY
DD/MM
110
Configuration Menus
DD MMM
DD/MM/YY
DD MMM YYYY
Time
This field is used to select the desired time format in the alarm messages. The options
provided through a pull down list box are:
None
HH:MM (24 Hour)
HH:MM AM
HH:MM:SS (24 hour)
HH:MM:SS AM
Event
Is the item in an alarm condition, or has it returned to normal? For a Digital Alarm, the
"Event" conditions are:
*ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm).
OK = acknowledged return -to-normal alarm (inactive alarm).
For an Analog Alarm, the conditions are: *High* (first level high alarm), *HiHi* (the second
or highest alarm), *Low* (the first low alarm), *LoLo* (the second or lowest alarm). When
an analog alarm returns to normal without first being acknowledged the event field reports
<High or <<HiHi.
Priority
Each alarm may be given one of three "Priorities": High, Medium, or Low. A discussion on
alarm priorities is found in the alarm configuration section of this manual, (WIN911
Configurator.CHM -> WIN-911 Configuration -> Digital Definitions, Analog Definitions and
Watchdog Timer Definitions).
Group
The name given to a group of alarms, such as: "Reactor Three" or "Section 5 Lift
Stations".
Tagname
The name given to a unique alarm.
111
WIN-911 Configurator
Description
A text field used to describe the "Tagname", or the alarm description. Example: "Water
level".
Value
The numeric value of the alarm at the exact time it was reported.
Units
The Engineering Unit description of the analog value: DEG.F, or GPM.
Limit
The value of the alarm limit.
Acked By
If the proper "Acknowledgment Option" was chosen, this would list the name of the
individual who acknowledged the alarm. For system events (e.g. shutdown of WIN-911),
this field will contain the actor responsible for the event (e.g. the windows login, "XTools
Client", etc.).
Column Order
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his/her needs by highlighting the item and
clicking the Move Up/Move Down buttons.
112
Configuration Menus
Printer Definition
Printer Definition
This button is used to define specific hardware and alignment definitions used by the
alarm printer. The definitions are for alarm printer parallel port assignment and the alarm
text formatting.
Note: Specter recommends a dot matrix or any other type of printer that is capable of
printing one line at a time. Page at a time printers will not be able to provide real-time
information because data is buffered until a page worth of alarm information has been
received.
113
WIN-911 Configurator
Port
The printer can be assigned to None, LPT1, LPT2, or LPT3.
Note that if a printer port is assigned for alarm printing, no other tasks can access the
printer. Do not configure an operating system printer on the LPT port. Alarm printing is
sent to the printer as normal text rather than through standard Windows drivers. The
alarm reporter will not use any special features of the printer.
Note: It is possible to redirect the Alarm Printer Port to a network printer located on a
remote node using a batch file. Refer to our knowledgebase at specterinstruments.com
114
Configuration Menus
Format
Upon a pre-selected condition, an alarm message will be assembled by WIN-911 and
displayed on the output device to bring attention to the condition. The message is
composed of up to ten concatenated text fields. These fields can be arranged in any
order, rigorously formatted, or omitted altogether. Date and Time styles are configured by
pull-down menus while the other fields are formatted by a combination of a text box entry
along with pad and truncate field check boxes.
The user may wish to view the alarm message in a columnar form for presentation effect.
To do this the user should specify each field's character count by adjusting the number in
the associated text box. To omit the field simply enter zero. Checking the Pad Fields
option will ensure that each field contains at least the specified number of characters.
Checking the Truncate Fields option will shorten the field to the specified size, should it
exceed the specified length.
The user may wish to view the entire text of each field. To do so, uncheck the pad and
truncate fields and ensure that the number one (1) is entered for the character count. This
free-form format will take only the number of characters needed to complete each of the
desired fields.
Date
This field is used to select the desired date format in the alarm messages. The options
provided through a pull down list box are:
None
MM/DD
MM/DD/YY
115
WIN-911 Configurator
MMM DD YYYY
DD/MM
DD/MM/YY
DD MMM YYYY
Time
This field is used to select the desired time format in the alarm messages. The options
provided through a pull down list box are:
None
HH:MM (24 Hour)
HH:MM AM
HH:MM:SS (24 hour)
HH:MM:SS AM
Event
Is the item in an alarm condition, or has it returned to normal? For a Digital Alarm, the
"Event" conditions are:
*ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm).
OK = acknowledged return-to-normal alarm (inactive alarm).
For an Analog Alarm, the conditions are: *High* (first level high alarm), *HiHi* (the second
or highest alarm), *Low* (the first low alarm), *LoLo* (the second or lowest alarm). When
an analog alarm returns to normal without first being acknowledged the event field reports
<High or <<HiHi.
Select "1" if you want the Event to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Priority
Each alarm may be given one of three "Priorities": High, Medium, or Low. A discussion on
alarm priorities is found in the alarm configuration section of this manual, (WIN911
Configurator.CHM -> WIN-911 Configuration -> Digital Definitions, Analog Definitions and
Watchdog Timer Definitions).
Group
116
Configuration Menus
The name given to a group of alarms, such as: "Reactor Three". Select "1" if you want the
Alarm Group description to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Tagname
The name given to a unique alarm. Select "1" if you want the "Tagname" to be visible, "0"
will ignore it. (See below for padding or truncating message lengths.)
Description
A text field used to describe the "Tagname", or the alarm description. Example: "Water
level". Select "1" if you want the comment field to be visible, "0" will ignore it. (See below
for padding or truncating message lengths.)
Value
The numeric value of the alarm at the exact time it was reported. Select "1" if you want
the value to be visible, "0" will ignore it. (See below for padding or truncating message
lengths.)
Units
The Engineering Unit designation for the analog value. Select "1" if you want the
Engineering Units to be visible, "0" will ignore it. (See below for padding or truncating
message lengths.)
Limit
The value of the alarm limit. Select "1" if you want the "Limit" to be visible, "0" will ignore
it. (See below for padding or truncating message lengths.)
Pad Fields to Fixed Length
If you select the "Pad Fields" check-box, the number in the text box (character count) that
is associated with each item becomes the fixed length of that item, padded with spaces
out to the specified length.
Truncate Fields to Fixed Length
If you select the "Truncate Fields" check-box, the number in the text box (character count)
that is associated with each item becomes the maximum length of that item. (In the
examples above, the selection of "1" would be nonsensical as only one character of each
selection would be visible.)
Column Order
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his/her needs by highlighting the item and
clicking the Move Up/Move Down buttons.
117
WIN-911 Configurator
Pager Definition
Pager Definition
This button defines the hardware settings and message format for numeric and
alphanumeric pagers.
WIN-911 can send the alarm messages to alphanumeric pagers such as the pagers
manufactured by NEC and Motorola. These pagers have different display sizes, although
the most common size is 4 lines of 20 characters. The overall message size is usually
limited to 199 characters, with the pager handling the scrolling through the message
parts. In addition, many pagers include a received message date and time stamp so that
date and time do not need to be sent.
The pagers typically have 6K to 8K of memory for messages so that the message
capability exceeds the needs of even a shutdown situation. The user must manually clear
the messages when they are no longer needed.
118
Configuration Menus
Ports
The "Ports" tab consists of serial port selection for the modem, and baud rate settings.
Numeric and local pager information is also set-up here.
Note: An important point to keep in mind when configuring applications to process e-mail,
SMS, and pager messages is that their respective modules operate independently. If not
properly implemented they may interfere with each other. Dial-out paging requires a
dedicated modem and phone line. e-mail uses whichever server connection has been
established, including but not limited to dialup networking. Ensure there is no sharing of
hardware (serial port) resources.
Dial-out Paging Port
The pager modem can be set to use None, COM1, COM2, COM3, up to COM256 for
sending paging information.
Note: Although Windows does allow the use of COM3 and COM4 for communications,
COM1 cannot be used simultaneously with COM3, or COM2 cannot be used
simultaneously with COM4, unless different IRQs are used. This effectively means that
COM3 and COM4 should not be used in industrial applications unless special hardware is
used, or software adjustments are made.
Dial-out Alphanumeric Password
The TAP protocol offers an optional security password. If implemented, enter the sixcharacter password in this text-box. If no password is required leave the text-box blank.
119
WIN-911 Configurator
Global Numeric Page Message
The purpose of the Global Numeric Page Message is to identify WIN-911 as the originator
or the numeric page. The numbers entered here are prefixed to the actual alarm numbers.
For example: A Base Number of "411" and an alarm message number of "66" will be
received at the numeric pager as "41166".Numeric messages must be enclosed in square
brackets "[ ]".
Baud Rate
Both the dial-out and local pager connection can be set to a baud rate of 110, 300, 600,
1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200, or 128000. The word size
and parity are handled automatically. This selection controls the speed at which WIN-911
will "talk" to the local modem and/or transmitter, not the external baud rate between the
local modem and the pager company's modem.
Data Bits
Both the dialout and local pager connection data bits can be selected using the provided
pull-down menus. The default setting is 7 data bits which is the setting specified by the
TAP protocol.
Parity
Both the dialout and local pager connection parity can be selected using the provided pulldown menus. The default setting is Even parity which is the setting specified by the TAP
protocol.
Local Port
The local pager transmitter can be set to use None, COM1, COM2, COM3, up to
COM256 for sending paging information.
Note: Although Windows does allow the use of COM3 and COM4 for communications,
COM1 cannot be used simultaneously with COM3, or COM2 cannot be used
simultaneously with COM4, unless different IRQs are used. This effectively means that
COM3 and COM4 should not be used in industrial applications unless special hardware is
used, or software adjustments are made.
TAP or COMP 2 Protocol Radio Button
The WIN911 Local Pager.dll can process numeric and alphanumeric pages with either the
TAP or COMP-2 protocols. Make the selection by clicking on the appropriate selection.
Numeric Delay Between
The delay between the numeric pager dial-string and the entry of the message string is
set in this text-box. The default setting is five seconds.
120
Configuration Menus
Commands
The modem control commands are modem-specific commands that are used for putting
the modem in the proper mode. The default commands should work with most "Hayes"
compatible modems.
Modem Initialization
This command is sent to the modem at program start up. The string sent includes
commands needed for proper operation with WIN-911. In the case of modems with nonvolatile RAM, this string will most likely be 'ATZ^M'. Note that '^M' is equivalent to a
carriage return. This string may be customized, depending on the pager company modem
setup.
Please note that only a "Z" is required in the modem initialization list box because WIN911 automatically attaches an "AT" prefix and a carriage return "^M" suffix to the entry.
Note: Modems with non-volatile memory should be properly configured, and then the
configuration should be saved in the modem's memory.
Dialing Prefix
This command instructs the modem to dial using either tone or pulse dialing. "Hayes"
compatible modems use the command 'ATDT' for tone dialing and 'ATDP' for pulse
dialing.
If your phone system requires a dialing prefix (such as 9 to get an outside line on a PBX
system), you may specify this prefix after the dialing command. To specify a delay time of
121
WIN-911 Configurator
two seconds, place a comma after the prefix (2 seconds is the default for a comma; see
your modem manual for the proper register set). For example, the dialing command to get
an outside line (on most PBX systems) and pause for 4 seconds might be 'ATDT9,,'.
Note: Only the "DT" is required in this list box because WIN-911 automatically appends
an "AT" to the beginning of this entry.
Dialing Suffix
The dialing suffix is appended to the end of the dialing command.
Modem Hang-Up
The modem hang-up instructs the modem to go "on hook" and return to command mode.
Modem Response Timeout
During WIN-911 Scan & Alarm startup, WIN-911 initializes the pager modem by sending it
ATZ commands and awaiting an OK response from the modem. This parameter varies
the amount of time WIN-911 will wait for the OK response. The default time is one
second.
122
Configuration Menus
Connect
The connect result codes are messages sent by the local WIN-911 modem to the Pager
Applet to indicate the state of the connection. The messages defined in this section are
case sensitive and must exactly match the result messages returned by the local modem.
The listings above indicate successful connections.
Note: If none of the "Connect Result Codes" in the left column match the modem's
response, the modem configuration will fail. Any of the "Connect Codes" in the left column
may be altered to reflect the actual response of the modem. Example: Change the
"Connect" to "Connect 300".
123
WIN-911 Configurator
Failed
If the connection was not successful, one of these failure codes will be logged.
124
Configuration Menus
Format
When an unacknowledged alarm event is received, an alarm message will be assembled
by WIN-911 and displayed on the output device to bring attention to the condition. The
message is composed of up to ten concatenated text fields. These fields can be arranged
in any order, rigorously formatted, or omitted altogether. Date and Time styles are
configured by pull-down menus while the other fields are formatted by a combination of a
text box entry along with pad and truncate field check boxes.
The user may wish to view the alarm message in a columnar form for presentation effect.
To do this the user should specify each field's character count by adjusting the number in
the associated text box. To omit the field simply enter zero. Checking the Pad Fields
option will ensure that each field contains at least the specified number of characters.
Check the Truncate Fields option to shorten the field to the specified size, should it
exceed it.
The user may wish to view the entire text of each field. To do so uncheck the pad and
truncate fields and ensure that a number one (1) is entered for the character count. This
free-form format will take only the number of characters needed to complete each of the
desired fields.
Date
This field is used to select the desired date format in the alarm messages. The options
provided through a pull down list box are:
None
125
WIN-911 Configurator
MM/DD
MM/DD/YY
MMM DD YYYY
DD/MM
DD/MM/YY
DD MMM YYYY
Time
This field is used to select the desired time format in the alarm messages. The options
provided through a pull down list box are:
None
HH:MM (24 Hour)
HH:MM AM
HH:MM:SS (24 hour)
HH:MM:SS AM
Event
Is the item in an alarm condition, or has it returned to normal? For a Digital Alarm, the
"Event" conditions are:
*ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm).
OK = acknowledged return-to-normal alarm (inactive alarm).
For an Analog Alarm, the conditions are: *High* (first level high alarm), *HiHi* (the second
or highest alarm), *Low* (the first low alarm), *LoLo* (the second or lowest alarm). When
an analog alarm returns to normal without first being acknowledged the event field reports
<High or <<HiHi.
Select "1" if you want the Event to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Priority
Each alarm may be given one of three "Priorities": High, Medium, or Low. A discussion on
alarm priorities is found in the alarm configuration section of this manual, (WIN911
Configurator.CHM -> WIN-911 Configuration -> Digital Definitions, Analog Definitions and
Watchdog Timer Definitions).
126
Configuration Menus
Group
The name given to a group of alarms, such as: "Reactor Three". Select "1" if you want the
Alarm Group description to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Tagname
The name given to a unique alarm. Select "1" if you want the "Tagname" to be visible, "0"
will ignore it. (See below for padding or truncating message lengths.)
Description
A text field used to describe the "Tagname", or the alarm description. Example: "Water
level". Select "1" if you want the comment field to be visible, "0" will ignore it. (See below
for padding or truncating message lengths.)
Value
The numeric value of the alarm at the exact time it was reported. Select "1" if you want
the value to be visible, "0" will ignore it. (See below for padding or truncating message
lengths.)
Units
The Engineering Unit designation for the analog value. Select "1" if you want the
Engineering Units to be visible, "0" will ignore it. (See below for padding or truncating
message lengths.)
Limit
The value of the alarm limit. Select "1" if you want the "Limit" to be visible, "0" will ignore
it. (See below for padding or truncating message lengths.)
Pad Fields to Fixed Length
If you select the Pad Fields check box, the number in the text box (character count) that is
associated with each item becomes the fixed length of that item, padded with spaces out
to the specified length.
Truncate Fields to Fixed Length
If you select the Truncate Fields check box, the number in the text box (character count)
that is associated with each item becomes the maximum length of that item. (In the
examples above, the selection of "1" would be nonsensical as only one character of each
selection would be visible.)
Label Fields
If you select the Label Fields check-box, the message will be formatted with column
headers and line breaks for each columns results. If the check box is left unchecked, the
message will concatenate all the columns results into a single line of text.
127
WIN-911 Configurator
Column Order
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his/her needs by highlighting the item and
clicking the Move Up/Move Down buttons.
128
Configuration Menus
Voice Card Definition
Voice Card Definition
This button defines the parameters associated with voice telephony. From this dialog you
can define the type of telephony, the timing parameters such as number of rings before
answering an inbound call, and volume. This section is optional and only used if you are
conducting voice telephony call-outs and/or call-ins.
Special Note: When running in Lite Mode Dialogic cards are not supported. All Voice
connections must use a TAPI modem.
129
WIN-911 Configurator
Voice
WIN-911 may use either a TAPI voice modem or Dialogic voice card to handle voice
notification. Use the radio button to select the hardware you will be using.
The drop down menu for compatible devices will list all TAPI compliant modems on your
system. Use it to select your TAPI modem. WIN-911 will be unable to use a TAPI modem
if more than one modem appears in this list. If more than one TAPI compliant modem is
installed, one must be removed.
Special Note: Do not share the TAPI Voice Modem COM port with Local Pager port, SMS
port, or Dialout Pager port selection. WIN-911 will not share COM ports. TAPI Voice
alarming module will not run when a shared COM port is defined.
130
Configuration Menus
Timing
Before aborting dial-out
Enter the number of rings that WIN-911 will allow before it aborts a voice dial-out attempt.
Before pickup in active mode
Enter the number of rings that WIN-911 will allow before it answers an inbound voice call
in active mode.
Before pickup in standby mode
Enter the number of rings that WIN-911 will allow before it answers an inbound voice call
in standby mode.
Before aborting first digit & Before aborting next digit
The default time between a computer requested input and the beginning of a user
response (touch-tone button) is 15 seconds and five seconds before next digit entered. If
the first tone is not entered during the first 15 seconds or the next digit within 5 seconds,
WIN-911 will abort the requested task and hang-up. If you wish to change the default
value, you must edit to increase or decrease the values. If a user input is received prior to
the timeout, the task is completed.
131
WIN-911 Configurator
Control
Volume setting in decibels (+10dB to -10dB)
This setting offsets the default volume of the telephony card up to plus or minus 10
decibels. This parameter is valuable in applications where there is a lot of ambient
industrial noise. The default setting is zero.
Outbound Line Selection
The dialogic card has four phone ports and can receive calls on any of those ports. The
board may only place calls on a single line. Select the line you wish to place your
outgoing calls on with this radio button.
132
Configuration Menus
SMS Definition
SMS Definition
This button defines settings and message formats for the SMS notifier.
WIN-911 can send alarm messages in the form of SMS messages to cell phones using a
wireless GSM modem. The WIN-911/PRO license allows the user to remotely
acknowledge alarms by sending a text message back to the GSM modem. The specifics
of the Ack message are explained in the "Ack Format" section below. WIN-911/PRO
licensed users can also send a health status request to monitor the health of WIN-911. A
list of recommended GSM modems can be found on our website at
www.specterinstruments.com -> Support -> 24/7 Online-> AppNotes -> WIN-911->
Recommended GSM Modem List - 080007.
The overall message size for an SMS message is limited to 160 characters. WIN-911
uses some number of characters to format alarm messages and acknowledgments. As a
result, the character limit is slightly less than 160 for both. These limits are discussed in
the "Message Format" and "Ack Format" sections below.
133
WIN-911 Configurator
Port
The "Port" tab is used to configure the necessary settings for WIN-911 to communicate
with the installed GSM modem.
Port
The GSM modem will be installed on one of the computer's 256 COM ports. Phone and
Modem Options in the Control Panel will tell you to which COM port the modem is
installed. The correct COM port should be configured here.
Special Note: Do not share the SMS COM port with Local Pager port, TAPI Voice Modem
port, or Dialout Pager port selection. WIN-911 will not share COM ports. The SMS
alarming module will not run when a shared COM port is defined.
Data Bits
The GSM modem data bits can be selected using the provided pull-down menu. The
default setting is 8 data bits. Refer to the modem's documentation or contact the modem
manufacturer for the recommended Data Bits.
Baud
134
Configuration Menus
The GSM modem's baud rate may be set from 110 to 921,600. This selection controls the
speed at which WIN-911 will "talk" to the GSM modem. Refer to the modem's
documentation or contact the modem manufacturer for the specified recommended Baud.
Stop Bits
The GSM modem's Stop Bits may be set with 1, 1.5, or 2 stop bits using the provided pulldown menu. Refer to the modem's documentation or contact the modem manufacturer for
the recommended Stop Bits.
Parity
The GSM modem's connection parity may be set to Even, Odd, None, Mark, or Space,
using the provided pull-down menu. The default setting is None. Refer to the modem's
documentation or contact the modem manufacturer for the recommended Parity.
Flow Control
The GSM modem's Flow Control may be set to CtsDtr, CtsRts, DsrDtr, DsrDts, None, or
XonXoff, using the provided pull-down menu. The default setting is None. Refer to the
modem's documentation or contact the modem manufacturer for the recommended Flow
Control.
Modem Response Timeout
This is the total time WIN-911 will always wait for an expected response from the modem.
Setting this value too low may cause the initialization and/or modem commands to fail.
The default value is 10 seconds.
Use "+" character prefix for Country Codes
Some cellular networks require a "+" be prefixed to the beginning of phone numbers.
Should yours require this, check this option.
Network Type
Select the type of network you will be using: either GSM, CDMA, or HSPA. Changing this
selection will also change the Modem Initialization string to match the string that is
required for either network.
Modem Initialization
This string represents the AT command sent to initialize and test the GSM modem. The
default value for GSM networks is: "e0;+CMGS=?;+CMGR=?;+CMGD=1,4," which turns
echo of commands off, tests that sending SMS is supported, tests that reading SMS
messages is supported, and deletes ALL received SMS messages currently on the
modem (also testing that deletion of SMS messages is supported). The default string for
CDMA networks is: "e0," which turns echo off. These default strings are suitable for most
modems, however additional AT commands may be needed to initialize the modem (e.g.
unlocking a locked SIM card, or switching a quad-band modem's country code). Refer to
your modem's documentation or contact its manufacturer for the necessary AT
initialization strings.
135
WIN-911 Configurator
Reset Defaults
Click this button to restore your SMS Device Settings to the default settings. The Network
Type setting will not be affected.
Send Inactive Unacknowledged Messages
Check this box and WIN-911 will send messages for inactive alarms that are not
acknowledged. Leaving this box unchecked means that will not send a message when an
alarm returns to a normal state.
Send Inactive Acknowledged Messages
Check this box and WIN-911 will send messages for inactive alarms that are
acknowledged.
Send Active Acknowledged Messages
Check this box and WIN-911 will send messages for active alarms that are
acknowledged.
136
Configuration Menus
Message Format
Upon a pre-selected condition, an alarm message will be assembled by WIN-911 and
displayed on the output device to bring attention to the condition. The message is
composed of up to eleven text fields. These fields can be concatenated or delimited,
arranged in any order, rigorously formatted, or omitted altogether. Date and Time styles
are configured by textboxes and pull-down menus while the other fields are formatted by
a combination of a text box entry along with minimum/maximum field size lengths.
The user may wish to view the alarm message in a labeled columnar form for
presentation effect. To do this the user should enable "Label Fields" and maybe specify
each field's character count by adjusting the number in the associated text box. To omit
the field simply uncheck the box next to the field in the Field Selection.
The user may wish to view the entire text of each field. To do so uncheck the minimum
and maximum length and place checks in everything under Field Selection. This free-form
format will take only the number of characters needed to complete each of the desired
fields.
Note: SMS alarm messages sent by WIN-911 can contain up to 134 characters, meaning
anything over this number will be concatenated after the 134th character. You can
enable/disable alarm fields as well as adjust the maximum field length for each individual
field to insure the contact receives the entire intended alarm message.
Note: Every SMS alarm message will contain a 6-digit ticket number at the beginning of
each message. This ticket number is used by WIN-911 to keep track of the active alarm.
Also the end of every message will contain the string "Ack:". If the recipient wants to
acknowledge the alarm they will need to send a reply back to the modem. The first 6
digits of the acknowledgement must be the ticket number, and the recipient's Ack code
must be at the end of the message. More details about acknowledging alarms via SMS
are discussed under 'SMS' in the 'Overview' section at the beginning of the help file.
137
WIN-911 Configurator
Tagname
The name given to a unique alarm. This check box is used to enable/disable the
Tagname field. (See Minimum/Maximum Length below for configuring a desired character
length.)
Description
A text field used to describe the Tagname, or the alarm description. Example: "Water
level". This check box is used to enable/disable the Description field. (See
Minimum/Maximum Length below for configuring a desired character length.)
Value
The numeric value of the alarm at the exact time it was reported. This check box is used
to enable/disable the Value field. (See Minimum/Maximum Length below for configuring a
desired character length.)
Acked By
138
Configuration Menus
The user who acked the alarm. If an Ack Code was required to acknowledge the
configured WIN-911 user will be logged. If no Ack Code was required the logged in
Windows user will be logged. This check box is used to enable/disable the Acked By field.
(See Minimum/Maximum Length below for configuring a desired character length.)
Priority
Each alarm may be given one of three "Priorities": High, Medium, or Low. A discussion on
alarm priorities is found in the alarm configuration section of this manual, (WIN911
Configurator.CHM -> WIN-911 Configuration -> Digital Definitions, Analog Definitions and
Watchdog Timer Definitions). This check box is used to enable/disable the Priority field.
(See 'Minimum/Maximum Length' below for configuring a desired character length.)
Event
Is the item in an alarm condition, or has it returned to normal? For a Digital Alarm, the
"Event" conditions are:
*ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm.)
OK = acknowledged return -to-normal alarm (inactive alarm.)
For an Analog Alarm, the conditions are: *High* (first level high alarm), *HiHi* (the second
or highest alarm), *Low* (the first low alarm), *LoLo* (the second or lowest alarm). When
an analog alarm returns to normal without first being acknowledged the event field reports
<High or <<HiHi.
This checkbox is used to enable/disable the Event field. (See 'Minimum/Maximum Length'
below for configuring a desired character length.)
Limit
The value of the alarm limit. This check box is used to enable/disable the Limit field. (See
Minimum/Maximum Length below for configuring a desired character length.)
Units
The Engineering Unit designation for the analog value. This check box is used to
enable/disable the Unit field. (See Minimum/Maximum Length below for configuring a
desired character length.)
Group
The name given to a group of alarms, such as: "Reactor Three". This check box is used to
enable/disable the Group field. (See Minimum/Maximum Length below for configuring a
desired character length.)
Label Fields
139
WIN-911 Configurator
If you select the "Label Fields" check box, each field of the message will be prepended
with a field label (e.g. "Limit: " will appear before the value of the alarm limit). If the check
box is left unchecked, only the contents of the fields will be in the message. Note that
enabling Label Fields will reduce the amount of characters available in the SMS message,
but will make the message more readable.
Abbreviate Labels
If you select the Abbreviate Labels check box, the longer field labels will be abbreviated
(e.g. "Desc.:" instead of "Description"). This will leave more characters for the alarm
message.
Field Suffix (Delimiter)
The "Field Suffix (Delimiter) is used to seperate the enabled fields in the message. By
default NEWLINE (\n) is selected. The user has the option to select one of the fourteen
predefined delimiters or can type in a custom delimiter by typing in the drop down menu.
Only one custom delimiter can be configured at a time. All custom delimiters will appear in
the message exactly as it appears in the Field Suffix (Delimiter) dropdown box. Some
delimiters in the list format the message such as NEWLINE (\n). This delimiter makes
each field appear on a new line. Below explains what will appear in the message when
selected.
LINERETURN (\r\n) = This will separate each selected field with a carriage return - line
feed resulting in each selected field being on a new line.
NEWLINE (\n) = This will separate each selected field with a line feed resulting in each
selected field being on a new line.
NONE () = This will result in nothing separating each selected field. The alarm message
will be concatenated without spaces.
PERIOD (.) = A "." will be used to separate selected fields.
RETURN (\r) = This will separate each selected field with a carriage return resulting in
each selected field being on a new line.
SPACE ( ) = A space will be used to separate selected fields.
TAB (\t) = Five spaces will be used to separate selected fields.
Minimum Length
If you select the Minimum Length check box, the number in the Field Size text box
(character count) that is associated with each item becomes the minimum length of that
item. This can be configured for each selected field.
Maximum Length
If you select the Maximum Length check box, the number in the Field Size text box
(character count) that is associated with each item becomes the maximum length of that
item. This can be configured for each selected field
140
Configuration Menus
Field Size
The number of characters selected allowed for the Minimum, Maximum or both field
lengths. This can be configured for each selected field.
Column Order
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his/her needs by highlighting the item
clicking the Move Up/Move Down buttons. Once the order is set, all selected fields will
group at the top of the list .
141
WIN-911 Configurator
Ack Format
Upon an alarm acknowledgement, an ack message will be assembled by WIN-911 and
displayed on the output device. The message is composed of up to eleven text fields.
These fields can be concatenated or delimited, arranged in any order, rigorously
formatted, or omitted altogether. Date and Time styles are configured by textboxes and
pull-down menus while the other fields are formatted by a combination of a text box entry
along with minimum/maximum field size lengths.
The user may wish to view the ack message in a labeled columnar form for presentation
effect. To do this the user should enable "Label Fields" and maybe specify each field's
character count by adjusting the number in the associated text box. To omit the field
simply uncheck the box next to the field in the Field Selection.
The user may wish to view the entire text of each field. To do so uncheck the minimum
and maximum length and place checks in everything under Field Selection. This free-form
format will take only the number of characters needed to complete each of the desired
fields.
Note: SMS acknowledgement messages in WIN-911 can contain up to 140 characters,
meaning anything over this number will be concatenated after the 140th character. You
can enable/disable alarm fields as well as adjust the maximum field length for each
individual field to insure the contact receives the entire intended alarm message.
Note: The beginning of every SMS acknowledgement message will contain the string
"Alarm Acked" followed by the 6-digit ticket number. This ticket number is used by WIN911 to keep track of all active alarms.
142
Configuration Menus
Tagname
The name given to a unique alarm. This checkbox is used to enable/disable the Tagname
field. (See Minimum/Maximum Length below for configuring a desired character length.)
Description
A text field used to describe the Tagname, or the alarm description. Example: "Water
level." This check box is used to enable/disable the Description field. (See
'Minimum/Maximum Length' below for configuring a desired character length.)
Value
The numeric value of the alarm at the exact time it was reported. This check box is used
to enable/disable the Value field. (See Minimum/Maximum Length below for configuring a
desired character length.)
Acked By
The user who acked the alarm. If an Ack Code was required to acknowledge the
configured WIN-911 user will be logged. If no Ack Code was required the logged in
143
WIN-911 Configurator
Windows user will be logged. This checkbox is used to enable/disable the Acked By field.
(See Minimum/Maximum Length below for configuring a desired character length.)
Priority
Each alarm may be given one of three Priorities: High, Medium, or Low. A discussion on
alarm priorities is found in the alarm configuration section of this manual, (WIN911
Configurator.CHM -> WIN-911 Configuration -> Digital Definitions, Analog Definitions and
Watchdog Timer Definitions). This check box is used to enable/disable the Priority field.
(See 'Minimum/Maximum Length' below for configuring a desired character length.)
Event
Is the item in an alarm condition, or has it returned to normal? For a Digital Alarm, the
"Event" conditions are:
*ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm).
OK = acknowledged return-to-normal alarm (inactive alarm).
For an Analog Alarm, the conditions are: *High* (first level high alarm), *HiHi* (the second
or highest alarm), *Low* (the first low alarm), *LoLo* (the second or lowest alarm). When
an analog alarm returns to normal without first being acknowledged the event field reports
<High or <<HiHi.
This checkbox is used to enable/disable the Event field. (See 'Minimum/Maximum Length'
below for configuring a desired character length.)
Limit
The value of the alarm limit. This check box is used to enable/disable the Limit field. (See
'Minimum/Maximum Length' below for configuring a desired character length.)
Units
The "Engineering Unit" designation for the analog value. This check box is used to
enable/disable the Unit field. (See Minimum/Maximum Length below for configuring a
desired character length.)
Group
The name given to a group of alarms, such as: "Reactor Three". This check box is used to
enable/disable the Group field. (See 'Minimum/Maximum Length' below for configuring a
desired character length.)
Label Fields
If you select the "Label Fields" check box, each field of the message will be prepended
with a field label (e.g. "Limit: " will appear before the value of the alarm limit). If the
144
Configuration Menus
checkbox is left unchecked, only the contents of the fields will be in the message. Note
that enabling Label Fields will reduce the amount of characters available in the SMS
message, but will make the message more readable.
Abbreviate Labels
If you select the "Abbreviate Labels" check box, the longer field labels will be abbreviated
(e.g. "Desc.:" instead of "Description"). This will leave more characters for the alarm
message.
Field Suffix (Delimiter)
The "Field Suffix (Delimiter) is used to separate the enabled fields in the message. By
default NEWLINE (\n) is selected. The user has the option to select one of the fourteen
predefined delimiters or can type in a custom delimiter by typing in the drop down menu.
Only one custom delimiter can be configured at a time. All custom delimiters will appear in
the message exactly as it appears in the Field Suffix (Delimiter) dropdown box. Some
delimiters in the list format the message such as NEWLINE (\n). This delimiter makes
each field appear on a new line. Below explains what will appear in the message when
selected.
LINERETURN (\r\n) = This will separate each selected field with a carriage return - line
feed resulting in each selected field being on a new line.
NEWLINE (\n) = This will separate each selected field with a line feed resulting in each
selected field being on a new line.
NONE () = This will result in nothing separating each selected field. The alarm message
will be concatenated without spaces.
PERIOD (.) = A "." will be used to separate selected fields.
RETURN (\r) = This will separate each selected field with a carriage return resulting in
each selected field being on a new line.
SPACE ( ) = A space will be used to separate selected fields.
TAB (\t) = Five spaces will be used to separate selected fields.
Minimum Length
If you select the Minimum Length check box, the number in the Field Size text box
(character count) that is associated with each item becomes the minimum length of that
item. This can be configured for each selected field.
Maximum Length
If you select the Maximum Length check box, the number in the Field Size text box
(character count) that is associated with each item becomes the maximum length of that
item. This can be configured for each selected field
Field Size
145
WIN-911 Configurator
The number of characters selected allowed for the Minimum, Maximum or both field
lengths. This can be configured for each selected field.
Column Order
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his needs by highlighting the item and
clicking the Move Up/Move Down buttons. Once the order is set, all selected fields will
group at the top of the list .
146
Configuration Menus
E-Mail Definition
E-Mail Definition
WIN-911 can send alarm messages via the Internet as a standard e-mail client. WIN-911
will use the systems established Internet connection to e-mail alarm information. The
connection must be a WAN/LAN connection such as DSL. This is a very powerful tool that
can result in remote alarm notification being received by a variety of output devices.
Depending on the user's service providers, this module can send messages to other
computers, paging services that convert e-mail messages to pages, SMS, fax's, etc.
Note: Specter Instruments does not support the use of Dial-up Networking to connect to
an ISP for e-mail service access. No customer support will be extended to users
attempting this kind of connection setup.
147
WIN-911 Configurator
SMTP Account
The SMTP Account page sets up the e-mail account from which the alarm messages
originate. This requires an e-mail account with an SMTP server and Internet connection.
SMTP Server Name
Enter the SMTP server name in this text box.
Source E-Mail Address
Enter the e-mail address of the account the alarm messages will originate from. The
source e-mail must be a valid e-mail account on the SMTP server.
Subject Source
Define the subject of your alarm messages here. You may specify a literal text string for
all message subjects by selecting User Defined and then entering that string in the field
below. Additionally, the message subject may contain the Group, Tagname or Description
of the alarm that triggered the e-mail.
Keep in mind that some mail servers require a subject message. Also, some mail clients
will mark messages that do not contain subjects as spam.
Fail connect attempt
Enter the amount of time to allow the E-Mail client/server connection to occur before
aborting the attempt. The default setting is 10 seconds and the upper limit is 300.
148
Configuration Menus
SMTP Port
The default port for SMTP servers is 25. If your server listens on another port, enter that
port number here.
149
WIN-911 Configurator
Authentication
Authentication is available using the POP3 standard. The requirement of this option
depends on the e-mail service provider. SMTP account settings must be completed first
before POP3 may be enabled. All possible combinations of SMTP and POP3
authentication are selected via the radio buttons.
POP3 Server Name
Specifies the service provider for incoming messages.
POP3 User Login Name
Specifies the account name assigned by the POP3 service provider.
POP3 User Login Password
Enter the service provider assigned password here.
POP3 Port
The default port for POP servers is 110. If your server listens on another port, enter that
port number here.
Share POP3 User Login Name and Password?
This check box enables SMTP authentication using POP3.
150
Configuration Menus
SMTP User Login Name
Specifies the authentication account name assigned by the SMTP service provider if
different than POP3.
SMTP User Login Password
Enter the service provider assigned authentication password here.
151
WIN-911 Configurator
Format
Upon a pre-selected condition, an alarm message will be assembled by WIN-911 and
displayed on the output device to bring attention to the condition. The message is
composed of up to eleven concatenated text fields. These fields can be arranged in any
order, rigorously formatted, or omitted altogether. Date and Time styles are configured by
pull-down menus while the other fields are formatted by a combination of a text box entry
along with pad and truncate field checkboxes.
The user may wish to view the alarm message in a columnar form for presentation effect.
To do this the user should specify each field's character count by adjusting the number in
the associated text box. To omit the field simply enter zero. Checking the Pad Fields
option will ensure that each field contains at least the specified number of characters. The
Truncate Fields option make the character count the maximum size.
The user may wish to view the entire text of each field. To do so uncheck the pad and
truncate fields and ensure that a number one (1) is entered for the character count. This
free-form format will take only the number of characters needed to complete each of the
desired fields.
Date
This field is used to select the desired date format in the alarm messages. The options
provided through a pull down list box are:
None
MM/DD
152
Configuration Menus
MM/DD/YY
MMM DD YYYY
DD/MM
DD/MM/YY
DD MMM YYYY
Time
This field is used to select the desired time format in the alarm messages. The options
provided through a pull down list box are:
None
HH:MM (24 Hour)
HH:MM AM
HH:MM:SS (24 hour)
HH:MM:SS AM
Event
Is the item in an alarm condition, or has it returned to normal? For a Digital Alarm, the
"Event" conditions are:
*ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm).
OK = acknowledged return -to-normal alarm (inactive alarm).
For an Analog Alarm, the conditions are: *High* (first level high alarm), *HiHi* (the second
or highest alarm), *Low* (the first low alarm), *LoLo* (the second or lowest alarm). When
an analog alarm returns to normal without first being acknowledged the event field reports
<High or <<HiHi.
Select "1" if you want the Event to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Priority
Each alarm may be given one of three Priorities: High, Medium, or Low. A discussion on
alarm priorities is found in the alarm configuration section of this manual, (WIN911
Configurator.CHM -> WIN-911 Configuration -> Digital Definitions, Analog Definitions and
Watchdog Timer Definitions.)
Alarm Group
153
WIN-911 Configurator
The name given to a group of alarms, such as: "Reactor Three". Select "1" if you want the
Alarm Group description to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Tagname
The name given to a unique alarm. Select "1" if you want the Tagname to be visible, "0"
will ignore it. (See below for padding or truncating message lengths.)
Description
A text field used to describe the "Tagname", or the alarm description. Example: "Water
level." Select "1" if you want the comment field to be visible, "0" will ignore it. (See below
for padding or truncating message lengths.)
Value
The numeric value of the alarm at the exact time it was reported. Select "1" if you want
the value to be visible, "0" will ignore it. (See below for padding or truncating message
lengths.)
Units
The Engineering Unit designation for the analog value. Select "1" if you want the
Engineering Units to be visible, "0" will ignore it. (See below for padding or truncating
message lengths.)
Limit
The value of the alarm limit. Select "1" if you want the "Limit" to be visible, "0" will ignore
it. (See below for padding or truncating message lengths.)
Pad Fields to Fixed Length
If you select the Pad Fields check box, the number in the text box (character count) that is
associated with each item becomes the fixed length of that item, padded with spaces out
to the specified length.
Truncate Fields to Fixed Length
If you select the Truncate Fields check box, the number in the text box (character count)
that is associated with each item becomes the maximum length of that item. (In the
examples above, the selection of "1" would be nonsensical as only one character of each
selection would be visible.)
Label Fields
If you select the Label Fields check box, the E-Mail will be formatted with column headers
and line breaks for each columns results. If the checkbox is left unchecked, the e-mail will
concatenate all the columns results into a single line of text.
Column Order
154
Configuration Menus
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his/her needs by highlighting the item and
clicking the Move Up/Move Down buttons.
155
WIN-911 Configurator
Logger Definition
Logger Definition
This button defines the types of historical logging and their format for archiving. Alarm
information, non-alarm events, and diagnostic information are among the things WIN-911 can
record for later analysis. This is an excellent tool for reconstructing events and verifying
accountability. Any one or both of the following log types can be used simultaneously.
156
Configuration Menus
Daily TXT
Daily Text file option will archive alarm activity in a 24 hour based "*.TXT" file. The files
are titled by Julian date such as "A00285.txt", where A is always the first character,
followed by two digits for the year and then three digits for the Julian day of the year.
Hence, the text file A07285.txt is the text file for 11 October, 2007, as it is the 285th day of
the year.
Upon a pre-selected condition, an alarm message will be assembled by WIN-911 and
written to the log file storing a record of the condition. The message is composed of up to
eleven concatenated text fields. These fields can be arranged in any order, rigorously
formatted, or omitted altogether. Date and Time styles are configured by pull-down menus
while the other fields are formatted by a combination of a text box entry along with pad
and truncate field check boxes.
The user may wish to view the alarm message in a columnar form for presentation effect.
To do this the user should specify each field's character count by adjusting the number in
the associated text box. To omit the field simply enter zero. Checking the Pad Field option
will ensure that each field contains at least the specified number of characters. The
Truncate Field option make the character count the maximum size.
The user may wish to view the entire text of each field. To do so uncheck the pad and
truncate fields and ensure that a number one (1) is entered for the character count. This
free-form format will take only the number of characters needed to complete each of the
desired fields.
Date
157
WIN-911 Configurator
This field is used to select the desired date format in the alarm messages. The options
provided through a pull down list box are:
None
MM/DD
MM/DD/YY
MMM DD YYYY
DD/MM
DD/MM/YY
DD MMM YYYY
Time
This field is used to select the desired time format in the alarm messages. The options
provided through a pull down list box are:
None
HH:MM (24 Hour)
HH:MM AM
HH:MM:SS (24 hour)
HH:MM:SS AM
Event
Is the item in an alarm condition, or has it returned to normal? For a Digital Alarm, the
"Event" conditions are:
*ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm).
OK = acknowledged return-to-normal alarm (inactive alarm).
For an Analog Alarm, the conditions are: *High* (first level high alarm), *HiHi* (the second
or highest alarm), *Low* (the first low alarm), *LoLo* (the second or lowest alarm). When
an analog alarm returns to normal without first being acknowledged the event field reports
<High or <<HiHi.
Select "1" if you want the Event to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Priority
158
Configuration Menus
Each alarm may be given one of three "Priorities": High, Medium, or Low. A discussion on
alarm priorities is found in the alarm configuration section of this manual, (WIN911
Configurator.CHM -> WIN-911 Configuration -> Digital Definitions, Analog Definitions and
Watchdog Timer Definitions.)
Group
The name given to a group of alarms, such as: "Reactor Three". Select "1" if you want the
Alarm Group description to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Tagname
The name given to a unique alarm. Select "1" if you want the Tagname to be visible, "0"
will ignore it. (See below for padding or truncating message lengths.)
Description
A text field used to describe the Tagname, or the alarm description. Example: "Water
level". Select "1" if you want the comment field to be visible, "0" will ignore it. (See below
for padding or truncating message lengths.)
Value
The numeric value of the alarm at the exact time it was reported. Select "1" if you want
the value to be visible, "0" will ignore it. (See below for padding or truncating message
lengths.)
Units
The Engineering Unit designation for the analog value. Select "1" if you want the
Engineering Units to be visible, "0" will ignore it. (See below for padding or truncating
message lengths.)
Limit
The value of the alarm limit. Select "1" if you want the "Limit" to be visible, "0" will ignore
it. (See below for padding or truncating message lengths.)
Pad Fields to Fixed Length
If you select the Pad Fields check box, the number in the text box (character count) that is
associated with each item becomes the fixed length of that item, padded with spaces out
to the specified length.
Truncate Fields to Fixed Length
If you select the Truncate Fields check box, the number in the text box (character count)
that is associated with each item becomes the maximum length of that item. (In the
examples above, the selection of "1" would be nonsensical as only one character of each
selection would be visible.)
159
WIN-911 Configurator
Column Order
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his/her needs by highlighting the item and
clicking the Move Up/Move Down buttons.
Days Before Deleting Daily Text Log File
When daily text files are selected as the log file type, the number of days can be specified
that the files are to be kept and then automatically deleted. This is an optional house
keeping function. The default selection is zero, which means the log files will NOT be
automatically deleted.
160
Configuration Menus
Monthly MDB
The Monthly MDB option archives data in a monthly based Microsoft Access database
file. This format allows the user to sort data and append notes to events using the Alarm
Log Manager. This Alarm Log Manager can be found in the WIN-911 Tools folder. The
files are titled with the word History followed by the month and year. An example would be
History 102007.mdb for October 2007.
Upon a pre-selected condition, an alarm message will be assembled by WIN-911 and
displayed on the output device to bring attention to the condition. The message is
composed of up to eleven concatenated text fields. These fields can be arranged in any
order. Date and Time styles are configured by pull-down menus. Unlike the Daily Text File
all other fields are included in their entirety because the database is not restricted in the
number of characters each field can contain or an overall character count for an event.
Date
This field is used to select the desired date format in the alarm messages. The options
provided through a pull down list box are:
None
MM/DD
MM/DD/YY
MMM DD YYYY
DD/MM
161
WIN-911 Configurator
DD/MM/YY
DD MMM YYYY
Time
This field is used to select the desired time format in the alarm messages. The options
provided through a pull down list box are:
None
HH:MM (24 Hour)
HH:MM AM
HH:MM:SS (24 hour)
HH:MM:SS AM
Column Order
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his/her needs by highlighting the item and
clicking the Move Up/Move Down buttons.
162
Configuration Menus
Data Poke Definition
Data Poke Definition
A Data Poke is basically a write operation performed on your SCADA/HMI. This has
several uses, which are discussed in the following sections.
Note: Do not configure WIN-911 to use the same tag for multiple Data Pokes.
163
WIN-911 Configurator
System Health
The System Health Poke sends a heartbeat signal to your HMI/SCADA server. When
provided with a valid item name, WIN-911 will regularly increment a number on your
server to demonstrate the fact that WIN-911 is still running. Should your server detect that
the tag is no longer being incremented, you can take corrective action.
Access Name
Select the data source that should be written to here.
Item Name
This is the address of the tag you wish to write to. Consult your server's documentation
for the proper syntax.
Increment value interval
This is the amount of time between writes.
Special Note: This tag must not be read only and should not be part of the Digital, Analog,
or Watchdog addressing.
164
Configuration Menus
Voice Health
This selection provides clients/servers with an indication of the voice applet's status by
poking a digital (discrete) message. Conditions that represent a failure will be either the
failure of the voice board or a user defined number of unsuccessful call-out attempts. The
voice board and drivers must be present and the timer must be started for the first
condition to report successfully. A failure of this condition constitutes a fatal error and no
voice call-outs will occur; WIN-911 must be restarted for the voice applet to be restored.
The second condition is determined by a user defined number of unsuccessful call-out
attempts. A healthy voice applet will report a digital one (1) and a failure will report a zero
(0).
Number of fails before changing health indicator
The user defined portion of the "Health Indicator" is set in this field. The default number of
failures for this application is three (3). Note that these are not indicative of a fatal error
(WIN-911 does not need to be restarted.). The alarm will be reset after the next
successful voice call.
Access Name
The "Access Name" is used to select a predefined data conversation from the list defined
in the Data Source Definition. This field must be defined.
Item Name
The "Item Name" is used to identify the particular item that WIN-911 will poke to. The
actual name entered will vary from server to server. Consult the server documentation for
additional information. This field is case sensitive and must be defined.
165
WIN-911 Configurator
Special Note: This tag must not be read only and should not be part of the Digital, Analog,
or Watchdog addressing.
166
Configuration Menus
Pager Health
This selection provides clients/servers with an indication of the paging applet's status by
poking a digital (discrete) message. An error free indication depends on two conditions
being satisfied; one of which is user defined and the other is modem dependent. The first
condition requires the modem be present and the timer started for the first condition to
report successfully. A failure of this condition constitutes a fatal error and no paging will
occur; WIN-911 must be restarted for paging to be restored. The second condition is
determined by a user defined number of unsuccessful paging attempts. A healthy pager
applet will report a digital one (1) and a failure will report a zero (0).
Number of fails before changing health Indicator
The user defined portion of the "Health Indicator" is set in this field. The default number of
failures for this application is three (3). Note that these are not indicative of a fatal error
(WIN-911 does not need to be restarted.). The alarm will be reset after the next
successful page.
Access Name
The "Access Name" is used to select a predefined data conversation from the list defined
in the Configure/Data Source Definition. This field must be defined.
Item Name
The "Item Name" is used to identify the particular item that WIN-911 will poke to. The
actual name entered will vary from server to server. Consult the server documentation for
additional information. This field is case sensitive and must be defined.
167
WIN-911 Configurator
Special Note: These tags must not be read only and should not be part of the Digital,
Analog, or Watchdog addressing.
Note for COMP2 Users: This function is very limited for pager systems using COMP2.
This protocol is a simplex or unidirectional protocol and is not capable of determining
which pages are transmitted successfully and which are not. The only thing it determines
is whether the selected COM port is available during startup.
168
Configuration Menus
Group
If more than one alarm occurs per "Group", the message will change (at a default rate of
every 30 seconds) to effectively scroll through all alarms in the selected alarm group. If all
of the alarms in this group are acknowledged in WIN-911, a "GROUP ACKED" string
value is sent to the data source application, thus reporting the "Group" is cleared. If all of
the alarms in this group are acknowledged in the data source application, an "Ack" string
value (case sensitive) is read by WIN-911 and immediately replaced with a "GROUP
ACKED", thus reporting the "Group" is cleared. If the user wants to change the scroll time,
or create a custom message to be sent in place of the "GROUP ACKED" default, change
the ASCII format using this tab. Note: A blank or empty field will effectively erase or clear
a message display or HMI screen reference.
169
WIN-911 Configurator
Format
The alarm message text string will change each time an alarm state change occurs for
that group. Note that only unacknowledged alarms will be transferred or "Poked". The
message is composed of up to eleven concatenated text fields. These fields can be
arranged in any order, rigorously formatted, or omitted altogether. Date and Time styles
are configured by pull-down menus while the other fields are formatted by a combination
of a text box entry along with pad and truncate field check boxes. This format does not
pertain to the Health pokes.
The user may wish to view the alarm message in a columnar form for presentation effect.
To do this the user should specify each field's character count by adjusting the number in
the associated text box. To omit the field simply enter zero. Checking the Pad Fields
option will ensure that each field contains at least the specified number of characters. The
Truncate Fields shortens the field to the selected size.
The user may wish to view the entire text of each field. To do so uncheck the pad and
truncate fields and ensure that a number one (1) is entered for the character count. This
free-form format will take only the number of characters needed to complete each of the
desired fields.
Date
This field is used to select the desired date format in the alarm messages. The options
provided through a pull down list box are:
None
MM/DD
MM/DD/YY
170
Configuration Menus
MMM DD YYYY
DD/MM
DD/MM/YY
DD MMM YYYY
Time
This field is used to select the desired time format in the alarm messages. The options
provided through a pull down list box are:
None
HH:MM (24 Hour)
HH:MM AM
HH:MM:SS (24 hour)
HH:MM:SS AM
Event
Is the item in an alarm condition, or has it returned to normal? For a Digital Alarm, the
"Event" conditions are:
*ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm).
OK = acknowledged return -to-normal alarm (inactive alarm).
For an Analog Alarm, the conditions are: *High* (first level high alarm), *HiHi* (the second
or highest alarm), *Low* (the first low alarm), *LoLo* (the second or lowest alarm). When
an analog alarm returns to normal without first being acknowledged the event field reports
<High or <<HiHi.
Select "1" if you want the Event to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Priority
Each alarm may be given one of three "Priorities": High, Medium, or Low. A discussion on
alarm priorities is found in the alarm configuration section of this manual, (WIN911
Configurator.CHM -> WIN-911 Configuration -> Digital Definitions, Analog Definitions and
Watchdog Timer Definitions.)
Group
171
WIN-911 Configurator
The name given to a group of alarms, such as: "Reactor Three". Select "1" if you want the
Alarm Group description to be visible, "0" will ignore it. (See below for padding or
truncating message lengths.)
Tagname
The name given to a unique alarm. Select "1" if you want the "Tagname" to be visible, "0"
will ignore it. (See below for padding or truncating message lengths.)
Description
A text field used to describe the Tagname, or the alarm description. Example: "Water
level". Select "1" if you want the comment field to be visible, "0" will ignore it. (See below
for padding or truncating message lengths.)
Value
The numeric value of the alarm at the exact time it was reported. Select "1" if you want
the value to be visible, "0" will ignore it. (See below for padding or truncating message
lengths.)
Units
The "Engineering Unit" designation for the analog value. Select "1" if you want the
Engineering Units to be visible, "0" will ignore it. (See below for padding or truncating
message lengths.)
Limit
The value of the alarm limit. Select "1" if you want the "Limit" to be visible, "0" will ignore
it. (See below for padding or truncating message lengths.)
Pad Fields to Fixed Length
If you select the "Pad Fields" check-box, the number in the text box (character count) that
is associated with each item becomes the fixed length of that item, padded with spaces
out to the specified length.
Truncate Fields to Fixed Length
If you select the "Truncate Fields" check-box, the number in the text box (character count)
that is associated with each item becomes the maximum length of that item. (In the
examples above, the selection of "1" would be nonsensical as only one character of each
selection would be visible.)
Column Order
The alarm message is composed of up to eleven text fields that can be arranged in any
order. The user can rearrange the order to suit his/her needs by highlighting the item and
clicking the Move Up/Move Down buttons.
172
Configuration Menus
IP Definition
IP Definition
WIN-911 can send alarm messages in the form of ASCII text to networked clients. Alarm
message transmission can be done either over a RAS (Remote Access Service)
connection or across a LAN. The IP notifier is a 2-way notifier which means it can listen
for acknowledgement responses to come back from the remote endpoint. In order to
make use of the IP connection, an application must be developed by the user in order to
receive and handle messages.
173
WIN-911 Configurator
Connection Settings
The Connection Settings tab contains the connection settings for both your primary and
secondary remote machines, as well as your local machine. Communication timing is also
set-up here.
Primary Remote Dialup Connection (RAS)
Enter the name of the primary RAS Connection. This Dial-up connection is configured to
connect to the primary remote computer via telephone line and modem.
Primary Remote IP Address
Enter the IP Address of the primary remote computer.
Use Secondary
174
Configuration Menus
Select this check box if the user wishes to configure a secondary remote connection. The
secondary remote connection is used only after WIN-911 fails to send the alarm message
to the primary remote machine. WIN-911 will continue to send messages to the
secondary remote machine until the connection is disconnected. The next time WIN-911
receives an alarm, it will try to send to the primary remote machine.
Secondary Remote Dialup Connection (RAS)
Enter the name of the secondary RAS Connection. This Dial-up connection is configured
to connect to the secondary remote computer via telephone line and modem.
Secondary Remote IP Address
Enter the IP Address of the secondary remote computer. IP addresses can only be used
with an 'Always-On' Internet connection, such as cable or DSL.
Attempts
This field configures the number of attempts to be made before failing over to the
secondary connection.
IP Port
This is the TCP port through which the IP connection will be made to the
primary/secondary/local endpoint. Any firewall used must allow connections through this
port.
Local IP Address
Enter the IP address of the local machine. If only RAS connections are being used, the IP
address comes from the RAS connection configured.
Delay Between Attempts (seconds)
This is the number of seconds waited before attempting to send another message after a
failed attempt.
Maximum Idle Time (seconds)
This is the number of seconds to wait for a new alarm before disconnecting from a remote
endpoint. If you are connecting through an always-on connection, WIN-911 will close the
TCP socket. If you are using a RAS connection, WIN-911 will close the TCP socket and
disconnect from the RAS.
Minimum Disconnect Time (seconds)
After disconnecting, WIN-911 will wait this number of seconds before establishing a new
connection to a remote endpoint. This allows a window of time for another application to
access the modem COM port.
Hardware Acquire Delay (seconds)
175
WIN-911 Configurator
When configured to use a RAS Connection on a particular modem, should that modem be
unavailable, WIN-911 will terminate any active connection on the modem in order to send
out an alarm message. The hardware will not immediately become available as the phone
line may still be in use. The hardware acquire delay is the amount of time WIN-911 will
wait before actually attempting to connect.
176
Configuration Menus
Protocol
Transmit Timeout (seconds)
This is the amount of time WIN-911 will attempt to send an alarm across the IP
connection. If transmission is not completed within this amount of time, WIN-911 will
consider the attempt to have failed.
Expected Response
This is the response string expected from the remote endpoint upon receipt of an alarm
message. WIN-911 will not consider the alarm message delivered successfully unless this
string is received. If this field is left empty, then WIN-911 will consider the alarm message
delivered when transmission is completed and will not wait for a response.
177
WIN-911 Configurator
Response Timeout (seconds)
The maximum time to wait for a response to an alarm message. This setting is used only
if an expected response is defined.
Acknowledge Alarm when Expected Response received
If this option is checked, then WIN-911 will acknowledge the alarm sent through the IP
connection when the Expected Response is received. This effectively acknowledges
alarms upon delivery and receipt of delivery. This setting is used only if an Expected
Response is defined.
WIN-911 IP Diagnostic Enabled
This control will enable or disable diagnostic logging, which is useful for debugging issues
with the IP notification module. It is recommended that diagnostic logging not be used
under normal, working circumstances.
Keep-alive Ping
The ping message text may be used to demonstrate to any client application that WIN911 is still connected. It is essentially, a heart beat message. The text is configurable and
may be preceded or followed by the message prefix and suffix as defined on the format
tab.
Use Message Prefix and Suffix
This check box will append any message prefix and suffix to the message string. The
default setting is unchecked.
Note: his setting is shared by the menu item of the same name under the Diagnostic
Logging global menu.
178
Configuration Menus
Format
The format tab's settings determine the format of all alarm messages sent by the IP
Notifier. An alarm message may contain any of the eleven available alarm fields listed
here, arranged in any order. Each field may be padded or truncated to a specified length.
Alarm strings are in the ASCII format and terminated by null characters.
Message Prefix
If supplied, the message prefix text will be appended to the beginning of each alarm
message.
Message Suffix
If supplied, the message suffix text will be appended to the beginning of each alarm
message.
179
WIN-911 Configurator
Date
Use the check box to enable or disable the date field. Select the date field to format the
date's appearance. The format is defined below.
Format
"M" = A single digit representation of the month. (e.g. 1-12)
"MM" = A two digit representation of the month. (e.g. 01-12)
"MMM" = An abbreviated representation of the month (e.g. Jan.)
"MMMM" = The full month name (e.g. January)
"D" = A single digit representation of the day of the month. (e.g. 1-31)
"DD" = A two digit representation of the day of the month. (e.g. 01-31)
"DDD" = An abbreviated representation of the day of the week (e.g. Mon.)
"DDDD" = The full name of the day of the week (e.g. Monday)
"YY" = A two digit representation of the year. (e.g. 08, 09, 10, etc.)
"YYYY" = A four digit representation of the year. (e.g. 2008, 2009, 2010, etc.)
In addition to these 10 date formats, other characters can be used to help format the date.
Any other character configured will appear in the message as it does in the Format text
box. For example: MMM DD, YYYY = Jan. 11, 2009 or M/D/YY = 1/11/09. Use the
Preview button under the Format text box to preview your configured format..
Preview
The preview button is only visible when the date field is enabled and selected. This button
can be used to preview the date format. Note that the preview does not consider minimum
and maximum length options and represents the date string prior to any padding or
truncation.
Time
There are eight available formats for the time field. Examples of the eight selections are
presented below.
HH:MM:SS AM/PM --------------- (e.g. 02:05:30 PM)
HH:MM AM/PM ------------------ (e.g. 02:05 PM)
HH:MM:SS (24 hour) ------------- (e.g. 14:05:30)
HH:MM (24 hour) ------------------ (e.g. 14:05)
HH:MM:SS AM/PM ZONE ------ (e.g. 12:05:30 PM CST)
HH:MM AM/PM ZONE ---------- (e.g. 12:05 PM CST)
HH:MM:SS ZONE (24 hour) ----- (e.g. 14:05:30 CST)
HH:MM ZONE (24 hour) ---------- (e.g. 14:05 CST)
180
Configuration Menus
Tagname
The tagname represents the name of a unique alarm.
Description
The description provides more context for any given alarm.
Value
The value of an alarm can be included in the alarm message. This is the value of the
alarm point at the moment when the alarm was triggered.
Acked By
The "acked by" field lists the user who has acknowledged the alarm. If an Ack Code was
required to acknowledge the alarm, then WIN-911 user will be logged. If no Ack Code was
required, then the current Windows user will be used.
Priority
Each alarm may be assigned one of three priorities: high, medium or low as determined
by your alarm tag's settings. Check this box to pass the priority along in your alarm
message.
Event
The event field indicates the current status of an alarm. A digital alarm may be in one of
the following states:
ALM* = unacknowledged active alarm.
ALM = acknowledged active alarm.
>ALM = unacknowledged return-to-normal alarm (inactive alarm).
OK = acknowledged return -to-normal alarm (inactive alarm).
An analog alarm may be in one of the following states:
*High* (first level high alarm)
*HiHi* (the second or highest alarm)
*Low* (the first low alarm)
*LoLo* (the second or lowest alarm).
When an analog alarm returns to normal without first being acknowledged the event field
reports <High or <<HiHi.
Limit
This is the alarm limit set point.
Units
This is the engineering unit for an analog value.
181
WIN-911 Configurator
Group
The name given to a group of alarms, such as: "Reactor Three".
Label Fields
The "label fields" option is designed to increase the readability of alarm messages. When
enabled, the name of each field will appear before the field's value.
Abbreviate Labels
When "abbreviate labels" is selected, longer field labels will be abbreviated (e.g. "Desc.:"
instead of "Description").
Field Suffix (Delimiter)
The Field Suffix (Delimiter) is used to separate alarm fields. By default, NEWLINE (\n) is
selected. In addition to the fourteen predefined delimiters, users may specify their own
custom delimiter. All custom delimiters will appear in the message exactly as it appears in
the Field Suffix (Delimiter) drop down box. Some delimiters in the list format the message
such as NEWLINE (\n). This delimiter makes each field appear on a new line. Below
explains what will appear in the message when selected.
AMPERSAND (&) = An "&" will be used to separate selected fields.
ASTERISK (*) = An "*" will be used to separate selected fields.
COMMA (,) = A "," will be used to separate selected fields.
DOLLAR ($) = A "$" will be used to separate selected fields.
EXCLAMATION (!) = An "!" will be used to separate selected fields.
LINERETURN (\r\n) = This will separate each selected field with a carriage return - line
feed resulting in each selected field being on a new line.
NEWLINE (\n) = This will separate each selected field with a line feed resulting in each
selected field being on a new line.
NONE () = This will result in nothing separating each selected field. The alarm message
will be concatenated without spaces.
PERIOD (.) = A "." will be used to separate selected fields.
POUND (#) = A "#" will be used to separate selected fields.
RETURN (\r) = This will separate each selected field with a carriage return resulting in
each selected field being on a new line.
SPACE ( ) = A space will be used to separate selected fields.
TAB (\t) = Five spaces will be used to separate selected fields.
TILDE (~) = A "~" will be used to separate selected fields.
Minimum Length
When minimum length is enabled, the field size determines the minimum length of the
currently selected field. If the length of the selected field's value is less than the field size,
then it will be padded with spaces.
Maximum Length
182
Configuration Menus
When maximum length is enabled, the field size determines the maximum length of the
currently selected field. If the length of the selected field's value is greater than the field
size, then it will be truncated to meet the field size.
183
WIN-911 Configurator
Options
Options
These selections will allow the user to customize and tune WIN-911 to meet various
application or performance needs. Upon selecting "Options", you may make modifications
to data initialization, select non-default paths, and adjust Pager and Watchdog Timing
adjustments. Global Direct Connect options are set here as well.
184
Configuration Menus
Paths
By default, Specter Instruments uses the WIN-911 directory for the runtime executable
modules. For the sound files and the historical log files, sub-directories are used. Both of
these selections can be modified by changing the default choices. The example below
shows the default for both the sound files and the alarm history files.
The "Configuration Path" is chosen automatically when you open a selected "*.MDB"
configuration file. The default for the configuration files is a sub-directory named
"Configuration Files".
185
WIN-911 Configurator
Timing
Two types of timing adjustments are available with this option: Paging and Watchdog
Timeouts.
Pagers
Before aborting page:
Enter the seconds that WIN-911 will wait before terminating an alphanumeric dialout
page. The default setting is 5 seconds.
Between initialization returns:
During initialization with the pager service, WIN-911 generates a series of "Carriage
Returns" (CRs) and waits for a response of "ID=". If the pager service requires a slower or
faster sequence of (CRs), the delay time can be modified. The default setting is 2000
milliseconds.
Watchdogs
Default Time-out:
A "Watchdog Alarm" is a type of WIN-911 alarm which monitors the data source. If a
device, DDE Server, or cable is disconnected, an alarm can be sent to the user to warn of
current problem conditions. Each "Watchdog" has a selectable timeout. This option will
186
Configuration Menus
allow the user to change the default setting from 2 minutes to other values. Entries must
be in whole minutes only.
187
WIN-911 Configurator
411
Special Note: When running in Lite Mode, RSView SE Direct Connect, RSView32 Direct
Connect, or FactoryTalk Alarms and Events, WIN-411 Reporting will always be disabled
and the current state of all these settings will be ignored when Scan & Alarm runs.
Do not request confirmation of selected report
Selection of this checkbox bypasses the need for operator confirmation of the report to be
played. The default selection for this checkbox is unchecked.
Do not request confirmation of selected point
Selection of this checkbox bypasses the need for operator confirmation of the point to be
changed. The default selection for this checkbox is unchecked.
Do not request confirmation of data change
Selection of this checkbox bypasses the need for operator confirmation of the new value
to be set. The default selection for this checkbox is unchecked.
Require Watchdog for first item of a Report
Selection of this option will force the first item of each report to be a watchdog type
verification. When this feature is enabled, and the user attempts to access reports, report
188
Configuration Menus
access will not be granted (if the report was defined containing a watchdog and the
watchdog is in the failed state).
189
WIN-911 Configurator
Initialization
These options modify the way WIN-911 is initialized as a client, control DDE error
messages, and offers timing adjustments to allow for large applications to stabilize prior to
initialization.
Runtime Startup Delay
In automatic start-up applications, a delay is often needed to allow the previously
launched data source or hardware to finish initialization prior to a client application starting
its initialization routine. This is most often seen in larger applications. This option gives the
user a way to set a delay before all initialization of Scan & Alarm, including hardware. This
is especially important when running Scan & Alarm as a service. When Scan & Alarm is
configured to run as a service it can initialize before hardware components have time to
start (i.e. Dialogic card).
Start Runtime as Service
Selection of this check box will cause the Scan & Alarm to start as a service. Windows will
need to be restarted in order for the Windows system services to start Scan & Alarm as a
service. When running as a service WIN-911 will be started automatically during the
startup of the operating system and will run in the background regardless of who (if
anybody) is logged in. WIN-911 behaves in much the same way as it does when running
as an application with a few exceptions. For a more detailed explanation of how Scan &
Alarm runs as a service see, WIN911 Configurator.CHM -> Overview ->WIN-911 As a
Service.
190
Configuration Menus
Allow Non-Admin Service Restarts
Selection of this check box will allow a non-administrator to stop and start WIN-911 when
it is running as a Window's service. If this check box is unchecked only users logged in
with Administrative privileges will be able to restart the WIN-911 system.
Start Runtime in Standby (Single Session)
Selection of this check box will cause the Scan & Alarm to start in Standby mode for a
single session. When in standby mode alarm monitoring will occur but no remote
notification will be conducted. This mode of operation is implemented for users wishing to
achieve WIN-911 redundancy. Running the Activate.exe program will change WIN-911's
mode to Active and remote notification will begin. Once WIN-911 has been activated the
check box will clear. You must go back into the configuration and recheck the box to
reset.
Enable DDE Request Upon Initialization
All DDE servers and clients are not alike, and therefore require different initialization
sequences. Selecting this check box will allow WIN-911 to be advised of any change and
then request initial values. By leaving this box unchecked, WIN-911 will only be advised of
a value change.
Log DDE Transaction Failures
The user can choose if he wants to log a DDE transaction failure. Selecting this check box
will enable logging of messages to the configured log file. Leaving it unchecked will ignore
the system generated error mes
191
WIN-911 Configurator
Advanced
Display alarms in Alarm Monitor
This check box will activate the "Monitor" applet when the WIN-911 module is launched.
In the "Monitor" program, you may display either the "Summary Display" or the "History
Display". Selecting the "Summary Display" will show only the alarms which are in alarm
state (both new alarms and acknowledged alarms). Selecting the "History Display" will
show the total history of all alarms since the data base was last cleared up to the user
defined limit (default is 2000). It will give a historical time and date stamped record of
each alarm transition (alarm, acknowledged, and return to normal or "OK").
Note: Any new groups created by a user edit or an import to the configuration will use this
as the default setting for the new group.
Send alarms to Alarm Logger
If this check box is checked, all activity, which would normally show up in the "History
Display", will also be recorded to a log file. Error messages, event logging, call
progression, and acknowledgement information are also logged. A new file is created
daily or monthly, depending on user preference.
Note: Any new groups created by a user edit or an import to the configuration will use this
as the default setting for the new group.
192
Configuration Menus
Send alarms to Alarm Printer
If the "Printer" module is enabled, alarms will be sent to the printer selected in the Printer
Definitions. (See WIN911 Configurator -> Global Menus -> Printer Definition".)
Note: Any new groups created by a user edit or an import to the configuration will use this
as the default setting for the new group.
Send alarms to IP
If the "IP" module is enabled, alarms will be sent to the configured IP address/ RAS
connection defined in the "IP Definition" dialog. (See WIN911 Configurator -> Global
Menus -> WIN911 IP".)
Note: Any new groups created by a user edit or an import to the configuration will use this
as the default setting for the new group.
Enable Local Annunciation
If a sound card is present in the system, you may choose to Enable the Audio
Annunciation features in WIN-911.
Note: Any new groups created by a user edit or an import to the configuration will use this
as the default setting for the new group.
Use Tagname for Item
Selecting this box will cause the "Tagname" to be copied directly into the item name. This
is useful when connecting to other tag oriented programs like Wonderware InTouch, GE
FIX, or RSView SE, etc.
Note: Any new tags created by a user edit or an import to the configuration will use this as
the default setting for the new tag.
Auto Ack on Return to Normal
Selecting this radio button will cause the alarm to automatically acknowledge as it returns
to normal. This option removes the requirement that the associated alarm be responded
to by a person in the event that no one has acknowledged the alarm at the time it returns
to a normal condition. Experiment with all three of these option boxes to get the results
you desire.
Note: Any new tags created by a user edit or an import to the configuration will use this as
the default setting for the new tag.
Use Is/Was
In some cases, using the "Is / Was" sound will not make sense. Selecting the check-box
next to "Use Is / Was" will activate its use. Leaving the check-box blank will omit its use.
An example of this sound would be "The Pump IS on".
Note: Any new tags created by a user edit or an import to the configuration will use this as
the default setting for the new tag.
193
WIN-911 Configurator
Enable Changes by Operator (Digital or Analog)
This check box will allow changes to this alarm or status point. If this check box is left
unchecked, changes will not be allowed. Note: Change by Operator is not supported by
Filter tags.
Note: Enable changes by operator will always be disabled and ignored in Lite mode.
Note: Any new tags created by a user edit or an import to the configuration will use this as
the default setting for the new tag.
Enable Long Tagnames
This check box will only need to be checke if WIN-911 has an error while searching for
lengthy tagnames. The checked box will prevent this error but, it will also slow down the
search time considerable.
Note: Uses this as the default database search method for the WIN-911 Configurator.
194
Configuration Menus
FIX
FIX Program Path
Use of the "Direct Connect" option with GE's FIX will require providing WIN-911 with the
location of the HMI package. The field provided allows the user a choice between
manually entering the path, or using the "Browse" button to invoke the "Select FIX
Directory" dialog box to define the path.
Alarm Queue
WUserQ1, WUserQ2, or AlmUserQ can be selected to pass data to WIN-911 by choosing
the appropriate radio button.
AlmUserQ Name must be declared by WIN-911 and when the AlmUserQ radio button is
selected this text box is enabled. The default name is "TeleDAC" (case sensitive), but the
user may name it anything up to sixteen characters.
Note: Specter Instruments recommends iFIX Dynamics users only use AlmUserQ rather
than either of the WUserQ's.
Special Note for AlmUserQ: The following command line argument must be entered in the
Configure Tasks list in the SCU: /nTeleDAC
Security
195
WIN-911 Configurator
Enable Security checkbox configures WIN-911 for iFIX security features. Text boxes are
provided for the iFIX security Login Name and Password.
Note: Be sure the user login used here can write to all alarm groups. If not,
acknowledgements originating within WIN-911 will not be honored by iFIX.
Alarm on any communications failure
Selection of the "Alarm on any communications failure" checkbox will allow dial-out alarm
processing in the event of a communications failure. If this checkbox is not selected,
alarm processing for communication failures will be prohibited.
196
Configuration Menus
RSView SE
These are the Global Options for the RSView SE Direct Connect.
The RSView tab of the Global Options allows the user to select the Alarm Severity Filter
and Dynamic Properties for the RSView SE Direct Connect data. These are global
settings that apply to all RSView SE Data Sources.
Alarm Severity Filter
The range of alarm severity that WIN-911 will monitor is selected through this pull-down
menu. All alarms falling outside of the selected filter will be ignored. Level one severity is
the most severe.
Dynamic Properties
The RSView SE Direct Connect is designed to allow as much seamless integration
between Rockwell and WIN-911 as possible. This includes receiving as much information
from RSView SE as possible dynamically during runtime, thus preventing the need to
redundantly and statically configure information in WIN-911. However, instances can arise
where this is not desired or possible.
All Dynamic Options: Globally enables all dynamic functions (default setting).
Tag Sounds: Dynamic Tag Sounds is the preferred mode of WIN-911 audio annunciation.
It uses a two tiered hierarchy of optional text sources to build the audio message at
runtime. The first choice of a text source for the Tag Sound extraction is the RSView Tag
197
WIN-911 Configurator
Description. This text will be provided to WIN-911 during runtime as the data is passed
from RSView SE. If the RSView Tag Description is undefined then WIN-911 will use the
WIN-911 Tag Sound which is statically defined in the WIN-911 configuration file. When
both sound text sources are undefined no sound will be generated.
Description: Dynamic descriptions accept description text from RSView during runtime as
alarms occur and are passed to WIN-911. When static descriptions are configured or
dynamic text is not available then WIN-911 uses the text defined in the alarm Base
Definition.
Analog State Sounds: Dynamic Analog State Sounds are generated by reading text
strings acquired from RSView during runtime as the data is passed from RSView to WIN911. This string is called the "Threshold Label." If the Threshold Label is not available
when the alarm data is passed, then WIN-911 falls back to the Analog Sound text that is
statically defined in the WIN-911 configuration (Analog Definition, Sounds tab). When the
check box is left unchecked then the RSView Threshold Label is ignored and only the text
in WIN-911 is used.
Note: If both the dynamic and static analog state sounds are undefined WIN-911 will use
a hard coded string of "Threshold X" for alarm state annunciation, where "X" is a variable
of 1 through 8 representing the actual level.
Digital State Sounds: Dynamic Digital State Sounds are generated by reading text strings
acquired from RSView during runtime as the data is passed from RSView to WIN-911.
This string is called the "Alarm Label." If the Alarm Label is not available when the alarm
data is passed, then WIN-911 falls back to the Digital Sound text that is statically defined
in the WIN-911 configuration (Digital Definition, Sounds tab). When the check box is left
unchecked then the RSView Alarm Label is ignored and only the text in WIN-911 is used.
Priority: Dynamic priority accepts severity level data from RSView during runtime as
alarms occur and are passed to WIN-911. When the alarm priority is configured statically
WIN-911 sets the priority during configuration development and it is not modifiable at
runtime.
Units: Dynamically configured units accept unit text from RSView during runtime as
alarms occur and are passed to WIN-911. When the engineering units are defined
statically they are set in the WIN-911 Configurator during development in the Analog
Alarm Base Definition tab and are not modifiable during runtime.
198
Configuration Menus
Wonderware
Wonderware InTouch Program Path
Use of the "Direct Connect" option with Wonderware's InTouch will require providing WIN911 with the location of the HMI package. The field provided allows the user a choice
between manually entering the path, or using the "Browse" button to invoke the "Select
Wonderware InTouch Directory" dialog box to define the path.
199
Configuration Menus
Configure Menu
These buttons are used to define the specific configuration information for a single
application (either WIN-911 or WIN-411). All changes made to Configuration information
is stored in the "*.MDB" file.
201
WIN-911 Configurator
Schedule Definitions
The list of defined schedules is shown here. If you wish to create a new schedule from
scratch, select "New". You may edit existing schedules by either double clicking or
highlighting the name and selecting the "Edit" button. You may have an unlimited number
of schedules.
The default "Always (24 hours - All week)" schedule is shown below.
Here you will notice that the schedule configuration sheet utilizes a combination of a
repeating cycle distributed across as many weeks as required superimposed on a
calendar. You may name the "Duty Schedule" to fit your application.
Note: Time is defined using a 24-hour time convention. The Start Time must come before
the End Time.
202
WIN-911 Runtime
Phonebook
Phonebook
All WIN-911 users are defined in the Phonebook, along with their contact methods,
access codes and schedule assignments. The following sections discuss the creation of
users and their notification connections.
203
WIN-911 Configurator
Phonebook Entry to Edit
If no names have previously been configured, select "New". You may edit existing names
by either double-clicking or highlighting the name and selecting the "Edit" button.
204
WIN-911 Runtime
Name Definition
This screen contains the definition for the user Tom Jones. His access code,
acknowledgement code and all of his connections are defined here.
Connections are ordered. Use the Move Up and Move Down buttons to arrange the order
in which your user's connections will be attempted.
Name
The Name is a unique identifier for the person that will have Group access. This name is
later found in a list box for selection purposes. Each name in the phone book can have
three options for customizing an initiated call. The options include: phone numbers;
choice of E-Mail, SMS, Voice, or Pager service; and Duty Schedule. Each phone or pager
number also has its own selection for: number of retries, delay between retries, and a
delay between this and the next phone number. The alarms to be directed to the dial-out
connections are selected in the Group Definition section of the configuration.
Name Sound
The user Name Sound is essentially a verbalization of the user name to be used in the
"Voice" dial-out operation. As with any other sounds, the sounds are selected from a
dialog box. A typical message might be "A message for Mr. Smith...". If your application is
for 411 only, or Voice Pager, user name sound is ignored. User name sounds are not
required.
Access Code
The Access Code is a unique numeric code (maximum of 15 digits) that is entered by the
user before alarm messages are provided over the telephone. This ensures that only
authorized persons receive the alarm status reports.
205
WIN-911 Configurator
Zero Access Code
The prompt for an Access Code may be disabled by configuring a user in the Phonebook
with an Access Code of zero. This is only possible when using a Dialogic board. The
prompt will not be disabled when using a TAPI voice modem.
When a user in the Phonebook has an access code of zero, the access code prompt is
bypassed and WIN-911 assumes that all subsequent dial-outs and call-ins are to the user
with an Access Code of zero. As a result, this user must be in all groups if alarms for
those groups are to be announced during a voice call.
When an alarm is acknowledged, an Acknowledgement Code must still be entered. This
code may belong to any user in your Phonebook. If your Phonebook contains duplicate
Acknowledgement Codes, then it is always assumed that the user who is acknowledging
an alarm is the first user in the Phonebook alphabetically.
Note: This feature may allow security breaches to occur. Do not use this feature when
liability or safety is an issue.
Anyone (no code)
If a user name of "Anyone (no code)" (case sensitive) is defined, the access code will be
requested, but a "#" key with no code will allow access, and an acknowledge code will be
requested, but a "#" key with no code will acknowledge alarms. There still must be a
unique Access Code entered in the phone Book of the configuration, but it will be
transparent to the user when he/she interacts with the system.
Note: This feature may allow security breaches to occur. Do not use this feature when
liability or safety is an issue.
Duplicate Access Code
Multiple user names using the same access code can be configured. However, during the
processing of inbound and outbound calls, WIN-911 will not be able to distiguish which
user is calling in and WIN-911 will assume that the user calling is the first person in
alphabetical order that has that Access Code assigned to it. Reusing access codes in not
recommended.
Note: This feature may allow security breaches to occur. Do not use this feature when
liability or safety is an issue.
Acknowledge Code
The Acknowledge Code is a required numeric code (maximum of 15 digits) used to
acknowledge an alarm condition, and can be used for local password entry. The
combination of the user name and Ack code can be used to ensure that alarms are
recognized by the appropriate persons if configured to be unique.
206
WIN-911 Runtime
Connection Definition
Select New or Edit to display the Connection Definition dialog.
Connection
The first selection is a drop down list box to determine the type of connection.
Note: Lite Mode only permits one type of connection to be configured per application.
Phone Number
If the connection is defined as Voice, Voice Pager, Numeric Pager, SMS Message, or
Dialout Announcer, this field contains the telephone number to be dialed. If Alphanumeric
Pager is chosen, this field will contain the pager service number designed to accept
incoming calls from modems. This is the dispatch number that the Pager Service will
assign for automatic computer message dial-ups.
Pager PIN
If Alphanumeric, Local Alpha, or Local Numeric Pager is chosen, this is where the
individual pager PIN number is entered. The maximum size of this number is 255 digits.
The number may include embedded Hayes commands such as "wait" and "pause".
Consult the modem manual for specific information. This field will be inactive for any other
type of connection.
207
WIN-911 Configurator
E-Mail
If E-Mail is chosen, enter the address of your contact here. You may send an E-Mail to
multiple addresses by separating each address by a semicolon.
The address field is limited to 255 characters. If your e-mail addresses exceed that, you
may place them in a text file. Each address should be separated by a newline. The text
file must have an extension of .txt and must be placed in the root directory of your WIN911 folder. By default this is: C:\Program Files\Specter Instruments\WIN-911 V7\. For
example, you may place several addresses, each on their own individual line, in a file
called "emails.txt." The file should then be placed in the root WIN-911 folder and the Email field should read "emails.txt" When a message is sent to that contact, emails.txt is
opened and then each address in the file would be sent the same message. The number
of addresses you may send to is limited only by your SMTP server.
Device ID
The Device ID is required to send messages to mobile devices using the Mobile-911
application. This serves as a sort of phone number or address so that Mobile-911's push
notifications can be routed to your device. Retrieve this number from the Mobile-911
application by navigating to your settings screen. Tap the Send Device ID button and an
email will be composed that contains the Device ID. Send the ID to yourself so that you
may copy and paste the ID from your email client.
Country Code
If an SMS Message connection is defined, this field contains the contact's country code
prefix. The country code for the United States and Canada is 1.
Number of Retries
If the phone or pager service is busy, not answering, or is answered by an answering
service, (Access Code was not entered), do you want to retry this number prior to going to
the next listed number or next person in the "Phone Book"? Or, if the e-mail service does
not send back a successful response, do you want to retry this e-mail address prior to
going to the next listed number or person in the "Phone Book"? Or, if the SMS module is
unable to send your message (e.g. signal strength too low), do you want to retry sending
the message prior to going to the next listed number? A value of "0" in this box will only
dial the number one time. A value of "3" (or any non-zero number) would retry this
number an additional three times (or equal to the integer in the box). Not all connection
types support retries.
Delay Between Retries
This is the number of minutes or seconds to wait before trying a connection again.
Delay Between Same Connection Type
Delay Between Same Connection Type is the number of minutes or seconds to wait
before trying the next connection of the same type. If you wish to separate each SMS, email, or other connection by five minutes, you would need to configure a five minute delay
208
WIN-911 Runtime
between each connection. The important thing to note is that the delay is between the
next connection of the same type, and not the next connection.
The Duty Schedule
Each connection may have a unique schedule for selecting the day or days that each
connection is valid, along with the starting time and stopping time for each day. The
number is dialed only on valid days and times. If more than one number is valid, each
valid number is called.
Note: A pre-existing, unacknowledged alarm will not be dialed out to a single user if
he/she comes on-duty after that Item has gone into an alarm condition. If the Group has
other users which were on call at the time of the alarm and the call-out is still in progress,
he/she will be added to the call out list.
Selecting a Duty Schedule
A list box selection will allow choices of pre-configured duty schedules. If you do not find a
schedule which fits your needs for this number, you may edit or add additional duty
schedules using the Schedule Definition discussed in the previous section.
209
WIN-911 Configurator
Data Source Definitions
Data can be served to WIN-911 generically or by custom data services where WIN-911 is
the client. OPC and DDE are the generic modes of data service and Direct Connect is the
custom data service available to meet the needs of the user. For more specific details
about the Data Source Definition see the data source's corresponding .CHM file in the
WIN-911 Help Library.
Select the Data Source Type
The "Data Source Type" list box shows all available data source connections. The user
specifies the data source by selecting one in the list. The user is then brought to a the
"Data Source Options" window. For more details about the "Data Source Options"
window, see the data source's corresponding .CHM file in the WIN-911 Help Library.
Data Source Definition to Edit
210
WIN-911 Runtime
The "Data Source Definition to Edit" window shows all configured data sources. Selecting
"Edit" or double-clicking on the "Access Name" will bring you back to the corresponding
"Data Source Options" window.
211
WIN-911 Configurator
Group Definitions
Group Definitions
This button is used to build "Groups". Groups are used to associate information with
people. Each data tag (alarm or information) is assigned to one group (and one group
only). A Group can have any number of data tags assigned to it. Each group has its own
Contact List that assigns people from the phone book and the order they are to be
contacted in. With this functionality you can organize your remote alarm notification
tasking in a compartmental fashion with different people (or teams) assigned to different
alarms (or alarm areas).
An example of an effective Group strategy might be a city water system that is composed
of a network of lift stations scattered throughout the city. If the city is large, you may need
to organize your groups into lift stations, with different people assigned to each lift station.
Group Definition to Edit
If a "Group" has not previously been configured, select "New". You may edit existing
"Groups" by either double clicking on or highlighting the name and selecting the edit
button. You may have an unlimited number of groups.
Selecting the "New", "Edit", or "Copy" button from the "Group Definition to Edit" brings you
to the "Group Definition" dialog.
Group Definition
A selection of the "Fresh Water Storage" group in the above example will bring up the
"Group Definition" dialog box. You may have an unlimited number of groups. For
example, you may want a separate group per lift station in a wastewater application.
It is with this dialog box that you can decide which alarms are to be "audible" and which
shall be merely displayed on the video monitor and logged to the printer. This step also
defines which alarms will be routed to the dial-up options. You may also use different
groups to "direct" which alarms are routed to the supervisor and which are simply
reported to the operators. Each alarm may only be used with one group. Applications,
212
WIN-911 Runtime
which require that the same alarm be assigned to several "Groups", will require you to
configure the same alarm with a different "Tagname" but with the same "Item Name".
213
WIN-911 Configurator
Base Definition
Group Name
This is a unique name used to identify the group. This name may be used in alarm
messages if desired. This name will appear in a pull down list box for future "Group"
selection. Note that if the name is changed after it is assigned to a specific data point, the
name change will be shown automatically.
Special Note for Numeric Pager Users
If a group reference number is needed in a numeric representation alarm, include it in the
group name with square brackets, such as: Lift Station [22]. The numeric pager option will
strip the alpha characters and send the numeric.
Display alarms in Alarm Monitor
This check box will activate the "Monitor" module when the WIN-911 module is launched.
In the "Monitor" window, you may display either the "Summary Display" or the "History
Display". Selecting the "Summary Display" will show only the alarms which are in alarm
state (both unacknowledged alarms and acknowledged alarms). Selecting the "History
Display" will show the total history up to the user defined limit (default 2000) of all alarms
and WIN-911 activities since Scan & Alarm was last started. It will give a historical time
and date stamped record of each alarm transition (alarm, acknowledged, and return to
normal or "OK").
Send alarms to Alarm Logger
214
WIN-911 Runtime
If this check box is checked, all activity, which would normally show up in the "History
Display", will also be recorded to a log file. By default, all log files are stored in the
"C:\Program Files\Specter Instruments\WIN-911 V7\Log Files" directory. Error messages,
event logging, call progression, and acknowledgement information are also logged. A new
file is created daily or monthly, depending on user preference.
Send alarms to Alarm Printer
If the "Printer" module is enabled, alarms will be sent to the printer configured in the
"Printer Definition" dialog.
Send alarms to IP
If the "IP" module is enabled, alarms will be sent to the configured IP address/ RAS
connection defined in the "IP Definition" dialog.
Pop-Up Alarms
A selection of a "Pop-Up Alarm" for the group will cause one of the following reactions for
any alarm condition in this group.
None
A selection of "None" will disable the "Pop-Up" feature for this group of alarms.
Summary List on New Unacked
If a "Pop-Up Alarms" selection of "Summary List on New Unacked" is made, any new
unacknowledged alarms will cause the Monitor (Summary) view to appear over any other
window. If the Monitor program is minimized, the view will be restored to the last location
and size. The display option must also be selected.
Summary List on Any Change
If a "Pop-Up Alarms" selection of "Summary List on Any Change" is made, any alarm
(including a return to normal) will cause the Monitor (Summary) view to appear over any
other window. If the Monitor window is minimized, the window will be restored to the last
size. The display option must also be selected.
Box
If the "Pop-Up Alarms Box" option is checked, any new unacknowledged alarms will
appear in its own individual pop-up dialog box. The dialog box will appear over any other
window and will disappear when the alarm is acknowledged. If this option is used, it is
recommended that the WIN-911 Monitor run as a minimized window. The display option
must also be selected.
215
WIN-911 Configurator
Contact List
Even though "Phone Book" names are selected here for remote dial-outs, it is important
to realize that WIN-911 creates a different queue for each connection type. Therefore, it
is possible for WIN-911 to be making an alphanumeric or numeric page and/or e-mail at
the same time it is making a voice dial-out alarm call.
Available Name List
The "Available Name List" contains all the contacts previously defined with in the "Phone
Book Definitions".
Selected Name List
The "Selected Name List" contains the "selected" names, which are assigned for this
group. To select a name, highlight the desired name and click on the "Add" button. To
remove a name from the "Selected Name List", highlight the desired name and click on
the "Remove" button. You may place the same person in the list more than once. The
location of the name in the list determines the order of alarm notification attempts. You
may organize the list in any desired order by using the "Move Up" and "Move Down"
Buttons. Phone numbers, retries, and retry delays are found in the "Phone Book."
216
WIN-911 Runtime
Contact Delays
Delay Before First Voice Call
"Delay Before First Voice Call" is used to allow time for an alarm to be acknowledged
locally before any voice calls are made. This time is expressed in either minutes or
seconds, depending on the selection from the pull down list box. This setting is
independent of the paging and e-mail delays.
Note: For voice calls there is only one delay timer, which is started with the generation of
an alarm. If a second alarm is generated during the timeout, the timer will be reset for the
callouts to begin. Configuring a long delay creates a situation conducive for a randomly
extended delay before voice calls commence.
Delay After Last Voice Call
"Delay After Last Voice Call" is used to select one of two possible options: 1) Single pass
through the contact list, or 2) Continuous cycling through the group contact list until
alarm(s) are acknowledged. A value of "0" will select a single cycle. Any other integer
value will select continuous cycling and the delay time in minutes or seconds, depending
on the selection from the pull down list box. This setting is independent of the paging and
e-mail delays.
Delay Before First Page, E-Mail, SMS and/or Mobile-911
"Delay Before First Page, E-Mail, SMS and/or Mobile-911" is used to allow time for an
alarm to be acknowledged before any pages, e-mails, SMS, or Mobile-911 messages are
217
WIN-911 Configurator
made. This time is expressed in minutes or seconds, depending on the selection from the
pull down list box. This setting is independent of the voice delays.
Delay After Last Page, E-Mail, SMS and/or Mobile-911
"Delay After Last Page, E-Mail, SMS and/or Mobile-911" is used to select one of two
possible options: 1) A single pass through the contact list, or 2) Continuous cycling
through the group contact list until the alarm(s) is acknowledged. A value of "0" will select
a single cycle. Any other integer value will select continuous cycling and the delay time in
minutes or seconds, depending on the selection from the pull down list box. This setting
is independent of the voice delays.
Special Note: You must specify a Delay After period greater than zero if you wish to
repeat the contacts in the contact list. If a zero is entered, the list is only contacted once.
218
WIN-911 Runtime
Group Poke
The "Group Poke" is used to send ASCII alarm messages to a DDE/OPC server. If the
DDE/OPC address is used by an application program, the alarm messages can be used
as any other ASCII string within the program. Some HMI software packages have the
ability to build "script language programming". Using this feature will allow WIN-911 to
acknowledge alarms in the HMI display, or to send an acknowledgement to a driver or
field device (such as a PLC).
Access
This field is a pull down list that contains all previously defined Data Source Access
Names for data sources which support Group Pokes.
Item
The "Item" field defines the "Item" that will receive the ASCII message containing the
alarm string. The alarm string is configured in the "Data Poke Definitions" under the
"Group Poke" tab. (see, WIN911 Configurator.CHM -> WIN-911 Global Menus -> Data
Poke for details.) The message will change immediately each time a new alarm state
change occurs for that group. Note that only unacknowledged alarms will actually be sent.
If more than one alarm occurs in that group, the message will cycle every 30 seconds
(default value) to effectively scroll through all alarms in the selected alarm group. If all of
the alarms in this group are acknowledged, a "global string" is sent to the DDE/OPC
address, thus overwriting the alarm string. If the user wants to change the message cycle
time, or design a custom message to be sent in place of the "Global Group Ack Text", the
default settings must be modified in the "Data Poke Definitions".
219
WIN-911 Configurator
Special Note: This function is used for remote acknowledgement from within data source
software or display of alarms for remote messaging systems. The data type for the tag
used must be an ASCII string and must not be read only. This tag is not part of the
Analog, Digital, Filter, or Watchdog address.
Group Poke - Interfacing 3rd Party Software
The "Group Poke" functions as a "Client" that will both read and write a DDE/OPC
message. This will make it possible for a "third party" application to "Acknowledge" any
WIN-911 Alarm Group. The purpose of the Group Poke is to receive acknowledgements
from the applications software to WIN-911 or notify the applications software of new
alarms.
It is quite often desirable to closely couple the graphics HMI software and WIN-911. Since
WIN-911 is a generic solution to alarm management and telephonic data acquisition, a
simple, universal interface between the two applications is made possible by the group
poke transfer. This is configured as part of the "Group Definition" and is used to send
alarm messages to a DDE/OPC server. If the HMI package has the ability to interpret
ASCII strings and logically react to the string values (sometimes called "Script Language
Programming"), the HMI software can interact with WIN-911. Using this feature will allow
WIN-911 to acknowledge alarms via the HMI display or to send an acknowledgement to a
driver or field device (such as a PLC).
To Send Alarms or "GROUP ACKED" from WIN-911 to the Applications Software:
Configure a "Data Poke" with a valid data link to the target applications software. This tag
must be created and should be reserved within the application software for the purpose of
receiving a text string. When an alarm occurs (which is assigned to this Group), WIN-911
will send the alarm message string to the Application's data address. The format and
structure of the Data Poke message must be defined. To define the format of the transfer
message go to the "Data Poke Defintions" from the main WIN-911 Configurator. There
are nine fields available which may be selected for transmission, including time and date.
(see WIN911 Configurator -> WIN-911 Global Menus -> Data Poke -> Format for more
details.)
If more than one alarm has occurred for that "Group", the ASCII Messages for all active
alarms will be transferred at a given cycle rate, effectively rotating the messages
displayed in the application software. The time period for this rotation is defaulted to 30
seconds, but can be changed by a setting in the Message Cycle Time on the "Data Poke
Definition's" "Group" tab. If all alarms in the "Group" are "Acknowledged", the global
Acknowledge text string is sent to the Application's data address. If the user wants to
change the scroll time, or edit the global Ack text string to be sent in place of the "GROUP
ACKED", see WIN911 Configurator -> WIN-911 Global Menus -> Data Poke -> Format for
more details.
To Send an "Ack" from the Applications Software to WIN-911:
When an Acknowledgement occurs within the HMI application software, the Application
must write the text string "Ack" (case sensitive) to the data tag name. WIN-911 monitors
all Data Poke tags and when the "Ack" is detected, WIN-911 will acknowledge all alarms
within that Group. After acknowledgement occurs within WIN-911, WIN-911 will send a
"GROUP ACKED" string (or custom message) to the data tag. This process will notify the
220
WIN-911 Runtime
application that the alarms have been acknowledged and clear the application, making it
ready for the next alarm condition.
Note: Do not use a single data address (TAG) in an HMI for more than one WIN-911
Group or for any other purpose.
Examples
If an alarm occurs in WIN-911, an ASCII alarm description is sent to the application
software from WIN-911 to the designated tag within the application software. When the
alarm is acknowledged within Scan & Alarm, WIN-911 sends an "all clear" message in the
form of the Global Group Ack Text to replace the alarm description in the application
software.
The application software can also acknowledge the alarm and transfer the
acknowledgement back to WIN-911 by writing a literal ASCII string containing the three
letter sequence of "Ack" (case sensitive) to the tag within the application software. WIN911 will read the "Ack" message, acknowledge the alarm(s) within that Group, and then
poke the user defined acknowledgement message (Global Group Ack Text).
221
WIN-911 Configurator
Sound
The Sound tab of the Group Definition dialog will associate a group sound and allow local
sound to be activated at the runtime computer. In many applications, the operators may
not be constantly watching the HMI/SCADA software. If an alarm occurs, much time may
expire before a visual alarm is noticed. The Sound option on WIN-911 will alert the local
operator of an alarm condition, which will then prompt attention.
Group Sound
The Group Sound is essentially a verbalization (or sound effect) of the Group name to be
used in both the audio annunciation and voice telephone connections. As with any other
sounds, the sounds are selected from a dialog box. Another example of a common
"Group Sound" is a siren, or alert horn.
Announcer Enabled
If a sound card is present in the system, you may choose to Enable the Audio
Annunciation features in WIN-911. Audio alarms are composed of several selected
sounds, which are automatically strung together to form a message. The format of a
complete audio alarm message is: GROUP SOUND + TAG SOUND + "IS / WAS" +
CONDITION SOUND + ACTIVE STATE SOUND. Any one of the six parts can be turned
off to fit your unique application. A typical example of a verbal alarm message is:
"Conveyor Number 4", "Selector Arm", "Is", "Jammed", "and is", "Active". To continue the
example: You might have 10 conveyor systems that are identical. To offer the same
alarming capability to each one, you would only need to create 10 "Group Sounds"
(Conveyor 1 through Conveyor 10) and create 10 groups of alarms. However, if you
wanted all 10 conveyors to use the same paging or telephone list, then you would need to
222
WIN-911 Runtime
have unique TAG sounds identifying each conveyor and possibly disabling the "Group"
sound. All 10 alarms would be assigned to the same group.
Repeat Enable / Duration
The Group Definition also gives you the choice of repeating the audio announcement of
unacknowledged alarms. Selecting a "0" in the edit field will disable the repeat feature. A
selection of "5" in the "Repeat" edit field "Minutes" in the Minutes/Seconds spinner will
cause any unacknowledged alarm to be announced every 5 minutes (or seconds), until
acknowledged.
Special Note: You must specify a Repeat period greater than zero if you wish to repeat
the announcements for this group. If a zero is selected, the group is only announced
once.
223
WIN-911 Configurator
Filter Definitions
Filter Definition
This button is used to define all filter points. Filter tags consist of both digital and analog
points. Filter tags are different from statically configured Digital, Analog and Watchdog
tags in that no import is necessary. Filter tags subscribe to alarms on the fly depending on
the criteria configured. Criteria is configured at both the data source level (Global Options)
and tag level (Filter Definition). Filter tags are configured using this button.
Note: Filter Tags are not supported by all data sources. See the data source's
corresponding .CHM help file in the WIN-911 Help Library for more details on Filter
Definitions.
Filter Definition to Edit
"Alarms" are arranged by "Groups". Using the pull down list box, select the "Group" that
the new or existing alarm is assigned. Only the alarms associated with the "Group" will be
listed. You may select the appropriate "Group" by the pull-down list box, or select "All
Groups".
After selecting the specific "Group" or selecting "All Groups", you are ready to add or
modify digital alarms.
224
WIN-911 Runtime
Selecting "New", "Edit", "Copy" or double-clicking on the "Filter Tag" will bring up the Filter
Definition window.
225
WIN-911 Configurator
Base Definition
Tagname
The WIN-911 Filter Tagname is a symbolic tool that allows the user to assign names to a
Filter tag or group of tags that are created by the tags filters and properties. It should be
kept in mind that this is WIN-911's name for the Filter alarm point or points not the data
sources.
Filter
The "Filter" allows you to subscribe to a specific set of alarms. This can be done by
clicking the Edit Filter button. The Edit Filter button opens up the data source's Filter
dialog. The Filter dialog allows the user to configure filters using data and syntax specific
to supported data sources. See the data source's corresponding .CHM help file in the
WIN-911 Help Library for more details on the Filter dialog and Filter Syntax.
Group Name
Alarms are organized by groups for reporting out-of-tolerance conditions. You have by
now created a unique digital alarm or point. You must choose a predefined "Group" to
specify the reporting actions for this alarm. (Remember, you have already selected a
group name, specifying the reporting options and an optional sound for this group.) A
226
WIN-911 Runtime
review of the "Group" button is not a bad idea here. To select another "Group", click on
the drop-down arrow with the cursor and choose. You may change the Group assignment
(move the tag to another group) simply by selecting another defined "Group" from the
drop down list box.
Alarm Type
Filter tags can monitor both Digital and Analog tags. If supported by the configured data
source, the Alarm Type drop down menu allows the user to specify the type of alarm the
Filter tag subscribes to. By default Any Alarm is selected.
Use Is / Was
In some cases, using the "Is / Was" sounds will not make sense. If supported by the
configured data source, selecting the check-box next to "Use Is / Was" will activate its
use. Leaving the check-box blank will omit its use. An example of this sound would be
"The Entry Door IS open".
Access Name
The "Access Name" is used to select a predefined data conversation from the list of
supported sources defined in the "Data Source Definitions".
Automatic Acknowledgement
Never
Selecting this radio button will require a manual acknowledgement of the alarm.
On Alarm
Selecting this radio button will cause the alarm to automatically become "Acknowledged"
as it enters into an alarm condition. This option would allow audio reports of an alarm's
current condition without initiating other reporting options listed in the "Group". If this
option is active, the message (going into an alarm condition) will not generate "Pop-Up"
alarm messages or any of the remote notification options. Because the alarm is
automatically acknowledged, the message coming back to a normal state would indicate
that the condition is in the normal mode. The "Was" message would never be used.
On Return To Normal
Selecting this radio button will cause the alarm to automatically acknowledge as it returns
to normal. This option removes the requirement that the associated alarm be responded
to by a person in the event that no one has acknowledged the alarm at the time it returns
to a normal condition. Experiment with all three of these options to get the results you
desire.
227
WIN-911 Configurator
Setup
These settings are not supported by all data sources. Refer to the help document for you
data source.
Digital Alarm and Normal Labels
These text strings are generic labels for the Filter Digital Alarm and Normal conditions.
Digital Priority
Alarm Priorities (Data Source) and Alarm Priorities (WIN-911) accomplish much the same
thing by sorting alarm message urgency in a way that ensures the alarm with higher
urgency gets priority in the remote notification sequence. Higher priority alarms will go to
the front of the line in the contact sequence while alarms with the same priority are
handled on a first come first serve basis.
For more details on Digital Alarm Priority mapping see the data source's corresponding
.CHM help file in the WIN-911 Help Library.
Analog Alarm Setpoint Enables
"Analog Alarm Setpoints" are enabled and disabled using the four corresponding
checkboxes. Since different data sources can have different ways for configuring
setpoints and thresholds WIN-911 must map these thresholds to four setpoints. For more
228
WIN-911 Runtime
details on Analog Alarm Setpoint mapping see the data source's corresponding .CHM
help file in the WIN-911 Help Library.
Analog Alarm Setpoint Priorities
Alarm Priorities (Data Source) and Alarm Priorities (WIN-911) accomplish much the same
thing by sorting alarm message urgency in a way that ensures the alarm with higher
urgency gets priority in the remote notification sequence. Higher priority alarms will go to
the front of the line in the contact sequence while alarms with the same priority are
handled on a first come first serve basis.
For more details on Analog Alarm Setpoint Priority mapping see the data source's
corresponding .CHM help file in the WIN-911 Help Library.
Number of Decimal Places
WIN-911 supports two types of analog data types: "Integer" or "Floating Point". WIN-911
supports: a) 32 bit signed integer values, and b) 32 bit IEEE floating point values. Note:
Acceptable Floating Point numbers (without round-off errors) are 3.4 e38, or a resolution
of 7 digits. Values beyond seven digits will exhibit round-off errors. "Integer Data Type" is
the default type and represented as "0" "Number of Decimal Places". To select "Floating
Point", select the "Number of Decimal Places" to something other than "0".
Engineering Units
The "Engineering Units" field is an optional text string which identifies the engineering
units a value represents. Analog values may be scaled and displayed as real world units
of measure.
229
WIN-911 Configurator
Tag Sound
The "Tag Sound" is essentially a verbalization of the "Tagname" to be used in the audio
annunciation. As with any other sounds, the sounds are selected from a dialog box. This
sound is required for any voice connection. Note that not all data sources support the tag
sound; see the data source's corresponding .CHM help file in the WIN-911 Help Library
for more details concerning Filter Tag Sounds
.
230
WIN-911 Runtime
Digital Sound
Sounds are essentially a verbalization of the alarm description and the "Alarm" and
"Normal" sound to be used in the audio annunciation. As with any other sounds, the
sounds are selected from a dialog box. Note that not all data sources support these digital
sounds. Refer to the help documentation for your data source.
Digital Alarm & Normal Sound
These sounds are the verbalization of the Alarm and Normal conditions. See the data
source's corresponding .CHM help file in the WIN-911 Help Library for more details
concerning Digital Alarm & Normal Sound.
231
WIN-911 Configurator
Analog Sound
Note that not all data sources support these analog sounds. Refer to the help
documentation for your data source.
Analog Alarm & Normal Sounds
A specific sound can be configured for each of the alarm conditions. These sounds are
normally the verbalization of the phrases "...above the threshold alarm", "...below the
threshold alarm". In addition, there is a return to normal sound which may be the phrase
"in the normal range".
Engineering Unit Sound
The "Engineering Units" field is an optional sound which identifies the engineering units a
value represents. Analog values may be scaled and displayed as real world units of
measure. See the data source's corresponding .CHM help file in the WIN-911 Help
Library for more details concerning Engineering Unit Sounds.
232
WIN-911 Runtime
Digital Definitions
Digital Definition
This button is used to define all digital points. With both WIN-911 and WIN-411, alarms or
monitored points are classified as either a Digital "1" or "0", "bit picked" Analog data
values or Text Match ASCII strings. Digital alarms/points are configured within this button.
(Note, some application software packages will convert a DDE/OPC digital value to an
ASCII string, such as "OPEN" or "CLOSED". WIN-911/411 can also interpret these
conditions as digital alarms. See below for an explanation.)
Note: The recommended maximum number of DDE Items should not exceed 1,500.
Note: Some data sources do not support Digitals.
Special Note: Lite Mode users are limited to a total of 24 digital tags and unlimited
watchdog tags. Analog tags are not supported in Lite Mode.
Digital Definition to Edit
Alarms/Points are arranged by "Groups". Using the pull down list box, select the "Group"
that the new or existing alarm/point is assigned. Only the alarms/points associated with
the "Group" will be listed. You may select the appropriate "Group" by the pull-down list
box, or select "All Groups".
After selecting the specific "Group" or selecting "All Groups", you are ready to add or
modify digital alarms.
233
WIN-911 Configurator
Selecting "New", "Edit", "Copy" or double clicking on the Tagname will bring up the
following dialog box:
Numeric Pager Considerations
If the WIN-911 application requires numeric pagers (do not confuse with alphanumeric
pagers), a special entry is needed during configuration. Any or all field(s): Group Names,
Tagnames, Descriptions, or Digital States may have an embedded numeric touch-tone
string. It must be surrounded by square brackets, and included in the format selection for
pagers. Upon an alarm, the numeric data is stripped and sent out as a numeric page.
Example: An alarm Tagname such as C_44N [88] and a base number of 411 would be
received by a numeric pager as 41188.
234
WIN-911 Runtime
Base Definition
Tagname
HMI data point tag names tend to be cryptic and otherwise non-descriptive. The WIN-911
"Tagname" is a symbolic tool that allows the user to assign names to data points that are
better fit for human consumption. It should be kept in mind this is WIN-911's name for the
data point, and not the data source's. The Item Name is the data source's name for the
data point and is independent of the Tagname (unless "Use Tagname for Item" is
selected).
Tagname is a unique identifier for an alarm/point. It could be as simple as: "Boiler
Temperature", although use of a structured tag naming convention is recommended.
Thus, a temperature switch might be represented as TS0501, where: TS indicates a
temperature switch, 05 indicates the process area, and 01 indicates that this is the first
sensor of this type in this process area. The description can be placed in the description
field.
Description
The "Description" field is used to provide a more detailed description of an alarm or point.
This information is in addition to the "Tagname" and "Alarm Group Name". It is best not to
include the "Tagname" or "Alarm Group Name" in this description, since it is redundant.
Typically, this is the beginning of the ASCII string message which can be displayed,
logged, or paged.
Group Name
Alarms are organized by groups for reporting out-of-tolerance conditions. You have by
now created a unique digital alarm or point. You must choose a predefined "Group" to
specify the reporting actions for this alarm. (Remember, you have already selected a
235
WIN-911 Configurator
group name, specifying the reporting options and an optional sound for this group.) A
review of the "Group" button is not a bad idea here. To select another "Group", click on
the drop-down arrow with the cursor and choose. You may change the "Group"
assignment (move the tag to another "Group") simply by selecting another defined
"Group" from the drop down list box.
Bit
Even though a digital alarm is a comparison of a "1" or "0", some applications require the
data server to read a 16 bit word or a 32 bit word, and decipher the word into 16 or 32
unique digital alarms. This is exactly the purpose of this selection. If your data item is
already broken into bit form, select Integer Bit 1 as your type. If your data item is an
integer value, select the "Type" drop-down list arrow, and choose the correct bit to pick
(from least to most significant) for this unique digital alarm/point.
If you are using the "ASCII string option" to define digital alarms, select "Text Match" for
the Bit Type.
The "Remote Alarm" selection is a selection associated with the "Direct Connect" options
only.
Access Name
The "Access Name" is used to select a predefined data conversation from the list of
supported data sources defined in the "Data Source Definition". This field must be
defined.
Use Tagname for Item
Selecting this box will cause the "Tagname" to be copied directly into the item name. This
is useful when connecting to other tag oriented HMI packages.
Item Name
The "Item Name" is used to identify the particular item to monitor in the data source. The
actual name entered will vary from server to server. Consult the server documentation for
additional information. This field is case sensitive and must be defined.
236
WIN-911 Runtime
Alarm Conditions
Alarm and Normal Labels
The text strings that identify the "Alarm" and "Normal" conditions which will appear on the
alarm monitor displays, reports and pages are identified here. Examples may be "On/Off",
"Open/Closed", "Normal/Alarm", or "Red/Green".
If you are using ASCII strings (as opposed to numeric 1 or 0) to represent the two digital
conditions (ON/OFF, OPEN/CLOSE), you should have selected "Text Match" in the
previous tab (Base Definition). In this mode of operation, WIN-911 uses these text strings
as comparison templates for identifying digital conditions. The ASCII strings defined in
these fields must match (case sensitive) the text being sent by the data source.
Note: Ensure that Digital data points defined using a Text Match comparison are
configured with the exact ASCII string that will be provided by the data source. An
inaccurate comparison template will not be able to interpret the incoming strings. It is also
worth noting that this situation will not generate any error messages during runtime!
Note: Alarm and Normal text boxes change to On and Off when the digital data is not
being monitored for alarm conditions.
Digital Alarm
The "Digital Alarm" value is either a "1" or a "0". A digital alarm condition can be either a
"1" state, or a "0" state. WIN-911 gives you the choice, since applications vary. Selecting
"ON" from the pull-down list will cause an alarm to be reported if the digital value is a "1".
The "OFF" selection reverses the choice.
237
WIN-911 Configurator
If you are using WIN-411, you may want to monitor a digital condition but not want it
alarmed. In this case, configure the digital point as if it were an alarm, but choose the
"None" selection.
Initial Value
Select the initialization value you wish WIN-911 to begin with upon start-up.
Priority
For each alarm, you may select three levels of "Priority": High, Medium, and Low. Within a
"Group", a higher priority alarm will bump a lower priority alarm down the queue to call
out, even if the lower priority alarm was first in line.
Automatic Acknowledgement/Never
Selecting this radio button will require a manual acknowledgement of the alarm.
Automatic Acknowledgement/On Alarm
Selecting this radio button will cause the alarm to automatically become "Acknowledged"
as it enters into an alarm condition. This option would allow audio reports of an alarm's
current condition without initiating other reporting options listed in the same "Group". If
this option is active, the message (going into an alarm condition) will not generate "PopUp" alarm messages or any of the "Dial-Out" options. Because the alarm is automatically
acknowledged, the message coming back to a normal state would indicate that the
condition is in the normal mode.
Automatic Acknowledgement/On Return To Normal
Selecting this radio button will cause the alarm to automatically acknowledge as it returns
to normal. This option removes the requirement that the associated alarm be responded
to by a person in the event that no one has acknowledged the alarm at the time it returns
to a normal condition. Experiment with all three of these option boxes to get the results
you desire.
238
WIN-911 Runtime
Sounds
"Sounds" are essentially a verbalization of the alarm description and the "on" and "off"
sound to be used in the audio annunciation. As with any other sounds, the sounds are
selected from a dialog box.
Tag Sound
The "Sound" is essentially a verbalization of the "Tagname" and/or the description to be
used in the audio annunciation. As with any other sounds, the sounds are selected from a
dialog box. This sound is required for any voice connection or 411 Reports.
Alarm & Normal Sound
These sounds are the verbalization of the "Alarm & Normal" alarm labels.
Use Is / Was
In some cases, using the "Is / Was" sound will not make sense. Selecting the check-box
next to "Use Is / Was" will activate its use. Leaving the check-box blank will omit its use.
An example of this sound would be "The Pump IS on".
Preview Announcer
Selecting this button will allow you to review this alarm's entire audio.. AS THEY WILL BE
HEARD IN THE LOCAL ANNOUNCER.. for each condition of the alarm in the local
announcer. Selecting the "Auto Acknowledge" option discussed above will affect whether
you can test the "State Acknowledged" button. Note: If this control is disabled see the
corresponding .CHM help file in the WIN-911 Help Library for more details.
239
WIN-911 Configurator
Changeable
The last tab selection is for WIN-411 applications only. If you are using the WIN-411
Option, a user may call-in to the computer to inquire on digital status conditions, not just
alarm conditions. If configured, the user may even change the status from a touch-tone
telephone. If the developer elects to allow the user to make changes, each alarm, or data
point must be configured to permit changes.
Note: Lite mode, RSView SE and RSView32 Direct Connect will not allow the enabling of
changes by the operator because 411 reports are ignored.
Enable Changes by Operator
This check box will allow changes to this alarm or status point. If this check box is left
unchecked, changes will not be allowed.
240
WIN-911 Runtime
Analog Definitions
Analog Definition
With both WIN-911 and WIN-411, alarms (or monitored points) are classified either as
digital "1" or "0", or analog data values. "Analog Alarms" are configured with the "Analog
Alarm Definition" button.
Note: The recommended maximum number of DDE Items should not exceed 1,500.
Note: Some data sources do not support Analog alarms.
Special Note to Lite Mode Users: Analog alarms are not permitted in Lite Mode.
Analog Definition to Edit
"Alarms/Points" are arranged by "Groups". Using the pull down list box, select the "Group"
that the new or existing alarm/point is assigned. Only the alarms/points associated with
the "Group" will be listed. You may select the appropriate "Group" by the pull-down list
box, or select "All Groups".
After selecting the specific "Group" or selecting "All Groups", you are ready to add or
modify analog alarms.
241
WIN-911 Configurator
Selecting "New", "Edit", "Copy" or double clicking on the "Tagname" will bring up the
Analog Definition sheet.
Numeric Pager Considerations
If the WIN-911 application requires numeric pagers (do not confuse with alphanumeric
pagers), a special entry is needed during configuration. Any or all field(s): Group Names,
Tagnames, Descriptions, or Digital States may have an embedded numeric touch-tone
string. It must be surrounded by square brackets, and included in the format selection for
pagers. Upon an alarm, the numeric data is stripped and sent out as a numeric page.
Example: An alarm Tagname such as C_44N [88] and a base number of 411 would be
received by a numeric pager as 41188.
242
WIN-911 Runtime
Base Definition
Tagname
HMI data point tag names tend to be cryptic and otherwise non-descriptive. The WIN-911
"Tagname" is a symbolic tool that allows the user to assign names to data points that are
better fit for human consumption. It should be kept in mind this is WIN-911's name for the
data point, and not the data source's. The Item Name is the data source's name for the
data point and is independent of the Tagname (unless "Use Tagname for Item" is
selected).
Tagname is a unique identifier for an alarm/point. It could be as simple as: "Boiler
Temperature", although use of a structured tag naming convention is recommended.
Thus, a temperature switch might be represented as TS0501, where: TS indicates a
temperature switch, 05 indicates the process area, and 01 indicates that this is the first
sensor of this type in this process area. The description can be placed in the description
field.
Description
The "Description" field is used to provide a more detailed description of an alarm or point.
This information is in addition to the "Tagname" and "Alarm Group Name". It is best not to
include the "Tagname" or "Alarm Group Name" in this description, since it is redundant.
Typically, this is the beginning of the ASCII string message which can be displayed,
logged, or paged.
Group Name
243
WIN-911 Configurator
Alarms are organized by groups for reporting out-of-tolerance conditions. You have by
now created a unique digital alarm or point. You must choose a predefined "Group" to
specify the reporting actions for this alarm. (Remember, you have already selected a
group name, specifying the reporting options and an optional sound for this group.) A
review of the "Group" button is not a bad idea here. To select another "Group", click on
the drop-down arrow with the cursor and choose. You may change the "Group"
assignment (move the tag to another "Group") simply by selecting another defined
"Group" from the drop down list box.
Engineering Units
The "Engineering Units" field is an optional field, which provides text that identifies the
engineering units. Analog values may be scaled and displayed as real world units of
measure.
Access Name
The "Access Name" is used to select a predefined data source conversation from the list
of supported data sources defined in the Data Source Definition. This field must be
defined.
Use Tagname for Item
Selecting this box will cause the "Tagname" to be copied directly into the item name. This
is useful when connecting to other tag oriented HMI applications.
Item Name
The "Item Name" is used to identify the particular item to monitor in the data source. The
actual name entered will vary from server to server. Consult the server documentation for
additional information. This field is case sensitive and must be defined.
244
WIN-911 Runtime
Conversion
Conversion Type
"Conversion Type" defines which filter is applied to the raw data. Being a 32-bit
application, analog data is treated as a 32-bit integer. Selection of "Floating Point" is not
defined here (see below: "Number of Decimal Places" for floating point definitions).
The incoming values can be processed in four ways. The first and simplest is that the
value is not scaled: numbers appear exactly as they are brought in. The next is a linear
scaling: raw values in the specified range are converted to the engineering units' range.
The third conversion is square root scaling where the square root of the raw value is
taken and then the value is converted to the engineering units' range. Square root
conversions are commonly used in flow calculations. The final conversion is "Bit Mask": a
selection of the number of bits to use in displaying data or calculating scaling factors.
None
Selection of "None" will make data available in its raw or native form.
Linear
Selection of "Linear" will enable linear scaling. If this is selected, minimum and maximum
values must be entered.
245
WIN-911 Configurator
Square Root
Selection of "Square Root" will first apply the "Square Root" of the raw data and then
make the scaling selections available.
Bit Mask
Selection of "Bit Mask" will strip the 32 bit native form to match the data coming from a
field device. For example, if the A/D converter is 12 bits, you could select "Bit Mask" and
then a resolution of 12 bits. These selections would then strip the excess data from the
raw 32-bit form and present it as 12 bit data. Scaling selections would then be available if
needed.
Remote Alarming
This selection is used for Direct Connect data and is not selectable for DDE/OPC data.
Raw Resolution
(See the above discussion on "Bit Mask".)
Raw Signed
A selection of this check box will convert a 32 bit unsigned integer into a 16 bit signed
integer.
Raw Minimum/Maximum
The raw engineering units' values are used to create a multiplier for converting values.
Scaled Minimum/Maximum
The scaled engineering units' values are used to create a multiplier for converting values.
You should enter the minimum and maximum values in engineering units which
correspond to the minimum and maximum raw data values. The software will
automatically scale the incoming (or in the case of WIN-411, outgoing) data to the correct
values for WIN-911 alarm comparison or WIN-411 reporting. Note that the min and max
engineering units are used to clamp the converted value. The value will not exceed the
min and max span.
Number of Decimal Places
WIN-911/411 supports two types of analog data types: Integer or Floating-Point. WIN911/411 supports: a) 32 bit signed integer values, and b) 32 bit IEEE floating point values.
Note: Acceptable Floating-Point numbers (without round-off errors) are 3.4 e±38, or a
resolution of 7 digits. Values beyond seven digits will exhibit round-off errors. Integer Data
Type is the default type and represented as "0" Number of Decimal Places. To select
Floating Point, select the Number of Decimal Places to something other than "0". This
selection will also select the number of decimal places to verbalize in a WIN-411 Report.
Scaling Examples
246
WIN-911 Runtime
Depending upon the source, supplying data to OPC values may be scaled to
"Engineering Units". However, some data may be in unscaled form. In the "Conversion"
tab, you will find the "Conversion Type List Box": None, Linear, Square Root, and Bit
Mask. Using the cursor and checking the "None" selection will disable any scaling
routines for this "Tagname". Selecting "Linear" will activate the scaling routine. You must
then fill in the minimum and maximum values for the raw data and corresponding
minimum and maximum values for the scale's data. The scaling is performed based upon
the entered values. For example: a Min/Max range for raw data of 0 and 50 and a
Min/Max selection for engineering units of 0 and 100 would result in a 2:1 scaling factor. A
raw data value of 25 would be scaled to 50. Also, it is important to note that the scaled
values are not permitted to go beyond the Min/Max settings.
Choosing "Square Root" scaling will allow two scalings to be applied to the raw data.
First, the "Square Root" of the raw data is taken, and then the results may be scaled. This
calculation is useful in flow measurements.
247
WIN-911 Configurator
Alarm Limits
The four alarm limits are used to determine when alarm conditions occur. The value must
be above the high limits for the high alarms and below the low limits for the low alarms. If
the value is scaled, the limits must be within the scaled range. Notice that you do not have
user defined visual alarm messages with Analog alarms. The visual messages are fixed:
High, HiHi, Low, and LoLo. The alarm selection boxes are used to select the desired
alarm states to be monitored. In WIN-411 applications, you may occasionally have a data
point which you want to monitor, but not alarm. In such cases, do not select any of the
Alarm States check boxes.
Initial Value
Select the initialization value you wish WIN-911 to begin with during start-up. The "Initial
Value" is used to enter a first value into the variable before the first values are read. It is
recommended that the "Initial Value" be set to a non-alarm level.
Priority
For each alarm, you may select three levels of "Priority": High, Medium, and Low. For that
"Group", a higher priority alarm will bump a lower priority alarm down the queue to call
out, even if the lower priority alarm was first in line.
Deadband
248
WIN-911 Runtime
You may also select a common "Deadband" for each "Tagname". Entering a value into
the "Deadband" edit field will activate this option. A value of "0" will cause an analog
alarm to trigger at one digit over the alarm value, and will report a normal condition when
the value equals the alarm value. A "Deadband" of "2" will execute an alarm exactly as
before, but to report a "Normal" state, the value must fall 2 digits below the alarm setting.
Automatic Acknowledgement/Never
Selecting this radio button will require a manual acknowledgement of the alarm.
Automatic Acknowledgement/On Alarm
Selecting this radio button will cause the alarm to automatically become "Acknowledged"
as it enters into an alarm condition. This option would allow audio reports of an alarm's
current condition without initiating other reporting options listed in the same "Group". If
this option is active, the message (going into an alarm condition) will not generate "PopUp" alarm messages or any of the "Dial-Out" options. Because the alarm is automatically
acknowledged, the message coming back to a normal state would indicate that the
condition is in the normal mode. The "Was" message would never be used.
Automatic Acknowledgement/On Return To Normal
Selecting this radio button will cause the alarm to automatically acknowledge as it returns
to normal. This option removes the requirement that the associated alarm be responded
to by a person in the event that no one has acknowledged the alarm at the time it returns
to a normal condition. Experiment with all three of these option boxes to get the results
you desire.
249
WIN-911 Configurator
Sounds
Tag Sound
The "Tag Sound" is essentially a verbalization of the "Tagname" and/or the description to
be used in the audio annunciation. As with any other sounds, the sounds are selected
from a dialog box.
Alarm Sounds
A specific sound can be specified for each of the alarm conditions. These sounds are
normally the verbalization of the phrases " ...above the high limit","...above the HiHi limit",
"...below the low limit", and "...below the LoLo limit". In addition, there is a return to normal
sound, which may be the phrase "now normal".
Engineering Unit Sound
The "Units" field is an optional sound which identifies the engineering units a value
represents. Analog values may be scaled and displayed as real world units of measure.
Use Is / Was
In some cases, using the "Is / Was" sound will not make sense. Selecting the check-box
next to "Use Is / Was" will activate its use. Leaving the check-box blank will omit its use.
Preview Announcer
Selecting this button will allow you to review this alarm's entire ... AS THEY WILL BE
HEARD ... for each condition of the alarm in the local announcer. Selecting the "Auto
Acknowledge" option discussed above will affect whether you can test the "In the Normal
250
WIN-911 Runtime
Range" button. Note: If this control is disabled see the data source's corresponding .CHM
help file in the WIN-911 Help Library for more details.
251
WIN-911 Configurator
Changeable
The last tab selection is for WIN-411 applications only. If you are using the WIN-411
Option, a user may call in to the computer to inquire on data values, not just alarm
conditions. If configured, the user may even change a value from a touch-tone telephone.
If the developer elects to allow the user to make changes, each alarm or data point must
be configured to permit changes.
Changeable by Operator
This check box will allow changes to this alarm or data point. If this check box is left
unchecked, changes will not be allowed.
Note: Lite mode, RSView SE and RSView32 Direct Connect will not allow the enabling of
changes by the operator because 411 reports are ignored.
Minimum and Maximum Values
Changes will be allowed only within the "Minimum and Maximum" values.
You must assign the range allowed for a change.
Minimum Value: Integer....................................-2147483648
Minimum Value: FP without round-off error ...-9999999
Maximum Value: Integer.................................. +4294967295
Maximum Value: FP without round-off error ...+9999999
252
WIN-911 Runtime
Watchdog Timer Definitions
Watchdog Timer Definition
Should trouble exist in either the server, cabling, or the actual control device, WIN-911 will
stop receiving new data from its data source. For this reason, WIN-911's alarm reporting
chores would be restricted, or totally shut down. Therefore, the "Watchdog Timer Alarms"
have been implemented. This method will also detect when a PLC has been shut down
for maintenance or program changes. The "Watchdog Timer" option in WIN-911 will alert
you if the data source becomes inactive. "Watchdog Timers" are arranged by "Groups"
just like other alarms/points. Using the pull down list box, select the "Group" that the new
or existing alarm/point is assigned. Only the "Watchdog Timers" associated with the
"Group" will be listed.
To utilize the "Watchdog Timer", you must choose a changing integer data value in each
device to be monitored. A good example of such a data value would be a "continuous
changing counter value" programmed into the PLC that you are monitoring. The
"Watchdog Timer" would monitor this value. If the value does not change over a preselected time period, an "Alarm Message" would be generated. If you are not receiving
data, you cannot alarm it. A typical voice message for this condition could be:
"WARNING, PLC#4, HAS LOST COMMUNICATIONS WITH ALARM LOGGER".
Watchdog Timer Definition to Edit
After selecting the specific "Group" or selecting "All Groups", you are ready to add or edit
watchdog alarms.
Selecting "New", "Edit", "Copy" or double clicking on the "Access Name" will bring up the
Watchdog Timer Definition sheet.
Numeric Pager Considerations
If the WIN-911 application requires numeric pagers (do not confuse with alphanumeric
pagers), a special entry is needed during configuration. Any or all field(s): Group Names,
Tagnames, Descriptions, or Digital States may have an embedded numeric touch-tone
253
WIN-911 Configurator
string. It must be surrounded by square brackets, and included in the format selection for
pagers. Upon an alarm, the numeric data is stripped and sent out as a numeric page.
Example: An alarm Tagname such as C_44N [88] and a base number of 411 would be
received by a numeric pager as 41188.
254
WIN-911 Runtime
Base Definition
Tagname
Tagname is a unique identifier of a watchdog alarm.
Description
The Description Field is used to provide a more detailed description of a watchdog alarm.
This information is in addition to the Tagname and Group Name. It is best not to include
the Tagname or alarm Group Name in this description since it is redundant.
Group Name
Alarms are arranged by Group. Select the Group to which the Watchdog Timer should be
assigned here.
Access Name
The Access Name is used to select a predefined data source conversation from the list
defined in the Data Source Definition. This field must be defined.
Use Tagname for Item
Selecting this box will cause the Tagname to be copied directly into the item name. This is
useful when connecting to other tag oriented HMI applications.
Item Name
The Item Name is used to identify the particular item to monitor in the data source. The
actual name entered will vary from server to server. Consult the server documentation for
additional information. This field is case sensitive and must be defined.
255
WIN-911 Configurator
Alarm Conditions
Alarm / Normal
The Alarm and Normal fields identify the normal and alarm states that appear on the
alarm monitor displays and reports.
Time-out After __ Minutes
Watchdog Timers monitor a changing value within your data source. If WIN-911 does not
see that value change after a certain period of time, it will place the Watchdog Timer into
its alarm state. This is the length of the timer. If an update from the point being monitored
is received after the alarm has been triggered, then the Watchdog Timer will return to its
normal state.
If this field is set to zero, the Watchdog Timer will alarm when connectivity to the data
source is lost.
Note: RSViewSE, RSView32, and FactoryTalk data sources behave differently with
respect to watchdogs. Refer to the help documentation for these data sources.
Priority
For each alarm, you may select three levels of Priority: High, Medium, and Low. For each
Group, a higher priority alarm will bump a lower priority alarm down the queue to call out,
even if the lower priority alarm was first in line.
Automatic Acknowledgement
256
WIN-911 Runtime
Never
Selecting this radio button will require a manual acknowledgement of the alarm.
On Alarm
Selecting this option will cause the Watchdog Timer to become acknowledged upon
receipt. It will still be announced by the local announcer, however no remote alarm
notification will occur.
On Return To Normal
Selecting this radio button will cause the alarm to automatically acknowledge as it returns
to normal. This means that all notifications for the Watchdog Timer will end when it
returns to normal.
257
WIN-911 Configurator
Sounds
Tag, Alarm, and Normal Sounds
Like other WIN-911 alarms, the "Sounds" are essentially a verbalization of the description,
and the normal and timer failure text to be used in the audio annunciation. As with any
other sounds, the sounds are selected from a dialog box.
Use Is / Was
In some cases, using the "Is / Was" audio will not make sense. Selecting the check-box
next to "Use Is / Was" will activate its use. Leaving the check-box blank will omit its use.
Preview Announcer
Selecting this button will allow you to review this alarm's entire audio... AS THEY WILL
BE HEARD … for each condition of the alarm in the local announcer.
258
WIN-911 Runtime
WIN-411 Reports
Overview
WIN-411 is a set of reporting features in WIN-911 which allow you to get the current
status of any data point. Simply build a report and access it by report number later on via
voice call or SMS message.
WIN-411 Voice Reports also allow you to change data values from a touch tone phone.
Data points that require this ability, must be configured as changeable in their digital or
analog definition.
The following data sources are supported by WIN-411:
•
InTouch
•
OPC
•
DDE
•
FIX
If your data source is not supported by WIN-411, a good solution is to create an OPC
connection to your SCADA/HMI package for data only, while keeping your direct
connection for alarming purposes.
Note: WIN-911 Lite does not support WIN-411 Reports.
259
WIN-911 Configurator
Prerequisites
General Knowledge
Prior to using this chapter to begin configuring WIN-411 Reports, you must have
completed the configuration of each of the data points or alarms to be monitored. If you
have not configured the data points or alarms, go to the "WIN-911 Configuration" section
of this help file.
A Data Point vs. an Alarm?
If you are using the WIN-911 alarm capabilities, you must configure data items as alarms.
If you are using the WIN-411 monitoring capabilities, you may either monitor alarm values
or just the data values. If you are configuring a data item to be both an alarm and a data
value, just configure the item as if it is a normal WIN-911 alarm. If you are configuring a
data item to be a data value only (with no alarming capabilities), you must configure the
items in the following manner:
Digital Data Point
Configure the item as if it were an alarm, but select "None" for the Digital Alarm list box
found in the Alarm Conditions tab.
Analog Data Point
Configure the item as if it were an alarm, but do not select any of the four Alarm States
check boxes found in the Alarm Limits tab.
260
WIN-911 Runtime
261
WIN-911 Configurator
The Audio
Global Sounds
Review the "WIN-911 Global Menus" section in this help file. Be sure you have completed
the necessary Common Sounds and the special WIN-411 sounds or text strings
necessary for Scan & Alarm to read during Runtime Voice Synthesis.
Data Point Sounds
Configure the digital, analog and watchdog data point sounds as if they were alarms. If
you are not alarming an analog data point, you may omit the alarm sounds for these
items, but you must create and use the Tag Sounds and State Sounds for digital points
and watchdogs.
262
WIN-911 Runtime
411 Options
Special Note: When running in Lite Mode, RSView SE Direct Connect, RSView32 Direct
Connect, or FactoryTalk Direct Connect, WIN-411 Reporting will always be disabled and
the current state of all these settings will be ignored when Scan & Alarm runs.
Do not request confirmation of selected report
Selection of this checkbox bypasses the need for operator confirmation of the report to be
played. The default selection for this checkbox is unchecked.
Do not request confirmation of selected point
Selection of this checkbox bypasses the need for operator confirmation of the point to be
changed. The default selection for this checkbox is unchecked.
Do not request confirmation of data change
Selection of this checkbox bypasses the need for operator confirmation of the new value
to be set. The default selection for this checkbox is unchecked.
Require Watchdog for first item of a Report
Select of this option to require the first item of your report to be a watchdog. If this feature
is enabled, report access will not be granted if the watchdog is in the failed state.
263
WIN-911 Configurator
Voice Report Definitions
Report Definition
From the WIN-911 main menu, select the "Define Report" button to build or edit WIN-411
reports. The Report Definition list box will pop-up.
Report Definition to Edit
If no reports have previously been configured, select "New". You may edit existing reports
by either double clicking or highlighting the report name and selecting the "Edit" button.
You may have an unlimited number of reports.
Report Definition
The example shown is a previously configured report, which has been named: "Fresh
Water Storage Report Number 1". A total of three data points are assigned to this report.
264
WIN-911 Runtime
Report Name
The "Report Name" is a required unique identifier for each report. You may configure an
unlimited number of reports.
Helpful Hint: Verbalizing data values as voice communications is time consuming. It is
suggested to keep each report as short as possible, but make as many reports as needed
to meet your application needs. In a waste water application, you might want to have a
separate report for each lift station consisting of no more than four data items or alarms.
Report Sound
A "Report Sound" is required. Use the same technique as discussed in earlier sections to
generate audio. Define a sound, which describes the report. In the example above, the
report audio was: "Fresh Water Storage Report Number 1".
Voice Report Number
Each report must be assigned a unique number. This number may be any unsigned
integer (1 to 15 digit number) and does not need to be sequential. Think of this as the
second level of security (the first being the initial user access code). To make it more user
friendly, some developers will match the report number with the report name (Lift Station
22 would be report number 22).
Change Authorization Code - Optional
265
WIN-911 Configurator
If the user is allowed to change any of the data points in this report, a third level of
security is available, an access code for changes. Without this code, a user may monitor
data values, but he may not change them. This number may be any unsigned integer (1
to 15 digit number) and does not need to be sequential. Change authorization code is
required even if no points are changeable.
Disabling Security:
If this level of security is not desired, enter a zero in this field and a change authorization
code will not be requested.
Note: Disabling may allow security breaches to occur. Do not use this feature when
liability or safety is an issue.
Available Tags
The "Available Tag List" contains all the data points or alarms that have been previously
defined, assigned to the "Group", and have a tag sound defined. A WIN-411 Report may
consist of data points or alarms from more than one "Group". You may select "All Groups"
to view all available "Tags".
Note: For a data point to appear in the WIN-411 configuration sheet it must have the
appropriate sound(s) assigned to it.
Selected Tags
The "Selected Name List" contains the data points or alarms which have been selected
for this Report. To select a data point or alarm, highlight the desired data point/alarm in
the Available Tag List and click on the "Add" button. Data points/alarms from any Group
may be included in a single Report. To remove a tag from the Report list, highlight the
desired tag and click on the "Remove" button. You may organize the list in any desired
order by using the "Move Up" and "Move Down" buttons.
Note: It is a good idea to place a watchdog tag in each report as the first item in the
report. This way an expired watchdog will alert the user accessing the report that there
may be no connection to the data source and report values may be invalid.
266
WIN-911 Runtime
Defining a Data Point to Change
Data Change Index
From the "Report Definition" edit box, select the data point to change by double-clicking
the left mouse button on the data point's ID field found in the report list. This will bring up
the "Change Definition" edit box. The example below is from the continuing Pneumatic
Conveyor Number 2 example.
Note: This dialog box will not be activated if you did not select the data point to allow
changes. This selection is made available during configuration of the digital or analog
alarm (data points).
Changeable by Operator
Select the "Changeable by Operator" check box to enable the change index field for the
tag. The software enables the appropriate input field.
Note: If a tag was imported as read-only and you attempted to make it changeable by
adding a change index, a warning message will be presented to inform you the point may
not be able to be written to.
Data Change Index
The "Data Change Index" is the fourth level of security (or password) allowing for a
change of a data value. This number may be any unsigned integer (1-65535), and does
not need to be sequential. Each data point must have a unique "Data Change Index"
within the same Report.
267
WIN-911 Configurator
Miscellaneous
Number of Decimal Places to Verbalize
If the data point is a floating point analog value, the number of decimal places to verbalize
in reporting the value is defined in the Analog Definition. Details about this can be found in
WIN-911 Configuration section of this help file. Whatever you select for the Number of
Decimal Places to display is also the number of Decimal Places to verbalize. If you select
the number "3", the data value will be reported to three decimal places. A value of 14.0
will be reported as 14.000; a value of 632.8733492 will be reported as 632.873. Up to
fifteen digits total can be verbalized.
Helpful Hint:
Verbalizing data values as voice communications is time consuming. It is suggested to
keep each report as short as possible, but make as many reports as needed to meet your
application. In a wastewater application, you might want to have a separate report for
each lift station consisting of no more than four data items or alarms.
WIN-411 & InTouch Direct Connect
When developing a WIN-411 report using InTouch Direct Connect with digital data that is
to be reported only and not monitored for any alarm condition, ensure that the "Bit:" field
is set for anything except "Remote Alarming".
268
WIN-911 Runtime
SMS Report Definitions
Text Report (Mobile-911 or SMS) Definition
Before data values can be requested from WIN-911, a 411 report must be built. Click the
411 icon to edit 411 reports.
Report Definition to Edit
If no reports have previously been configured, select "New Text". You may edit existing
reports by either double clicking or highlighting the report name and selecting the "Edit"
button.
Report Definition
269
WIN-911 Configurator
A 411 report contains a set of data points which may be requested by report number or
individually through an SMS message or Mobile-911 transaction. When a request is made
for a 411 report, every data point in the report will be sent back to the phone which
requested the report as separate text messages. Request an individual report item by its
index number and that item will be sent to the requesting phone. The following is a
description of the elements of a Text Report.
Report Number
The Report Name is a unique identifier for each Mobile-911 or SMS report. The maximum
length of this field is three digits. Reports are requested by number.
Available Tags
The Available Tag List contains all of the tags available for inclusion in a Mobile-911 or
SMS Report. They are organized by group. Use the drop down menu to select the groups
you would like to see.
Note: For a data point to appear in the WIN-411 configuration sheet it must have the
appropriate sound(s) assigned to it.
Selected Tags
The Selected Report Item list contains all items in your report. A Report Item has two
components, a tagname, which is the name of the tag within WIN-911 and a short
description. When a report is delivered it will contain both of these fields. The tagname is
the name of the report item and the short description gives more context. The Default
270
WIN-911 Runtime
Short Descriptions radio button determines what the default short description of a tag will
be when it is added to a report.
Add a Report Item to your SMS Report by selecting it in the Available Tag List and then
clicking add. If the Default Short Description is set to User Defined, then you will be
prompted for a Short Description.
When the Default Short Description is set to Copy Descriptions, then the tag's description
is copied into the Short Description field. Likewise, when Copy Tagnames is selected, the
tagname is copied into the Short Description field.
Remove a Report Item by using the remove button or right clicking the Report Item. Use
the Move Up and Move Down buttons to arrange the order of the Report Items.
271
WIN-911 Configurator
Requesting Reports
Once a report is defined, it may be requested using its report number. Send a text
message to the WIN-911 machine containing the text "411:<report number>." For
example, to request report 21 send in the following:
411:21
If the phone which sent in the request is configured within WIN-911, then WIN-911 will
respond with the 411 report. An example report is shown below:
If you would like to request a single Report Item send in the text "411:<report
number>:<report item>." If you would only like the first item of report 21 send in the
following:
411:21:1
If WIN-911 cannot determine which report you would like, possibly because of a
formatting error or because that report does not exist, it will respond with "BAD411REPORT:<report number>." If the report item you've specified does not exist, then it will
respond with "BAD411-ITEM:<item number>." If you are not licensed for 411 reports, you
will receive "411 Request Rejected per license."
272
WIN-911 Runtime
Scan & Alarm Operation
The WIN-911 runtime system (Scan & Alarm) operation is TeleDAC.exe (executable)
which reads the configuration, starts the appropriate DLL's, scans the alarm conditions,
makes on-the-fly configuration modifications, and shuts down Scan & Alarm. Once
started, controls can be accessed through the tray icon. By right-clicking on the tray icon,
a control menu will pop-up giving the operator the options to show or hide the status
windows, bypass alarms, override contact's schedules, and shutdown WIN-911.
Because WIN-911 is usually a mission critical application, three security options are
offered that prevent unauthorized personnel from modifying or shutting down WIN-911: 1)
Requiring User Name and Ack codes to modify or shutdown Scan & Alarm (see "WIN-911
Global Menus.CHM" -> Display Definition -> Monitor Appearance -> Monitor
Acknowledge). 2) A global password can be set that will be required to access the WIN911 Configurator and can be configured to shutdown Scan & Alarm (see "WIN-911 Global
Menus.CHM" -> Display Definition -> Monitor Appearance -> Monitor Acknowledge). 3) A
combination of 1 and 2.
273
WIN-911 Configurator
When "Interact with Desktop" is Enabled WIN-911 will function the same way it does now
except you can't exit Scan & Alarm in the usual manner. You would have to go through
the Service Control Manager to shut it down or use the Restart.exe applet.
When "Interact with Desktop" is Disabled the user cannot use the WIN-911 Alarm Monitor
and hence, cannot acknowledge alarms or send manual messages. All the tray icons are
disabled as well as all applets, except Restart.exe.
274
WIN-911 Runtime
Startup
Starting of WIN-911 can be done a variety of ways, such as double clicking the
TeleDAC.exe from Explorer, using the Start\Run -> TeleDAC.exe, or Start Button -> All
Programs -> WIN-911 V7 -> Scan & Alarm task bar sequence or the Restart.exe applet.
Windows can start WIN-911 automatically with the Windows Startup program or WIN-911
can be launched by another vendor's startup program. It can also be started when
Windows boots via the 911SRV.exe Service Wrapper. Note: Starting WIN-911
automatically can launch WIN-911 before the data source or hardware is ready. Utilize the
delay configured in the Global Options/ Initialization tab to give the hardware and data
source plenty of time to initialize.
Launching the WIN-911 program will automatically launch all modules necessary to run
the configured application. Each module's status during startup will be displayed on the
WIN-911 Status window (TeleDAC). This information will provide an overview of the
module connections and any error messages. Once they are launched, the WIN-911
Status window will minimize to the system tray. To review the launch messages after the
status window is minimized right-click the Scan 911/411 tray icon and select "Show
Status" from the pop-up menu. If you want to close this windows after reviewing the
messages, right-click the tray icon and select "Hide Status".
275
WIN-911 Configurator
Shutdown
WIN-911 can be shutdown one of three ways: 1) right-clicking on the tray icon will pop up
the control menu where Exit WIN-911 can be selected; 2) from the Status (TeleDAC)
window; click the 'X' will invoke the shutdown sequence; 3) using the Shutdown.exe
command applet. Except when using the Shutdown.exe, confirmation of intent to
shutdown WIN-911 will appear prompting the operator to confirm the shutdown by clicking
Exit. If WIN-911 is running as a service it can be shutdown one of two ways: 1) executing
Restart.exe, or 2) stopping the WIN-911 Service Wrapper in the Windows Service
manager shuts down Scan & Alarm. Note: Only a Windows user with Administrative
privileges can stop the WIN-911 service.
Note: Security is available with this function that would require a user name and ack code
before the function will execute. Additionally, the global system password can be required
when the Shutdown.exe command applet is used.
276
WIN-911 Runtime
Bypassing Alarms
Alarms can be removed from and returned to the active callout list without having to take
WIN-911 offline and modify its configuration. This is done with the Bypass Alarms
command, accessed by right-clicking on the tray icon and selecting Bypass Alarms or
running the Bypass.exe from the Tools folder. When selected the following dialog box will
appear:
This warning is to ensure that the operator is aware that the bypassed alarm will not be
called out. To accept responsibility, click Bypass and select the alarms to bypass.
Note: This confirmation dialog only appears when alarms are bypassed directly by
TeleDAC.exe and not the third party BYPASS.exe scripting tool, unless the global setting
for user Ack on Bypass is set.
277
WIN-911 Configurator
Note: Security is available with this function that would require a user name and ack code
before the function will execute.
278
WIN-911 Runtime
Dialout Override
Individuals scheduled in a group's phone list can be removed from and returned to the
active callout list without having to take WIN-911 offline and modify its configuration. This
is done with the Dialout Override command, accessed by right-clicking on the tray icon
and selecting Dialout Override or running the Override.exe from the Tools folder. When
selected the following dialog box will appear:
This warning appears to ensure the operator is aware that the person who is being
removed from the callout list will not receive remote notification of any alarm condition
until restored. To accept responsibility, click Override and select the users to override.
Note: This confirmation dialog only appears when schedules are overridden directly by
TeleDAC.exe and not the third party Override.exe scripting tool.
Warning: All Override information is stored globally, independent of the configuration file.
Any user placed in override may or may not be in the current list for the active
configuration.
279
WIN-911 Configurator
Overrides can be scheduled one of two ways, either permanently or by date. As the name
would indicate, anyone who is overridden using the Permanent button is immediately
overridden and will remain so until manually restored using the delete button. The
Selected Date button will schedule an override for each selected 24-hour calendar date.
You can have as many "selected date " based overrides as you need and that override
will be restored automatically to the active call out list at midnight of the following day.
Note: Security is available with this function that would require a user name and ack code
before the function will execute.
280
WIN-911 Runtime
The WIN-911 Alarm Monitor
By default, the WIN-911 Monitor will automatically be launched at runtime. After
initialization the Monitor window appears in Summary mode, ready for you to begin work.
Note that the size and position is saved when the program is exited and the monitor
window will return to its last position and size when restarted. Note that if WIN-911 is
exited when the monitor is minimized, next time WIN-911 is started the monitor will be
minimized.
Warning: When 911SRV.exe service wrapper is controlling WIN-911,"Interact with
Desktop" must be enabled to use the Monitor.
The Monitor Window consists of several distinct areas: Title Bar, Control Bar, Display
area, and Scroll Bar.
The Control Bar provides access for six items. The "Acknowledge" button may be
selected by mouse commands or by pressing (and holding) the Alt key and the letter key
that is underlined. If the mouse is used, the command is initiated when the mouse button
is released.
The Control Bar also presents the "Summary" and "History" radio buttons. The
"Summary" and "History" buttons will allow an easy selection of desired visual
presentation of alarms, and status information.
The third item in the Control Bar is the "Alarm Count Box". It will provide the user with a
count of total alarms visually available (depending on the Summary or History selection).
If more alarms are listed than can be displayed, it will give information as to the total
number of alarms and which one is currently being displayed. An example would be :
"Record 14 of 14 "
The fourth item is the Lock button. This button relocks the Acknowledge feature after a
user has entered his/her acknowledge code to acknowledge alarms. This is a
configurable security feature that removes acknowledgement authorization before the
281
WIN-911 Configurator
designated relock time has elapsed. The Lock button only appears when the WIN-911
system is unlocked. If the configuration doesn't require an acknowledge code to
acknowledge alarms then the button will not appear.
The fifth item is the "Manual Message" button, which will be available if paging, SMS, or
e-mail notifications have been configured.
The sixth item is the "Display Lock". When depressed this button stops the automatic
scrolling of the monitor as the space required to display the activity exceeds the space
provided for the monitor. This button also disables all events from toggling between
current History and Summary views.
The Display area provides a scrollable window showing the alarm lines. The scroll bar
adjusts as the alarm buffer grows, so that the entire buffer can be accessed.
Also, unless otherwise configured the Alarm Monitor window can be resized using the
Min/Max buttons in the top right of the Monitor window. The window can also be resized
by stretching the border both vertically and horizontally. The columns within the Monitor
window also can be resized by dragging the column borders horizontally.
Event Status Reporting
During a normal alarm dial-out sequence, the status events of the page, e-mail, SMS
message, or telephone call are logged in the "History " display. These include such items
as: Who is being called? Did the person answer? Did they acknowledge the alarm? To
view these events, select the "History " radio button.
Upon a serious failure or event, such as losing a server, the status is logged as described
above, but the "History " display is automatically selected by default. Global monitor
settings can disable this behavior.
Acknowledge Button
The Acknowledge button will acknowledge all of the active alarms requiring
acknowledgment (not one at a time). See the "Acknowledge Options" section to
customize acknowledgment selections.
When the default alarm colors are used, acknowledged alarms appear in reverse video
from the unacknowledged alarms. For example, red characters on white background
indicate an acknowledged alarm and white characters on red background indicate an
unacknowledged alarm.
Summary and History Buttons
The "Summary / History" radio buttons will select the desired visual mode. The alarm
history displays the alarms in the order that they occurred. The most recent alarm is
always shown on the bottom of the display. Note that the screen buffer permits a
maximum of 2,000 alarms by default (10,000 max); the oldest alarms will be scrolled off
the list. The additional alarms will be contained in the archive file if it was selected in the
Group Definition. The alarm summary display is built from the alarm history display and
shows only the alarm points which are in an alarm state (whether acknowledged or not).
The alarm summary display will not show alarms that have cleared (and been
282
WIN-911 Runtime
acknowledged). Also shown in the History display are logged event states such as
telephone and pager progress, who was called, who acknowledged, etc.
Pop-Up Window
The pop-up window option allows the user to enable the WIN-911 Monitor window to be
the top window. This can be configured in the alarm group definition to either pop-up
when a new alarm occurs or upon any event.
Acknowledgment Options
In the WIN-911 Configurator -> Display Definition -> Acknowledge tab. See "WIN-911
Global Menus.CHM ", for more information. Default settings are shown below.
Enable Total Acknowledge
The user may acknowledge all current alarms at one time by clicking on the menu bar
"Acknowledge " button. Leaving this box unchecked will disable the "Total Acknowledge"
option.
Enable Single Acknowledge
Some applications require individual acknowledgments on an alarm by alarm basis.
Selecting this check box will allow this option. An alarm is acknowledged by doubleclicking a displayed alarm in the Summary display. Leaving this box unchecked will
disable single acknowledgments.
283
WIN-911 Configurator
Require Ack Code to Acknowledge
If security and/or enhanced historical alarm record keeping are needed, the developer
may use this option to require an operator to enter his/her user name and
acknowledgment code in order to have access to local alarm acknowledgments. Selecting
this box will activate this feature. The user may also acknowledge more than one alarm at
a time. That is the purpose of the relock time. The developer may select this in minutes. If
the developer selects this option and selects 2 minutes for relock, the operator may
acknowledge as many alarms as he/she wishes, without re-entering his/her code. In this
example, if two minutes elapse after the last acknowledgment, the system will relock and
require a password to be re-entered to acknowledge the next alarm. A selection of "0"
minutes for relock would require re-entering the code for each alarm. Leaving this box
unchecked will disable password protection. If this option is implemented, the "Alarm
Monitor" would appear as follows:
If an alarm is activated, the user may acknowledge it in any of the modes of
acknowledgment, but he/she must first enter his/her name (Operator) and "Ack" code
(from the Phone Book) before the acknowledgment is processed. The user's access code
is also accepted in place of the user's name.
Appearance
In some applications, the developer may desire to "Lock Out " unauthorized access to the
standard Windows access tools such as: no access to "minimize or maximize", or
"elimination of the standard Windows frame" around the Monitor. These modifications are
available in the Global Monitor settings in the WIN-911 Configurator. (See "WIN-911
Global Menus.CHM" -> Monitor Definition -> Monitor Appearance, for more information.)
Default settings are shown below.
284
WIN-911 Runtime
The developer may remove any or all of the standard Windows access tools such as:
Caption Bar, Min/Max Commands, and the Windows Frame. The following is an example
of the WIN-911 Monitor with all controls removed:
285
WIN-911 Configurator
Manual Messenger
Options are available to allow users to be remotely notified of alarm conditions by
automatic paging, e-mail, and/or SMS message. Pager selections include numeric,
alphanumeric, local alpha, and local numeric pagers.
The "Manual Message" button will only be present when Pager, E-Mail, and/or SMS
connections have been configured for at least one user. WIN-911 is designed to alert
alarm events by sending the alarm message to targeted remote messaging devices. The
"Manual Message" button will allow the user to create a custom message, and send it to
anyone in the WIN-911 phone book that has a remote messaging connection. In the
example below, the user selected Tom Jones from the Phone Book, and typed in a
custom message. Clicking the Send button will send the message.
Message to Send
Type the message you wish to be sent in the Message to Send text box.
Note: When sending messages to numeric pagers, enclose the digits you wish to send in
brackets. e.g., [123]
Message Status
In the Manual Messenger dialog box, the user has access to status information on the
messaging connections. The information shown in this box will indicate the progress of
message negotiations with the server.
286
WIN-911 Runtime
2-way SMS Manual Messages
Sending a manual message via SMS is slightly different than sending a manual message
via e-mail or pager. This is because a SMS manual message will accept a reply in the
form of a SMS message. The SMS messenger is a 2-way communication where e-mail
and Paging are only 1-way. If a contact in the 'Phone Book' sends a SMS text message to
WIN-911 while the Manual Messenger is open the sent text should appear in the
"Message Status" window. Note: Every SMS message that is sent to the Manual
Messenger will result in WIN-911 responding with a SMS message saying "Invalid SMS
received: ....". Although it is not an invalid message to the Manual Messenger, it is an
invalid message to TeleDAC.exe. Just ignore the "Invalid SMS" response if sending
manual messages.
287
WIN-911 Configurator
Alarm Logger
The Alarm Logger module can be selected for long term storage of alarm history data.
Alarm archiving is selected in the group definitions. In addition to the normal alarm history
data, there are additional historical elements such as system startup and shutdown. This
is meant to allow more complete alarm analysis. Also, this file is very useful if you are
using remote notification as it will document who was contacted and what their response,
if applicable, was.
Monthly MDB File
The data format for this file is Microsoft Access database format (*.MDB located in the
Log Files folder) and uses date and time style and column order as defined by the
Monthly MDB tab of the global definition of the WIN-911 Configurator. This data file can
be viewed dynamically by Alarm Log Manager.
The alarm database is built on a monthly basis and is designed to take advantage of the
files ability to sort data, add notes to events and refresh the presentation to include the
most recent events.
Daily Text File
The data format for this file is ASCII and uses the alarm string format setup by the Daily
TXT tab of the global definition in the WIN-911 Configurator. It may be viewed with any
text editor. The file may be sent to the Print Manager to obtain a printout of the history for
some selected day.
A new file is created daily. The filename is built based upon the Julian date. The format of
this name is the letter 'A', followed by a two-digit year and then a three digit Julian date.
The extension of the file is "*.TXT ". The file created on February 15, 2005 would be
A05046.TXT (as that is the 46th day of the year 2005).
288
WIN-911 Runtime
Alarm Log Manager
Alarm events that are archived using the Access MDB File format can be viewed with the
Alarm Log Manager giving the user the ability to sort, enter comments, print out records,
and refresh current events.
Events can be sorted by clicking on a column title bar in the Alarm Log Manager. This will
be helpful in locating, organizing, and reorganizing events by any of the alarm message
fields
By double clicking on any event in the Alarm Log Manager, a text box will appear,
allowing the operator to add notes. These could include details of the event that are not
part of the WIN-911 alarm message which could be helpful for event reconstruction and
archiving.
For more detailed information about the Alarm Log Manager see the Alarm Log Manager
help file.
289
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement