win-911 enterprise edition - general electric

78
WIN-911 Enterprise Edition Quick Start 04/14

Upload: others

Post on 19-Feb-2022

11 views

Category:

Documents


0 download

TRANSCRIPT

WIN-911 Enterprise Edition Quick Start 04/14

Copyright 1993 - 2014

All Rights Reserved

No part of this publication may be reproduced, transmitted, transcribed, stored in retrieval system, or

translated into any language or computer language, in any former by any means, electronic, mechanical,

magnetic, optical, chemical, manual, or otherwise, without the written permission of WIN-911 Software (a

DBA of Specter Instruments, Inc.) 4020 S. Industrial Drive, Suite 120, Austin, Texas 78744.

The software described in this document is furnished under a license agreement or nondisclosure

agreement. The software may be used or copied only in accordance with the terms of agreement.

DISCLAIMER

WIN-911 SOFTWARE MAKES NO REPRESENTATION OR WARRANTIES WITH RESPECT TO THE CONTENTS

HEREOF AND SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS

FOR ANY PURPOSE. Further, WIN-911 Software reserves the right to revise this publication and to make

changes from time to time in the content hereof without obligation of WIN-911 Software to notify any

person of such revision or changes.

NOTICE TO USER

This manual should not be construed as any representation or warranty with respect to the software named

herein. Occasionally changes or variations exist in the software that are not reflected in the

manual. Generally, if such changes or variations are known to exist and to affect the product significantly, a

release note or README.DOC file accompanies the manual and distribution disk(s). In that event, be sure

to read the release note or README.DOC file before using the product.

TRADEMARKS

WIN-911® and Mobile-911™ are trademarks of WIN-911 Software.

Windows XP®,, Server 2008®, Windows 7®, Windows 8®, Silverlight®, and .NET Framework® are

registered trademarks of Microsoft Corporation.

Cepstral® is a registered trademark of Cepstral, LLC

iOS® is a registered trademark of Apple Incorporated

Android® is a registered trademark of Google Incorporated

Blackberry® is a trademark of Research In Motion Limited

Dialogic® is a registered trademark of Dialogic Corporation

FactoryTalk View® is a registered trademark of Rockwell Automation, Inc.

InTouch® and ArchestrA® are trademarks of Wonderware Corporation.

Proficy®, Cimplicity®, Dynamics®, and iFIX® are trademarks of GE.

GoXam™ is a trademark of Northwoods Software

Ozeki™ is a trademark of Ozeki Informatics Ltd.

CodeMeter is a trademark of WIBU

WIN-911 Enterprise Edition Quick Start 04/14 Contents • i

Contents 1. Introduction ................................................................................................... 1

WIN-911 Enterprise Edition ............................................................................... 1

Key differences from the WIN-911 Version 7 ............................................... 1

System Requirements .................................................................................... 1

Tech Support ................................................................................................. 1

About this Manual ......................................................................................... 1

WIN-911 Enterprise Edition Installation ............................................................. 1

Prerequisites .................................................................................................. 1

Modifying WIN-911 Enterprise Edition .............................................................. 1

Uninstalling WIN-911 Enterprise Edition ........................................................... 1

Licensing WIN-911 Enterprise Edition ............................................................... 1

2. Overview .......................................................................................................... 13

Modules & Concepts ....................................................................................... 13

Dispatcher .................................................................................................... 13

Data Source ................................................................................................. 13

Notifier ......................................................................................................... 13

Reporting ..................................................................................................... 13

Workflow of Configuring and Applying Strategies and Tactics .................... 13

Development of Tactics .............................................................................. 13

Development of Strategies ......................................................................... 13

3. Contacts ........................................................................................................... 25

Contacts Overview .......................................................................................... 25

Manage Email Settings ................................................................................ 25

ii • Contents WIN-911 Enterprise Edition Quick Start 04/14

Email Connections Workspace Editor ........................................................ 25

Organize with Roles .................................................................................... 25

4. Notification ...................................................................................................... 39

Standby/Activate ............................................................................................. 39

Schedules ......................................................................................................... 39

Schedules Collection Selector List .............................................................. 39

Schedule Workspace Editor ........................................................................ 39

Tactics .............................................................................................................. 39

Tactics Collection Selector List .................................................................... 39

Tactics Workspace Editor ............................................................................ 39

Strategies ......................................................................................................... 39

Strategies Collection Selector List ............................................................... 39

Strategy Workspace Editor ......................................................................... 39

List of Conditions and their definitions ....................................................... 39

List of Actions and their definitions ............................................................ 39

5. Alarming .......................................................................................................... 59

Alarming Overview .......................................................................................... 59

OPC DA Sources ............................................................................................. 59

OPC DA Sources Collection Selector List ................................................... 59

OPC DA Workspace Editor ......................................................................... 59

OPC DA Alarms ............................................................................................... 59

Collection Selector List ................................................................................ 59

Item/Alarm Workspace Editor .................................................................... 59

Labels ............................................................................................................... 59

WIN-911 Enterprise Edition Quick Start 04/14 Contents • iii

Labels Collection Selector List ..................................................................... 59

Label Workspace Editor .............................................................................. 59

6. Reporting ......................................................................................................... 69

Overview .......................................................................................................... 69

Reports Collection Selector List ...................................................................... 69

Report Workspace Editor ................................................................................ 69

Number ........................................................................................................ 69

Name ........................................................................................................... 69

Description ................................................................................................... 69

Items ............................................................................................................. 69

Copyright 1993 - 2014 .......................................................................................... i

All Rights Reserved ................................................................................................. i

WIN-911® and Mobile-911™ are trademarks of WIN-911 Software. .................... i

iv • Contents WIN-911 Enterprise Edition Quick Start 04/14

WIN-911 Enterprise Edition Quick Start 04/14 1 Introduction • 1

1. Introduction

WIN-911 Enterprise Edition WIN-911 Software would like to welcome you to the next

generation of our remote alarm notification software family:

WIN-911 Enterprise Edition!

WIN-911 is the most proven and advanced alarm notification

software suite available for the automation industry. Capable

of using a wide variety of notification methods, WIN-911 can

reach you wherever you are. WIN-911 interfaces with

SCADA/HMI data servers to monitor values and flag

alarms. When an alarm is detected WIN-911 will notify remotely

located users by dispatching electronic messages containing

vital information and allowing the recipient to respond by

replying to the message with acknowledgement

instructions. In addition to simple notification, WIN-911 allows

users to interact with your SCADA/HMI by accepting requests

for both report data and current alarm conditions.

WIN-911 Enterprise Edition is a complete rewrite of our flagship

product using current technology and standards. This release

supports Email, Voice, and Mobile-911 messaging for remote

notification delivery and subscribes as a client to any OPC DA

server for data monitoring and alarm reporting. This release

2 • 1 Introduction WIN-911 Enterprise Edition Quick Start 04/14

includes a suite of custom data source connections to iFIX,

FactoryTalk A&E, and Cimplicity.

Key differences from the WIN-911 Version 7

The configuration tool is a browser-based GUI that

configures the product live during runtime.

Each module has two primary components, an

Application Server running in Internet Information

Services (IIS), and a runtime executable running in the

system's services. Hence, Enterprise Edition is "always

on" and does not require a restart to apply

configuration changes; nor is it affected by Windows

users logging in and off the host computer.

The Email notification method for Enterprise Edition is

capable of two-way communication. Thus a remote

user will receive alarm notifications in near-real time,

and be able to acknowledge alarms by responding

with the proper credentials. The user can also request

information from WIN-911 at his/her convenience.

Dramatic enhancements to the Schedule interface

allows the user to easily create complex schedules via

an intuitive calendar/agenda presentation. Schedules

use appointments that can revolve around blocks of

time, days of the week, weeks of the months, or

months, or years....

WIN-911 Enterprise Edition introduces a revolutionary

concept in the design and deployment of complex

notification tasking: Strategies and Tactics. Alarms are

associated with a single Strategy. Each Strategy

controls the execution of any number of Tactics which

conduct remote notification procedures.

WIN-911 Enterprise Edition Quick Start 04/14 1 Introduction • 3

System Requirements Windows 7 Pro x64, 8 (x64), 8.1 (x64), Server 2008 R2,

2012, & 2012 R2.

A minimum of 2 processors and 2 GB of RAM.

Internet Information Services (IIS).

Internet connection for VoIP and/or Mobile-911

connections.

Analog phone line and supported TAPI modem for

TAPI voice connections.

Access to Email Server with a DEDICATED Email

account from which WIN-911 can send alarm

messages and receive acknowledgement and report

requests.

Tech Support You can contact WIN-911 Enterprise Tech Support at

[email protected] or call (800) 331-8740 between the

hours of 8:00 AM and 5:00 PM Central, Monday through

Friday.

About this Manual

This manual is an Install & Quick Start guide for setting up the

WIN-911 software and discussing the basic principles of remote

alarming. All four of these chapters are contained in the

complete digital documentation and help file that can be

accessed electronically after the WIN-911 setup is complete.

WIN-911 Enterprise Edition

Installation Insert the WIN-911 Enterprise Edition CD.

4 • 1 Introduction WIN-911 Enterprise Edition Quick Start 04/14

Prerequisites

The install will first conduct an inspection of your operating

system to verify all the necessary prerequisites are present and

generate a list of missing programs and features. You will be

required to install all components before proceeding to the

WIN-911 install.

The prerequisites include:

Microsoft .NET 4.0 (or higher)

Windows Edition and Feature Set Detection

WIBU CodeMeter Control Center

SQL Server Compact

Application Initialization for IIS

Click the continue icon (red, right-pointing arrow) at the

bottom of the page to advance to the next section. Later

pages will have a previous page icon at the botton left that

you can use to navigate back to an earlier page.

WIN-911 Enterprise Edition Quick Start 04/14 1 Introduction • 5

Review the Software License Agreement and tick the “I agree”

tick box followed by the continue icon (right pointing arrow)

that appears after accepting the agreement.

6 • 1 Introduction WIN-911 Enterprise Edition Quick Start 04/14

The WIN-911 Software Compatibility Tester will appear with a

list of required features not currently installed. The list

appears in the order that the listed features will be found in

the IIS manager. Indentions represent folders that will have to

be drilled down into to locate the enabling tick-box. Click

“edit icon” on the bottom right of the list and enable all the

required features.

Once all features and roles for IIS are selected click “OK” and

wait for IIS to complete setup. This step may require a reboot.

The next step is to click the “refresh” icon located at the upper

right of the page. Once all prerequisites are satisfied a

continue button is presented at the lower right.

WIN-911 Enterprise Edition Quick Start 04/14 1 Introduction • 7

Click the continue icon to advance to the next section.

Enter the user credentials WIN-911 will require to grant

access to the WIN-911 configuration GUI. The username

will require both the machine name and the username,

separated by a backslash, (\). A convenient browse

button is provided to the right which allows you to

avoid syntax errors. Click the OK (check) icon then enter

the password followed by the Validate button. The

8 • 1 Introduction WIN-911 Enterprise Edition Quick Start 04/14

install will verify the credentials, and if correct, the

continue icon will appear in on the bottom right.

Click the continue icon to advance to the next section.

WIN-911 Enterprise Edition Quick Start 04/14 1 Introduction • 9

You are now at the module selection page. Verify that all the

modules you wish to use are checked. The options include an

Alarm sources section, a Notifiers section, and a Support

section. The alarm sources options include OPC DA,

FactoryTalk A&E, and iFIX. If you are not using iFIX, you can

save disk space, system resource, and cut down on

configuration confusion by not having it install. The same

ration-al figures for the notifiers you install. You can choose

from email, voice, and Mobile-911 (our smart phone app). If

you do not plan on taking advantage of Voice type

notification you can deselect the Voice Notifier and it will

remain uninstalled.

Note the up or down pointing arrow to the left of each

section. Clicking it will collapse or expand the sections for

your editing.

At the bottom of the page is the InstallPath, with the default

path in place. You can modify this using the browse icon

located to the right of the path.

Once your options are finalized select to continue icon arrow

to proceed with the installation.

This part could take several minute to complete. In the

meantime billboards will be displayed that give tips and

information about configuring WIN-911 Enterprise Edition. We

recommend that you pay particular attention to the sections

concerning Strategies and Tactics.

10 • 1 Introduction WIN-911 Enterprise Edition Quick Start 04/14

Once complete your system will need to reboot. Click the

Finish button and your system will reboot.

Modifying WIN-911 Enterprise

Edition See the on-line help document for information about

modifying an existing WIN-911 Enterprise Edition deployment.

Uninstalling WIN-911 Enterprise

Edition See the on-line help document for information about

uninstalling an existing WIN-911 Enterprise Edition deployment.

WIN-911 Enterprise Edition Quick Start 04/14 1 Introduction • 11

Licensing WIN-911 Enterprise

Edition Note: After an initial installation WIN-911 Enterprise will be

configured with a demo license that will run 30 days without

restriction.

To license WIN-911 click on the CodeMeterControl Center

thumbnail located in the lower right of your tray.

1) Select the non-demo container (blue highlight)

2) Click the “License Update” button and follow the

wizard to generate a license request file.

3) Upload your request file via

http://www.win911.com/enterprise-edition/licensing/.

4) Select the demo license container and click “Remove

License”.

12 • 1 Introduction WIN-911 Enterprise Edition Quick Start 04/14

5) Drag and drop the license file sent to you onto the

CodeMeter Control Center window.

6) Click “Enable” and your WIN-911 CodeMeter Center

will indicate that your license is activated.

WIN-911 Enterprise Edition Quick Start 04/14 2 Overview • 13

2. Overview

Modules & Concepts WIN-911 Enterprise Edition provides an innovation to alarm

notification products and methods. With these new concepts,

complex alarm notification rules can be easily rendered,

significantly reducing development, deployment, and

maintenance efforts. WIN-911 Software introduces a novel flow

chart-style graphical interface to easily set up notification

“Strategies” and “Tactics.” Appropriate strategies are triggered

by events such as a change to alarm state and in response the

strategy invokes a set of instructions (tactics) based on the

policies developed by the WIN-911 administrator. Each tactic

can contain multiple instructions, and can even contain other

tactics (which are referred to as sub-tactics). The method of

assembling remote alarm notification scenarios afforded by

WIN-911 Enterprise Edition is substantially easier to build,

understand, visualize, and modify than other currently available

products.

What is Strategic Notification?

Strategic Notification

Logically follows your process

Allows more efficient use of personnel

Allows policies to be executed dynamically

14 • 2 Overview WIN-911 Enterprise Edition Quick Start 04/14

Changes with your organization

Highly Customizable

Easy to configure

Scales well with complexity

Script free

Kludge free

Escalation logic beyond a simple callout list.

Callout lists are still supported and still simple!

Strategic Notification Tools

Alarms trigger Strategies

Strategies utilize Tactics

Tactics specify the action to take:

Call Adam

Call Adam and then send an email to Bob

Notify the Safety Officer and then all plant personnel

on duty.

Send Emails to Adam and Bob. Wait 5 minutes, and if

the alarm is still unacknowledged, Call Charles.

If it‘s the weekend, call Adam. Otherwise, send an

email to Bob if the alarm is low priority or Charles if it’s

high priority.

Strategies specify a set of policies for when to take actions:

When an alarm occurs, call Adam

When the alarm changes state, send an email to

Adam.

After 30 minutes, check if the alarm is acknowledged

and if not, notify the supervisor.

When the alarm gets acknowledged, notify everyone

who was previously notified about the alarm.

Example: Adam

When an alarm occurs, notify Adam

When the alarm changes state, notify Adam.

WIN-911 Enterprise Edition Quick Start 04/14 2 Overview • 15

When the alarm becomes acknowledged, stop notification.

Figure 1 is a conceptual drawing that shows both the

environment of WIN-911 Enterprise Edition and its main

components. The typical environment will be a plant or factory

controlled by automated machinery (1) embodying

programmable logic controllers (PLCs) or the like. Such

machinery will typically be integrated into a SCADA network (3)

hosted by operating systems that will likewise host WIN-

911. The automated machinery uploads its data to the SCADA

Network which centralizes that data in a well known manner

and makes it available to other applications and services

running within the operating systems. WIN-911 may comprise

user-defined modules that query data from the SCADA

network and invoke strategies that receive alarm events and

queue tactics that conduct remote notification procedures. A

configuration can contain an unlimited number of strategies

(5). Based upon a derived alarm event (7) each strategy can

then invoke any number of user defined tactics (9). Each tactic

may comprise a logical series of tasks that handle alarm event

16 • 2 Overview WIN-911 Enterprise Edition Quick Start 04/14

messaging based on predetermined conditions and user input.

The tasks are configured by utilizing a set of instructions that

are subdivided into notifications, decisions and miscellaneous.

A tactic can likewise invoke other tactics, which are called sub-

tactics. When the tactics are complete or the alarm event

terminates, the tactics and strategies end.

WIN-911's architecture is distributed between software

modules that seamlessly interact with each other. Each module

consists of three primary components which include an

application server and GUI that runs within Microsoft's Internet

Information Services (IIS) (11). This allows the system to be

configured and monitored through internal password

protected URLs that can be accessed by any computer in the

network. The third component is the runtime executable that

runs in the Operating System's Services. The module manifest

includes the dispatcher, data source, Email notifier, and report

modules, which are detailed below.

Dispatcher The dispatcher module is the primary component of WIN-911

Version 8's infrastructure. It maintains the execution of all

strategies and tactics; receives and implements programming

from the GUI whenever a schedule, strategy, tactic, or role edit

is saved; and directs notifier modules during runtime

operations.

Data Source The data source module communicates directly with the

SCADA network and receives alarm event data which it

distributes to the dispatcher and the GUI. It receives and

implements programming from the GUI whenever an edit is

saved and works in conjunction with the GUI to conduct alarm

database imports. The module subscribes to alarm services

WIN-911 Enterprise Edition Quick Start 04/14 2 Overview • 17

provided by the SCADA and validates the data's integrity and

security. It also receives alarm acknowledgement messages

from the Email notifier modules which it delivers to the SCADA

and receives acknowledgement confirmation messages which

it routes to the controlling strategy.

Notifier The notifier module receives remote notification tasking from

tactics running in the dispatcher module, subscribes as a client

to the configured gateway server, and contains the connection

and gateway data entered from the GUI. It receives and

implements programming from the GUI whenever an edit is

saved. It utilizes the configured protocol to deliver alarm

messages, receives responses from the alarm-responder with

alarm acknowledgement requests and report requests which it

relays to the data source module for processing by the

SCADA.

Reporting The reporting module receives remote report tasking from

tactics running in the Dispatcher Module, interfaces directly

with the data source and email notifier modules to conduct

reporting as required by a tactic or as a result of an alarm-

responders request. The report module receives and

implements programming from the GUI whenever an edit is

saved.

18 • 2 Overview WIN-911 Enterprise Edition Quick Start 04/14

Figure 9 shows a hypothetical time-based series of events that

demonstrate the interaction of the modules during runtime.

This figure highlights how strategies and tactics share

information in order to execute remote notification rules during

the life of an alarm event.

The scenario begins when the WIN-911 administrator assigns

an alarm event to the strategy he/she developed in the GUI.

Sometime after the configuration goes live the source module

delivers an alarm event message that it received from the

SCADA and routes it to the associated strategy within the

dispatcher module.

The strategy processes the alarm event condition according to

its policy and calls tactic 1.

Tactic 1 immediately instructs the Email Notifier to send an

alarm message to Tom Jones and waits the configured amount

of time for a response from Tom.

After the elapsed time expires tactic 1 again instructs the Email

Notifier to call Bob Jones and deliver the alarm event message

and process Bob's response, if any.

WIN-911 Enterprise Edition Quick Start 04/14 2 Overview • 19

In the scenario Bob declines to Acknowledge the alarm and

tactic 1 informs the strategy and terminates.

Sometime later the source module receives an updated

message from the SCADA that the alarm event has escalated

and routes the update to the Strategy. The escalation event

takes the form of a state change and the strategy’s state

change policy calls tactic 2.

Tactic 2 instructs the Email notifier module to broadcast an

asynchronous batch of Email messages to all Email connections

designated with "Manager" roles. One of them responds with

an acknowledgement code which the Email notifier relays to

the source module and subsequently delivers

acknowledgement request to the SCADA.

The SCADA accepts the acknowledgement and informs the

source module. The source module routes the

acknowledgement confirmation to the strategy which stops all

tactics in progress in accordance with its alarm

acknowledgement policy and then terminates the strategy.

Workflow of Configuring and

Applying Strategies and Tactics

Entering Preliminary Compilation of Required Data.

1) Launch an Internet browser and enter the URL:

e.g., https://MachineName/WIN911/. From here you can

navigate to all other module GUIs using the navigation links

located at the top of the page.

2) Standby/Activate toggle is located in the System tab which

allows the WIN-911 Administrator to globally stop all Alarm

20 • 2 Overview WIN-911 Enterprise Edition Quick Start 04/14

notification processes. WIN-911 Enterprise Edition operates by

default in an “always on” mode and any changes to the

configuration go live as soon as possible. If the WIN-911

administrator wishes to configure “off-line” before going live,

use this toggle to put WIN-911 in Standby. All strategies will

run, but no actual remote notification will be dispatched until

WIN-911 is placed back into Active mode.

3) Input connection information for locating and notifying

alarm responders. This information will include Email

addresses, duty schedules and roles and is entered through the

/Contacts/Connections link. Further details of connection data

entry are suppressed for the remainder of this discussion in

order to focus on the development of strategies and tactics

that follow.

Development of Tactics 1) Design tactics by clicking the navigation links

/notification/tactics. Click the add-create icon (+) at the

bottom right of the tactics list to bring up a blank tactic

workspace in edit mode. Enter a unique name for the tactic

and give it a brief description in the fields provided. The blank

tactic is represented by a green circular start node, where the

tactic begins, and red end node, where the tactic concludes,

and directional link lines that represent the flow of tasking.

2) Drag and drop tactical instruction blocks from the right hand

pane directly into the tactic design workspace. Blocks are

chosen from the three categories notification, decision, and

miscellaneous. Position the block by dropping it on the link in

the place where you want the block to execute.

For example: If you want the tactic to pause for 5 minutes

before taking action, you would click on the Misc tab at the

bottom right of the instruction block pane (which would bring

up the Misc instruction block section) and drag the delay block

WIN-911 Enterprise Edition Quick Start 04/14 2 Overview • 21

to the middle of the tactic and drop it between the start node

and the end node. The tactical display will adjust with the new

block present. You would then need to set the delay for 5

minutes by clicking the block and selecting the edit icon in the

center of the edit form that appears. Select the minute’s unit

and click the up arrow five times to set the timer.

The tactic can evaluate the acknowledgement condition of the

alarm by the insertion of an Ack decision block. Click the

decision tab at the bottom of the instruction block pane to

display the desired section. Click the Decision block and drag

and drop it in the tactic directly on the flow line beneath the

delay block. The tactical display will adjust by including the

block and will branch the tactical path into two separate

routes. One route will branch off to the left representing the

path to be taken if the condition (acknowledgement) is false.

This is indicated by the letter F and a red color-coded

corner. The right (unlabeled) path is to be taken if the

condition is true. Both routes terminate in the end node.

The tactic will invoke remote notification procedures when

arriving at a notification block, which can be selected from the

notification instruction blocks section. A single person (or

entire groups of people) can be notified in a single notification

block, depending on the particular block selected. In this

example, a notify single block will be dropped in the false path

that will instruct the tactic to notify the designated

contact. After the block is dropped in the path, the WIN911

administrator will click the block and select edit to designate

the contact to be notified. The contact selector polls the Email

notifier for its respective list of contacts to choose from and

displays them in a scrollable selection list. The contact will have

a duty schedule that determines when that person is on

duty. The notify block has the option to ignore that schedule

and notify that person regardless, which this in example we will

use. By clicking the checkbox to the left of the contacts name

and the checkbox below the selection list named "Ignore Duty

22 • 2 Overview WIN-911 Enterprise Edition Quick Start 04/14

Schedule", the notification block and the example tactic are

complete. Click the save icon at the bottom right of the

workspace and the tactic now appears in the tactics list box and

is available for selection in the strategies workspace.

Development of Strategies Create any number of strategies based on the desired

notification rules. Each strategy will have a unique user-defined

name and can optionally contain a description to elaborate on

the function of the strategy. Then designate policies to define

the behavior of the strategy under particular conditions. The

strategy will manage the remote notification procedures by

controlling the tactics based on the events that occur in the life

cycle of the alarm. Typically the strategy will begin with a

triggering event (or condition) like a new alarm, which will call

an initial beginning tactic (Action). Each strategy can have an

unlimited number of interior policies that modify the

notification rules as required by subsequent events such as

state changes and elapsed time. Lastly each strategy should

have a terminal condition that will end the strategy based on

the end of the alarms life cycle.

Design strategies by clicking the navigation links

/notification/strategies. Click the create icon at the bottom

right of the strategies list to bring up a blank strategy

workspace in edit mode. Enter a unique name for the strategy

and give it a brief description in the fields provided. The

strategy is configured by creating policies that contain a

condition (which is an alarm event) and an Action (which will

usually involve the invocation and/or modification of a

tactic). In this example the WIN-911 Administrator will create

a new strategy by selecting an initial policy that begins

execution when a new alarm event occurs. The policy

condition is selected from the pull-down list by clicking the

down arrow and highlighting "New Alarm". The action that the

initial policy takes will be to start tactic 1 by clicking the down

WIN-911 Enterprise Edition Quick Start 04/14 2 Overview • 23

arrow in the pull-down list and highlighting the "Start Tactic"

action. This will bring up and extra input button that the WIN-

911 Administrator clicks to specify the desired tactic.

The example strategy will be terminated when the alarm event

is both acknowledged and the value of the data returns to its

normal range. Thus a second policy is added with the

condition "terminal" and the action "end strategy" selected.

When the strategy is saved it then becomes available in the

alarms workspace where a particular alarm event can be

assigned to the strategy.

After the strategy and its tactics are developed and tested they

can be utilized by the runtime modules when the strategy is

assigned to an alarm event. This is done by clicking the

navigation links alarming/source/alarms and then selecting the

desired item. Next click the edit icon followed by the alarms

tab. The strategy pull-down selector is enabled and the WIN-

911 administrator can click the down arrow and highlight the

desired strategy. Once this is done the save icon can be

selected, causing the strategy and its associated tactics to be

written to the dispatcher module which will execute the

updated configuration next time the alarm event occurs.

When editing an existing strategy or tactic the modification is

written to the dispatcher whenever the save icon is clicked. If

the existing strategy is in-progress when the save icon is clicked

then the existing strategy is allowed to conclude before the

modification is applied. Tactics are handled in similar but

independent fashion. If a tactic is in-progress when the save

icon is clicked, the tactic is allowed to conclude before the

modification is applied. A tactic can be modified during the

execution of its parent strategy so long as that tactic is not in-

progress when the save icon is selected. If it is then the

modification will be applied at the tactic's conclusion, all of

which is transparent to the user.

24 • 2 Overview WIN-911 Enterprise Edition Quick Start 04/14

WIN-911 Enterprise Edition Quick Start 04/14 3. Contacts • 25

3. Contacts

Contacts Overview Remotely located responders are alerted to alarm events

electronically via messages dispatched from WIN-911 in

accordance with the tactics and strategies configured by the

administrator. The contact information, including Gateway

Settings, Connections, and Roles are specified in the Contacts

pages.

Start here to define the connections WIN-911 will contact and

the gateways WIN-911 will use to reach the outside world.

Note: The Quick Start manual only details the configuration of

Email connections. WIN-911 is capable of conducting voice

telephony and Mobile-911 connections that are documented in

the online help file.

Manage Email Settings Email notification allows for one-way or two-way

communications with any Email capable device. Messages

may contain either rich HTML or plain text for compatibility with

a wide range of devices.

26 • 3. Contacts WIN-911 Enterprise Edition Quick Start 04/14

Email Gateway

Define the settings required to connect to your local or

Internet-based mail server.

Edit/View Mode

The Email gateway workspace (like all workspace's in Version

8) can be toggled between view mode (which allows the WIN-

911 administrator to view the details of the gateway without the

ability to edit), and edit mode (which allows the properties of

the gateway to be changed). In view mode, the edit icons

appears at the bottom right of the workspace; in edit mode the

edit icons is replaced with the save and cancel icons.

Note: The Email gateway page can be navigated away from with

the workspace still in edit mode. No changes will be

saved/applied until the Administrator navigates back to the

gateway page and clicks the save icon. All changes made prior

to the navigation will remain available for saving until the

browser session is closed.

Note: WIN-911 is capable of using different servers for outgoing

and incoming mail.

Note: WIN-911 requires a dedicated Email address due to the

way it handles the inbox. Any messages left in the inbox will be

deleted from the server by WIN-911 at runtime.

Outgoing Server

The outgoing server uses the SMTP protocol to dispatch alarm

and report messages.

Type

WIN-911 uses SMTP as the outgoing server protocol.

Host

Specify the server name or IP address of your

outgoing mail server.

WIN-911 Enterprise Edition Quick Start 04/14 3. Contacts • 27

Use TLS/SSL

Check this box if the outgoing server WIN-911 will use

requires encryption.

Port

Enter the port number that the WIN-911 Email server

will use to send outgoing mail.

Email Address

Enter the dedicated Email address in the text entry box

that WIN-911 will use to dispatch alarm and report

messages, and receive acknowledgement and report

requests.

Username

Specify the credentials required by your mail server.

Password

Enter the password as configured in the Email server

that authenticates the WIN-911 account.

Test Outgoing Server Settings

Click "Test Outgoing Server Settings" button to test

WIN-911 ability to connect to the mail server and send

messages. If the server values have been properly set,

WIN-911 will display a "success" message. If the test

fails, refer to the Windows Event Viewer for details

concerning the error that occurred when the test was

attempted and take corrective action.

Understanding Required Warning Message

Note: Before the gateways settings can be saved, WIN-

911 requires that you read the following warning and

check the confirmation box to the lower right.

28 • 3. Contacts WIN-911 Enterprise Edition Quick Start 04/14

The gateway Email account must be reserved for

exclusive use by WIN-911. Do not attempt to access

the account from another mail client. Be aware that

WIN-911 will delete messages on this account.

Incoming Server

The incoming server can use either the POP3 or IMAP protocol

to receive incoming acknowledgement and report requests.

Use Incoming Email (required for

Acknowledgement and Report Requests)

Click this check box to configure WIN-911 to receive

incoming mail.

Type

WIN-911 supports POP3 and IMAP as the incoming

server protocol. The default protocol is POP3.

Host

Specify the server name or IP address of your

incoming mail server.

Use SSL

Check this box if the incoming server requires

encryption.

Port

Enter the port number that the WIN-911 Email server

will use to receive incoming mail.

Poll Rate (min)

Enter frequency in minutes that WIN-911 will poll the

server for incoming mail. Keep in mind that this setting

affects the responsiveness of the system to remote

users attempting to interact with WIN-911 via email.

WIN-911 Enterprise Edition Quick Start 04/14 3. Contacts • 29

Use Outgoing Credentials or Specify

In the event that the mail server uses the same

credentials for incoming mail as it does for outgoing,

use the default setting of "Use Outgoing

Credentials". Otherwise select "Specify" and enter the

username and password required by the incoming

server.

Test Incoming Server Settings

Click the "Test Incoming Server Settings" button to test

WIN-911 ability to connect to the mail server and

receive mail. If the server values have been properly

set, WIN-911 will display a "success" message.

If the test fails refer to the Windows Event Viewer for

details concerning the error that occurred when the

test was attempted and take corrective action.

Email Connections

Connections specify a destination for alarm notification

reports. Email connections also determine just what you will

see in alarm and report Email messages, connection availability

and the permissions a connection has been granted

concerning acknowledgement and report requests.

Email Connections Selector List

On the left side of the Email connections workspace is a master

list of all defined Email connections. Each Email object contains

four properties; the Name, Description, Email Address, and

Roles displayed in columnar format. Properties can be used to

sort and filter the Email connections using tools provided within

the form. The active sorting column is indicated by a black

triangle in the middle of the column heading. Active filtering is

indicated by a yellow column header.

30 • 3. Contacts WIN-911 Enterprise Edition Quick Start 04/14

Select a connection to edit: An individual connection is selected

by clicking the check box to the left of the connection's

properties. Only one connection can be selected at a time.

Sorting

When the name column has a black triangle pointing down,

the Email connections will be arranged by name in descending

alphabetical order. Clicking on the triangle will reverse the list

and cause it to be arranged in ascending order. A third click

on the triangle will deselect the column. Any property column

can be sorted.

Search

The search field will filter the Email connections collection

selector list by suppressing the display of Email connections

that do not contain the character string entered. Any property

column can be searched. The search field will be highlighted

yellow while the search filter is in session.

Filtering

On the right side of the property column heading is a black

filter symbol. Clicking it brings up a custom filter design

form. This form provides several options the WIN-911

administrator can use to exclude unwanted Email connections

from being listed in the collection selector. "And/Or"

expressions can be created that key on the selected property

data for inclusion or exclusion. A filter can be configured for

any property column. The selected property (Name or

Description) column header will be highlighted yellow while the

custom filter is applied. If more than one column has filters

applied, each will be highlighted.

Grouping

Dragging and dropping a property column header into the

grey area above the Email connections list will cause the

collection selector to group the Email connections

WIN-911 Enterprise Edition Quick Start 04/14 3. Contacts • 31

accordingly. The collection selector now lists the title of the

selected object in bold font with a drop-down arrow to the

left. Click on the drop-down arrow and the collection selector

will drop a list of all the Email connections that contain a

particular object title. Groups can be compounded by

dragging another object into the "Group by" field. Grouping

can be removed by hovering over the group title and clicking

the "X" that appears to the right of the title. Any property can

be grouped.

Email Connections Workspace Editor Clicking one of the edit buttons below the Email connections

list or selecting one of the individual Email connections will

bring up the Email Workspace editor to the right of the list. This

environment allows the WIN-911 Administrator to create an

Email connection to meet the exact needs of his/her

specifications.

Edit/View Mode

The Email connection workspace (like any WIN-911 workspace)

can be toggled between view mode (which allows the WIN-911

administrator to view the details of the Email connection), and

edit mode (which allows the properties of the connection to be

changed). In view mode the edit icons appears at the bottom

right of the workspace. In edit mode the edit icons are

replaced with the save and cancel icons.

Note: The Email Connections Workspace page can be navigated

away from while the workspace is in edit mode. No changes will

be saved/applied until the Administrator navigates back to the

Email Connections page and clicks the save icon. All changes

made prior to the navigation will remain available for saving

until the browser session is closed. If your browser session is

closed prior to saving, all edits will be lost.

General

32 • 3. Contacts WIN-911 Enterprise Edition Quick Start 04/14

Name

Each Email connection must have a unique name that

identifies the particular Email connection.

Description

An extra text field for organization and administration

purposes, similar to a code comment.

Email Address

View or enter the Email address that WIN-911 will send

assigned alarm and report messages to for this

connection. It is acceptable to assign a unique Email

address to multiple connections if your situation

warrants such action; however, a warning message will

be generated to inform the WIN-911 administrator that

a pre-existing connection already uses this address

and lists the number of times it has been used.

Schedule

View or select the schedule that WIN-911 will honor

when sending alarm and report messages. A

connection can have only one assigned schedule, but

a schedule can contain multiple appointments. See

Schedules.

Roles

View or assign roles to the selected connection by

clicking the add button in edit mode. Each connection

can have multiple roles. See Roles.

Send Welcome Message

Click the "Send" button in view or edit mode to send

a WIN-911 Welcome message to the selected

connection. The welcome message will test the

gateway and connection settings as well as provide

the recipient vital information about how to use

WIN-911 Enterprise Edition Quick Start 04/14 3. Contacts • 33

his/her Email account to receive alarm and report

messages and request acknowledgements, reports,

and alarm updates.

Welcome to WIN-911! Here are some instructions for

interacting with the Email module: Overview: WIN-911

allows for alarm acknowledgement, report requests,

and alarm requests via Email. Please note that

command keywords are not case sensitive.

Acknowledgement:- To acknowledge alarms, simply

reply to the delivered alarm message. Note that your

connection must be configured to allow

acknowledgement. If your connection is configured

to require an ack password, be sure to include it in the

body of your reply Email.- To provide a comment with

your acknowledgement, enter the keyword

“COMMENT:” followed by your comment in the body

of your reply Email. Report Requests: To request

reports, send an Email with the subject "REPORT"

followed by either the report name or number (e.g.

"REPORT 14" or "REPORT Freshwater Tanks"). You can

also limit your request to specific report items (e.g.

"REPORT 14 : 1,2,3" would pull first three items of

report number 14, or "REPORT XYZ : 1-3,7-9" would

pull items 1 through 3 and items 7 through 9 of report

whose name is XYZ) Alarm Requests: - To request

alarms, send an Email with the subject "GET". You can

limit the response to a specific alarm state, severity

threshold, and/or set of labels. The general structure

of the subject of your mail should be: “GET STATE SEV

X LABEL1, LABEL2, LABEL3” - Valid state values are:

ALL, ACTIVE, UNACKED, ACTIVE ACKED, ACTIVE

UNACKED, and INACTIVE UNACKED. Specification of

state is optional; if you do not specify a state, then

“ALL” will be assumed.- Specification of a severity

threshold is optional; the valid range is 1 to 1000.-

Label values are restricted to the Labels defined in

34 • 3. Contacts WIN-911 Enterprise Edition Quick Start 04/14

your Win911 configuration. You can specify any

number of labels which should all be separated by

commas. – For example, "GET SEV 750" would pull all

alarms with a severity of at least 750. Likewise, "GET

Safety" would pull all alarms with the "Safety" label.

You can be as general as “GET ALL” or as specific as

“GET ACTIVE UNACKED SEV 500 Safety, Building2”.

Alarm Format

Subject

View or select the contents of the alarm message

subject. It can contain a static default subject of "WIN-

911 Alert" or use a dynamic alarm descriptor that is

taken from the report definition during runtime.

Body

View or select an alarm message format from the five

available options: Default Text Simple, Default Text

Verbose, Default HTML Simple, Default HTML

Verbose, and Diagnostic. The simple selections

include minimal information about the alarm whereas

the verbose options include amplified details. The

Diagnostic option is the most detailed and includes

information regarding Email notifier modules

interaction with the Email server and is not intended

for normal remote notification operations. The HTML

options include a more visually appealing, rich

presentation with a color-coded alarm condition and

acknowledgement information but will not be

compatible with "text-only" Email servers or devices.

Preview

A "What You See if What You Get" window shows the

administrator what an alarm message will look like

with the current options selected.

WIN-911 Enterprise Edition Quick Start 04/14 3. Contacts • 35

Report Format

Subject

View or select the contents of the report message

subject. It can contain a static default subject of "WIN-

911 Report" or use a dynamic report descriptor that is

taken from the report definition during runtime.

Body

View or select the report message format from the

four available options: HTML Report, Default Report

(Horizontal), Plain Text Vertical Report, and Plain

Vertical Report Verbose. The simple selections include

minimal information about the alarm whereas the

verbose options include amplified details. The HTML

options include a more visually appealing rich

presentation with color-coded alarm condition and

acknowledgement information but are not compatible

with text only Email servers or end-users.

Preview

A "What You See if What You Get" window shows the

administrator what a report message will look like with

the current options selected.

Ack Options

View or select the connection's acknowledgement

options with this tab.

There are three options each Email connection can be

configured for concerning the ability to issue

acknowledgement requests: Ack on Any Reply, Ack

with Password, and Do Not Allow. In edit mode this

setting can be selected or modified by clicking the

36 • 3. Contacts WIN-911 Enterprise Edition Quick Start 04/14

desired button. The "Ack with Password" option

contains a text entry box where the ack password is

defined. The password will not be visible in view

mode.

To provide a comment with your acknowledgement,

enter "comment:" followed by your comment in the

body of your reply Email.

To acknowledge alarms using a password, include the

password in the body of your reply Email.

Note: The only Email message that can properly issue

an acknowledgement request is the original alarm

message. If an error message is received concerning

an incorrect password with the instructions to "try

again later", do not reply to the error message, but

rather reply to the original alarm message with the

corrected password.

Note: In the event that several alarm conditions exist

simultaneously regarding a single OPC-DA item (i. e. a

High limit and a Hi-Hi limit having been exceeded), the

alarm responder will need to issue an

acknowledgement request for each outstanding alarm

condition. Acknowledging the Hi-Hi alarm will not

affect the acknowledgement state of the High alarm. In

order for an alarm event to become terminal, its

associated condition must be acknowledged.

Alarm Request Options

WIN-911 labels provide a way to organize alarms and

connections have the ability to request alarms by label,

alarm state, etc.

WIN-911 Enterprise Edition Quick Start 04/14 3. Contacts • 37

View or select the connection's alarm request options

by clicking one of the two options: All Alarms, or

Specific Alarms. If the Administrator wishes to limit

the connection’s alarm request to specific labels, the

labels must be added using the labels selection

tool. There are no limits to the number of labels that

can be assigned to a connection.

For example, a technician may only be authorized to

interact with alarms from “Area 2”. An administrator

can add the “Area 2” label to the set of specific alarms

this connection is allowed to request; then requests for

alarms will be automatically filtered to include only

alarms from “Area 2” as specified.

See Labels for more details.

Organize with Roles

Roles represent a label for organizing connections based on

availability, location, or responsibility. Roles can be used in a

notification tactic to notify all connections with something in

common.

38 • 3. Contacts WIN-911 Enterprise Edition Quick Start 04/14

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 39

4. Notification

Standby/Activate Standby/Activate toggle is located in the System tab which

allows the WIN-911 Administrator to globally stop all Alarm

notification processes. WIN-911 Enterprise Edition operates by

default in an “always on” mode and any changes to the

configuration go live as soon as possible. If the WIN-911

administrator wishes to configure “off-line” before going live,

use this toggle to put WIN-911 in Standby. All strategies will

run, but no actual remote notification will be dispatched until

WIN-911 is placed back into Active mode.

Schedules The Schedules workspace allows the WIN-911 administrator to

develop any type of schedule needed to determine who is on

duty and when certain instructions are to be carried out. WIN-

911 comes with eight commonly used schedules as well as

development tools to create custom schedules to meet your

unique needs.

Schedules define the availability of connections and can be

used in a notification tactic to control notifications. They can

40 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

occupy a single space in time, like an appointment, or be

comprised of a pattern of appointments which can recur based

on days, weeks, months and even support floating holidays.

WIN-911 provides a suite of predefined common schedules that

the administrator can use to build Tactics. The default schedule

is "Always". These schedules are hard coded and not

modifiable. If the specifications of a particular tactic require a

different schedule than the ones provided, the WIN-911

administrator can create his/her own schedule by using the

creation/edit workspace that appears when one of the edit

buttons is clicked at the bottom of the schedules collection

selector list.

Schedules Collection Selector List Please refer to Email Collection Selector discussion in Chapter

3 for details on utilizing this tool.

Schedule Workspace Editor Clicking one of the edit buttons below the schedules list or

selecting one of the individual schedules will bring up the

Schedule Workspace editor to the right of the list. This

environment allows the WIN-911 Administrator to create

schedules to meet the exact needs of his/her specifications.

Edit/View Mode

The Schedule workspace (like all WIN-911 workspaces) can be

toggled between view mode (which allows the WIN-911

administrator to view the details of the schedule), and edit

mode (which allows the properties of the schedule to be

changed). In view mode the edit icons appears at the bottom

right of the workspace. In edit mode the edit icons are

replaced with the save and cancel icons.

Note: The Schedules page can be navigated away from while

the workspace is in edit mode. No changes will be saved/applied

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 41

until the Administrator navigates back to the schedules page

and clicks the save icon. All changes made prior to the

navigation will remain available for saving until the browser

session is closed. If the browser session is closed before saving,

all edits will be lost.

Name

Each schedule must have a unique name that identifies the

particular schedule.

Description

An extra text field for organization and administration

purposes, similar to a code comment.

Calendar/Agenda

Beneath the description text box is a color-coded calendar

display with three view formats: Day, Week, and Month. The

default view is month, which is highlighted on the left side of

the black view selector bar across the top of the calendar. The

view can be toggled by clicking the desired view name. On the

right side of the view selector bar is the currently selected date

and time and navigation arrows for advancing the view up or

down the date and time selection. In this view, the user can

navigate to a particular point in time and examine the schedule

definition.

Appointments

Each schedule can be comprised of any number of

appointments to meet the user’s exact needs. Each

appointment can have its own subject, description, start and

end times, recurrence pattern, category and priority.

Once in edit mode you can add a new appointment by

highlighting the date and clicking the "Add New Appointment"

icon, followed by "Double-click to Edit". If the appointment is

part of a series, the appointment editor asks if you wish to

42 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

modify this single instance or carry the modification

throughout the series.

Subject

Each appointment may have a subject/title that identifies the

particular appointment. This subject need not be unique.

Start/End time

Input fields to select the beginning and end of a block of time

the appointment occupies. The time and date can be entered

manually following the provided format by clicking the

calendar icon in the right corner of the entry field to bring up

a time and date selection dialog box. The dialog only provides

start and end times that begin on the hour or half-hour. If you

need a finer resolution you will have to enter it manually.

All day event

Check this box to select the entire 24 hour period of the

selected day.

Edit Recurrence

If the selected appointment is to be a repeating series or part

of a pattern click the edit recurrence button to bring up the

recurrence dialogic box. From this window you can edit the

appointment time, establish a recurrence pattern designate the

span of time the pattern is too honored.

Categorize

Color-coded attributes that help the administrator visually

organize schedules.

Priority

Priority is an optional attribute that designates the appointment

as high (red exclamation point) or low (down arrow). Higher

priorities take precedence over lower priority appointments.

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 43

Tactics Tactics represent the logical flow of notification for a particular

event. Tactics define which connection should be notified, in

what order, and under what circumstances.

Tactics Collection Selector List Please refer to Email Collection Selector discussion in Chapter

3 for details on utilizing this tool.

Tactics Workspace Editor Clicking one of the edit buttons below the tactics list or

selecting one of the individual tactics will bring up the Tactics

Workspace editor to the right of the list. This environment

allows the WIN-911 Administrator to create tactics to meet the

exact needs of his/her specifications.

Edit/View Mode

The tactics workspace (like any WIN-911 workspace) can be

toggled between view mode (which allows the WIN-911

Administrator to view the details of the tactic) and Edit mode

(which allows the properties of the tactic to be changed). In

view mode, the edit icons appear at the bottom right of the

workspace. In edit mode, the edit icons are replaced with the

save and cancel icons.

Note: The Tactics page can be navigated away from while the

workspace is in edit mode. No changes will be saved/applied

until the Administrator navigates back to the tactics page and

clicks the save icon. All changes made prior to the navigation

will remain available for saving until the browser session is

closed. If you browser session is closed before saving, all edits

will be lost.

Name

44 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

Each tactic must have a unique name that identifies the

particular tactic.

Description

An extra text field for organization and administration

purposes, similar to a code comment.

Tactic Elements

Figure 3 is the tactic creation workspace of WIN-911. The figure

representing the tactic is composed of elements that include a

green Start Block (21) a red End Block (27), various Instruction

blocks (25) (chosen from the right panel), and connected with

directional links (23). The tactical progression begins at the

start block and proceeds to the instruction blocks where tasks

are executed and decisions are made as to the next move in

the tactic. The tactic is terminated when the progression

reaches the end block and the calling strategy is updated with

the results of the tactic. Navigational tools are provided at the

upper right corner of the tactic workspace for zooming on

tactical details and moving the elements or focus with the

directional buttons.

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 45

Tactical Building Blocks

The user can drag and drop various instructions into the tactic

from the instruction block selection pane on the right. The

instruction block selection pane is divided into three tabbed

subsections (31) titled Notifications, Decisions, and

Miscellaneous (Misc).

Notifications

Figure 3 depicts the instruction block subset is titled

Notifications (on the right hand panel). Notifications include a

notification to a single individual (31) (shown as the rectangle

marked “Single”), a notification to multiple

individuals (33) (shown as the overlapping rectangles marked

“Notify All”), a report of data to be sent to a designated

individual (35) (shown as the rectangle marked “Send Report”),

and the initiation of another Tactic (37) (shown as the rounded

rectangle marked “Sub-Tactic”). Notifications contain

additional parameters, such as how the individual should be

contacted (e.g. by Email) and whether the individual should be

contacted only when he/she is on schedule or regardless of

that persons schedule.

Single...

The “Single…” block requests a single notification to be

performed. This block can be configured to wait until the

notification is completed before moving to the next block

(Synchronous Mode) or move to the next block immediately

after requesting a notification (Asynchronous Mode).

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

select the connection to be notified, select the option to honor

the connection's schedule or override it (by checking the

"Ignore Schedules"), and to perform the notification

asynchronously or synchronously (by checking the "Wait for

46 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

Notification to Complete"). A search filter is provided at the

top of the form to limit the displayed connections based on the

selected connection property.

See Connections and Schedules.

Notify All

The “Notify All” block requests all connections, or all

connections of a role (if specified) to be notified in no particular

order. The assumed setting will be to notify all configured

connections. Only when a role is specified is this block limited

to a particular group of connections.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

select the role or roles that the notification block will attempt

to notify, select the option to honor the connection's schedule

or override it (by checking the "Ignore Schedules"). A search

filter is provided at the top of the form to limit the displayed

roles based on the selected role property.

See Roles.

Send Report to

Immediately generates and sends a specified report to a

specified connection.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

select the report that the notification block will attempt to

dispatch, select the connection that will receive the report, and

select the option to honor the connection's schedule or

override it (by checking the "Ignore Schedules"). Search filters

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 47

are provided at the top of the report and connection lists to

limit the displayed options based on the selected property.

Send Report to

Immediately generates and sends a specified report to a All

connections.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

select the report that the notification block will attempt to

dispatch; all connections that will receive the report, and the

option to honor the connection's schedules or override them

(by checking the "Ignore Schedules"). Search filters are

provided at the top of the report and connection lists to limit

the displayed options based on the selected property.

See Reporting, Connections and Schedules.

Sub-Tactic

This block will begin the evaluation of a different tactic using

the current alarm data. Execution of current tactic resumes on

completion of the sub-tactic.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

select the tactic to be evaluated. Search filters are provided at

the top of the tactics list to limit the displayed options based

on the selected property.

Note: The sub-tactic cannot be self-referencing. Hence the

selected sub-tactic must be a different tactic than the parent

tactic. When the sub-tactic finishes its evaluation the parent

tactic resumes evaluation where the sub-tactic concluded.

48 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

Decisions

Figure 4 is the tactic creation workspace with the decisions tab

selected in the instruction blocks pane, as shown on the right

hand panel. The defining feature of decisions is that they

branch the workflow into multiple directions based on whether

predefined parameters are true or false. Decisions include an

Ack Decision Block (43) (branches based on whether or not

the current alarm has been acknowledged), an active decision

bock (45) (branches based on whether the current alarm is

active), a schedule decision block (47) (branches based on

whether the time matches certain predefined schedule

parameters), a label decision block (49) (branches based on

whether or not the alarm belongs to the specified machinery

or other device onto which a control is installed), a severity

decision block (51) (branches based on the value of the alarm’s

severity), and a time-span decision block (53) (branches based

on whether or not a specified time span has been

exceeded). When elements on the right-hand panel are

dragged and dropped into the center panel, decisions link

together in the manner that the user wishes the flow of

instructions to follow, except unlike notifications, decisions

branch into multiple paths depending on whether the

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 49

predefined parameters are true or false. If the decision

criterion is determined to be false, then the tactical progression

follows the Link connected to the left corner marked F for false

and color-coded with a red tip. Otherwise the tactical

progression follows the right link connected to the unmarked

corner which represents true. In the depicted example, an

acknowledged decision bock (41) has been introduced into

the tactical progression flow. If the alarm condition has been

acknowledged by the previous John Smith notification block,

then the tactical progression will follow the path to the right,

indicating a true condition and ending the tactic. If the alarm

event has not been acknowledged then the progression will

follow the left link which is attached to the corner marked F and

color-coded orange.

Ack Decision Block

Branches tactic progress based on whether or not the alarm is

acknowledged at the time of evaluation.

Active Decision Block

Branches tactic progress based on whether or not the alarm is

active at the time of evaluation.

Schedule Decision Block

Branches tactic progress based on whether or not the specified

Schedule has an appointment scheduled at the time of the

evaluation.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

select the schedule to be assigned to this block. A search filter

is provided at the top of the schedules list to limit the displayed

options based on the selected property.

See Schedules.

50 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

Label Decision Block

Branches tactic progress based on whether the active alarm is

marked with the specified label.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

select the label to be assigned to this block. A search filter is

provided at the top of the labels list to limit the displayed

options based on the selected property.

See Labels.

Severity Decision Block

Branches tactic progress based on whether or not the current

severity of the alarm exceeds a specified limit.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

specify the severity by either moving the slider bar along the

range from 0 to 1000 or manually enter the number by typing

it in to the text entry box or clicking the up/down arrows.

See Severity.

Timespan Decision Block

Branches tactic progress based on whether or not the specified

timespan has been exceeded.

Double-clicking the center of the block will bring up the edit

selector.

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 51

Click the center icon to edit properties. From this form you can

specify the origin of the time span (Alarm Time, Last State

Change, or Tactic Start Time) and enter timer value using the

hours and minutes input box where you can type it directly in

or click the up/down arrows.

Miscellaneous Blocks

Figure 5 is (like Figures 3 and 4) the tactic creation workspace

with the Misc tab selected in the instruction blocks pane, as

shown on the right hand panel. As implied by the name of the

subsection, the miscellaneous Instruction blocks affect the

tactical progression in unique ways that do not fit into the

previous subsections. Misc instruction blocks include a loop

block (57) which loops a set of instructions and/or tactics a

specified number of times, before proceeding to the next

instruction; a delay block (59) which causes the tactical

progression to delay a specified amount of time before

proceeding to the next instruction; and an Ack block (61) which

performs an acknowledgement on behalf of a designated

individual. In the example depicted a delay instruction

block (55) is introduced into the tactical progression on the

false leg of the decision link. Thus, if the alarm event is

unacknowledged, then the tactic will pause for a period of time,

52 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

e.g., 5 minutes (or other amount of time as set by the user)

before executing a notify all broadcast.

Loop Block

Performs a sequence of instructions multiple times.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

specify the number of loops to be conducted before the

tactical progression moves beyond.

Delay Block

Causes the progress of a tactic to pause for the specified

amount of time.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

specify the amount of time (in minutes and seconds) before

tactical progression resumes.

Ack Block

Attempt to automatically acknowledge the alarm on behalf of

the user.

Double-clicking the center of the block will bring up the edit

selector.

Click the center icon to edit properties. From this form you can

enter a comment that the ack block will write when attempting

the acknowledgement.

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 53

Strategies Strategies are associated with alarms and define the tactics or

set of tactics used for notification during the lifetime of the

alarm.

Strategies Collection Selector List Please refer to Email Collection Selector discussion in Chapter

3 for details on utilizing this tool.

Strategy Workspace Editor Clicking one of the edit buttons below the strategies list or

selecting one of the individual strategies will bring up the

Strategy Workspace editor to the right of the list. This

environment allows the WIN-911 Administrator to create

strategies to meet the exact needs of his/her specifications

Edit/View Mode

The strategy workspace (like any WIN-911 workspace) can be

toggled between view mode (which allows the WIN-911

administrator to view the details of the strategy), and edit mode

(which allows the properties of the strategy to be changed). In

view mode the edit icons appears at the bottom right of the

workspace. In edit mode the edit icons are replaced with the

save and cancel icons.

Note: The strategy page can be navigated away from while the

workspace is in edit mode. No changes will be saved/applied

until the Administrator navigates back to the strategies page

and clicks the save icon. All changes made prior to the

navigation will remain available for saving until the browser

session is closed. If your browser session is closed before saving,

all edits will be lost.

54 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

Figure 2 is a screen shot of the strategy creation portion of

WIN-911. Based on the state of the alarm, the user configures

the strategy to initiate the appropriate tactic. Additional tactics

can be called by the strategy, depending, for example, on

whether the alarm has been acknowledged, the alarm has

become inactive, the alarm has recurred, and/or other

conditions. Moreover, multiple tactics can be controlled by the

same triggering event. What is also unique about strategies is

whenever a new alarm condition arises, the administrator can

configure the strategy to either 1) complete any or all tactics

already in progress, or 2) halt any or all tactics.

Name

Each strategy must have a unique name that identifies the

particular strategy.

Description

An extra text field for organization and administration

purposes, similar to a code comment.

Policies

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 55

Strategies are composed of any number of lines of "If-Then"

code called policies (13). The policy will contain a Condition

(15) selection that stipulates the type of alarm event, and the

Action (17) that is to be taken as a result. The Action, in most

cases will point to a specific tactic (19) that will conduct remote

notification procedures.

List of Conditions and their definitions

New

The first occurrence of an alarm event encountered by WIN-

911. Note that this can include inactive or even acknowledged

alarms if WIN-911 is started during an alarm lifetime.

Acknowledged

An alarm event that has been acknowledged and indicates that

the acknowledgement status has changed.

Any State Change

An already existing alarm event (not new) that has experienced

a change in activity, acknowledgment, and/or condition.

Active

An alarm event whose value is in an alarm condition and

indicates that activity has changed.

Inactive

An alarm event whose value has returned to its normal

condition and indicates that activity has changed.

Condition Changed

The alarm event condition has changed, resetting the alarm to

unacknowledged.

Note: Not supported with OPC-DA.

Quality Changed

56 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

An alarm event indicates that quality has changed, typically

from good quality to some lower quality.

Elapsed Time

The specified time has passed since the strategy has started.

Recurrence

A multiple of the specified time has passed since either the

strategy was started.

Terminal/Normal State

The termination of an alarm event based on its value returning

to normal and having been acknowledged.

List of Actions and their definitions

Stop Tactic

Instruction to stop a specified tactic. Only the currently

executing block of the tactic is allowed to finish executing.

Stop All Tactics

Instruction to stop all tactics invoked by the particular strategy,

allowing elapsed time and recurrence policies to continue.

Notify Previous

Instruction to notify all connections previously notified by all

tactics of this strategy.

Start Tactic

Instruction to invoke a specified Tactic based on an Alarm Event

Condition.

Restart Tactic

Instruction based upon an alarm event to restart a specified

tactic that is currently "in-progress", allowing the currently

WIN-911 Enterprise Edition Quick Start 04/14 4. Notification • 57

executing block to finish executing. Note that if the tactic is not

in progress, a new instance of the tactic will be started.

Stop Strategy

Instruction to stop the current strategy, including all tactics and

all time and recurrence policies, allowing only Notify Previous

actions to complete.

58 • 4. Notification WIN-911 Enterprise Edition Quick Start 04/14

WIN-911 Enterprise Edition Quick Start 04/14 5. Alarming • 59

5. Alarming

Alarming Overview Create, manage, and organize the alarms monitored by the

WIN-911 system.

Note: The Quick Start manual only details the configuration of

OPC DA alarms. WIN-911 is capable of connecting to multiple

HMI/SCADA systems that are documented in the online help

file.

OPC DA Sources Specify how to connect to your OPC DA sources.

OPC DA Sources Collection Selector List Please refer to Email Collection Selector discussion in Chapter

3 for details on utilizing this tool.

60 • 5. Alarming WIN-911 Enterprise Edition Quick Start 04/14

OPC DA Workspace Editor Clicking one of the edit buttons below the OPC DA sources list

or selecting one of the individual OPC DA sources will bring up

the OPC DA Workspace editor to the right of the list. This

environment allows the WIN-911 Administrator to create all the

OPC DA sources needed to meet his/her specifications.

Edit/View Mode

The OPC DA workspace (like any WIN-911 workspace) can be

toggled between view mode (which allows the WIN-911

Administrator to view the details of the data source), and edit

mode (which allows the properties of the data source to be

changed. In view mode the edit icons appears at the bottom

right of the workspace. In edit mode the edit icons are

replaced with the save and cancel icons.

Note: The OPC DA sources page can be navigated away from

while the workspace is in edit mode. No changes will be

saved/applied until the Administrator navigates back to the

OPC DA source page and clicks the save icon. All changes

made prior to the navigation will remain available for saving

until the browser session is closed.

Name

Each data source must have a unique name that distinguishes

it from the others.

Description

An extra text field for organization and administration

purposes, similar to a code comment.

Machine Name

Select the computer that identifies the system hosting the data

source. You can enter the name manually by typing it into the

text box or you can use the browse button to the right and

check the computer on your network that hosts the data

source. You may also type "localhost" if the OPC DA server in

WIN-911 Enterprise Edition Quick Start 04/14 5. Alarming • 61

on the same machine at the WIN-911 Enterprise Edition OPC

DA source.

Server Class

Select the OPC DA server name. You can enter the name

manually by typing it into the text box or you can use the

browse button to the right and check the server you wish to

connect to.

OPC DA Alarms Configure alarm conditions on data provided by an OPC DA

source. Alarms represent specific alarm conditions such as a

tank level exceeding a high limit or a valve being opened that

would normally be closed and require an alarm responder to

be notified. Alarms trigger a notification strategy.

Collection Selector List Please refer to Email Collection Selector discussion in Chapter

3 for details on utilizing this tool.

Item/Alarm Workspace Editor Clicking one of the edit buttons below the items/alarms list or

selecting one on the individual items will bring up the

Item/Alarm Workspace editor to the right of the list. This

environment allows the WIN-911 Administrator to create the

items/alarms for which WIN-911 is to conduct remote

notification.

WIN-911 subscribes to the OPC-DA server as a client and is

provided raw data values and WIN-911 flags alarms based on

set-point configured by the administrator. Thus the workspace

is divided into two tabbed sections, Item and Alarm. The item

62 • 5. Alarming WIN-911 Enterprise Edition Quick Start 04/14

page configures the parameters WIN-911 uses to communicate

with the server and the alarm page contains the set-points

WIN-911 uses to determine alarm conditions.

Edit/View Mode

The OPC-DA workspace (like any WIN-911 workspace) can be

toggled between view mode (which allows the WIN-911

Administrator to view the details of the item/alarm), and edit

mode (which allows the properties of the item/alarm to be

changed). In view mode the edit icons appear at the bottom

right of the workspace. In edit mode the edit icons are

replaced with the save and cancel icons.

Note: The OPC-DA item/alarm pages can be navigated away

from while the workspace is in edit mode. No changes will be

saved/applied until the Administrator navigates back to the

OPC-DA item/alarm pages and clicks the save icon. All changes

made prior to the navigation will remain available for saving

until the browser session is closed.

Item

Name

Each item must have a unique name that distinguishes

it from the others. When WIN-911 delivers alarm

messages, this is the name it will use. The name can

be independent of the Item ID (which must meet the

syntax of the OPC-DA server and is often cryptic).

Description

An extra text field for organization and administration

purposes, similar to a code comment. It is intended

to allow for elaboration on the information concerning

the alarm/item. Such information can contain location

data (like Lift Station 22), or a description of the data

that makes it more verbose.

WIN-911 Enterprise Edition Quick Start 04/14 5. Alarming • 63

Area

The area is an optional attribute that can be assigned

to help identify the item in environments that may

have multiple sections with similar functions, such as a

waste water treatment plant with multiple lift

stations. An area example would be "Lift Station

22". When importing from WIN-911 Version 7, the

grouping name will be imported as the area.

Source

Select the OPC-DA server name. You can enter the

name manually by typing it into the text box or you

can use the pull-down list and click the previously

configured data source.

ItemID

The "ItemID" is the name of the tag as it exists within

the OPC-DA server and is the name with which WIN-

911 uses to communicate with the server. You can

type the name in manually using the text entry box

provided, but it is highly recommended that you use

the browse button to the right and select the ItemID

directly from the server for the sake of convenience

and the prevention of syntax errors.

Update Rate

The administrator can set the update rate at which the

OPC DA data source module refreshes its data. The

default value is 1.000 ms.

Units

The "units" field is an optional attribute which provides

the engineering units (when applicable).

Item Labels

64 • 5. Alarming WIN-911 Enterprise Edition Quick Start 04/14

The "Item Labels" are optional attributes for

organizing alarms in a logical manner. They can

represent function, location, severity, or other such

category that serves the project requirements.

Alarm

Note: Each individual item can be assigned any number of

alarm conditions.

Name

Each alarm must have a unique name that

distinguishes it from the others. When WIN-911

delivers alarm messages, this is the name it will use.

Description

An extra text field for organization and administration

purposes, similar to a code comment. It is intended

to allow for elaboration on the information concerning

the alarm/item. Such information can contain location

data (like Lift Station 22), or a description of the data

that makes it more verbose.

Condition

The value or state of the OPC-DA item that constitutes

and alarm condition.

Item Value

Alarm condition based on the relationship of an item's

value to a setpoint. The relationship can be equal to,

not equal to, greater than, less than, or a combination

thereof.

Quality

An alarm condition based on the OPC-DA item quality

attribute.

WIN-911 Enterprise Edition Quick Start 04/14 5. Alarming • 65

Watchdog

An alarm condition based on an item value changing

within a specified time limit. This alarm type is used to

verify the operational status of a data server.

For example: a server's system clock that increments

every minute could be used as a watchdog alarm with

a 2 minute time limit. If the value fails to update within

the set time limit WIN-911 will activate an alarm

condition to indicate the possible loss of the

associated server.

Strategy

The strategy that WIN-911 invokes when the alarm

event occurs.

Severity

A numeric attribute from 1 to 1000 that designates that

urgency of an alarm event. It can be used as an

organizational tool and be used in a tactic to

determine how an alarm is dispatched and which

alarm has priority over another. The default severity

is 500.

Units

The "units" field is an optional attribute which provides

the engineering units (when applicable).

Alarm Labels

The "Alarm Labels" are optional attributes for

organizing alarms in a logical manner. They can

represent function, location, severity, or other such

category that serves the project requirements.

66 • 5. Alarming WIN-911 Enterprise Edition Quick Start 04/14

Labels Labels represent a label for organizing alarms based on

location, device, functions, severity, or other logical

grouping. Labels can be used in a notification tactic to control

notification.

Labels Collection Selector List Please refer to Email Collection Selector discussion in Chapter

3 for details on utilizing this tool.

Label Workspace Editor Clicking one of the edit buttons below the labels list or selecting

one of the individual labels will bring up the Label Workspace

editor to the right of the list. This environment allows the WIN-

911 Administrator to create labels to meet the exact needs of

his/her specifications.

Edit/View Mode

The label workspace (like any WIN-911 workspace) can be

toggled between view mode (which allows the WIN-911

administrator to view the details), and edit mode (which allows

the properties of the label to be changed). In view mode the

edit icons appear at the bottom right of the workspace. In edit

mode the edit icons are replaced with the save and cancel

icons.

Note: The Labels page can be navigated away from while the

workspace is in edit mode. No changes will be saved/applied

until the Administrator navigates back to the Labels page and

clicks the save icon. All changes made prior to the navigation

will remain available for saving until the browser session is

closed. If the browser session is closed before saving, all edits

will be lost.

WIN-911 Enterprise Edition Quick Start 04/14 5. Alarming • 67

Name

Each label must have a unique name that identifies the

particular label.

Description

An extra text field for organization and administration

purposes, similar to a code comment.

Colors

Each label can have a color pattern to help visually organize

the alarms. The WIN-911 Administrator can select a

background and foreground (text) color for each label. The

color-picker for the foreground and background colors are

invoked by clicking the associated icon next to the color to be

edited. He/She can preview the current selections with the

"what-you-see-is-what-get" presentation of the role provided

below the color editing tools.

68 • 5. Alarming WIN-911 Enterprise Edition Quick Start 04/14

WIN-911 Enterprise Edition Quick Start 04/14 6. Reporting • 69

6. Reporting

Overview

Reports provide operational data that is not necessarily

associated with an alarm condition. Reports can be dispatched

in accordance with a strategy or in response to an "on-

demand" query from a remotely located user.

Reports Collection Selector List Please refer to Email Collection Selector discussion in Chapter

3 for details on utilizing this tool.

Report Workspace Editor Clicking one of the edit buttons below the reports list or

selecting one of the individual reports will bring up the Report

Workspace editor to the right of the list. This environment

allows the WIN-911 Administrator to create the reports which

WIN-911 will dispatch.

70 • 6. Reporting WIN-911 Enterprise Edition Quick Start 04/14

Number Each report must have a unique number that distinguishes it

from the others. When WIN-911 delivers a reports, this number

will be used to identify it. This number may also be used to

request the report (instead of requesting by name).

Name Each report must have a unique name that distinguishes it from

the others. When WIN-911 delivers a report, this name will

identify it. This name may also be used to request the report

(instead of requesting by number).

Description An extra text field for organization and administration

purposes, similar to a code comment. It is intended to allow

for elaboration on the information concerning the report. Such

information can contain location data (like Lift Station 22), or a

description of the contents that makes the presentation more

verbose.

Items View or select the items to be included in this report. Clicking

the add button in edit mode will bring up the item selection

form. A search filter is provided at the top of the item list to

limit the displayed items based on the selected property and

text entered in the search text entry box.

See OPC DA Items.