Remote Automation Solutions Guide: Alarm View Reference Guide-OpenEnterprise v2.83 Manuals & Guides

Reference Guide

D301474X412
April 2012

OpenEnterprise Alarm View Reference
Guide (V2.83)

Remote Automation Solutions

Website: www.EmersonProcess.com/Remote

Reference Guide

w

D301474X412
April 2012

Alarm Vie

Contents

1 Alarm View ...............................................................................................................................1

1.1 AlarmView Configuration.....................................................................................................1

1.1.1 Properties Context Menu..............................................................................................2

1.2 The Property Pages............................................................................................................2

1.2.1 The General Page........................................................................................................3

1.2.1.1 Show Millisecs........................................................................................................3

1.2.1.2 Show Column Headings ........................................................................................ 3

1.2.1.3 Allow Runtime Configuration..................................................................................4

1.2.1.4 Auto Resize Columns ............................................................................................ 4

1.2.1.5 Edit Menus Button..................................................................................................4

1.2.1.5.1 Custom menu availability..................................................................................4

1.2.1.5.2 Context menus and Security ............................................................................4

1.2.1.5.3 OEMenus and Alarm View Filtering..................................................................4

1.2.1.6 Use Sub Menu .......................................................................................................4

1.2.1.7 Config File Specification ........................................................................................4

1.2.1.8 Realtime Data ........................................................................................................4

1.2.1.9 Historical Data........................................................................................................5

1.2.2 The Databases Page....................................................................................................5

1.2.2.1 Specifying Database Connections.........................................................................5

1.2.2.2 Add DataService Dialog.........................................................................................6

1.2.2.3 Available DataServices List ...................................................................................6

1.2.2.4 Remove Button ......................................................................................................6

1.2.3 The Attributes Page......................................................................................................6

1.2.3.1 Available Attributes ................................................................................................7

1.2.3.2 Selected Attributes.................................................................................................7

1.2.3.3 The Add Button......................................................................................................7

1.2.3.4 The Remove Button...............................................................................................7

1.2.3.5 The Add All Button.................................................................................................7

1.2.3.6 The Remove All Button..........................................................................................7

1.2.3.7 Color Override Dialog.............................................................................................8

1.2.3.7.1 Color Overrides Overview ................................................................................8

1.2.3.7.2 Priority, Condition and Attribute Selection........................................................ 9

1.2.3.7.3 Settings.............................................................................................................9

1.2.3.7.4 Text and Background Color Changes............................................................10

1.2.3.7.5 Blink Type.......................................................................................................10

1.2.3.7.5.1 Highlight...................................................................................................10

1.2.3.7.5.2 Invert colors..............................................................................................10

1.2.3.7.5.3 System Default.........................................................................................10

1.2.3.7.5.4 Text Only..................................................................................................10

1.2.3.7.6 Apply Color Overrides Button.........................................................................11

1.2.3.7.7 Reset Defaults................................................................................................11

1.2.3.8 Column Aliases Dialog.........................................................................................11

1.2.3.8.1 Column Name.................................................................................................11

1.2.3.8.2 Column Alias...................................................................................................11

1.2.3.8.3 Column and Alias List.....................................................................................11

1.2.4 The Display Page .......................................................................................................11

1.2.4.1 Available Blink Types...........................................................................................12

- i -

Reference Guide

w

D301474X412
April 2012

Alarm Vie

1.2.4.2

1.2.4.3 Highlight ...............................................................................................................12

1.2.4.4 Invert colors..........................................................................................................12

1.2.4.5 Text only...............................................................................................................12

1.2.4.6 Window Background Color ..................................................................................13

1.2.4.7 Enable Blink To Color ..........................................................................................13

1.2.4.8 Blink to Color........................................................................................................13

1.2.4.9 Blink Rates...........................................................................................................13

1.2.5 The Font Page............................................................................................................14

1.2.5.1 Change Button .....................................................................................................14

1.2.5.2 Current Font.........................................................................................................14

1.2.5.3 Spacing ................................................................................................................14

1.2.6 The Sound Page.........................................................................................................14

1.2.6.1 Sound Alarms.......................................................................................................15

1.2.6.2 Alarm States.........................................................................................................15

1.2.6.3 Priority Order Dialog.............................................................................................15

1.2.7 The Historical Page....................................................................................................15

1.2.7.1 Time Delta............................................................................................................16

1.2.7.2 Max Rows ............................................................................................................16

1.2.7.3 Time Delta Slice...................................................................................................16

1.2.7.4 Time Delta Slice Failure Count ............................................................................16

1.2.7.5 Advanced Configuration Dialog ...........................................................................17

1.2.8 The Suppression Page...............................................................................................18

1.2.8.1 Enable Maximum Suppression............................................................................18

1.2.8.2 Days.....................................................................................................................18

1.2.8.3 Hours....................................................................................................................18

1.2.8.4 Minutes.................................................................................................................18

1.2.8.5 Seconds ...............................................................................................................18

1.2.9 The TimeZone Page...................................................................................................18

1.2.9.1 Adjust Time Values..............................................................................................19

1.2.9.2 Time Zone List .....................................................................................................19

1.2.10 The Filter Page........................................................................................................19

1.2.10.1 Filters on Custom Alarm Summary Attributes....................................................20

1.2.10.2 Use Filter Check.................................................................................................20

1.2.10.3 Modify Button......................................................................................................20

1.2.10.4 Current Filters List ..............................................................................................20

1.2.10.5 Signal Page.........................................................................................................20

1.2.10.6 Object Page........................................................................................................22

None.....................................................................................................................12

1.2.4.9.1 Text Off...........................................................................................................13

1.2.4.9.2 Text On...........................................................................................................13

1.2.7.5.1 Available Messages List.................................................................................17

1.2.7.5.2 Add New Message Button..............................................................................17

1.2.7.5.3 Remove Message Button...............................................................................17

1.2.7.5.4 Update Message Button.................................................................................17

1.2.7.5.5 Selected Message Text Box...........................................................................17

1.2.10.5.1 Device Name................................................................................................21

1.2.10.5.2 Base, Extension and Attribute......................................................................21

1.2.10.5.3 Using Wildcards............................................................................................21

1.2.10.6.1 Name............................................................................................................22

1.2.10.6.2 Description....................................................................................................22

- ii -

Reference Guide

w

D301474X412
April 2012

Alarm Vie

1.2.10.7

1.2.10.8 Site Page............................................................................................................23

1.2.10.9 State Page..........................................................................................................24

1.2.10.10 Date Time Page................................................................................................25

1.2.10.11 Type Page.........................................................................................................27

1.2.10.12 Parameters Page..............................................................................................27

1.3 Alarm View Runtime..........................................................................................................28

1.3.1 Alarm View Status Bar................................................................................................29

1.3.1.1 Database Connection Status ...............................................................................29

1.3.1.2 Connected Databases .........................................................................................30

1.3.1.3 Alarm Client Server Connection Logging.............................................................32

1.3.2 Context Menus ...........................................................................................................32

1.3.3 Changing the Sort Order of Alarms............................................................................32

1.3.4 Alarm View Context Menus........................................................................................32

1.3.4.1 Acknowledge Alarm .............................................................................................32

1.3.4.2 Silence Alarm.......................................................................................................33

1.3.4.3 Alarm Suppression...............................................................................................33

1.3.4.4 Suppress Alarm....................................................................................................33

1.3.4.5 Timed Suppression Dialog...................................................................................33

1.3.4.6 Acknowledge All...................................................................................................33

1.3.4.7 Silence All ............................................................................................................33

1.3.4.8 Suppress All.........................................................................................................34

1.3.5 Common Context Menus............................................................................................34

Priority Page.......................................................................................................22

1.2.10.7.1 All Priorities...................................................................................................23

1.2.10.7.2 Selection of Priorities....................................................................................23

1.2.10.7.3 Priority Selection Dialog ...............................................................................23

1.2.10.7.4 Range of Priorities........................................................................................23

1.2.10.8.1 Operators......................................................................................................24

1.2.10.8.2 Clients...........................................................................................................24

1.2.10.8.3 Plant Areas...................................................................................................24

1.2.10.8.4 Access Areas................................................................................................24

1.2.10.8.5 Callout Areas................................................................................................24

1.2.10.9.1 Note on State Filters.....................................................................................25

1.2.10.10.1 Ignore Start Time........................................................................................26

1.2.10.10.2 Ignore End Time.........................................................................................26

1.2.10.10.3 Apply To......................................................................................................26

1.2.10.10.4 Occurrence Time........................................................................................26

1.2.10.10.5 Logged Time...............................................................................................26

1.2.10.10.6 Acknowledged Time...................................................................................26

1.2.10.10.7 Timestamp..................................................................................................27

1.2.10.11.1 Alarm Conditions List..................................................................................27

1.2.10.11.2 Event Type..................................................................................................27

1.2.10.11.3 Conditions as Text......................................................................................27

1.2.10.12.1 Parameter List............................................................................................28

1.2.10.12.2 Parameter Name........................................................................................28

1.2.10.12.3 Parameter Value.........................................................................................28

1.3.1.2.1 Unconnected Databases................................................................................31

1.3.1.2.2 Disconnected Alarms......................................................................................31

1.3.4.5.1 Actual Time.....................................................................................................33

1.3.4.5.2 Relative Time..................................................................................................33

- iii -

Reference Guide

w

D301474X412
April 2012

Alarm Vie

1.3.5.1

1.3.5.2 Resize Columns...................................................................................................34

1.3.5.3 Export Data ..........................................................................................................34

1.3.5.4 Print......................................................................................................................34

1.3.6 Event View Context Menus ........................................................................................34

1.3.6.1 Adjust Time Range Dialog ...................................................................................34

1.3.6.2 Create Event Dialog.............................................................................................35

2 Index .......................................................................................................................................37

Please Wait Message ..........................................................................................34

1.3.6.1.1 Enable Time Range Adjustmet.......................................................................35

1.3.6.1.2 Time Range Adjustment Fields......................................................................35

1.3.6.2.1 Attribute List....................................................................................................35

1.3.6.2.2 Preconfigured Strings.....................................................................................35

1.3.6.2.3 Attribute Value................................................................................................36

1.3.6.2.4 Example Created Event..................................................................................36

- iv -

Reference Guide

w

D301474X412
April 2012

Alarm Vie

1 Alarm View

The OpenEnterprise Alarm View component can be configured to display process alarm or event
information. It is normally configured to run as a child window within the OpenEnterprise Desktop, as
shown in the image below. It may also run outside the Desktop environment in its own custom
container.

The Alarm View provides a rich set of functionality to enable users to configure Alarm and Event
windows specific to their own operational needs. User Configurable features that are available
include: -

• Timestamp resolution to show milliseconds;

• Alarm presentation - filter, style, blink modes and color;

• Annunciation behaviour - e.g. sound alarms, specify a .WAV file, select priorities for sound;

• Database Sources;

• Historical retrieval.

1.1 AlarmView Configuration

OpenEnterprise Views are configured through their Property pages. There are two ways to access the
Property pages.

1. From the 'Configure' Menu Item
Within the Desktop

If the Alarm View is running in a child window within the Desktop then it can be placed into
Configure Mode by selecting the 'File/Mode/Configure' menu option as shown below.

- 1 -

Reference Guide

w

D301474X412
April 2012

Within the View Container

If the Alarm View is running within its own container, then the Configure option is available
directly from the Menu Bar, as shown in the example below.

Alarm Vie

2. Ctrl + M Keyboard Option

The View may be toggled between Runtime and Configure Mode by pressing an d holding down the
'Ctrl' and 'M' keys together on the computer's keyboard. When in the Desktop, the View must be the
active window (i.e. selected).

1.1.1 Properties Context Menu

Once in Configure Mode the Property Pages for the Alarm View can be accessed by right-clicking
within the Alarm View and then selecting the 'Properties...' context menu, as shown below.

1.2 The Property Pages

The Property Pages provide the user with tabbed dialogs that together allow complete configuration of
the Alarm View component. Each Property page contains different sets of configuration options.

- 2 -

Reference Guide

w

D301474X412
April 2012

Alarm Vie

1.2.1 The General Page

This page enables the user to perform different types of configuration on the Alarm View component
which affect not only how it is displayed but also what type of data (realtime or historical) is displayed.
It also provides access to the Menu Editor dialog, so that Custom Menus can be configured for the
Alarm View.

1.2.1.1 Show Millisecs

When checked, date/time fields are displ

1.2.1.2 Show Column Headings

n checked, column headings within the Alarm Client are displayed.

Whe

ayed with a millisecond resolution.

- 3 -

Reference Guide

w

D301474X412
April 2012

1.2.1.3 Allow Runtime Configuration

n checked, the user will be able to access these property pages whilst in Runtime mode with a

Whe
right click within the Alarm Client.

1.2.1.4 Auto Resize Columns

n checked, the Alarm Client's columns are automatically resized to accommodate the largest

Whe
data field.

1.2.1.5 Edit Menus Button

Alarm Vie

This button al
displayed from which new context menu items may be defined.

Further details may be found within the Menu Editor Help.

1.2.1.5.1 Custom menu availability

stom context menus will only be available if the Alarm View is run within the Desktop.

Cu

1.2.1.5.2 Context menus and Security

Standard Alarm Client co
available or denied to users of the Alarm Client through security tokens. Refer to the User Security
Configuration Help for further details.

1.2.1.5.3 OEMenus and Alarm View Filtering

ugh OEMenus filters can be passed to an Alarm View based on any attribute in the Alarm

Thro
Summary table (alarmsummary_table). The filters available on the Filter Page of the Alarm View only
apply to the default attributes of the Alarm Summary table, but parameters passed through OEMenus
can also filter the Alarm View on custom attributes. See the Filtering on Custom Alarm Summary
Attributes topic for instructions on how to do this.

1.2.1.6 Use Sub Menu

If the Use su
See the Menu Editor Help file for further information.

lows the configuration of a customised Context Menu. If selected, the Menu Editor is

ntext menu options, as well as Custom context menu options, may be made

b-menu option is checked, a separate sub-menu is used for Custom context menu items.

1.2.1.7 Config File Specification
rowse] button will display a standard Windows™ File Open dialog to allow the User to

The [B
interactively select a desired pre-configured Alarm Client file.

Configured Alarm Client files are saved with the '.AC' file extension. The edit box displays the name of
the (.AC) file the client will use for its configuration. This allows the user to specify a .AC file to load
into the container.

Note: If a file name is specified in this field, the Property Pages are disabled until either the [OK] or
[Apply] button is selected and the file loads into the Alarm View instance.

1.2.1.8 Realtime Data

This is Ala
display data from the selected Database(s) Alarm Summary table(s). The Alarm View displays current
alarms. It queries the Alarm Summary table in active mode and therefore refreshes itself automatically
as the data changes.

rm Viewer mode. When checked, the Alarm Client will dynamically retrieve and actively

- 4 -

Reference Guide

w

D301474X412
April 2012

1.2.1.9 Historical Data

Alarm Vie

This is Event
from the selected Database Event History table. When in Event View mode, the Alarm View displays
both alarms and events. The Event History table is queried in static mode. To update the display it
must be refreshed manually using the Context menu. The time period for display of alarms and events
may be changed to enable the viewing of alarms and events from any past logged time period - see
the Runtime section for further details on how this is done.

Note: Realtime and Historical Data Type configurations for the Alarm View are totally independent.
So, for example if the Alarm View Data Type is set to Realtime and all the pages are configured, and
then the Data Type is changed to Historical by selecting the Historical button, the databases,
attributes and filters previously defined are not automatically reassigned.

Viewer mode. When checked, the Alarm Client will statically retrieve and display data

1.2.2 The Databases Page

This page enables the user to define a list of available databases from which alarms or events will be
obtained for display in the Alarm View.

1.2.2.1 Specifying Database Connections

The 'Databa
or events. The Alarm Client will attempt to connect to each of the specified databases once the
property sheet is closed.

Select the [Add] button and enter the name of a valid Alarm Database. If the database is running on
the same machine as the Desktop, and with its default name, then the Database can be defined as
'rtrdb1'. Databases distributed over a network, whether in Standalone or Redundant mode are usually
defined by the Server's DNS name(s) followed by a colon, followed by 'rtrdb1' (eg OEServer:rtrdb1). If
the Database is running in Redundant mode a comma is used to separate the declared
Master/Standby Databases (eg Master1:rtrdb1,Master2:rtrdb1). Databases may also be defin ed by IP
addresses (eg 102.10.0.90:rtrdb1,102:10.0.91:rtrdb1). The Server DNS names may be aliased using
the Hosts file found in the 'C:\Winnt\System32\Drivers\etc' directory. This allows Databases to be
named independently of specific IP addresses or DNS names. A sample Hosts entry is shown below:

-

101.100.0.183 oeserv1 oedwat1 #pserv1

101.100.0.184 oeserv2 oedwat2 #pserv1

ses' property page allows the selection of databases that will be used for sourcing alarms

- 5 -

Reference Guide

w

D301474X412
April 2012

The IP addresses of the Servers are defined on the left, then after a space or tab each alias name is
specified. In the example above there are two alias names defined for each Server. The hash
indicates that what follows is a user defined comment.

The 'rtrdb1' part of the database name is an alias for a sevice defined in the Services file. This can be
found in the same directory as the Hosts file. In applications where there is more than one database
defined, these aliases may be given more descriptive names such as 'nw3000', 'dynamiclogic' or
'corporate'. Each alias must have a unique service number, and the numbers must be applie d
consistently across the application.

1.2.2.2 Add DataService Dialog

Alarm Vie

The nam
DataServices.

1.2.2.3 Available DataServices List

This list di
connections be successful, the Alarm View will display alarms from all the Databases configured here.

1.2.2.4 Remove Button

This button

e of the DataService is typed into the field using the correct format for Database

splays the DataServices to which the Alarm Client Server will attempt to connect. Should all

will remove the selected DataService from the DataServices list.

1.2.3 The Attributes Page

This page allows the user to select attributes to be displayed for alarms or events during Runtime,
configure text/background/flashing color overrides for the displayed alarms or to assign aliase s to the
attribute names.

- 6 -

Reference Guide

w

D301474X412
April 2012

Alarm Vie

1.2.3.1 Available Attributes

This list on th
Alarm View component. As available attributes are placed into the Selected Attributes list, they are
removed from this list.

1.2.3.2 Selected Attributes

This is

1.2.3.3 The Add Button

When this is
Selected Attributes list. The selected attribute will be included when the Alarm View is placed into
Runtime mode.

1.2.3.4 The Remove Button

When this but
transferred back into the Available Attributes list. The attribute will then not be displayed within the
Alarm View when it is placed into Runtime mode.

1.2.3.5 The Add All Button

When sel
Attributes list. No prior selection is necessary. All attributes will then be displayed by the Alarm View
in Runtime mode.

e Attributes Page displays the list of attributes that are available for display within the

a list of the attributes that have been chosen for display within the Alarm View.

selected, the attribute highlighted in the Available Attributes list will be transferred to the

ton is selected, the highlighted attribute from the Selected Attributes list will be

ected, all of the attributes within the Available Attributes list will be placed into the Selected

1.2.3.6 The Remove All Button

When this but
transferred to the Available Attributes list. The View will now display no attributes if placed into
Runtime mode.

ton is selected all attributes currently within the Selected Attributes list will be

- 7 -

Reference Guide

w

D301474X412
April 2012

1.2.3.7 Color Override Dialog

Alarm Vie

The Col
Database within the AlarmPriorityBlock table) and to specify different text / background colour and
blink type combinations. To understand more about how these color override s work, see the the Color
Overrides Overview topic.

or Override Dialog enables the user to override the System defaults (which are set in the

1.2.3.7.1 Color Overrides Overview

Below is a di
Priority Configuration Tool in setting alarm colors for a saved Alarm View. Note that the Alarm Priority
Config Tool is not part of the Alarm View's configuration pages, but is part of the OpenEnterprise
Toolbox suite of configuration tools.

agram of the relationship between the Color Override Dialog, Display Page and Alarm

- 8 -

Reference Guide

w

D301474X412
April 2012

Alarm Vie

1.2.3.7.2 Priority, Condition and Attribute Selection

Whe

n color overrides are configured, they will apply to alarms which have the Priority and Condition
selected in these boxes. The color overrides for the selected Priority/Condition combination wi ll only
apply to the column selected in the Attribute list box. [All] is an option for each box.

1.2.3.7.3 Settings

Alarm State Colo
Once a Priority, Condition and Attribute combination has been chosen the Text and Background

colour, along with the Blink type for each Alarm State may be specified in this section.

r Overrides

- 9 -