InTouch HMI Alarms and Events Guide

520 Pages·2007·4.13 MB·English

by  Invensys Systems Inc.

Wonderware
InTouch® HMI Alarms
and Events Guide
10/14/15
All rights reserved. No part of this documentation shall be reproduced, stored in a retrieval system, or
transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without the
prior written permission of Schneider Electric Software, LLC. No copyright or patent liability is assumed
with respect to the use of the information contained herein. Although every precaution has been taken in
the preparation of this documentation, the publisher and the author assume no responsibility for errors or
omissions. Neither is any liability assumed for damages resulting from the use of the information
contained herein.
The information in this documentation is subject to change without notice and does not represent a
commitment on the part of Schneider Electric Software, LLC. The software described in this
documentation is furnished under a license agreement. This software may be used or copied only in
accordance with such license agreement.
© 2015 Schneider Electric Software, LLC. All rights reserved.
Schneider Electric Software, LLC
26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
[phone]
http://software.schneider-electric.com
For comments or suggestions about the product documentation, send an e-mail message to
[email protected].
ArchestrA, Avantis, DYNSIM, EYESIM, Foxboro, Foxboro Evo, I/A Series, InBatch, InduSoft, IntelaTrac,
InTouch, PIPEPHASE, PRO/II, PROVISION, ROMeo, Schneider Electric, SIM4ME, SimCentral, SimSci,
Skelta, SmartGlance, Spiral Software, VISUAL FLARE, WindowMaker, WindowViewer, and
Wonderware are trademarks of Schneider Electric SE, its subsidiaries, and affiliated companies. An
extensive listing of Schneider Electric Software, LLC trademarks can be found at:
http://software.schneider-electric.com/legal/trademarks/. All other brands may be trademarks of their
respective owners.
3
Contents
Welcome ..................................................15
Documentation Conventions ......................................................... 15
Technical Support .......................................................................... 16
Chapter 1 Overview of Alarms and Events....................17
About InTouch Alarms ................................................................... 18
Alarm Priorities ........................................................................... 19
Alarm Sub-States ........................................................................ 20
Alarm Acknowledgement ............................................................ 20
Alarm Groups .............................................................................. 20
About InTouch Events ................................................................... 21
Types of InTouch Alarms ............................................................... 22
Discrete Alarms ........................................................................... 22
Analog Alarms ............................................................................. 23
InTouch Distributed Alarm System .............................................. 25
Alarm Providers and Consumers ............................................... 27
Distributed Alarm Group Lists .................................................. 28
Summary Alarms versus Historical Alarms .............................. 29
Alarm Disablement, Inhibition, and Suppression ..................... 29
Terminal Services Alarm Support .............................................. 30
Distributed Alarm System Data Storage ................................... 31
InTouch HMI Alarms and Events Guide
4 Contents
Chapter 2 Configuring Alarms.....................................33
Defining Alarm Hierarchies .......................................................... 34
Creating an Alarm Group ........................................................... 34
Modifying an Alarm Group ......................................................... 36
Deleting an Alarm Group ........................................................... 36
Configuring Tags with Alarm Conditions ..................................... 37
Configuring Discrete Alarms ...................................................... 37
Configuring Value Alarms .......................................................... 38
Configuring Deviation Alarms ................................................... 40
Configuring Rate of Change Alarms .......................................... 41
Disabling Alarms ......................................................................... 42
Inhibiting Alarms ........................................................................ 43
Setting Event Properties for Individual Tags .............................. 44
Configuring Global Settings for Alarms and Events ................... 45
Configuring the Alarm Buffer Size ............................................ 45
Enabling Events .......................................................................... 46
Making Alarm Enabling Retentive ............................................ 47
Creating an Alarm Group List File ............................................... 48
Chapter 3 Alarm Queries ...........................................51
Example Alarm Queries ................................................................ 53
Getting More InTouch Query Information ................................... 54
Chapter 4 Viewing Current Alarms ..............................55
Configuring an Alarm Viewer Control .......................................... 56
Configuring the Appearance of the Grid .................................... 56
Configuring the Display Font ..................................................... 60
Selecting and Configuring Display Columns ............................. 60
Controlling Which Features Users Can Access at Run Time ... 63
Configuring Which Alarms to Show ........................................... 65
Creating Custom Saved Queries Using Query Favorites ......... 67
Configuring Colors for Various Types of Alarm Records .......... 68
Configuring the Shown Time Format of Alarm Records ........... 69
Configuring the Sort Order of Alarm Records ........................... 71
Using an Alarm Viewer Control at Run Time .............................. 73
Understanding Status Bar Information .................................... 74
Using Query Favorites at Run Time .......................................... 74
Using Alarm Viewer Control ActiveX Properties ......................... 76
Configuring Colors for ActiveX Controls ................................... 83
Using Alarm Viewer Control ActiveX Methods ............................ 84
Acknowledging Alarms ............................................................... 84
InTouch HMI Alarms and Events Guide
Contents5
Suppressing Alarms .................................................................... 89
Retrieving Information About an Alarm ................................... 94
Running Queries ......................................................................... 94
Moving and Freezing the Display .............................................. 97
Sorting Alarm Records ................................................................ 98
Showing Other Information ........................................................ 99
Selecting Specific Alarms ......................................................... 100
Showing the Context Menu ...................................................... 103
Error Handling When Using Methods and Properties .............. 103
Using ActiveX Events to Trigger Scripts .................................... 103
Running a Script When a New Alarm is Detected .................. 104
Chapter 5 Acknowledging Alarms in Real Time............ 105
Understanding Alarm Acknowledgement Models ...................... 106
Condition Acknowledgement Alarm Model ............................. 106
Expanded Summary Alarm Model ........................................... 106
Event-Based Alarm Model ........................................................ 108
Checking the Acknowledgement Model of a Tag
at Run Time .......................................................................... 108
Using Dotfields to Acknowledge Alarms ..................................... 109
Acknowledging Alarms or Alarm Groups ................................ 109
Acknowledging Value Alarms .................................................. 112
Acknowledging Discrete Alarms .............................................. 113
Acknowledging Deviation Alarms ............................................ 114
Acknowledging Rate-of-Change Alarms .................................. 115
Using Script Functions to Acknowledge Alarms ........................ 116
Ack() Function ........................................................................... 116
Using Automatic Acknowledgement When the
Tag Value Returns to Normal .................................................. 117
Using Alarm Clients to Acknowledge Alarms ............................ 118
Using Alarm and Acknowledgement Comments ........................ 119
Chapter 6 Controlling Alarm Properties
of Tags and Groups at Run Time................ 121
Determining if Tags or Alarm Groups are in an
Alarm Condition ........................................................................ 127
$NewAlarm System Tag ........................................................... 127
$System System Tag ................................................................. 128
.Alarm Dotfield .......................................................................... 129
.Normal Dotfield ........................................................................ 130
.AlarmDsc Dotfield .................................................................... 130
.AlarmDev Dotfield ................................................................... 131
InTouch HMI Alarms and Events Guide
6 Contents
.AlarmROC Dotfield .................................................................. 132
.LoStatus Dotfield ..................................................................... 133
.LoLoStatus Dotfield ................................................................. 134
.HiStatus Dotfield ..................................................................... 135
.HiHiStatus Dotfield ................................................................. 136
.MinorDevStatus Dotfield ......................................................... 137
.MajorDevStatus Dotfield ......................................................... 138
.ROCStatus Dotfield ................................................................. 139
Reverting Alarm Status Handling to InTouch 7.1 Behavior ..... 140
Determining if Alarm Limits Are Set for Tags ........................... 141
.LoLoSet Dotfield ....................................................................... 141
.LoSet Dotfield ........................................................................... 142
.HiSet Dotfield ........................................................................... 143
.HiHiSet Dotfield ....................................................................... 143
.MinorDevSet Dotfield .............................................................. 144
.MajorDevSet Dotfield ............................................................... 145
.ROCSet Dotfield ....................................................................... 146
Enabling and Disabling Alarms for a Tag or Alarm Group ....... 147
Enabling/Disabling All Alarms ................................................ 147
Enabling/Disabling LoLo Alarms ............................................. 149
Enabling/Disabling Low Alarms .............................................. 151
Enabling/Disabling High Alarms ............................................. 153
Enabling/Disabling HiHi Alarms ............................................. 155
Enabling/Disabling Discrete Alarms ........................................ 157
Enabling/Disabling Minor Deviation Alarms .......................... 159
Enabling/Disabling Major Deviation Alarms .......................... 161
Enabling/Disabling Rate-Of-Change Alarms .......................... 163
Changing a Tag's Alarm Limits .................................................. 165
.LoLoLimit Dotfield ................................................................... 165
.LoLimit Dotfield ....................................................................... 166
.HiLimit Dotfield ....................................................................... 167
.HiHiLimit Dotfield ................................................................... 167
.MinorDevPct Dotfield .............................................................. 168
.MajorDevPct Dotfield ............................................................... 169
.DevTarget Dotfield ................................................................... 170
.ROCPct Dotfield ....................................................................... 171
Changing a Tag's Alarm Deadbands ........................................... 172
.AlarmValDeadband Dotfield ................................................... 172
.AlarmDevDeadband Dotfield .................................................. 173
Changing the Alarm Comment Associated with a Tag .............. 174
.AlarmComment Dotfield .......................................................... 174
InTouch HMI Alarms and Events Guide
Contents7
Associating User-Defined Information with an
Alarm Instance .......................................................................... 175
.AlarmUserDefNumX Dotfields ................................................ 175
.AlarmUserDefStr Dotfield ....................................................... 176
Determining the Inhibitor Tag of a Tag or Alarm Group .......... 178
.AlarmDscInhibitor Dotfield ..................................................... 178
.AlarmLoLoInhibitor Dotfield ................................................... 179
.AlarmLoInhibitor Dotfield ....................................................... 180
.AlarmHiInhibitor Dotfield ....................................................... 181
.AlarmHiHiInhibitor Dotfield ................................................... 182
.AlarmMinDevInhibitor Dotfield .............................................. 183
.AlarmMajDevInhibitor Dotfield .............................................. 184
.AlarmROCInhibitor Dotfield ................................................... 185
Counting the Number of Active or Unacknowledged Alarms .... 186
.AlarmTotalCount Dotfield ....................................................... 187
.AlarmUnAckCount Dotfield .................................................... 187
.AlarmValueCount Dotfield ...................................................... 188
.AlarmValueUnAckCount Dotfield .......................................... 189
.AlarmDscCount Dotfield .......................................................... 190
.AlarmDscUnAckCount Dotfield .............................................. 191
.AlarmDevCount Dotfield ......................................................... 192
.AlarmDevUnAckCount Dotfield .............................................. 193
.AlarmROCCount Dotfield ........................................................ 193
.AlarmROCUnAckCount Dotfield ............................................ 194
Chapter 7 Viewing Alarm Hierarchies......................... 197
Configuring an Alarm Tree Viewer Control ............................... 198
Configuring the Appearance and Colors .................................. 198
Configuring Fonts ..................................................................... 201
Configuring Automatic Refresh ................................................ 201
Controlling Which Features Users can Access at
Run Time ............................................................................... 203
Configuring Which Providers and Groups to Show ................. 205
Creating Custom Saved Queries Using Query Favorites ....... 206
Configuring the Sort Order for Alarm Groups ........................ 207
Using an Alarm Tree Viewer Control at Run Time ................... 208
Understanding Status Bar Information .................................. 209
Using Query Favorites .............................................................. 209
Using Alarm Tree Viewer Control ActiveX Properties .............. 209
Using Alarm Tree Viewer Control ActiveX Methods ................. 211
Retrieving Information About the Control .............................. 211
Retrieving Information About Specific Entries ....................... 212
InTouch HMI Alarms and Events Guide
8 Contents
Freezing the Tree ...................................................................... 218
Creating a Query String from a Selection ............................... 218
Running Queries ....................................................................... 219
Error Handling when Using Methods and Properties ............... 220
Using Alarm Tree Viewer Control ActiveX Events to Trigger
Scripts ........................................................................................ 220
Chapter 8 Printing Alarms........................................ 221
Configuring Alarm Printing and Logging ................................... 222
Configuring Printer Settings .................................................... 222
Configuring Which Alarms to Print ......................................... 227
Configuring the Format of Print and File Output .................. 229
Configuring Log Files for Alarms ............................................. 233
Saving and Loading Configuration Files ................................. 234
Printing Alarms ........................................................................... 235
Logging Alarms to a File ............................................................. 236
Starting Alarm Printer with a Specific Configuration ............... 237
Controlling the Alarm Printer Using Scripting .......................... 237
Stopping and Starting an Alarm Printer Instance
or Query ................................................................................. 238
Querying Alarm Query Information ........................................ 242
Querying Instance Information ................................................ 248
Querying Printer Information .................................................. 252
Setting Alarm Query Information ............................................ 254
Handling Alarm Printer Errors ................................................ 258
Chapter 9 Recording Alarms into an Alarm Database ... 259
SQL Server Accounts for Alarm DB Logger Manager ............... 260
Using the Alarm DB Logger Manager ........................................ 260
Configuring Alarm Database Logging ........................................ 261
Configuring the Database Connection ..................................... 261
Configuring Which Alarms to Log ............................................ 262
Configuring the Logging Interval ............................................. 263
Configuring Alarm DB Logger as a Service ............................. 265
Starting and Stopping Alarm Database Logging ....................... 266
Alarm Database Views ................................................................ 266
Alarm History View .................................................................. 267
Event History View ................................................................... 269
Alarm Event History View ....................................................... 270
Alarm Database Stored Procedures ............................................ 273
Calling a Stored Procedure ....................................................... 273
InTouch HMI Alarms and Events Guide
Contents9
AlarmCounter Database Stored Procedure ............................. 273
EventCounter Database Stored Procedure .............................. 275
Chapter 10 Viewing Recorded Alarms ........................ 277
Configuring the Alarm DB View Control .................................... 278
Configuring the Database Connection ..................................... 278
Configuring the Appearance of the Grid .................................. 279
Configuring the Display Font ................................................... 280
Selecting Alarm or Event Data ................................................ 281
Selecting and Configuring Display Columns ........................... 281
Controlling Which Features You Can Access at Run Time .... 284
Configuring the Shown Time Format and Time
Zone for Alarm Records ........................................................ 286
Selecting the Time Period of Data from the Alarm
Database ................................................................................ 288
Creating Custom Filters and Using Filter Favorites .............. 290
Configuring Colors for Various Types of Alarm Records ........ 296
Configuring the Sort Order for Alarm Records ....................... 297
Using an Alarm DB View Control at Run Time ......................... 298
Sorting Records ......................................................................... 298
Understanding Status Bar Information .................................. 298
Using Alarm DB View ActiveX Properties ................................. 299
AckAlmBackColor Property ...................................................... 299
AckAlmBackColorRange1 Property ......................................... 299
AckAlmBackColorRange2 Property ......................................... 300
AckAlmBackColorRange3 Property ......................................... 300
AckAlmBackColorRange4 Property ......................................... 301
AckAlmForeColor Property ...................................................... 301
AckAlmForeColorRange1 Property .......................................... 302
AckAlmForeColorRange2 Property .......................................... 302
AckAlmForeColorRange3 Property .......................................... 303
AckAlmForeColorRange4 Property .......................................... 303
AckRtnBackColor Property ...................................................... 304
AckRtnForeColor Property ....................................................... 304
AlmRtnBackColor Property ...................................................... 304
AlmRtnForeColor Property ...................................................... 305
AutoConnect Property ............................................................... 305
ColorPriorityRange1 Property .................................................. 306
ColorPriorityRange2 Property .................................................. 306
ColorPriorityRange3 Property .................................................. 306
ColumnResize Property ............................................................ 307
ConnectStatus Property ............................................................ 307
InTouch HMI Alarms and Events Guide
10 Contents
CustomMessage Property ......................................................... 308
DatabaseName Property ........................................................... 308
DisplayMode Property .............................................................. 308
DisplayedTimeZone Property ................................................... 309
Duration Property ..................................................................... 309
EndTime Property ..................................................................... 310
EventBackColor Property ......................................................... 311
EventForeColor Property .......................................................... 311
FilterFavoritesFile Property .................................................... 311
FilterMenu Property ................................................................. 312
FilterName Property ................................................................. 312
FromPriority Property .............................................................. 312
GroupExactMatch Property ...................................................... 313
GroupName Property ................................................................ 313
MaxRecords Property ................................................................ 314
Password Property .................................................................... 314
PrimarySort Property ............................................................... 315
ProviderExactMatch Property .................................................. 315
ProviderName Property ............................................................ 316
QueryTimeZoneName Property ............................................... 316
RefreshMenu Property .............................................................. 316
ResetMenu Property ................................................................. 317
RowCount Property ................................................................... 317
RowSelection Property .............................................................. 318
SecondarySort Property ............................................................ 318
ServerName Property ............................................................... 318
ShowFetch Property .................................................................. 319
ShowGrid Property ................................................................... 319
ShowHeading Property ............................................................. 320
ShowMessage Property ............................................................. 320
ShowStatusBar Property .......................................................... 320
SilentMode Property ................................................................. 321
SortMenu Property ................................................................... 321
SortOrder Property ................................................................... 322
SpecificTime Property ............................................................... 322
StartTime Property ................................................................... 323
Time Property ............................................................................ 323
ToPriority Property ................................................................... 323
TotalRowCount Property .......................................................... 324
UnAckAlmBackColor Property ................................................ 324
UnAckAlmBackColorRange1 Property .................................... 325
UnAckAlmBackColorRange2 Property .................................... 325
UnAckAlmBackColorRange3 Property .................................... 326
InTouch HMI Alarms and Events Guide