Real Timetables

OASyS DNA®
RealTime Tables
www.schneider-electric.com
Legal Information
The Schneider Electric brand is the sole property of Schneider Electric Industries SAS. Any
trademarks of Telvent Canada Ltd. or Telvent USA, LCC referred to in this guide are the sole
property of Telvent Canada Ltd. or Telvent USA, LCC. The Schneider Electric brand and
trademarks may not be used for any purpose without the owner's permission, given in writing. This
guide and its content are protected, within the meaning of the applicable copyright and trademark
laws and international conventions. Unless otherwise agreed in writing, you may not reproduce all
or part of this guide on any medium whatsoever without the permission of Telvent Canada Ltd. You
also agree not to establish any hypertext links to this guide or its content. All other rights are
reserved.
© 2015 Telvent Canada Ltd. All rights reserved.
Table of Contents
Table of Contents
1 Introduction.................................................................................................................................7
1.1 Database concepts...........................................................................................................7
1.2 Failure Avoidance..............................................................................................................7
2 ADE Navigation..........................................................................................................................8
2.1 ADE terminology...............................................................................................................8
2.2 Types of displays.............................................................................................................10
2.3 Select dialog boxes.........................................................................................................10
2.4 User Customization.........................................................................................................16
2.5 Table View Tasks.............................................................................................................18
3 ADE database configuration.....................................................................................................19
3.1 ADE configuration process..............................................................................................20
3.2 Row Edit and Row Details comparison...........................................................................20
3.3 Logging onto the ADE application...................................................................................21
3.4 Advanced Database Editor window................................................................................22
3.5 Table Edit configuration...................................................................................................27
3.6 Row Edit and Row Details configuration.........................................................................60
3.7 Daylight Savings Time (DST)..........................................................................................68
4 Troubleshooting........................................................................................................................69
4.1 Using the Registry Editor to Fix String Errors in Tables..................................................69
5 Perspective...............................................................................................................................75
5.1 Perspective process........................................................................................................76
5.2 Perspective procedures..................................................................................................78
6 Pivot and Transfer....................................................................................................................86
6.1 Color scheme..................................................................................................................86
6.2 Pivot and Transfer process.............................................................................................87
6.3 Pivot and Transfer procedures........................................................................................91
7 Alarms and Events...................................................................................................................97
7.1 Events.............................................................................................................................97
7.2 Alarms.............................................................................................................................98
8 Telemetered data....................................................................................................................108
9 The Age Watchdog Application ..............................................................................................109
9.1 Stale Data and Return-To-Normal Processing..............................................................109
9.2 Mode Switches and Age Watchdog...............................................................................110
9.3 Selecting a Monitored Point in Age Watchdog...............................................................111
10 Age Watchdog Table.............................................................................................................112
10.1 Main Tab Age Watchdog Row Details.........................................................................113
10.2 ageWatchdog Timing Configuration Tab......................................................................114
11 Using the Age Watchdog Summary Window........................................................................116
11.1 Message Set for ageWatchdog ...................................................................................117
12 Alarm Suppression table......................................................................................................118
12.1 Alarm Suppression Row Edit.......................................................................................119
3
Table of Contents
12.2 Importing from Excel into the Almsuppression table...................................................120

13 Alarm Disturbance table.......................................................................................................121
13.1 Alarm Disturbance Row Edit.......................................................................................122
14 Alarm Inhibit Priority table....................................................................................................123
14.1 Alarm Inhibit Priority Row Edit.....................................................................................124
15 Analog table.........................................................................................................................126
15.1 Main Tab Analog Row Edit..........................................................................................127
15.2 Input tab Analog Row Edit...........................................................................................130
15.3 Output tab Analog Row Edit........................................................................................133
15.4 Alarming tab Analog Row Edit....................................................................................136
15.5 Inhibits tab Analog Row Edit.......................................................................................138
15.6 RVE tab Analog Row Edit...........................................................................................140
16 Area of Responsibility...........................................................................................................142
16.1 Groups.........................................................................................................................142
16.2 LegacyAOR Mode.......................................................................................................145
16.3 Implications of Changing to LegacyAOR Mode..........................................................145
16.4 ToggleAORMode.........................................................................................................148
16.5 Fixing tableSecurity Configuration in LegacyAOR Mode............................................149
16.6 Illegal Flips..................................................................................................................150
16.7 Troubleshooting Mode Flips to LegacyAOR................................................................151
17 Xoscontrol table....................................................................................................................153
17.1 Xoscontrol Row Edit....................................................................................................154
18 Application table...................................................................................................................156
18.1 Main tab Application Row Edit....................................................................................157
18.2 Values tab Application Row Edit..................................................................................158
19 Area table.............................................................................................................................160
19.1 Main tab Area Row Edit..............................................................................................161
19.2 Groups tab Area Row Edit..........................................................................................162
19.3 Adding groups to an area record.................................................................................163
20 Circuit table..........................................................................................................................164
20.1 Circuit Row Edit...........................................................................................................165
21 Collect table..........................................................................................................................166
21.1 Collect Row Edit..........................................................................................................167
21.2 Data collection by exception.......................................................................................168
21.3 Configuring a new collection entry..............................................................................168
21.4 Configuring an existing collection entry.......................................................................169
21.5 Deleting collection entries...........................................................................................169
22 Connection table..................................................................................................................171
22.1 Main tab Connection Row Edit....................................................................................172
22.2 Scan Edit tab Connection Row Edit............................................................................174
22.3 Physical Connection Edit tab Connection Row Edit....................................................179
22.4 Inhibits tab Connection Row Edit................................................................................182
22.5 Sample connection record configuration.....................................................................183
23 Group table...........................................................................................................................188
23.1 Group Row Edit...........................................................................................................189
24 Job Scheduler table..............................................................................................................191
4
Table of Contents
24.1 Jsh Row Edit...............................................................................................................192

24.2 Job Scheduler and DistribuSyS..................................................................................196
24.3 Pre-configured job scheduler records.........................................................................197
25 Modem bank table................................................................................................................198
25.1 Main Tab Mbank Row Edit..........................................................................................199
25.2 Inhibits Tab Mbank Row Edit.......................................................................................201
26 Message table......................................................................................................................202
26.1 Message Row Edit......................................................................................................203
26.2 State message sets.....................................................................................................207
27 Modem table.........................................................................................................................212
27.1 Main tab Modem Row Edit..........................................................................................213
27.2 Communications tab Modem Row Edit.......................................................................215
27.3 Commands tab Modem Row Edit...............................................................................217
27.4 Inhibits tab Modem Row Edit......................................................................................220
27.5 RealTime field communications..................................................................................221
27.6 Modem installation and configuration..........................................................................222
27.7 Sample modem record configuration..........................................................................227
28 Multistate table.....................................................................................................................230
28.1 Multistate point subtypes.............................................................................................231
28.2 Multistate table allowances.........................................................................................231
28.3 Multistate record configuration....................................................................................231
28.4 Main tab Multistate Row Edit.......................................................................................232
28.5 Input tab Multistate Row Edit......................................................................................234
28.6 Output tab Multistate Row Edit....................................................................................241
28.7 Alarming tab Multistate Row Edit................................................................................246
28.8 Inhibits tab Multistate Row Edit...................................................................................248
28.9 RVE tab Multistate Row Edit.......................................................................................249
29 Omnicomm table..................................................................................................................251
29.1 Omnicomm Row Edit...................................................................................................251
30 Rate table.............................................................................................................................253
30.1 Main tab Rate Row Edit..............................................................................................254
30.2 Input tab Rate Row Edit..............................................................................................257
30.3 Rate Averages and Integration tab Rate Row Edit......................................................260
30.4 Alarming tab Rate Row Edit........................................................................................263
30.5 Inhibits tab Rate Row Edit...........................................................................................265
31 Xos user attributes Table......................................................................................................267
31.1 Xos user attributes Row Edit.......................................................................................268
32 Remote table........................................................................................................................269
32.1 Main tab Remote Row Edit.........................................................................................270
32.2 Scan Parameters tab Remote Row Edit.....................................................................274
32.3 Remote Schedule tab Remote Row Edit.....................................................................280
32.4 Inhibits tab Remote Row Edit......................................................................................284
32.5 Sample remote record configuration...........................................................................285
33 Remconnjoin table................................................................................................................287
33.1 Remconnjoin Row Edit................................................................................................288
33.2 Job scheduler scripts..................................................................................................289
34 RVE Rules Set Table............................................................................................................291
34.1 Parameters of Rule Checking ....................................................................................292
5
Table of Contents
34.2 Rule Violation..............................................................................................................292

35 Signal configuration table.....................................................................................................294
35.1 Sigconfig Row Edit......................................................................................................295
36 Spooler table........................................................................................................................297
36.1 Spooler Row Edit........................................................................................................298
36.2 Spooling events to a file..............................................................................................299
36.3 Spooler replication and failovers.................................................................................299
37 Status table..........................................................................................................................301
37.1 Main tab Status Row Edit............................................................................................302
37.2 Input tab Status Row Edit............................................................................................304
37.3 Output tab Status Row Edit.........................................................................................307
37.4 Alarming tab Status Row Edit.....................................................................................309
37.5 Inhibits tab Status Row Edit.........................................................................................311
37.6 RVE tab Status Row Edit............................................................................................313
38 Table Security table..............................................................................................................315
38.1 Table security records.................................................................................................316
39 Test Mode Set table..............................................................................................................317
39.1 Main tab Test Mode Set Row Edit...............................................................................318
39.2 Test Mode Points tab Test Mode Set Row Edit...........................................................320
39.3 Point Selector..............................................................................................................321
40 Xosalmattr Table...................................................................................................................322
40.1 Xosalmattr Row Edit....................................................................................................323
41 XOS Color Mapper table......................................................................................................325
41.1 XOS Color Mapper Row Edit......................................................................................326
42 FlexTag Tables.....................................................................................................................328
42.1 Enabling Flexible Tagging...........................................................................................328
42.2 FlexTagType table.......................................................................................................329
6
Introduction
1 Introduction
The Advanced Database Editor (ADE) is a generalized Windows .NET application designed to
maintain database management system (DBMS) configuration data.
Within ezXOS it provides a direct user interface to the RealTime database. ADE replaces the
SCADA configuration forms used by ezXOS, but the product is not limited to that function. In
addition, ADE does not need to be run at an ezXOS station.
1.1 Database concepts

The database management system, which is the central structure of the system, is organized
into two major components: one optimized for real-time data and the other for managing long-
term historical data.
The real-time functionality is managed using the RealTime database system. Long-term system
history is managed using the Historical database, also referred to as XIS (eXtended Information
System).
The database management system provides all of the interfaces required to move data between
the components. It is structured to gather data, store acquired data, and provide framework for
data processing, device control, and internal monitoring of system processes.
The RealTime database is specially designed for real-time data processing.
Typically, both configuration data and real-time data from the field instruments are contained in
the same RealTime database table. For example, in the Analog and Rate tables, each record
(i.e., each row) represents the current configuration and state of one device. RealTime
databases remain fixed in size because the real-time data is constantly flowing through them.
The number of records only grows when new devices are configured.
The system continuously scans, or polls, the data sources for new data. (This polling takes from
several hundred microseconds to several seconds.) Every time the system gathers data from
the data sources, it populates the RealTime database fields. This data only remains in the
RealTime database until the next update, at which time it is overwritten with fresh data. Real-
time data from the RealTime database is displayed on the ezXOS user interface and updated
on every scan.
1.2 Failure Avoidance

Certain practices should be avoided in order to keep your system running smoothly.
CAUTION: DO NOT add, modify, or delete records from the groupAreaJoin table. This will
create data inconsistencies between the groupAreaJoin table and the Area table.
7
ADE Navigation
2 ADE Navigation
2.1 ADE terminology
The ADE documentation uses standard terminology to refer to user interface objects. A table of
commonly-used software and RealTime terms and definitions are provided.
Table 1 - Terminology
Term Meaning/Comments
action menu Menu that appears when you click any row in a data summary table, for
example, Analog Summary
applet Program underlying a Windows icon
AutoCAD Third-party software used to create windows for the systemNote the
capitalization.
button Typically, a drawing of a push button with a command or option label on

itClicking the button results in the action described in the label.
call up To cause to be displayed or to open
check box Small square box that is selected (“checked”) or cleared to turn an option on
or offTypically, several check boxes are contained within one “dialog box”.
click To click: to press the left button on the mouseIf the command refers to the
middle or right button, the documentation specifies “middle-click” or “right-
click.
combo box Text box with a listbox attachedYou can either type information, or select it
from the listbox.
command An action that you can initiate by clicking a menu button or typing a
command and parameters on the command lineFor example, you would use
a command to open a valve.
confirmation Dialog box containing 1) an advisory or warning message about an action

box initiated by the user, and 2) a response mechanism (e.g. Y/N), which allows
the user to confirm that the specified action is to proceedExample: “Are you
sure you wish to delete this record? Y/N.”
control panel Window containing buttons and/or options for control of field devices
display To present on the screen; used only as a verb
dialog box Window containing command buttons and options through which you can
carry out commands or tasks
drop-down Arrow associated with a drop-down combo box or listbox, indicating a list that
arrow the user can view by clicking the arrow
engineering Units in which values are expressed that are relevant to the applicable
units device, as opposed to “raw values” which are non-interpreted values directly
from the field instrumentation
Table continued…
8
ADE Navigation
Table 1 - Terminology (continued)

Term Meaning/Comments
field A small area in a window, in which 1) read-only data appears, or 2) you can
type data; An identifying label appears beside or above the field
identifier System code or name for an entity, such as a database record
label Text attached to any option, box, command, etc.
listbox Dialog box containing a list of items that the user can select with a click
menu List of commands that you can select by clicking
message box Dialog box containing an advisory, warning, or error message about an
action the user has initiated or performed
option A choice presented in a dialog boxExample: the Orientation dialog box

contains the options Portrait and Landscape.
point (noun) The system definition (i.e. a table record) of a field device
property sheet Window that shows information (“properties”) about an object in the
interfaceLike the “dialog box” (see above), the window can contain command
buttons and options.
read-only value A value displayed in a window that you cannot alter through that window
record Standard entry in a database table
remote A remote is a remote processing unit that receives data from field devices,
and often interprets the data, and transmits the data to the host computer.
Types of remotes include: RTUs, PLCs, GCs and FCs
row Data summary entry that is usually synonymous with a record
row header Button, usually unnamed, at the left end of a table entry; typically used to
display a dialog box related to the entry
select In the context of a checkbox, to select means to place a checkmark in the

box
slider Indicator on a graphic gauge that displays and sets a value from a
continuous range
table The RealTime database contains tables (for example, the Rate table, Analog
table and Status table). Tables contain “records”, which in turn contain
“fields.” “Row” is sometimes used as a synonym for “record,” particularly
when being contrasted with table columns.
unavailable Typically applies to situations where some members of a list of commands or

options are not available for useThese unavailable items will usually be
“grayed-out,” or may in fact not appear at all.
window Any display presented in the graphical user interface We do not use the
terms “panel” (by itself) or “screen” in this context, although we do use the
expression “control panel.” “Display” is used only as a verb.
9
ADE Navigation
2.2 Types of displays

Screens in the Advanced Database Editor interface are either dialog boxes, windows or action
menus.
• Dialog boxes are screens that allow you to interact with the system by entering data or
making selections.
• Windows are screens that only display information, such as tables, sum-mary windows,
sche-matics of the system, maps or single line diagrams.
• Action menus are screens that appear when you right-click the mouse pointer on an object.
• You may also see other terms used for individual screens, such as tool and panel.
2.3 Select dialog boxes

Select dialog boxes provide a list of valid entries you can chose from to configure an editable
record field.
In ADE, fields that require a record have an ellipsis button (...) beside them. This button calls up
a select dialog box that lists all of the valid entries for that field.
Figure 1 - Ellipsis button
Select dialog boxes are often used for selecting remote, group and message records.
10
ADE Navigation
Figure 2 - Select dialog box example (Analog select dialog box)
Select dialog boxes do not always contain the same fields and filters. The items below are
common to most select dialog boxes.
Table 2 - Items on the select dialog box

Item Description
Push pin icon Click the Push pin if you want the select dialog box to remain
open after making a selection. Click this button again to
disable the behavior.
Refresh Click Refresh to update the list in the select dialog box.
Accept Click Accept to apply the record you have chosen to the field.
Cancel Click Cancel to close the select dialog box. No entry will be
applied to the field.
2.3.1 Using a select dialog box

Use the ellipsis button (...) beside an editable field to access a select dialog box.
Procedure
1. Click the ellipsis button (...) beside the field you want to edit.
11
ADE Navigation
Figure 3 - Fields with ellipsis buttons
Step Result: The select dialog box appears listing all the valid entries for that field.
12
ADE Navigation
Figure 4 - Remote select dialog box
2. Select the desired entry.

3. Click Accept.
2.3.2 Select dialog box filters

Some select dialog boxes allow you to apply various filters to the list of options they display.
For example, the Remote select dialog box, shown in the figure below, allows you to filter the
list of remote names by group, message, communication process, or all three. Different select
dialog boxes contain different filtering capabilities.
13
ADE Navigation
Figure 5 - Remote select dialog box
Applying filters to select dialog boxes

Use the filters in the select dialog boxes to filter the list of available entries.
Procedure
1. Select Enable Filters on the dialog box.

2. Click the arrow next to the Group, Base Message or Comm. Process field.
A select dialog box appears for each filter you choose. These filtering dialog boxes may
contain filtering functions of their own.
The names you select in the filter select dialog boxes should now appear in the Group,
Base Message or Comm. Process field on the Remote select dialog box. The selected
filters are automatically applied to the list of points. Only point names that match all of the
filters appear on the Remote Select dialog box name list.
3. Click Dismiss at any time to close a select dialog box without making a selection. To refresh
the dialog box’s list, click Refresh.
4. Even if filters are not enabled, click Refresh to update the list.
If the select dialog box has been open for a while, click Refresh or Search to obtain an
updated list.
5. Click the name of a remote on the Remote select dialog box’s list.
14
ADE Navigation
The Remote select dialog box closes and the name of the remote you selected appears in
the Remote field on the Summary window’s Filters panel.
6. Click Search on the Summary’s Filters panel.
2.3.3 Editing fields using select dialog boxes

When you click an ellipsis button (...), it opens a select dialog box with a list of valid entries for
that field. You can edit the field by changing it to one of the records listed in the select dialog
box.
Figure 6 - Ellipsis button
Procedure
1. Click the ellipsis button (...) beside the field you want to edit.
2. Click the desired record in the select dialog box.
The example below displays the Remote select dialog box.
Figure 7 - Remote Select dialog box
3. Click Accept.
15
ADE Navigation
2.3.4 Searching lists in the select dialog box

You can scroll through the list of options in a select dialog box or used the Name filter to locate
the desired selection.
Procedure
• If more than one page of options are listed in a select dialog box, you can find the desired
item by scrolling through the list using the scroll bar on the right of the dialog box.
OR
• If you know the approximate name of the option you are looking for, type the first letters of
the name into the Name field. The list automatically updates to display options beginning
with those letters.
The example below displays a list of remote options being filtered using the Name field.
Figure 8 - Name filter example
2.4 User Customization

You can customize the ADE application and perform group actions.
You can customize the following:
16
ADE Navigation
• form size
• column size
2.4.1 Setting user settings

Use the Auto Save Settings function to set user settings.
Procedure
• Select Tools > Auto Save Settings, as shown in the figure below.
The user can enable or disable this setting as required. If Auto Save Settings is disabled,
you can set the user settings by selecting Save Settings Now.
Figure 9 - Auto Save Settings
2.4.2 Child form menu

There are a number of group actions that can be used when multiple forms are opened. These
actions are accessed through the ADE.
All of the group actions can be accessed through All Child Forms in the Windows menu.
Figure 10 - All Child Forms menu
NOTE: A child form is a form that is accessed off a main form. For example, Row Edit and
Table Edit dialog boxes are all child forms accessed from the Tree View.
17
ADE Navigation
Minimizing all open forms

Use the group Minimize feature to close all open child forms.
Procedure
• Select Window > All Chid Forms > Minimize.
Result
All open forms are minimized.
Expanding all minimized forms
Use the group Expand feature to expand all minimized child forms.
Procedure
• Select Window > All Chid Forms > Expand.
Result
All minimized forms are expanded.
Closing all open forms
Use the group Close feature to close all open child forms.
Procedure
• Select Window > All Chid Forms > Close.
Result
All opened forms are closed.
2.5 Table View Tasks

All RealTime Table Edit dialog boxes contain a View menu that allows you to configure
different views of the RealTime database, see changes made to table data, and clear, find or
replace data.
The View menu contains the following options:
• Show Hide
• Show Row Changes
• Show Row Errors
• Show Selected
• Show All Rows
• Clear Find Replace
18
ADE database configuration
3 ADE database configuration

The ADE database is presented in a tree view in the Advanced Database Editor window that
allows you to retrieve, view, modify and configure data.
The Advanced Database Editor window is where you access the RealTime tables stored in
ADE. This window opens as soon as you log into ADE.
ADE displays data in three primary ways:
• the tree view in the Advanced Database Editor window to demonstrate relationships and
allow access to the Table Edit and Row Edit dialog boxes.
• a Table Edit view to display records in a single table
• a Row Edit view to display details of a single record
ADE allows you to configure data through one of the following dialog boxes:
• Table Edit dialog box for batch edits
• Record Edit dialog box for single record edit
• Record Details for single record edit
NOTE: ADE allows you to perform the same task in a variety of ways. You have the choice of
using menus, toolbars or keyboard shortcuts. In this document, tasks are explained
using the application menus.
19
3.1 ADE configuration process

The configuration process is represented in the figure below.
Figure 11 - Schematic diagram of the ADE configuration
3.2 Row Edit and Row Details comparison

The Row Edit and Row Details dialog boxes are used for editing and configuring RealTime
records.
The two dialog boxes are similar, but please note the following important differences:
Table 3 - Row Edit and Row Details comparison

Access Row Edit dialog box Row Details dialog box
and
Buttons
Open From the Advanced Database Editor From the Table Edit dialog box.
window.
Apply Not Applicable 1. Save the data into the Table Edit
dialog box.
2. Close the Row Details dialog box.
3. Return to the Table Edit dialog box.
Table continued…
20
Table 3 - Row Edit and Row Details comparison (continued)

Access Row Edit dialog box Row Details dialog box
and
Buttons
NOTE: The data is not saved into the

database. The user can save
the data into the database,
through Save in the Table Edit
dialog box.
Cancel Not Applicable 1. Close the Row Details dialog box.
2. Return to the Table Edit dialog box.
Save Save the data into the database Not Applicable, the data is not saved into
the database.The data is applied to the
Table Edit dialog box. For more
information, refer to Apply.
New, Same as the Table Edit dialog box. Not Applicable
Delete
3.3 Logging onto the ADE application

To view the Advanced Editor window, you must log into ADE.
Procedure
1. Go to Start Menu > OASyS DNA SCADA Suite > Advanced Database Editor
Step Result: The ADE System Selector dialog box appears.
Figure 12 - ADE System Selector dialog box
2. In the Select a system field, click the drop-down arrow and select a system from the list.
3. Click OK.
Result
The Advanced Database Editor window appears.
21
NOTE: The ADE application opens to the last saved view configuration.
3.4 Advanced Database Editor window

The Advanced Database Editor window is displayed in a tree view that provides an overall
view of the RealTime database tables.
Different views are available that display different sets of database tables. For example, the
Main view contains the Area, Modem Bank, OmniComm, and Remote tables.
Figure 13 - Advanced Database Editor window
In the Advanced Database Editor window, you can:
• browse the database
• locate specific records
• filter records
3.4.1 Table views

The RealTime tables displayed in the Advanced Database Editor window are grouped into nine
different views.
Use the View menu to select the table grouping you want to display. A list of the tables included
in each view is provided in the table below.
22
Figure 14 - View menu
Table 4 - ADE Views

View option Tables/Record
ACE ACE Config
Realtime All the RealTime tables
Protocols Modbus, OPC
Perspective Remote Telemetery, Analog, Rate, Status
NOTE: The perspective view is unique. For more information,
refer to Perspective.
PI PI, PI template
Main Area, Connection, Modem Bank, Omnicomm, Remote
Alarm Alarm Attribute, Alarm Disturbance, Alarm Inhibit Priority, Alarm
Suppression, Test Mode
Security Area, Machine, Table Security,
DistribuSyS Dataset, Slot Ranges
System Application, Color Map, Flexible Tag Type, Flex Tag Exclusivity,
Job Schedule, Message Set, Omnicomm, Sig Config, Spooler
Related Information
Perspective on page 75
Changing the view in the Advanced Database Editor

Use the View menu to select the table grouping you want to display.
Procedure
• Select the desired view from the View menu.
Result
The Advanced Database Editor window updates to display the tables associated with the
selected view.
23
3.4.2 ADE tables and tasks

The Advanced Database Editor window displays a list of tables contained within the chosen
view.
This information is presented in a tree view, and the lists of tables can be expanded to reveal all
the records contained in the tables or filtered by any selected parent node. For example, in the
Main view, you can display all the remote records by clicking on the plus icon (+) beside the
Remote table. If you select a remote record in the list, it reveals an Analog table. If you expand
the Analog table by clicking on the plus icon (+), it only lists analog records that contain the
selected remote.
Your AOR and security permissions may affect which records you can access.
Figure 15 - ADE Expanded Tree View
Expanding the ADE tree view

Use the icons in the Advanced Database Editor window to expand tables and records.
Procedure
1. Click the plus icon (+) next to the table you want to view.
Figure 16 - Plus icon
24
Step Result: The expanded tree view appears displaying all the records contained within
that table.
Figure 17 - Tree View Filters
2. (Optional) Click the plus icon (+) beside a record.
Step Result: The record expands to display the tables associated with that record.
3. (Optional) Continue expanding tables and records as needed.
Filtering tables in ADE
Use the Name field to filter tables listed in the Advanced Database Editor window.
Procedure
1. Click the Name field next to the table you want to expand.
Step Result: The field becomes active and displays the phrase Enter Search Criteria.
2. Type the name of the record you want to search for.
If you only want to search for part of a record name, use the asterisk (*) as a wild card
character.
3. Press ENTER.
Result
The table expands and displays the rows that match the search criteria.
25
Figure 18 - Tree view filters
NOTE: All search criteria are saved. Use the drop-down arrow in the Name field to recall
previous searches.
Accessing a Row Edit dialog box from the ADE window
You can open the Row Edit dialog box for any record using the Advanced Database Editor
window.
Procedure
1. Expand the table containing the record of interest by clicking on the plus icon (+) beside the
table name.
26
Figure 19 - Tree view record selection
2. Double-click the record name.
Result
The record’s Row Edit dialog box appears.
NOTE: The form size settings are saved for each individual user. Every user of ADE has their
own settings. For more information, refer to “User Customization”.
3.5 Table Edit configuration

The Table Edit dialog box is used for batch editing of multiple records.
Multiple records can be seen and edited using the Table Edit dialog boxes. Records can also be
selected and grouped using filters in this form.
When you open a Table Edit dialog box, it may open without any data, as shown in the first
figure below. In order to view the data, you have to retrieve the data from the database. You can
either retrieve all the data or the data that match certain criteria.
CAUTION: Some database tables may have an extremely large number of rows associated
with it. It may not be wise to load all of the data into a table. Data can be filtered to
access smaller amounts of data.
27
Figure 20 - Table Edit dialog box - no automatic data retrieval
NOTE: Since all the rows in RealTime tables represent a record, the words row and record are
interchangeable.
3.5.1 Accessing the Table Edit view from the ADE window
You open the Table Edit dialog box for a RealTime table through that Advanced Database
Editor window.
Procedure
• In the Advanced Database Editor, double-click the table icon beside the table you want to
view.
Figure 21 - Table icon
Result
The Table Edit dialog box appears.
3.5.2 Table Edit menus and toolbar

All Table Edit dialog boxes contain a menu bar and toolbar that allow you to add, delete and edit
data stored in the table.
The list below describes the common icons and menu items located on the Table Edit dialog
box.
28
Table 5 - Menu and toolbar item definitions

Icon Menu Item Click the Icon/Menu to
Load Table > Load load data into the table
Save Table > Save save any changes made to the database
Changes Changes
Insert Row Table > Insert Row insert a new row to the table
Delete Row Table > Delete Row delete selected rows
Update Table > Update update current results with the entered
Displayed Displayed Data Find and Replace data
Data
Duplicate Table > Duplicate duplicate all displayed rows
Displayed Displayed Data
Data (Clone)
Undo Edit > Undo reverse unsaved changes made in the
table
Redo Edit > Redo reapply changes that have been undone
--- Table > Export to export data to Excel

Excel
--- Table > Import import data from Excel
from Excel
Related Information
Find & Replace grid on page 30
Status and information bar on page 32
Populate the Data Grid on page 37
Insert new record on page 40
Insert duplicate records on page 41
Undo/Redo on page 44
Saving the data on page 47
Exporting data from ADE to Excel on page 49
Importing data from Excel on page 49
Deleting a record on page 66
3.5.3 Icons on the Table Edit dialog box

Table Edit dialog boxes use icons to represent information about the data.
These icons are for informational purposes only; they are not attached to a command.
Table 6 - Icon definitions

Icon Description
Primary This icon represents a required field in the table.
Key
Foreign This icon represents a field that is a primary key in another table.
Key
Table continued…
29
Table 6 - Icon definitions (continued)

Icon Description
Filter This icon indicates filtered information.
Regular This icon indicates the data is a regular expression.

Expression
The following icons appear in the Data grid, either in the row header or in a cell. The icons
indicates that the data has been marked or modified, but has not yet been saved to the
database.
Change This icon indicates that the data has been changed (modified).
Delete This icon indicates that this row (in the data grid) is marked to be
deleted from the database.
NOTE: The row is deleted when the user saves the data to the
database.
Add This icon indicates that this row (in the data grid) is marked to be
added to the database.
NOTE: The row is added when the user saves the data to the
database.
Error • An error in the row header indicates that the row (in the data
grid) contains one or more errors.
• An error in a cell indicates that the cell contains an error.
CAUTION: You cannot save the data if the row contains an error.
3.5.4 Find & Replace grid

Each Table Edit dialog box contains a Find & Replace grid where you can replace, filter and
search for records.
The Find & Replace grid contains three rows:
• Filter row
• Find row
• Replace row
30
Figure 22 - Find & Replace area
Filter row
The filter row is used to filter the data in the Table Edit dialog box. When the number of records
in a table gets too large, or only a certain type of record is required, you can specify filter criteria
in the filter row. You can filter the displayed data or filter the data it retrieves from the database.
Figure 23 - Filter icon
NOTE: The use of the wild card character (*) is permissible.
Find row
The find row is used to display row(s) in the Data grid that met the finding criteria specified in
the find row.
Figure 24 - Find icon
Replace row
The Replace row is used to edit data in multiple rows and columns.
Figure 25 - Replace icon
31
3.5.5 Data grid

The Data grid displays data that has been retrieved from the database.
Figure 26 - Table Edit dialog box
If there are any errors in the record, yellow shading will appear along the row.
Figure 27 - Table Edit Row Error
The error icon in the row header indicates that the that there are errors in the row. Hovering
your cursor over the icon initiates a popup window that describes the error.
Smaller error icons appear in the cell to indicate the cell is in error. Hovering your cursor over
the icon initiates a popup window that describes the error.
Related Information
Errors in rows and cells on page 40
3.5.6 Status and information bar

The Status and information bar is located on the bottom right-hand corner of the Table Edit
dialog box.
This displays basic information about the table such as the number of records it contains and
any recent edits made to the table.
32
Figure 28 - Table Edit Status and information bar
3.5.7 Table Edit features

Table Edit dialog boxes allow you to make batch edits to an entire RealTime table as well as
perform useful functions such as populating the data grid and exporting data to Microsoft Excel.
You can edit the data in the Table Edit view, as follows:
• Select a criterion or edit a field
• Populate the Data grid
• Insert new row
• Insert duplicate rows
• Edit existing rows
• Find and replace data
• Delete rows
• Save the data
• Export data to Excel
• Import data from Excel
• Rearrange columns
• Configure multiple table views
• Pivot and transfer
33
3.5.8 Table field types

There are several types of fields (columns) in a Table Edit dialog box. You can select criteria or
edit the field according to the field type.
The field types are:
• Primary key: This field contains an alphanumeric string and is marked by a primary key.
• Foreign key: The field contains an alphanumeric string and is marked by a foreign key.
• Alphanumeric string
• Numeric
• Check box
The table below summarizes the different ways of selecting or editing fields.
NOTE: Matching criteria are used to filter, find and replace data. The data is displayed in the
Data grid.
Table 7 - Field types and selecting/editing the field

Field Type Select Matching Criteria or Edit the Field
Foreign Key Field with • Open the Select dialog box, select a name and click Accept.
Alphanumeric String
• Type alphanumeric string - it is a whole string match.
• Use Regular Expression - it is a partial string match.

Alphanumeric String • Type alphanumeric string - it is a whole string match.
• Use Regular Expression - it is a partial string match.

Numeric Field • Type the number - it is a whole number match.
NOTE: There is no partial number match.

Check Box • Select the check box
• Clear the check box
Selecting criteria through a select dialog box

In some fields, you can call a Select dialog box to help you configure the field.
This procedure is applicable to a foreign key field, where the field is associated with a select
dialog box.
Procedure
1. Click inside the field.
Step Result: A square button appears, as shown in the figure below.
34
Figure 29 - Table Edit dialog box - Find row
2. Click the button.
Step Result: A Select dialog box appears, for example, the Group Select dialog box.
Figure 30 - Group Select dialog box
3. Select the desired item, and click Accept.
Result
The field that you clicked inside in Step 1 is populated with information from your selection in
Step 3.
35
Alphanumeric string: Selecting all string match

Many fields, such as the Name field, require alphanumeric entries.
Procedure
• Type the desired criterion in the Table Edit dialog box, for example, the Name.
Alphanumeric string: Selecting sub-string match

You can select sub-string match for the fields in the Find & Replace grid.
Procedure
1. Right-click inside a desired field.
Step Result: The Is Regular Expression check box appears, as shown in the figure below.
2. Select the check mark.
Step Result: The field is marked with an x.
36
3. Type the desired alphanumeric text.
Result
The alphanumeric text is a sub-string match criterion. For example, text in the image above.
Numeric field: Selecting a number match
Some fields in the Table Edit dialog box require integer entries.
Procedure
• Type the desired number.

There is no partial number match (using Regular Expression).
Check box field: Selecting a criterion
Table Edit dialog boxes contain some fields that are configured with check boxes.
Procedure
• Select (check) or clear the desired check box.
3.5.9 Populate the Data Grid

In a Table Edit dialog box, you can populate the data grid with all the data or retrieve the data
that match certain criteria (filter data).
When you load data into a Table Edit dialog box, you have the option of loading all the records
associated with that table, or filtering the data so it only loads some data.
37
Figure 33 - Table Edit dialog box (with data)
Navigation in Table Edit
To move between the Find & Replace grid and the data grid, you have to click on a cell with
your mouse. However, you can move between the cells in each grid without a mouse click. Hold
Alt + directional keys to navigate between the cells in a Table Edit dialog box. This
functionality works for both new and existing rows.
Populating some data from a table: Filtered load
Use the Filter & Replace grid to filter the data loaded into the Data grid.
Procedure
1. Enter match criteria for filtering in the Find & Replace grid.
Use the asterisk (*) as a wildcard character.
2. Press ENTER.
Result
The Data grid in the Table Edit dialog box is populated with data that matches the criteria you
entered in Step 1.
38
Populating all data from a table: Table load

Use the Load feature to load all the records contained in a RealTime table into the Data grid of
a Table Edit dialog box.
Procedure
1. Click Table > Load.
Step Result: The Load Database Message dialog box appears.
Figure 35 - Load Database Message dialog box
2. Click Yes to load the database information into the Table Edit dialog box.
Result
The Table Edit dialog box is populated with all the records contained in that RealTime table, as
shown in the figure below.
39
3.5.10 Errors in rows and cells

The error icon appears in rows and cells in the Table Edit dialog box to indicate that there is a
problem with the data.
Figure 37 - Error icon
An error icon in the row header indicates there is one or more errors in the row. Hover your
cursor over the error icon to display a popup window that describes the error.
An error icon in an individual cell indicates there is an error in the cell. Hover your cursor over
the error icon to display a popup window that describes the error.
Figure 38 - Table Edit row error
3.5.11 Insert new record

You can add additional records to RealTime tables by adding new rows to its Table Edit dialog
box.
Procedure
1. Click Table > Insert Row.
40
Step Result: A new yellow shaded row appears in the Data grid, as displayed in the figure
below. The add icon (+) and error icon appear in the row header to indicate that this is a
newly added row and that it requires configuration.
Figure 39 - Insert Row example
2. Configure the required fields on the new row and save your changes.
Related Information
Edit Existing Rows on page 41
3.5.12 Insert duplicate records

You can create new records by duplicating existing rows in the Table Edit dialog box and editing
them as needed.
Procedure
1. Click Table > Duplicate Displayed Data.
Step Result: All the displayed rows are duplicated.

2. Edit the duplicated data as required.
Related Information
Edit Existing Rows on page 41
3.5.13 Edit Existing Rows

Records can be edited directly from any Table Edit dialog box in the data grid which appears
directly below the Find & Replace grid in the Table Edit dialog box.
Procedure
1. Select the field you want to edit by placing your cursor in the field's cell within the data grid.
41
For more information about editing according to the field types, refer to “Table Field Types”.
2. Enter your desired text.
Result
The change icon appears in each changed cell and the related row header.
Figure 40 - Change icon
At this point, these changes have not been saved to the database; they are only visible to the
user. Select Table > Save Changes to do so.
Navigation in Table Edit
To move between the Find & Replace grid and the data grid, you have to click on a cell with
your mouse. However, you can move between the cells in each grid without a mouse click. Hold
Alt + directional keys to navigate between the cells in the Table Edit dialog box. This
functionality works for both new and existing rows.
Related Information
Table field types on page 34
3.5.14 Reject all changes

Unsaved edits performed in the Table Edit dialog box can be rejected.
Procedure
1. Click Edit > Reject Changes > All.
Step Result: The Reject Changes dialog box appears.
Figure 41 - Reject Changes dialog box
2. Click Yes to reject all of the changes made in the Table Edit dialog box.
Result
The change icons are removed from the fields containing rejected changes, and the edited
fields return to the values they were saved as prior to editing.
42
3.5.15 Reject all changes in a row

Unsaved edits performed to a single record (row) in the Table Edit dialog box can be rejected.
Procedure
1. Select the desired row by clicking on its row header.

2. Click Edit > Reject Changes > Row.
Step Result: The Reject Changes dialog box appears.
Figure 42 - Reject Changes dialog box
3. Click Yes to reject all of the changes made in the selected row.
Result
The change icons are removed from the fields containing rejected changes, and the edited
fields return to the values they were saved as prior to editing.
3.5.16 Reject a single change

Unsaved edits performed to a single field in the Table Edit dialog box can be rejected.
Procedure
1. Right-click the change icon in the cell containing the change you would like to reject.
2. Select Reject Change.
The is removed and the field with the rejected change returns to the value it was saved as
prior to editing.
Result
The change icon is removed from the field containing the rejected change, and the edited field
returns to the value it was saved as prior to editing.
43
3.5.17 Undo/Redo
While in the Table Edit dialog box, Row Edit dialog box and Row Details dialog box, the Undo
and Redo commands are enabled.
Undo
Undo reverses any unsaved changes made to the fields in the reverse order they were
originally performed.
Figure 44 - Undo icon
You can undo up to five changes. The Undo command is activated through one of the following
actions:
Procedure
• Select Edit > Undo (not available in Row Details).
• Click the Undo icon (not available in Row Details).
• Right-click to access the action menu, and select Undo.
• Apply the shortcut key CTRL-Z.

Redo
Redo reapplies any changes that have been undone in the order they were originally
performed.
Figure 45 - Redo icon
You can redo up to five changes. The Redo command is activated through one of the following
actions:
Procedure
• Select Edit > Redo (not available in Row Details).
• Click the Redo icon (not available in Row Details).
• Right-click to access the action menu, and select Redo.
• Apply the shortcut key CTRL-Y.
3.5.18 Find and Replace data

The Find and Replace procedure is used to update a large number of records in a Table Edit
dialog box at the same time.
Whatever criteria matches the information entered in the Find row will be replaced with the
configuration specified in the Replace row. For example, if you enter 400 in the Hi Limit field in
the Find row and 500 in the Hi Limit field in the replace row, any records in the Data grid with a
Hi Limit of 400 will have that value changed to 500.
44
Figure 46 - Find and Replace data
Procedure
1. Enter the criteria you want to replace in the Find row.

2. Enter the replacement values in the corresponding fields in the Replace row.
Each field entered in the Find row must have an equivalent field in the Replace row.
3. Press ENTER.
Result
Any records in the Data grid meeting the criteria established in Step 1 are updated with the
values configured in Step 2.
Related Information
3.5.19 Finding and replacing data

Populate the Data grid to retrieve the records you want to use when finding and replacing data.
Procedure
1. Enter the criteria you want to replace in the Find row.

2. Enter the replacement values in the corresponding fields in the Replace row.
Each field entered in the Find row must have an equivalent field in the Replace row.
3. Select Table > Update Displayed Data.
Result
Any rows in the Data grid that match the Find criteria is replaced with the data entered in the
Replace row. The change icon appears on the affected fields and rows. See the figure below for
an example.
45
Figure 47 - Example: Records containing “test” in the Name are changed to “book”
Related Information
3.5.20 Clearing the Find & Replace grid

An action menu is available that allows you to clear the fields you have configured in the Find &
Replace grid.
Procedure
1. Right-click on one of the row headers in the Find & Replace grid.
Step Result: The Clear menu appears.
Figure 48 - Clear action menu
2. Click Clear.
3. Select the row you want to clear.
Result
Any configurations made to the selected row are removed.
46
3.5.21 Deleting records

You can delete records by deleting rows in a Table Edit dialog box.
Procedure
1. Select the row that represents the record you want to delete.
To select more than one row, use the SHIFT or CTRL keys.
2. Select Table > Delete Row.
Step Result: The Delete icon appears in the row header(s) or the selected row(s).
Figure 49 - Delete icon
NOTE: At this point, the changes have not been saved to the database.
3. Select Table > Save Changes.
Step Result: The Save Changes message dialog box appear.

4. Click Yes to save the changes permanently to the database.
Step Result: The Delete Row dialog box appears to inform you of the number of rows
(records) that will be deleted.
Figure 50 - Delete Row dialog box
5. Click Yes.
Result
The selected row(s) are deleted from the Table Edit dialog box and their corresponding records
are deleted from the database.
Related Information
Status and information bar on page 32
3.5.22 Saving the data

The Data grid displays changes that have been made to records in the table that have not yet
been saved. To keep these changes, you must save them to the database.
Procedure
Step Result: A confirmation dialog box appears.

2. Click Yes to save the changes to the database, or click No to discard any changes made.
The system checks the validity of the rows before saving. If there is an error, the system will
not save the data.
47
3.5.23 Resolving errors when saving to the database fails

Changes are not saved to the database if there is an error in the data you are trying to save.
You must correct the changes
If there are errors in the data, the system responds with a Table Edit error.
Figure 51 - Table Edit error dialog box
The Data grid will display yellow shading on any rows that contain errors. The Error icon in the
row header indicates that there are errors in the row. Hovering your cursor over this icon
initiates a popup window that describes the current error, as shown in the figure below.
Figure 52 - Table Edit in error
Procedure
1. Click OK in Table Edit error dialog box.

2. Hover your cursor over the error icons in the Data grid to get details about the errors and try
to resolve them.
3. Click Table > Save Changes.
Step Result: If the errors have been resolved, a dialog box appears to prompt you to
confirm the changes. If the row is still in error when the save is initiated, a second error
message appears.
4. Click OK.
Result
If errors persist, return to the Data grid and try to resolve the issues or reject the changes.
Related Information
Reject all changes on page 42
3.5.24 Excel capabilities in ADE

In ADE, you can export data to Excel, import data from Excel and create Excel templates.
ADE is compatible with both XLS and XLSX files; however, a maximum of 256 ADE columns
can be exported into one XLS spreadsheet. The Multiple Table View feature can help with this
limitation. The newer XLSX files do not have this restriction.
Throughout the documentation, the file extension .xlsx is used. Please note that .xls is also
applicable.
48
Exporting data from ADE to Excel

You can export the data in an ADE table to an Excel spreadsheet.
Procedure
1. Open and load data for the table you want to export.
2. Select Table > Export to Excel.
Step Result: The Save As dialog box appears.

3. Type a new name, or select the existing name of an Excel spreadsheet.
4. Click Save to save the spreadsheet.
Importing data from Excel
You can import data in an Excel spreadsheet to ADE.
Prior to importing an Excel spreadsheet to ADE, the following must be noted:
• The spreadsheet name must match the ADE table to which you are importing data.
• The column names between the Excel spreadsheet and ADE Table Edit dialog box must
match.
• The order of the columns does not have to match.
Procedure
1. Open the RealTime table to which you want to import information.
Step Result:
49
Figure 53 - The Table Edit Window
2. Click Table > Import from Excel.
Step Result: The Open dialog box appears.
Figure 54 - The Open Dialog Box
50
3. Select the file type from the drop down menu. For example, you can select xls files, xlsx
files, and All Files.
4. Select the Excel file that you want to import and click Open.
Step Result: The information from the spreadsheet appears in the Table Edit dialog box.
NOTE: If you are importing an xlsx file, and you do not have the Access Database Engine
2007 installed on your computer, you will be prompted to do so or you will not be
able to import the file. To download the Access Database Engine 2007, please visit
http://www.microsoft.com/en-us/download/details.aspx?id=23734.
NOTE: You must have the correct permissions to save this information to the database.
Blank cell translation
When importing data from an Excel file, a blank cell may not be translated as you intended.
The following table outlines how different types of blank cells are translated into ADE fields.
Table 8 - Creating blank cells from excel table imports

Excel Cell Content & Type ADE field translates as:
Empty cell under a string column (i.e. description) Keeps the existing value that is in the
database
Type “blank” in a cell under a string column. Empty field
Empty cell under a numeric column (i.e. Keeps the existing value that is in the
analog.tolerance) database.
Creating a new record using an Excel template

The Excel template allows you to create a new record by using template records of a table from
an existing Excel file.
Before you begin

Export ADE data into an Excel spreadsheet. Refer to “Export data to Excel” for more details.
The resulting table may be opened and edited in Excel.
Procedure
1. Click New Record on a Row Edit dialog box.

Step Result: A blank Row Edit dialog box appears.
51
Figure 55 - New Row Edit dialog box
2. Click Select Excel Template.
The Select Excel Template button will only be available for a new record, it can not be
applied to an existing record.
3. In the Open window, navigate to the desired template.
4. Double-click on the desired template.
5. Type the desired name or scroll through the list to find it.
6. Select the desired name, and click Accept in the Excel template Row select dialog box.
52
Figure 56 - Excel Template Row Select dialog box
7. Click the Save Record as a New Record icon.
Result
The field values in the template record are copied to the new record.
NOTE: Information in fields that do not have matching names will not be copied.
NOTE: Primary key or read only fields will not be copied.

Related Information
3.5.25 Sorting data in columns

Data in the Data grid can be sorted in columns alphanumerically.
Procedure
1. Click on the column header to sort the data alphanumerically.

2. (Optional) Click the column header again to sort the data in the opposite direction.
53
3.5.26 Resizing columns

The columns on the Find & Replace grid and the Data grid can be resized to your preference.
Procedure
1. Place the cursor between two column headers so that the cursor changes to a four-headed
arrow.
2. Click and drag the column divider until the column has the desired width.
3.5.27 Moving columns

The columns on the Find & Replace grid and the Data grid can be reorganized to your
preference.
Procedure
1. Click on the desired column header.

2. Drag the column to the desired position and release the mouse button.
Red arrows appear when you drag the column to a valid location.
3.5.28 View Menu

The Table Edit View menu allows the user to configure different views of the Table Edit dialog
box, see changes made to the Table Edit dialog box, and clear, find or replace data.
Figure 57 - Table Edit View Menu
The View menu contains the following options:
• Show Hide
• Show Row Changes
• Show Row Errors
• Show Selected
• Show All Rows
• Clear Find Replace
54
3.5.29 Multiple table views

Multiple table views enable you to work with subsets of a RealTime table by defining different
views. You can define up to five different views by using the Table Edit dialog box.
Multiple views are useful when a table contains fields you naturally see together. For example,
you may see tank records categorized into two views: tank general configuration and strapping
table views.
NOTE: This feature helps solve the Excel 2003 limitation, whereby a worksheet can only hold a
maximum of 256 columns. Some tables in RealTime have more than 256 columns, for
example, the Tank table, which cannot be exported to a .xls file in its entirety due to
these restrictions. Having multiple views of the Tank table enables you to export the
table into several .xls files in a manageable way. Newer versions of Excel that use
the .xlsx file extension do not have these limitations.
Displaying and hiding table columns in a Table Edit dialog box
The Show Hide Columns dialog box allows you to hide or display any of the columns in a
Table Edit dialog box.
Procedure
1. Click View > Show Hide....
Step Result: The Show Hide Columns dialog box appears. The dialog box lists all table
column labels as check boxes for the table.
55
Figure 58 - Show Hide Columns dialog box
2. In the Show Hide Columns dialog box, do one of the following:
• Select a pre-configured view from the View drop-down menu.
• Select/clear the check boxes to indicate which columns you want to be visible.
3. Click OK.
Result
The Table Edit dialog box updates to display the columns configured to appear.
Related Information
Multiple table views on page 55
56
Configuring a view
You can configure different View settings for each RealTime Table Edit dialog box.
Procedure
1. Select View > Show Hide...
Step Result: The Show Hide Columns dialog box appears.
2. Select/clear the check boxes to indicate which columns you want visible in the new view.
3. Click Save.
Step Result: The View Configuration dialog box appears.
57
Figure 60 - Views Configuration dialog box - Save
4. Choose a new slot by selecting a check box.

5. Type the name of the new view in the View name field.
6. Click Save.
Result
The newly configured view appears in the View drop-down list.
Deleting a view
You can delete any of the pre-configured View settings.
Procedure
1. Select View > Show Hide....
Step Result: The Show Hide Columns dialog box appears.
58
2. Click Delete.
Step Result: The Views Configuration dialog box appears.
59
Figure 62 - Views Configuration dialog box
3. Select the view you want to delete.

4. Click Delete.
Result
The view disappears and is no longer available in the View drop-down list.
3.6 Row Edit and Row Details configuration

You can edit individual records and add new records to ADE using the Row Edit and Row
Details dialog boxes.
These dialog boxes contain the same information, but differ in how they are accessed and how
the changes are made and saved in the database.
Related Information
Row Edit and Row Details comparison on page 20
60
3.6.1 Row Edit dialog box

The Row Edit dialog box lets you configure individual records stored in the ADE.
Figure 63 - Row Edit dialog box example
The Row Edit dialog box is accessed directly from the Advanced Database Editor window.
The dialog box offers New and Save record options which commit changes directly to the
database.
Row Edit menu items and toolbar
All Row Edit dialog boxes contain a menu bar and toolbar that allow you to edit, add, save and
delete records.
Table 9 - Row Edit menu and toolbar items

Icon Menu Item Click the Icon/Menu to For More information,
refer to
New Record > open a blank Row Edit “Configuring a new record”
Record New dialog box.
OpenEx Record > open the existing record. “Accessing a Row Edit
isting Open dialog box”
Record
Table continued…
61
Table 9 - Row Edit menu and toolbar items (continued)

Icon Menu Item Click the Icon/Menu to For More information,
refer to
Save Record > save any changes made to
Current Save the database.
Record
Save As Record > save a new record into the “Saving the current record
New Save as New database. as a new record”
DeleteC Record > delete the current record.
urrent Delete
Record
Undo Edit > Undo reverse unsaved changes “Undo/Redo”
made to the dialog box.
Redo Edit > Redo reapply changes that have “Undo/Redo”
been undone.
History --- show the Row Edit dialog
box history.
Tools > Pivot and Transfer pivot and transfer records. “Pivot and transfer”
Related Information
Undo/Redo on page 44
Accessing a Row Edit dialog box on page 62
Configuring a new record on page 65
Saving the current record as a new record on page 65
Accessing a Row Edit dialog box

You can access the Row Edit dialog box for any record in ADE through the Advanced
Database Editor window.
Procedure
1. Expand the ADE tree view to locate the desired record.
62
Figure 64 - ADE expanded tree view
2. Double-click the desired record.
Result
The Row Edit dialog box for the selected record appears.
Related Information
Expanding the ADE tree view on page 24
Editing an existing record

You can make edits to a record through its Row Edit dialog box.
Procedure
1. Open the Row Edit dialog box of the record you want to edit.
2. Make the necessary changes to the appropriate fields.
Step Result: Change icons appear beside all edited fields until the changes are saved or
rejected.
63
Figure 65 - Edited Row Edit dialog box example
3. Click Record > Save.

4. Click Yes to save the changes to the database.
Related Information
Reject a single change on page 64
Reject multiple changes on page 65
Reject a single change

Unsaved edits performed in the Row Edit dialog box and Row Details dialog box can be
rejected.
Procedure
1. Right-click the Change icon beside the change you want to reject.
2. Select Reject Change.
Result
The Change icon is removed and the field with the rejected change returns to the value it was
saved as prior to editing.
64
Reject multiple changes

All unsaved edits performed in the Row Edit dialog box and Row Details dialog box can be
rejected.
Procedure
• Click Edit > Reject Changes.
Result
All unsaved changes in the dialog box are rejected and return to the values they were saved as
prior to editing.
Configuring a new record
You can configure a new record from the Row Edit dialog box.
Procedure
1. Open a Row Edit dialog box.

2. Click Record > New.
Step Result: A blank Row Edit dialog box appears.
3. Fill in the necessary fields in the Row Edit dialog box.
4. Select Record > Save as New.

5. Click Yes to add the new record to the database.
Saving the current record as a new record
You can use the Save as New feature to save an existing record as a new record.
If you are configuring a new record that is similar to an existing record, this can save you time
since you will not have to configure all the fields.
Procedure
1. Open a Row Edit dialog box that contains data you would like to use in a new record.
2. Rename the record by editing the Name field.
Step Result: The Save as New option is activated once the Name field is changed.
3. (Optional) Edit additional fields as required.
4. Click Record > Save as New.

5. Click Yes to add the record to the database.
Result
A new record is created. If you did not edit any of the information in the record, the new record
will be identical to the record it was created from with the exception of the record’s Name.
65
Deleting a record
You can delete any RealTime record through its Row Edit dialog box.
Procedure
1. Open the Row Edit dialog box you want to delete.

2. Select Record > Delete.

3. Click Yes to delete the record from the database.
3.6.2 Row Details dialog box

The Row Details dialog box lets the user configure individual records.
Figure 67 - Row Details dialog box
The Row Details dialog box is accessed from the Table Edit dialog box. It offers only Apply and
Cancel buttons and no Save option. Any changes made through the Row Details dialog box are
only temporary and are not written into the database until the Table Edit dialog box containing
the changes is saved.
Related Information
66
Accessing a Row Details dialog box

You can access the Row Details dialog box for a record through a Table Edit dialog box.
Procedure
1. Open the Table Edit dialog box containing the record you want to open.
2. Click Table > Load.
Step Result: The Data grid is populated with all the records in the table. To filter the list,
refer to “Populating some data in a table: Filtered load”.
3. Double-click the row header of the record you want to access.
Figure 68 - Accessing the Row Details dialog box
Result
The Row Details dialog box for the selected record appears.
Related Information
Populating some data from a table: Filtered load on page 38
Editing records in the Row Details dialog box

You can use the Row Details dialog box to edit records.
Procedure
1. Open the Row Details dialog box for the record you want to edit.
2. Make the necessary changes to the appropriate fields in the Row Details dialog box.
3. Click Apply.
Step Result: The Row Details dialog box closes and the changes are temporarily saved in
the Table Edit dialog box.

5. Click Yes to save the changes to the database.
67
3.7 Daylight Savings Time (DST)

™ ™
The infrastructure of OASyS DNA 7.6 and OASyS DNA 7.5 uses UTC (Coordinated Universal
Time), a neutral form which is not affected by Daylight Savings Time (DST). How these times
are converted for your convenience varies by application.
For applications that include a timestamp (log files, NMC, AdminPager) the timestamp is
converted to the time zone that has been set for your computer. This setting can be accessed in
the Microsoft Date and Time Properties panel.
NOTE: Within the Historical documentation, there are references to both GMT and UTC. All
fields refer to data in the same time zone, the two notations are to indicate a difference
in how the data is represented. GMT represents a time in older tables which are stored
in seconds. UTC represents a time in newer tables which is stored as a SQL datetime2
data type.
Custom applications developed for your system may handle the UTC to DST conversion
differently; check with your Service manager if you have questions.
68
Troubleshooting
4 Troubleshooting
This section explains specific scenarios and how to troubleshoot them.
4.1 Using the Registry Editor to Fix String Errors in Tables
Context
A string column in an Excel file with mixed data (numbers and text) may not be imported
correctly (the text data may not be imported). The text data can be excluded from the import
because Excel estimates the data type of the column. Excel bases its estimate on the data of
other records. By default, it looks at 8 records; if none of the records contain text data, Excel
assumes the column only contains numbers and text data is excluded when the information is
imported to ADE.
Solution
To correct the error, you can increase the number of records that Excel uses to estimate the
data type. This value can be edited in the TypeGuessRows dialog box in the Registry Editor.
Follow the work flow below to access the Registry Editor.
In this example, the user used the Export to Excel option and changed some of the
Descriptions from numbers to text.
1. The Table Edit window shows an error after editing the table in Excel, and importing it back
in.
69
Troubleshooting
2. To clear the table, right-click in the grey area beside the table, and select Reject Changes
> All.
3. On the Table Edit dialog box pop-up, click Yes to clear the rows in the Table Edit window.
70
Troubleshooting
4. Open the Command Prompt, type regedit and hit Enter on your keyboard.
5. Click Yes on the User Account Control dialog box.
6. In the Registry Editor window, navigate to the applicable location (depending on the Excel
spreadsheet extension):
• For an .XLS Spreadsheet - HKEY_LOCAL_MACHINE > SOFTWARE >

Wow6432Node > Microsoft > Jet > 4.0 > Engines > Excel > TypeGuessRows
• For an .XLSX Spreadsheet - HKEY_LOCAL_MACHINE > SOFTWARE >

Wow6432Node > Microsoft > Office > 12.0 > Access Connectivity > Engine >
Engines > Excel > TypeGuessRows
71
Troubleshooting
Figure 69 - .XLS Spreadsheet - Registry Editor TypeGuessRows Location
Figure 70 - .XLS Spreadsheet - Registry Editor TypeGuessRows Location
7. Double-click TypeGuessRows to open the Edit DWORD Value dialog box. Edit the Value
Data field to reflect the number of rows you want ADE to scan. The default value is set to
8.
NOTE: As long as you make the row number one more than the amount you need, it will
scan the rest of the rows. For example, in step 1 the text descriptions start in row
8. If you enter 8 in the Value Data field, it will scan the remaining 3 rows with text
descriptions.
72
Troubleshooting
NOTE: You can also enter 0 as the special value setting. This means that ADE will scan all
of the rows. Depending on the size of the table, this option could cause a
significant performance impact.
8. Click OK.
9. In ADE, from the Table Edit window, navigate to Table > Import from Excel.
10. In the Open dialog box, select the spreadsheet you wish to re-import, and click Open.
11. The table with text and number Description fields will import properly into ADE.
73
Troubleshooting
74
Perspective
5 Perspective
A Perspective view is available in ADE to show the relationship between a record and its
associated records.
For example, a Remote Telemetry Perspective for a remote consists of the remote record and
the analog, rate and status child records that are associated with this remote. When the user
opens the Perspective root record, the Perspective child records are automatically opened in a
stack fashion. Grouping the table records into Perspective root and children records has the
following advantages:
• You can edit all the records in a Perspective from a Perspective Root.
• You can export a Perspective to Excel.
• You can import a Perspective from Excel.

• You can create and clone templates using Perspective.
Figure 71 - Perspective icon
OASyS DNA contains one Perspective root, the remote (marked with the Perspective icon) and
three Perspective telemetry child records that are associated with the root, the analog, the rate
and the status records. Any new remote record will appear in the Perspective view, and the
three telemetry records that are associated with this remote record, will appear underneath the
remote record.
Figure 72 - ADE Perspective view
75
Perspective
The ADE Perspective view (see the figure above) shows that the remote records are a
Perspective Root by marking them with a Perspective icon. Expanding the Perspective Root
(remote) reveals all the three records that are associated with the remote.
5.1 Perspective process

The Perspective process includes opening and closing the Perspective Root, importing and
exporting to Excel, and using the Perspective to generate templates.
5.1.1 Open the Perspective Root
Procedure
• Open the Perspective Root.
Result
All the Perspective child dialog boxes are opened as well.
NOTE: Only one Perspective Root dialog box can be opened at one time.
5.1.2 Close the Perspective Root
Procedure
• Close the Perspective Root.
Result
All the Perspective child dialog boxes are closed as well.
NOTE: Any of the Perspective child dialog boxes can be closed individually.
5.1.3 Edit from Perspective

You can edit all of the records in a Perspective.
Procedure
1. Edit the Perspective Root Table Edit by doing the following:
a) Use the Find/Replace of the Perspective Root dialog box.
b) Manually edit the Perspective Root dialog box.

If the Perspective child dialog boxes contain the same fields as the ones modified in the root
record, then the modifications affect the Perspective Root fields and the same-name
Perspective child dialog boxes fields.
2. (Optional) Edit the Perspective child dialog boxes by doing the following:
a) Use the Find/Replace of each Perspective child dialog box.
b) Manually edit the Perspective child dialog box.

The Perspective child dialog box modification affect only that Perspective child dialog box’s
fields.
3. Click Save.
76
Perspective
5.1.4 Export to Excel

A Perspective can be exported to Excel.
Procedure
1. Open the Perspective Root.

2. Export to Excel.
Result
The system creates or modifies an XLSX file.
5.1.5 Import from Excel

A Perspective can be imported from Excel.
Procedure

2. Import from Excel.
3. Select the desired XLSX file.
NOTE: The name of the Perspective Root record has to be the same as the name of the
remote in the XLSX file, otherwise the import will fail. If the Perspective Root import
fails, the Perspective child import is aborted.
5.1.6 Use Perspective as a template

You can use a Perspective Root to make a template.
Procedure
1. Open the Perspective root (e.g., Remote Table Edit).

2. (Optional) Edit the records across the tables and/or the Perspective child dialog boxes.
3. Export to Excel.
4. Save the Excel file.
This is your configuration template, for example, TEMPLATE.xlsx.

5. Close the Perspective root (e.g., Remote Table Edit).
Result
All the Perspective child dialog boxes will close as well (Analog, Rate and Remote Table Edit).
In Excel
Procedure
1. Open TEMPLATE.xlsx.
2. Modify the remote name.
3. (Optional) Edit TEMPLATE.xlsx.
4. Save TEMPLATE.xlsx.
77
Perspective
In the ADE RealTime view
Procedure

2. Import TEMPLATE.xlsx into the Perspective Root Table Edit dialog box.
3. Save the new record in the RealTime database.
Result
A new record is added to the table.
In the Perspective view
Procedure
1. Open the Perspective root of the new record.
Step Result: All the Perspective child dialog boxes open.

2. Import TEMPLATE.xlsx into the Perspective root Table Edit.
3. (Optional) Save the Perspective Root Table Edit.
The Perspective child dialog boxes are filled with telemetry data from TEMPLATE.xlsx.
However, saving the Perspective child dialog boxes may fail because the same record
names may already exist in the RealTime database.
4. Rename the records with duplicate names. Do one of the following:
a) Use the Find/Replace of the Perspective root dialog box.
b) Use the Find/Replace of each Perspective child dialog box.
c) Manually edit the Perspective child dialog box(es).

5. Save the Perspective root and the Perspective child dialog boxes.
5.2 Perspective procedures

Once you have opened the Perspective Root, you can edit records in the Perspective, export
and import the Perspective and create templates from the Perspective.
5.2.1 Opening the Perspective Root and Perspective children

When you open the Perspective Root, all the records associated to the root are also opened.
Procedure
1. Click View > Perspective.
Step Result: The ADE Perspective view appears.

2. Expand the Remote Telemetry table.
The Perspective Root is marked by the Perspective icon. The analog, rate, and status
records associated with the remote record (Perspective Root) are contained within each
Perspective Root.
78
Perspective
Figure 73 - ADE Perspective view
3. Double-click the Perspective icon.
Step Result: The Perspective Table Edit view appears. This includes the Perspective Root
and its children.
79
Perspective
Figure 74 - Perspective Table Edit view
Perspective dialog boxes
Figure 75 - Perspective Root (Remote Table Edit) dialog box
The Perspective Root (remote Table Edit) dialog box displays the following characteristics:
• The menu and toolbar are highlighted in two shades of pink to differentiate it from other
Table Edit dialog boxes.
• The Find & Replace grid has two rows instead of three, and there is no Load row.
80
Perspective
• The Data grid contains only one record row.
• The Insert Row and Duplicate Displayed Data icons are disabled.
Figure 76 - Perspective child (Analog Table Edit) dialog box
The Perspective child (Analog Table Edit) dialog box is similar to the Perspective Root dialog
box with the following exceptions:
• The menu and toolbar are only highlighted in one shade of light pink.
• The Insert Row and Duplicate Displayed Data icons are enabled.
5.2.2 Close the Perspective records

When the user closes the Perspective Root dialog box, all the Perspective child dialog boxes
are closed as well.
If any of the Perspective child dialog boxes are not saved, the system will ask whether you want
to save the records.
You can close Perspective child dialog boxes individually without closing the other Perspective
dialog boxes.
5.2.3 Edit records in a Perspective from the Perspective Root

When the Perspective Root record is modified, it affects the Perspective Root fields and can
affect the Perspective child records.
If a child record contains the same fields as the ones modified in the Perspective Root, the child
fields are also modified.
For example, if the Perspective Root is a remote record, and the Perspective children are the
telemetry records (i.e., analog, status, multistate, and rate records), then modifying the remote’s
Description field will change the Description field of the analog, status, multistate, and rate
records.
If you modify a Perspective child record, the modifications only affect that record.
81
Perspective
5.2.4 Save the Perspective records

Each Perspective child dialog box must be saved individually since they are not saved by
saving the Perspective Root dialog box.
Since closing the Perspective Root dialog box closes all of the child dialog boxes as well, a
save prompt will appear for each Perspective child dialog box that has been modified before it
closes.
NOTE: You can save an individual Perspective dialog box without saving all the dialog boxes in
the Perspective.
5.2.5 Exporting a Perspective to Excel

You can export a Perspective into Excel. When exporting from the Perspective Root, all tables’
records are exported into one Excel file.
Procedure
1. Open the Perspective Root dialog box.

2. Click Perspective > Export Perspective to Excel.
Step Result: The Save As dialog box appears.
3. Type a new name, or select an existing name for the Excel file.
4. Click Save.
Result
The Excel file generated for the perspective will contain different tabs for the Perspective Root
and each Perspective child. The example below shows a Perspective that contains the
Perspective Root (remote tab) and three Perspective children: analog, rate and status tabs.
Figure 77 - Excel file of the Perspective Root (remote tab)
NOTE: There can only be one record in the Perspective Root’s worksheet (i.e., the remote
tab). If there is more than one, the export is cancelled.
82
Perspective
Figure 78 - Excel file of a Perspective child (analog tab)
Related Information
5.2.6 Importing Perspective Root data from Excel

When importing the Perspective Root from Excel, the Excel file with the table names in the
Perspective are imported into the appropriate Perspective Root and Perspective child dialog
boxes.
Procedure
1. Open the Perspective Root dialog box.

2. Select Perspective > Import Perspective From Excel.
Step Result: The Table Edit dialog box appears.

3. Click Yes to continue the import.
Step Result: The Open dialog boxx appears.

4. Select the Excel file that you want to import and click Open.
Step Result: The information from the Excel file appears in the Perspective Root and child
dialog boxes. The Perspective child dialog boxes are marked with triangle or plus icons to
indicate that the records have been changed or added.
83
Perspective
Figure 79 - Import Perspective from Excel window example

You must have the correct permissions to save this information to the database.
Related Information
Importing data from Excel on page 49
5.2.7 Creating a Perspective template
Procedure
1. Open the Perspective Root and Perspective child dialog boxes.

2. From the Perspective Root, export the Perspective to an Excel file.
3. Save the XLSX file.
Related Information
Exporting a Perspective to Excel on page 82
Importing Perspective Root data from Excel on page 83
5.2.8 Modifying the Excel file
Procedure
1. Open the XLSX file.

2. Modify the remote name.
84
Perspective
3. (Optional) Modify the desired fields of the Perspective Root record.

4. (Optional) Modify the desired fields of the Perspective child record(s).
5. Save the XLSX file.
Result
The XLSX file is the configuration template.
5.2.9 Creating a Perspective based on a template
Procedure
1. Open the Remote Table Edit dialog box.

2. Import the template XLSX file to the Remote Table Edit.
Step Result: The new remote record is added to the Remote Table Edit dialog box.
3. Save the Remote Table Edit dialog box with the new remote record.
4. Open the Perspective Root of the new remote.
5. Import the template Excel file into the Perspective Root.
Saving the Perspective child dialog box may fail because the same record names already
exist in the RealTime database.
6. Edit the Perspective child dialog box(es) to make their keys unique. Do one of the following:
• Use the Find/Replace of the Perspective Root dialog box.
• Use the Find/Replace of each Perspective child dialog box.
• Manually edit the Perspective child dialog boxes.

7. Save the Perspective root and the Perspective child dialog boxes.
85
Pivot and Transfer
6 Pivot and Transfer

The Pivot and Transfer feature allows you to replicate and transfer records from one system
(source) to another system (target).
For example, you can create, test and approve a remote record in a test system before you
replicate/transfer it to the production system.
A Pivot occurs when you connect to a target system. A Transfer occurs when you save the
newly transferred records to the target system.
Pivot and Transfer can be used from the following dialog boxes: Table Edit, Row Edit,
Perspective Root.
6.1 Color scheme

During a Pivot and Transfer, dialog boxes appear in different color schemes so you can easily
identify if they are connected to the source system or target system.
The table below indicates when different color schemes are used:
Table 10 - Color scheme

Dialog Box Color of the Source Color of the Target
Table Edit blue green
Tow Edit blue green
Perspective pink green
The figure below provides an example of how a Table Edit dialog box from a target system
would appear.
Figure 80 - Color scheme example - target system
86
Pivot and Transfer
6.2 Pivot and Transfer process

There are three stages involved in the Pivot and Transfer process.
To complete a Pivot and Transfer, you must:
• Pivot - Choose the target system
• Connect to the target system - If required, you must enter your credentials to connect to the
target
• Transfer: Transfer records from the source system to the target system
6.2.1 Pivot: Choosing the target system

During the Pivot process, you open the records you want to transfer (source), and select the
system to which the records will be transferred (target).
Procedure
1. Open one of the following edit dialog boxes:
• Table Edit
• Row Edit
• Perspective Root Table Edit

These dialog boxes are known as source dialog boxes. In this example, the Analog Table
Edit dialog box is used.
Figure 81 - Source table edit dialog box
2. Click Tools > Pivot and Transfer.
Step Result: The System Selector dialog box appears.
87
Pivot and Transfer
Figure 82 - System Selector dialog box
3. In the Select Target System field, click the drop-down arrow and select a target system.
You can only select one system at a time.
4. Click Transfer.
6.2.2 Connect to the target system

Depending on your credential type, you may have to login in order to connect to the target
system.
The credential type can be Single Sign On (SSO) or Windows. A Windows credential type
requires a login. If you have an SSO credential type, a target dialog box will open automatically
after the Pivot process is complete.
Related Information
Pivot: Choosing the target system on page 87
Transfer: Transferring records from the source to the target system on page 90
Connecting to the target system with a Windows credential type

If your credential type is Windows, the ADE login dialog box appears. You must login to connect
to the target system.
Before you begin

You must complete the Pivot process before connecting to the target system.
Procedure
1. Type your User name.
88
Pivot and Transfer
Figure 83 - ADE login window
2. Type your Password.

3. Click OK.
Result
You are connected to the target system; on of the following target dialog boxes appears:
• Target Table Edit dialog box
• Target Row Edit dialog box
• Target Perspective Root dialog box
What to do next
To complete the transfer, refer to “Transfer: Transferring records from the source to the target
system”.
Connecting to the target system with an SSO credential type
If your credential type is SSO, or you have already connected to this target system before, you
do not need to login.
After completing the Pivot process, one of the following target edit dialog boxes appears:
• Target Table Edit dialog box
• Target Row Edit dialog box
• Target Perspective Root dialog box
What to do next
To complete the transfer, refer to “Transfer: Transferring records from the source to the target
system”.
89
Pivot and Transfer
6.2.3 Transfer: Transferring records from the source to the target system
You must save the newly transferred records to the target system to complete the Transfer
process.
Figure 84 - Target dialog box example
The target dialog box displays the following information:
• The title indicates which system the dialog box is connected to.
• The modified records and fields are marked with a triangle icon.
• The newly inserted records are marked with a plus icon.
NOTE: All the fields in a target dialog box are read-only by default. Refer to “Edit the target
dialog box” for information on how to configure a target dialog box.
Procedure
1. Review the information in the target dialog box, and make sure the records waiting to be
transferred are correct.
Records waiting to be transferred are marked with a plus icon.
2. Save the changes in the target dialog box.
Result
The records are transferred from the source to the target system and saved in the database.
Related Information
Editing the target dialog box on page 91
90
Pivot and Transfer
6.3 Pivot and Transfer procedures

The Pivot and Transfer process varies slightly when it is done from different types of dialog
boxes.
This section describes how to edit information in a target dialog box and provides specific
instructions on how to perform a Pivot and Transfer from a Table Edit, Row Edit and Perspective
Root dialog box respectively.
6.3.1 Editing the target dialog box

The fields in the target dialog box are read-only by default. You can modify this attribute in the
table’s dbedit xml by setting the WritableTargetForm to True.
Procedure
1. Open the dbedit XML file for the desired table. For example, the analog.xml.
2. Add WritableTargetForm="true" to the Description field, as follows:
<Field
Name="description"RowLabel="Description"ColumnLabel="Description"To
olTipText="Description of the
record"TabOrder="20"IsRequired="false"IsReadOnly="false"IsVisible="
true"WritableTargetForm="true"DisplayWidthToUse="Maximum"></Field>
3. Run DBEditDisplaySchemaMerger.exe from the cmd line.
Result
You can now edit data in the target dialog box.
6.3.2 Pivot and Transfer from a Table Edit dialog box

You can perform a Pivot and Transfer from any RealTime Table Edit dialog box.
Procedure
1. Open the Table Edit dialog box (source) that contains the records you want to transfer.
2. Retrieve the records that you want to transfer.
Pivot and Transfer will transfer all the retrieved records in the source Table Edit dialog box to
the target.
91
Pivot and Transfer
5. Click Transfer.
Step Result: Either an ADE login dialog box or the target Table Edit dialog box appears.
6. If required, type your User name and Password, and click OK in the ADE login dialog box.
Step Result: The target Table Edit dialog box appears.
Figure 86 - Target Table Edit dialog box example
Result
The transfer of the records to the target system is complete.
6.3.3 Pivot and Transfer from a Row Edit dialog box

You can perform a Pivot and Transfer from a Row Edit dialog box to transfer a single RealTime
record.
Procedure
1. Open the Row Edit dialog box (source) for the record you want to transfer.
92
Pivot and Transfer
Figure 87 - Source Row Edit dialog box example
NOTE: Pivot and Transfer will only transfer one record to the target system at a time.
4. Click Transfer.
Step Result: Either an ADE login dialog box or the target Row Edit dialog box appears.
Step Result: The target Row Edit dialog box appears.
93
Pivot and Transfer
Figure 89 - Target Row Edit dialog box example
NOTE: The Target Row Edit dialog box marks the modified fields of an existing record with
triangle icons.
6. Click Record > Save Changes.
Result
6.3.4 Pivot and Transfer from a Perspective Root

You can Pivot and Transfer a set of records in a perspective at one time by performing a Pivot
and Transfer from the Perspective Root dialog box.
You can Pivot and Transfer one Perspective Root record at a time. You can also Pivot and
Transfer one Perspective child record from each of the tables that are connected to the
Perspective Root record.
Procedure
1. Click View > Perspective.

2. Open the Perspective Root dialog box (source) that contains the records you want to
transfer.
All the Perspective child dialog boxes appear as well.
94
Pivot and Transfer
Figure 90 - Source Perspective Root dialog box example
3. In the Perspective Root dialog box, click Tools > Pivot and Transfer.
5. Click Transfer.
Step Result: Either an ADE login dialog box or the target Row Edit dialog box appears.
Step Result: The target Perspective Root dialog box appears.
95
Pivot and Transfer
Figure 92 - Target Perspective Root dialog box
7. Different actions are required depending on whether or not the Root record exists in the
target system. Do one of the following:
• If the Root record exists in the target system, the target Perspective Root dialog box and
all its child dialog boxes are opened. Click Table > Save Changes.
• If the Root record does not exists in the target system, then the target Perspective Root
dialog box is opened, but its child dialog boxes are not. Do the following:
a) Click Table > Save Changes.
Step Result: The Perspective Root record is created in the target system, and all the
Perspective child dialog boxes related to that Perspective appear.
b) Click Table > Save Changes.
Result
Related Information
Perspective on page 75
96
Alarms and Events
7 Alarms and Events

Alarms and events are used to announce and record important activities within the system.
There are several configuration options that allow you to set conditions for the generation and
logging of alarms and events.
An event is a record of conditions and activity within the system. The event history provides a
chronological record of changes in the system’s condition, as well as actions taken by system
users over time. An alarm is used to announce a significant event that requires an operator’s
immediate attention. The generation of an alarm also creates a corresponding event record.
However, the generation of an event does not necessarily create a corresponding alarm.
You can configure conditions for the following:
• Generation of alarms
• Annunciation and display of alarms

• Suppression of alarms by conditions in other related records
• Printing of event logs
7.1 Events
The Event Summary window provides a detailed summary of the operational activity on the
SCADA system. Events are recorded both for operator-initiated actions and for application-
generated activities.
A record is generated in the event summary when any of the following occur:
• The system detects a condition which will generate an alarm
• A significant event occurs in an application
• The user issues commands to field devices
• The user modifies system configuration parameters
• The user acknowledges an alarm
Event Logging
When an event is generated, it is recorded in two locations. First, a copy is stored in the
HistoricalDB Event table (refer to the Historical Reference). You can view the event through the
Event Summary window in ezXOS, as discussed in the Operation Reference).
Second, the event message is formatted and placed in the queue for the appropriate spooler.
The spooler process records the event on the appropriate log printer or in a log file. The event
message takes the form of a single line of text stating the nature of the occurrence. For more
information, refer to the Historical Reference. The group to which the field device is assigned
determines which spooler is used. The designated “system” spooler is used for events that do
not have an appropriate group. (Groups are discussed in detail in the group Table (Module 19)
in theRealTime Tables Reference).
The Event database will quickly fill with data if you do not empty or purge it periodically. The
archive/cleanup process performs the necessary database purging. If you store events in a log
file, you should periodically delete old entries from the log file. Spooling events to a file is also
discussed in the Historical Reference.
97
Alarms and Events
7.2 Alarms
Alarms are used to notify the operator of a significant event or state. Alarming generates
database and system alarms and its alarm conditions are highly configurable.
The system generates three kinds of alarms: database alarms, system alarms, and application
alarms. A database alarm is always associated with a specific record in the RealTime database.
A condition that generates a system or application alarm may or may not have a specific
RealTime record associated with it. System and application alarms are similar in that they do
not need to be tied to a specific point in the database; however, you should elect to configure an
application alarm in situations where you want to use one or multiple fields in the alarm
database that are not available for system alarms. Another benefit of application alarms is the
ability to have them replicated based on the dataset field. Most alarms are database alarms.
Alarms refer to either a state or a significant event. If the alarm refers to a state, it persists until
the alarm is acknowledged and the condition that caused the alarm is cleared. For example, a
value that moved an analog record into a high alarm state would generate a state alarm, which
persists for the entire time that the record remains in that state. Even if the operator
acknowledges the alarm, the record remains in the Alarm Summary until the record’s value
moves out of that high alarm state.
If the alarm is caused by a transient condition or an event, the alarm is not persistent: it
vanishes from the Alarm Summary after the operator acknowledges it. For example, a rate-of-
change (ROC) alarm for an analog record is a non-persistent alarm. Such an alarm serves to
notify the operator of a condition that has occurred, even though the record may still be well
within its normal operational range.
InstAlarm automatically suppresses alarms that may occur when a record has recently been
commanded to change state, or when its alarm state has just changed. This component helps
reduce the number of nuisance alarms. For example, starting a pump could create a pressure
wave that causes several sensors downstream from the pump to go into an alarm state
temporarily. You can configure InstAlarm to suppress these alarms in the downstream devices.
The alarm/event inhibit features available through ezXOS provide you with the flexibility to
specify whether or not a given point generates event messages or alarms.
The following baseline windows notify the operator of alarms:
• The Alarm Summary window .
• The Newest Priority Alarms window.
• The Station Alarm Summary window.
• Alarm summaries for individual tables, such as analog, rate, and status.
For more information on these windows, refer to the Operation Reference.

NOTE: Within ezXOS, the system identifies an alarm condition by replacing the color of the
affected device or monitored value with a different solid or flashing color.
98
Alarms and Events
7.2.1 Instrument Fail Check

Instrument Fail Check can be configured on rate and analog records to generate alarms when
RTUs receive values outside their measurable range.
Sometimes, due to instrument or sensor malfunction, analog and rate instruments and/or their
associated transducers try to send a value to the RTU that is outside of the RTUs’ measurable
range. If the Instrument Fail Check check box is selected for RTUs capable of sensing
instrument failures, an analog or rate point alarm is generated when an instrument failure
occurs.
For an RTU that is not capable of sensing “out-of-range” failures, selecting Instrument Fail
Check causes the generation of alarms whenever the RTU encounters a raw value that is
outside its measurable range.
If the RTU is not capable of sensing “out-of-range” failures, select Instrument Fail Check to
generate alarms whenever the raw value is not within the raw value range.
NOTE: Instrument failure handling is protocol-specific.
For analog points, instrument failure alarms “clamp” a value that exceeds the minimum or
maximum alarm threshold to the value of the threshold it exceeded. For example, if the
maximum pressure value allowed is 50, and this value increases from 45 to 55, the value will be
locked in at 50.
For rate points, instrument failure alarms “clamp” a value that exceeds the minimum or
maximum alarm threshold to the last known good value. For example, if the maximum flow rate
value allowed is 50, and this value increases from 45 to 55, it will be locked in at 45.
7.2.2 Deadbands
Alarm deadbands control the sensitivity of the high and low alarms. These alarms are always
triggered when the value being monitored crosses the high or low limit. The value that causes
the alarm state to end depends on the configured deadband.
When the record is in the high alarm state, it remains in that state until it drops below the high
limit minus the deadband, as shown in the figure below. These conditions prevent minor
fluctuations from repeatedly putting the value into and out of the alarm state. Similarly, when a
record is in the low alarm state, it remains in that state until it rises above the low limit plus the
deadband. If the deadband is set to zero, this feature is disabled. These deadband rules apply
in the same manner to all of the limits.
An ADE validation rules ensures that bad configurations cannot be entered. The rules are:
• High must be greater than Low for at least deadband value for that level
• High-High must be greater than High for at least the High-High deadband value
• Low-Low must be less than Low for at least the Low-Low deadband value.
99
Alarms and Events
Figure 93 - Deadband Example
7.2.3 Alarm Limits

Standard normal operating values for the analog and rate records lie within certain High and
Low limits. When a measured value exceeds the high limit, or goes below the low limit, a state
alarm is generated to indicate that a condition requires attention.
A second set of limits, known as High-High and Low-Low, are above and below the high and
low limits. When a measured value exceeds the High-High, or goes below Low-Low limits, a
state alarm is generated to indicate that a critical condition has occurred.
NOTE: Typically, a higher severity is assigned to High-High / Low-Low conditions than to the
High/Lowconditions.
In ESCADA, there are expanded alarm limit levels. It is possible to configure four High Limit
levels and four Low Limit levels:
• L4-High
• L3-High
• High-High
• High
• Normal
• Low
• Low-Low
• L3-Low
• L4-Low
It is possible to configure the levels for all of these limits either individually, in sets or by linking
them to levels set for other records.
100
Alarms and Events
7.2.4 Rate of Change Checks

Analog and rate instruments register a value that increases or decreases depending on process
conditions. InstAlarm can monitor the rate-of-change (ROC) in the value. Rate-of-change is
determined by normalizing the last scan value and the current value to the unit time (in
seconds).
Some instruments have a manufacturer’s specification indicating that errors can occur if a
certain ROC value is exceeded. At times, a monitored process variable can require a ROC limit
to prevent errors based on rapid adjustments to the system. In these cases, select the Rate of
Change Alarm check box on the Alarming tab in the analog Row Edit dialog box in the
RealTime Tables Reference, and enter the maximum allowable rate-of-change (in engineering
units per second) in the Rate of Change Limit: field. An alarm is generated if the calculated
rate of change is greater than this amount.
The correct limit is determined by the instrument specifications and the process limitations.
7.2.5 Creep Detection

Creep Detection can detect calibration deterioration in analog and rate instruments. Since
analog and rate instruments can creep out of their calibrated state over time, Creep Detection
can be configured to measure the difference between the current value and the creep setpoint
and trigger an alarm if the difference exceeds the maximum deviation value specified for that
instrument.
You may need to properly calibrate analog and rate instruments to ensure that their values are
accurate and do not creep out of the calibrated state. Analog and rate records have an option
that allows you to store an initial value or creep setpoint, updated on startup and whenever a
creep alarm is generated. This initial value can then be compared to all subsequent values. This
comparison measures any creep deviation of the input value. The amount of creep is the
absolute difference between the current scan value and the creep setpoint that was set when
the last creep alarm occurred:
If the analog record is supposed to test for creeping, select the Creep Detection check box on
the Alarming tab in the Analog Row Edit dialog box. You should do this when the instrument
specifications indicate a maximum raw deviation value that is acceptable before calibration
deterioration occurs. Convert this raw value to the applicable engineering units for the record
and enter it in the Deviation Alarm Limit: field. An alarm is generated if the calculated creep
exceeds this limit.
7.2.6 Flatline Alarming

Analog instruments and rate instruments register a value that increases or decreases
depending on process conditions. OASyS DNA can monitor the change in this value. The
change is determined by subtracting the last scanned value from the current value. A flatline
alarm is generated if the analog or rate value does not change within a specified time period
(timeout).
NOTE: The flatline monitoring process runs once a minute; therefore, you can delay the
generation of a flatline alarm by one minute.
101
Alarms and Events
Flatline Alarm Message

The message text that indicates that an analog, a rate, a status, or a reservoir record is in a
flatline alarm:
Analog: (or Rate: or Reservoir: or Status:) <name> in Flatline state

for N minutes. Value = M
Where:
<name> = the name of the point
N = the configured timeout
M = the point value.
Alarm Severity: High
The message text that indicates that an analog, a rate, a status, or a reservoir record returned
from a flatline alarm:
Analog: (or Rate: or Reservoir: or Status:) <name>: RTN from

Flatline state. Value = M
Alarm Severity: Low

Flatline Alarm Conditions
A flatline alarm is declared when an analog or rate record value does not change within a
configured amount of time (timeout).
A flatline alarm is not declared, if the flatline alarm is disabled or the record is:
• manual-entry or calculated
• in instrument failure
• offscan
• manual
• configured to have a timeout of zero
• stale
7.2.7 State-Based Alarming

State-based alarming is implemented for analog, rate, and status records. State-based alarming
helps prevent nuisance alarms, which occur when the actions of devices affect the readings of
other devices. High/low/creep/rate-of-change alarm checking is implemented for tables that hold
floating record values, such as analog and rate records.
Status records can be configured to have normal and abnormal states. Analog records have
lowlow/low/high/highhigh abnormal states and a normal state.
Abnormal state alarming
Abnormal state alarming is used to represent a status or analog record that is in an abnormal
state.
Unless alarming of the state for a given status record is inhibited and the point shifts to an
abnormal state, the following occurs:
102
Alarms and Events
• The record goes into alarm.
• The appropriate workstation displays an alarm message.
• The alarm message is spooled to the event log.
If the alarm represents an abnormal state, it remains in the alarm summary as a non-flashing
alarm after it is acknowledged; it is then cleared from the Newest Priority Alarms window. The
name of the record, its associated remote, and its description field appear in both the alarm
message and the event log.
Return-to-normal alarming
When a record that is in alarm returns to a normal state, a return-to-normal alarm is generated
to communicate the change in state.
When an alarm condition clears, the system:
• Generates a return-to-normal alarm message
• Clears the alarm from the alarm summaries after the operator acknowledges it
• Spools the return-to-normal alarm message to the event summary

When the alarm message is generated, it flashes until the user acknowledges it. After the user
acknowledges it, it stops flashing and is deleted from the alarm summary unless the status
record has been configured to sustain off-normal alarms. When the record returns to normal,
the return-to-normal alarm message appears on the user’s workstation and the message begins
flashing again. When the user acknowledges the alarm, the return-to-normal alarm disappears
from the alarm summary.
If the record returns to normal before the user acknowledges the alarm, the return-to-normal
alarm message is submitted to the user and remains flashing until it is acknowledged. Even if
the alarm condition clears before the alarm is acknowledged, the user must still acknowledge
the alarm.
NOTE: An alarm is not generated if the user commands a status record to an abnormal state.
7.2.8 Commanded Status Record Alarming

Two types of alarm processing are associated with commanded status records: uncommanded
change-of-state (COS) and command failure.
NOTE: State-based alarming is triggered whenever an uncommanded status change occurs. A
status record with a configured output can generate a state-based alarm if it changes
state without being commanded.
Uncommanded Change-of-State
An uncommanded change of state occurs when a status record changes state without being
commanded. The alarm message and event log will display the name of the status record, its
associated remote, and its description field.
When the user acknowledges an uncommanded change-of-state alarm, the alarm normally
disappears immediately from the alarm summary. However, if the status record has been
configured to sustain off-normal alarms, the system consults the abnormal state table. If the
state changed to an abnormal state, the alarm remains in the alarm summary even if the user
has acknowledged it.
Like state-based alarming, it is possible to independently disable alarming of transitions to

normal or abnormal states, as well as the logging of an uncommanded change-of-state.
103
Alarms and Events
NOTE: An alarm is not generated if the user commands a status record to an abnormal state.
Command Failure Alarming
There are two alarms associated with command failures: change-of-state failure alarm and
command failure timeout alarm.
The system generates a change-of-state alarm when a device, which has been directed or
commanded to change state, takes a long time to change from its present state. Some devices,
such as large block valves, can take several minutes to attain the commanded state. Rather
than waiting for several minutes to generate a command failure alarm, you can specify a
maximum amount of time to wait for the device to change state. The state which the device
failed to reach is likely not the final state, but the fact that a change has occurred indicates that
the commanded action is taking place.
NOTE: A change-of-state alarm applies only to status records configured as outputs.
The system generates the command failure timeout when the commanded device does not
reach the final commanded state within the maximum time allowed. Refer to .
The only limitation on the time specifications is that the command failure timeout for the final
commanded state must be larger than the change-of-state failure timeout.
7.2.9 Timeout Alarms

When commands are sent to an analog or status record, a timeout period is required to give the
device time to perform the operation. If the operation is not performed within this period, a
timeout alarm is generated.
NOTE: Rate records are typically flow measuring devices with no control capabilities; therefore,
rate records do not have this functionality.
Command Failure Timeout Alarming
For status records, the timeout period for command failure (in seconds) is configured through
the Cmd Failure Timeout: field on the Output tab for Status Row Edit dialog box. This is the
maximum period of time for a command to succeed. After the time period has passed, the
system issues a failure alarm. The state that the device changes to is likely not the final state,
but the fact that a change has occurred indicates that the commanded action is taking place. A
typical value would be three to five seconds, but this is device dependent. If the device does not
change state within the specified period, the system generates an alarm.
If a command can not be sent to the status record due to communication problems, the system
generates an alarm and logs the event.
Command Timeout Alarming
For analog records, the timeout period for setpoint commands (in seconds) is configured
through the Command Timeout: field on the Output tab in the Analog Row Edit dialog box.
Because analog values do not immediately stop at the setpoint, there is also a Setpoint
Tolerance value. A setpoint is reached when the value is within the tolerance boundary (the
setpoint value plus or minus the Setpoint Tolerance value).
The operation of the instrument plays an important role in determining the correct timeout
period. Generally, the correct timeout period will be arrived at by trial and error in the testing of a
commanded output.
104
Alarms and Events
If a command can not be sent to the analog record due to communication problems, an alarm is
generated and the event is logged. All generated alarms are cleared from the alarm summary
upon acknowledgement.
7.2.10 Communication Alarms

The communication line between the RTU and the host computer may encounter minor errors
and problems. The details from all communication alarms and events are recorded in the
Historical database.
The statistics for communication errors are recorded in the Remote table, and then transferred
to the Historical database’s CommStats database, where they are stored in the RemPeriodStats
table. The connection statistics are recorded in the Connection table, and then transferred to the
Historical database’s CommStats database, where they are stored in the ConnPeriodStats
table.
To view historical results, click any field of a record’s information line on the Remote Summary,
Remote Primary Statistics Summary, or Remote Alternate Statistics Summary windows in
ezXOS. When the action menu appears, click Historical Statistics to open the
Communications Statistics Edit dialog box that displays historical results.
7.2.11 Communication Timeouts

A no-reply timeout period is configured for all RTUs. If an RTU does not communicate within
that period, an alarm is generated.
The system reports most types of communication failures as soon as they occur (e.g. security
error, illegal message, short message). However, if the remote fails to communicate, the system
generates a no-reply alarm if the failure lasts for longer than the no-reply timeout period.
Network Alarms
InstAlarm and InstEvent can also generate alarms related to critical network components and
the network communication between the host computers and the terminal servers. For example,
if the primary LAN fails over to the secondary LAN, an alarm message is generated to indicate
that a failover has occurred.
The following tables shows the messages for the internal network failover flag alarms defined in
the CPU message set.
Table 11 - Network communication alarm text

Alarm Text Description
Fail This message indicates the workstation CPU is failing over to a backup
unit (or there is a failing LAN).
Pending This message indicates the workstation CPU is attempting to start up.
Init This message indicates the workstation CPU is in the initialization stage of
recovery.
Standby This message indicates the workstation CPU is in standby mode and
ready to go live if all conditions are right.
Hot This message indicates the workstation CPU is “hot” or in a live
operational state.
Table continued…
105
Alarms and Events
Table 11 - Network communication alarm text (continued)

Switch This message indicates the host CPU and its LAN is failing, requiring a
LAN switch. (This is also used for device failover to another unit.)
Doswitch This message indicates the process of switching LANs during a host CPU
failover. (This is also used for device failover to another unit.)
7.2.12 Non-Covered Alarms

Non-covered alarms refer to alarms related to an area that is not currently selected for control
by a user. This may occur during times when fewer users are on duty, such as during the night
shift. Any or all workstations can be configured to receive non-covered alarms.
“Non-covered” does not apply to system alarms. This is controlled by a separate configuration
setting, the Receive System Alarms check box, which can be found in the NMC. If a database
record has no value in its group field, it is considered as not belonging to any area and is
treated the same as a system alarm. These types of database records will be received, or not
received, by an ezXOS station depending on that station's Receive System Alarms setting.
They will never be considered non-covered alarms.
If a database record goes into alarm and no operator is currently controlling the area(s) that
record exists in, it is considered a non-covered alarm, and all ezXOS stations that have
Receive System Alarms configured will see it. As soon as an operator selects that control
area, the alarm is no longer non-covered, and it will be removed from all ezXOS stations except
for the operator’s who selected that control area.
The following should be considered with non-covered records:
• Database records can belong to groups, and a group can belong to any number of areas. Be
wary that if the group belongs to Area 1, and no operator is controlling Area 1, the group
may also belong to Area 2, and if there is an operator controlling Area 2, the alarm is not
considered non-covered.
• In the Area Row Edit dialog box, you can Enable Alarm Cover Checking. If the area is not
configured to perform cover checking, any non-covered alarms from that area will not be
reported as non-covered. A record will only be reported as non-covered if the record is in a
group that is in an area that has alarm cover checking enabled and no operator is controlling
the areas enabled for alarm cover checking. It is highly recommended that you check the
area records’ settings and see if alarm cover checking is enabled.
• Toggling control areas on or off may take up to 1 minute to take effect. Despite the fact that
you can configure a Check-in Timeout (sec) for area records that defines how often cover
checking occurs, the check for covered or non-covered alarms has been hard-coded to
occur about once a minute. Therefore, when control areas are updated, it may take up to 1
minute before an alarm shows up as non-covered or has its non-covered status removed.
When alarms are being generated for an area that is controlled by an operator, non-covered
alarms from another area occur only if alarm cover checking is enabled. If alarm cover checking
is disabled, the system will not generate non-covered alarms.
NOTE: If an operator receives a non-covered alarm, she does not automatically have the
authority to acknowledge it or to control the necessary devices in that area. First, she
must be able to select the area with the non-covered alarm for control, which can only
106
Alarms and Events
occur if the workstation rights and/or user rights allow it. At any given time, therefore, at
least one user should have rights to control each area.
7.2.13 Logging Commanded COS and Setpoints

User-commanded status change-of-state (COS) and analog setpoints are both logged as
events. Successful commands are only logged with a success statement if Log Command
Success is selected in either the Analog Output dialog box or Output tab for Status Row Edit
dialog box.
The system will record any permitted command issued by the operator (i.e., if the command is
aborted due to a command tag, the system will not record the event). Unsuccessful commands
are logged with the command and either a communication failure statement, if communication
failure prevented the command from reaching the remote, or a command failure statement, as
explained in Communication Failure Timeout Alarming and Communication Timeouts.
Most protocols process an output command at the RTU when the RTU is successful in receiving
the command.
107
Telemetered data
8 Telemetered data
The analog, rate and status records are primarily used for sending and recording telemetry data
to and from field devices.
The records hold configuration information and the following types of data:
• Data acquired from telemetry field devices and the output command values sent to the
devices
• Data consisting of the following:
− Manually entered values: These are used in place of telemetry values when an
instrument cannot be used in the process control system. Manual values can also be
used for testing. These values only affect the host-end values not the remote field values.
− Calculated data: These are numerical values generated by calculation algorithms.

Calculations may be performed by Application Calculation Engine (ACE) routines stored
in the RealTimeDB tables. The Application Calculation Engine Reference discusses how
to set up and run ACE routines. SQL statements can also be used to produce calculated
data.
Each telemetry field device is defined in one record in the appropriate RealTimeDB table, as
shown in the following table.
Table 12 - Telemetered Data Tables

Table Description
Analog The Analog table defines analog devices and their input and/or output
(setpoint) capabilities (e.g., pressure, voltage).
Rate The Rate table defines devices that send analog signals representing flow
rates (e.g., m3/h, kWh) and/or devices that send pulse counts
representing accumulated quantity (e.g., m3, kW).
Status The Status table defines all digital devices (e.g., valves, breakers) that
have a limited number of discrete possible states (e.g., open, closed, in
transit).
Related Information
Analog table on page 126
Rate table on page 253
Status table on page 301
108
The Age Watchdog Application
9 The Age Watchdog Application

The Age Watchdog application monitors specific telemetered points within an Omnicomm
process to ensure that they are actively being krunched.
Communication connections to remote devices are generally managed by Omnicomm, which

polls and receives data depending on the connection type. It is important that Omnicomm
remain active, polling the remotes and krunching their data. If Omnicomm or one of the remotes
it manages fails, the integrity of the data in the system is compromised.
The Age Watchdog application monitors the points it owns by checking their timestamps at a
defined interval and comparing them against the current time. If the difference is longer than the
configured acceptable timespan, the application responds according to event and alarm
configuration for the point.
Whenever a monitored point has not been updated within the expected timespan, it is declared
suspect. Suspect points result in a demand poll to the remote if Demand Polling is enabled. If
the monitored point is not updated within a specified period of time, the ageWatchdog record in
ADE is declared old. When a record is declared old, the data quality of its monitored point is
considered potentially invalid and the Age Watchdog application performs the following actions:
• Issues an ageWatchdog related alarm against the point's remote if it is not alarm-inhibited.
• Issues an ageWatchdog related event against the point's remote if it is not event-inhibited.
• Issues an ageWatchdog related event against the monitored point if it is not event-inhibited.
• Stales the remote of the monitored point.
• Stales the monitored point and all points that belong to the same remote.
• Sets the state of the ageWatchdog record associated with the monitored point to "Stale
Data".
• Triggers a Historical data collection of all staled points.
9.1 Stale Data and Return-To-Normal Processing

When the data quality of a monitored point is declared old by the Age Watchdog application, the
state of the ageWatchdog point changes to "Stale Data". The Age Watchdog application
continues to watch monitored points in this state by checking the value of the timestamp once
every minute. If the timestamp of the telemetered point monitored by the ageWatchdog record
changes, the ageWatchdog point requires Return-To-Normal processing because the monitored
point is considered fresh again.
When the timestamp on a monitored point with a "Stale Data" status changes, the following
Return-To-Normal processing occurs for the ageWatchdog point:
• The state is set to "Fresh Data".
• An ageWatchdog-related, non-persistent alarm is issued against the point's remote if it is not

normal-alarm-inhibited.
• An ageWatchdog related event is issued against the point's remote if it is not normal-logging-
inhibited.
• An ageWatchdog related event is issued against the point if it is not normal-logging-inhibited.
109
9.2 Mode Switches and Age Watchdog

The Age Watchdog application monitors the ownership of the monitored point in order to
prepare for any potential mode-switch.
When a point that is monitored by an ageWatchdog record changes ownership upon mode-
switch, there are implications for the ageWatchdog record. In steady state conditions, the
timestamps of monitored points on the non-owning system can become extremely out-of-date in
comparison to the timestamps on the owning system. This is because the owning system
actively polls and krunches the data; however, baseline telemetry does not force replication on
the non-owning system unless a state or value change is drastic enough to trigger it.
Timestamps on the non-owning system can be as old as the last time that system had
ownership. If monitored points continued to be sampled immediately after a mode-switch, it
would result in points being falsely declared as old, and potentially false alarms, events, and
staled remotes.
In order to prevent this, the Age Watchdog application monitors which system owns the
monitored point, and when it takes ownership. It also uses a registry variable to configure a
delay in sampling after a mode-switch occurs.
Figure 94 - Age Watchdog Sampling Before and After a Mode-Switch
The figure above shows a point for which ownership changes upon mode-switch. During the
day, meanalog (a point monitored by Age Watchdog) is owned by the ES system. During the
night, a mode switch occurs. Immediately after the mode-switch Main takes ownership of
meanalog, but its timestamp on the Main system is from the early morning. To prevent Age
Watchdog sampling from occuring until the Main system has polled and krunched all points in its
dataset, the registry variable is used to pause processing long enough that all timestamps
should be up-to-date.
The RealTime registry variable that tells Age Watchdog how long it should pause is called
AGEWATCHDOG_SAMPLEDELAY_SECONDS. This variable is located in config\Registry
\RealTime.xml and is defaulted to 100 seconds.
<Value Name =AGEWATCHDOG_SAMPLEDELAY_SECONDS>100</Value>
110
NOTE: The minimum allowable value for this variable is 40 seconds. A RealTime service
startup is required at the server (where changes to this variable are made), in order for
the new setting to come into effect.
AGEWATCHDOG_SAMPLEDELAY_SECONDS is configurable on a per server basis to accomodate
differing system load requirements and differing physical polling capabilities across geographic
locations. For instance, imagine that in the example above the ES system is a central control
system that is located in a city with good internet access, and Main is located in the mountains
away from advanced technology. If Main has to use slower radio or satellite communications to
poll remotes, it will take longer for meanalog to be krunched; therefore the
AGEWATCHDOG_SAMPLEDELAY_SECONDS variable should be set long enough to ensure that the
point will be updated before Age Watchdog resumes sampling.
9.3 Selecting a Monitored Point in Age Watchdog

Clicking the ellipsis button (...) for the Monitored point field on the Main tab of the Age
Watchdog table opens the Point Selector dialog box for the application.
Figure 95 - Age Watchdog Point Selector
The Point Selector allows you to select a specific telemetered record to associate with the Age
Watchdog point. Typically, you will select an analog, rate, multistate, or status record. However,
selection of custom telemetered tables is also enabled, as long as the record contains the
following fields: group, dataset, flag, pointtype, timestamp, and rtu. When you save the record,
Age Watchdog will check the validity of the point you have selected.
Table 13 - Fields on the Point Selector for Age Watchdog

Field Description
Table Select the table you want Age Watchdog to monitor.
Record Click the ellipsis button (ui) to open the Record Selector.
Select the specific record in the table that you want Age
Watchdog to monitor.
Current This field displays the Monitored point that is currently
selected. You can enter the field for the point in place of the *;
however, this information is not required. All three entries are
required, so leave the * if you decide not to specify the record's
field.
111
Age Watchdog Table
10 Age Watchdog Table

The ageWatchdog table is used to configure records for the Age Watchdog application, which
monitors specified telemetered points within an Omnicomm process.
The Age Watchdog table allows you to select one telemetered point per record in the
Monitored point field. The timestamp of this point will be checked according to a Sampling
Interval. When checked, the difference between the point's timestamp and the current time is
compared to a Time Qualifier span. If the difference is greater than the Time Qualifier, the
point will be considered suspect.
If Demand Poll has been enabled for the ageWatchdog record, a demand poll is issued to the
associated remote. The Monitored point will then be checked every minute to determine if the
demand poll resulted in an update to the point's timestamp.
If the timestamp of the Monitored point has not changed once the Demand Poll Timeout has
expired, the Age Watchdog application will respond according to alarm and event configuration
for the point. The Age Watchdog application will then continue to check the Monitored point's
timestamp every minute. If the timestamp has been updated, the Omnicomm process and
remotes are clearly working, so the Age Watchdog application will perform Return-To-Normal
processing.
NOTE: The timestamp of the configured point is checked every minute by default, if the
Sampling Interval is set to zero. As a result, the remote of the monitored point and the
point itself will be staled every minute if the Time Qualifier span is also left at zero.
Each record in the ageWatchdog table also maintains a persistent state, which indicates the
data quality of the monitored point. The records can have one of the following states: disabled,
fresh data, suspect data, or stale data. The message set that corresponds to these states is
called ageWatchdog.
• Disabled indicates that the ageWatchdog record is disabled due to manual intervention or a
configuration error.
• Fresh Data indicates that the Age Watchdog application finds no problems after checking the
timestamp of the monitored point.
• Suspect Data indicates that the Age Watchdog application considers the Monitored point to
be potentially invalid, and has issued a demand poll to trigger an update to the point's
timestamp.
• Stale Data indicates that the Age Watchdog application has staled the monitored point after
its record has been declared old.
NOTE: The state of ageWatchdog records is preserved whenever the RealTime Service is
restarted. It is also replicated across systems for seamless operation of long sampling
intervals across system restarts and mode switches.
NOTE: Any discrepancies that occur between the ageWatchdog records enabled, flag.cmsg,
and state fields will be corrected the next time the Age Watchdog application processes
the monitored points.
112
Age Watchdog Table
10.1 Main Tab Age Watchdog Row Details

The Main tab in the ageWatchdog Row Details dialog box is used to set up the basic
properties of the Age Watchdog record.
Figure 96 - Main Tab in the Age Watchdog Row Details dialog box
NOTE: Name and Monitored Point are required fields.
NOTE: System performance will be affected if you enable too many points in the Age
Watchdog application. Select only a small subset of points for Age Watchdog
processing.
Table 14 - Items on the Main tab in the ageWatchdog Row Details Dialog Box
Item Description
Name Type the unique name of the ageWatchdog record. This field
has a 31 character limit (e.g., station_5_PLC_1_board_2 ).
Description Type a description for the ageWatchdog record. This field
has a 47 character limit (e.g., Monitoring status input on
second board).
Monitored Point Click the ellipsis button (...) and select the name of the
telemetered point you want Age Watchdog to monitor.
Watchdog Enable Select this checkbox if you want to enable Age Watchdog to
monitor the point.
Base Message Click the ellipsis button (...) and select the message
associated with the record from the Message Select dialog
box. The Base Message field is defaulted to
"ageWatchdog".
113
Age Watchdog Table
The Age Watchdog table restricts selections for the Monitored point. It can only reference
points from tables that contain all of the following fields:
• group
• dataset
• flag
• pointtype
• timestamp
• rtu
If these fields do not exist for the Monitored point, the attempted configuration will be
considered illegal.
NOTE: The Age Watchdog application may erroneously disable the point if it has difficulty
accessing the Monitored point to verify it contains all of the required fields.
NOTE: The following error message will be returned if you attempt an illegal Age Watchdog
configuration: "Age Watchdog cannot be configured for specified table. The table needs
to contain the following fields: group, dataset, flag, pointtype, timestamp, rtu."
10.2 ageWatchdog Timing Configuration Tab

The Timing Configuration tab of the ageWatchdog table is used to configure the sampling
interval, the time qualifier span, and demand polling for the record. The Age Watchdog
application will check the timestamp of the telemetered point associated with the record as
frequently as the sampling interval specified in this tab.
The timestamp of the Monitored point is compared to the current time, and the difference is
compared to the configured time qualifier span. If the difference between the current time and
the point's timestamp is greater than the time qualifier span, the point is considered suspect. If
Demand Poll has been enabled, a demand poll is issued to the remote that owns the monitored
point.
NOTE: The sampling interval will be derived from the sum of the Sampling Interval Hours and
Sampling Interval Minutes. The time qualifier span will be derived from the sum of the
Time Qualifier Hours and Time Qualifier Minutes in seconds.
NOTE: Do not configure too many points with small sampling intervals. The processing will
impact system performance.
Every minute, the timestamp of the monitored point is checked to see if has been updated until
the Demand Poll Timeout has expired. Once the Demand Poll Timeout has expired, the
monitored point is considered old; ageWatchdog will respond depending on alarm and event
configuration.
114
Age Watchdog Table
Figure 97 - Timing Configuration Tab in the ageWatchdog Table
NOTE: The timestamp of the monitored point is checked every minute by default, if the
sampling interval is set to zero. As a result, the remote of the configured point and the
point itself will be staled every minute if the time qualifier span is also left at zero.
NOTE: Do not set the time qualifier span to be shorter than the remote polling frequency. For
more information on polling frequency, refer to Connection and Remote table
documentation.
Table 15 - Items on the Timing Configuration Tab of the ageWatchdog Table

Item Description
Sampling Interval Enter a positive number to indicate the number of hours you want
Hours ageWatchdog to wait between samples of the monitored point.
Sampling Interval Enter a positive number to indicate the number of minutes you want
Minutes ageWatchdog to wait between samples of the monitored point.
Time Qualifier Hours Enter a positive number to indicate the acceptable number of hours
that can elapse before ageWatchdog will consider a point stale.
Time Qualifier Minutes Enter a positive number to indicate the acceptable number of
minutes that can elapse before ageWatchdog will consider a point
stale.
Demand Poll Enable Select this check box if you want to enable Demand Polling when a
monitored point becomes suspect.
Demand Poll Timeout Enter a positive number to indicate the acceptable number of
Minutes minutes that can elapse before a Demand Poll is considered a
failure.
NOTE: Do not select Demand Poll Enable if the remote for the Monitored point does not
support demand polling.
NOTE: The Age Watchdog application issues a single demand poll to a remote. Retries are
handled by standard Omnicomm processing.
115
Using the Age Watchdog Summary Window
11 Using the Age Watchdog Summary

Window
The Age Watchdog Summary window shows the operator the status of points configured in
the Age Watchdog application, which monitors certain telemetered points within the RealTime
database to determine if they are updated by Omnicomm within an expected time frame. Alarms
will appear in the Age Watchdog Summary window to indicate potential problems with the
Monitored point
The Age Watchdog Summary can be opened from the Summaries section of the ezXOS
Navigation Menu. Each row shows the name and value path of all points configured with Age
Watchdog records, as well as the message, internal state, demand poll setting, point
description, and last sample time for the monitored point. The display can be filtered by the
name of the point and the internal state. The default message set matches the internal state;
however, this message set can be customized.
The Agewatchdog Control panel can be opened for each record shown in the summary. The
control panel shows the remote that is associated with the Age Watchdog record, the sampling
frequency for the Monitored point in hours and minutes, the time qualifier, and the demand poll
timeout. An operator can control the demand polling for each record, as well as whether or not
the record remains enabled in the Age Watchdog application.
Procedure
• Click Summaries > Age Watchdog on the ezXOS Navigation Menu to access the Age
Watchdog Summary window.
Step Result: The Age Watchdog Summary window opens.
Figure 98 - Age Watchdog Summary Window
116
Using the Age Watchdog Summary Window
Table 16 - Age Watchdog Summary Field Descriptions

Fields Description
Row Header The left hand button of the row, which opens
the Agewatchdog Control panel. An alarm
icon will appear in the first column.
Name The name of the Age Watchdog record.
Monitored Point The telemetered point that the record is

monitoring.
Message The message associated with the state of

the Age Watchdog record.
Internal State The current state of the Age Watchdog

record.
Demand Poll Whether or not the Age Watchdog record is

configured to issue a demand poll when the
point has not been updated within the
expected time frame.
Description Description of the Age Watchdog record.
Last Sample Time The time that the last sample interval
completed.
11.1 Message Set for ageWatchdog

Table 17 - State Message Sets in ageWatchdog
State Description
Disabled The ageWatchdog record has been disabled either due to manual intervention
or a configuration error.
Fresh Data The Age Watchdog application has not found problems when sampling the
timestamp of the point being monitored by the ageWatchdog record.
Stale Data After declaring the ageWatchdog record old, the Age Watchdog application has
staled the point it was monitoring.
Suspect Data After polling the point that is monitored by the ageWatchdog record, and its
timestamp is found to be old, the Age Watchdog application sets the point to
Suspect Data. Demand Polling will commence if it is configured.
117
Alarm Suppression table
12 Alarm Suppression table

The Alarm Suppression (Almsuppression) records define all the suppression criteria that is
configured for a record. Almsuppression records are located in the Almsuppression table and
are created and edited using the Almsuppression Row Edit dialog box.
Figure 99 - Almsuppression Table Edit
The Almsuppression Table Edit dialog box allows you to add, modify and delete suppression
criteria.
118
12.1 Alarm Suppression Row Edit

The Alarm Suppression (Almsuppression) Row Edit dialog box is used to set the suppression
method and timeouts for a point.
Figure 100 - Almsuppression Row Details dialog box
Refer to the table below for field descriptions and instructions on how to configure the editable
fields.
Table 18 - Items on the Almsuppression Row Edit dialog box

Items Description
Suppression Method Click the drop-down arrow and select one of the following
suppression methods:
• Parent Control
• Parent Alarm
• Parent Transient
Parent Table This is not available for the Transient Suppression Method. You
can choose either Analog or Status.
Parent Point This is not available for the Transient Suppression Method. This is
the parent point.
Child Point Type the name of the child record whose alarms you want to
suppress for a parental state. When the parent’s state satisfies the
conditions for the suppression, the system will not display an
Table continued…
119
Table 18 - Items on the Almsuppression Row Edit dialog box (continued)

Items Description
alarm when the child point enters a state that would otherwise
trigger an alarm.
Child Table Type the name of the table containing the child record whose
alarms you want to suppress for a parental state.
Parent Alarm/Control This field applies only when Suppression Method is set to Parent
Control or Parent Alarm.
Parent Return to Normal This field applies only when Suppression Method is set to Parent
Alarm.
Alarm Holdoff This field applies only when Suppression Method is set to Parent
Alarm or Transient.
Valid for Specified State Select the check box to enable the Alarm State field.
Alarm State Type the state for which the alarm suppression configuration is
valid. For analog, it might be high alarm state; for status, it might
be the opened state. The alarm state options that are provided are
sensitive to the child record being edited. Only the valid child
states are shown.
12.2 Importing from Excel into the Almsuppression table

™
As of OASyS DNA 7.6 , you can now export the Almsuppression table to Excel, edit it, and
import the data from the spreadsheet back into ADE. It is important to understand how importing
and exporting works with the Almsuppression table so you do not create unintended records.
The Almsuppression table uses a combination of fields to work together as a unique identifier
for the row. These fields are: childPt, childDB, parentDB, parentPt, and suppressionType. All of
these fields work together to identify whether or not a particular record is unique.
If you want to export your Almsuppression records to Excel in order to modify them, it is
important to remember that all of these fields are working together. Whenever you modify one of
these identifying fields in a row in the exported Excel spreadsheet and import the records back
into ADE, a new record is created in addition to the original. However, if you edit one of the
records and it becomes identical to another record in the spreadsheet, ADE considers it a
duplicate and ignores this row when importing the data.
NOTE: You can modify non-key fields in the spreadsheet and import the data back into ADE
exactly the same way as you import data into other RealTime tables.
120
Alarm Disturbance table
13 Alarm Disturbance table

The Alarm Disturbance (Almdisturbance) records are used to suppress alarms below a set
severity level. Almdisturbance records are located in the Almdisturbance table and are created
and edited using the Almdisturbance Row Edit dialog box.
Figure 101 - Almdisturbance Table Edit
In alarm disturbance mode, the system suppresses alarms whose severity level is lower than or
equal to a configured severity. This mode of suppression applies to all types of alarm, such as
state-based alarms and command failure alarms.
Return-to-normal state alarms are typically configured with low severity levels. Instead of
updating the alarm summary to show that the alarm has returned to the normal state, alarm
disturbance mode purges the alarm from the alarm summary.
Alarm processing requires considerable resources, and alarm disturbance mode helps reduce
the alarm processing required when the system is inundated with alarms. By suppressing lower-
priority alarms, it also reduces the number of alarms submitted to the operator.
Each Almdisturbance record allows you to configure the maximum alarm severity that the
system will suppress. This configuration takes effect without the need to restart RealTime
services.
The operator has the ability to enable or disable alarm disturbance mode through ezXOS (refer
to the “Alarm Summary” section in the Operation and Control Reference). A developer can also
write an application to automatically enable or disable alarm disturbance mode. Enabling or
disabling alarm disturbance mode in one system does not affect the mode setting in another
system.
When an operator disables alarm disturbance mode, the system regenerates suppressed state-
based alarms, such as those resulting from data krunch; however, other low priority alarms,
such as command failure alarms and system alarms, are not regenerated. The system
reevaluates non-inhibited alarm records of analog, status, and rate points for which no alarm
record exists in the alarm summary.
121
Alarm Disturbance table
13.1 Alarm Disturbance Row Edit

The Alarm Disturbance (Almdisturbance) Row Edit dialog box allows you to set what severity of
alarm will be suppressed on a system.
Figure 102 - Almdisturbance Row Edit dialog box
fields.
Table 19 - Items on the Almdisturbance Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the Almdisturbance
record from the Almdisturbance Select dialog box.
System Name Click the ellipsis button (...) and select the name of the system for which
you want to suppress alarming from the System List Select dialog box.
Maximum Severity Click the drop-down arrow and select an alarm severity level. Any
record alarms on the system with a severity equal or greater to the
Maximum Severity selection is suppressed.
NOTE: The Almdisturbance record Name must match the System Name.
Related Information
Select dialog boxes on page 10
122
Alarm Inhibit Priority table
14 Alarm Inhibit Priority table

The Alarm Inhibit Priority (Alminhpriority) records allow you to configure the priorities of the
alarm inhibit types, so the most important inhibit types are reported. Alminhpriority records are
located in the Alminhpriority table and are created and edited using the Alminhpriority Row Edit
dialog box.
Figure 103 - Alminhpriority Table Edit
In order to manage alarms and events, it is necessary to analyze the alarms that have been
generated and the alarms that have been inhibited or suppressed. It is possible to prevent
alarms from being generated in a variety of ways (e.g., inhibits, parent control suppression,
transient suppression, etc.). When an alarm is inhibited or suppressed, an event may still be
generated and stored in the Historical database for this alarm. The event will have the alarm
inhibit type specified and events can be filtered based on this inhibit type. If an alarm is inhibited
for more than one reason, however, the highest priority inhibit type in effect will be the one that
is stored in the event record.
123
14.1 Alarm Inhibit Priority Row Edit

Each Alarm Inhibit Priority (Alminhpriority) record assigns a priority for a particular alarm inhibit
type. These priorities are configured in the Alminhpriority Row Edit dialog box with higher
numeric values associated with higher priorities.
Figure 104 - Alminhpriority Row Edit dialog box
fields.
Table 20 - Items on the Alminhpriority Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the Alminhpriority
record from the Alminhpriority Select dialog box.
Type Click the drop-down arrow and select one of the possible alarm inhibit or
suppression types. This is the suppression type that will be assigned a
Priority. The choices are:
• Undefined - The alarm associated with this even was not
suppressed or inhibited.
• Unknown - The alarm is suppressed by an unknown suppression

method.
• App Specific - The alarm is suppressed by an application-specific

method.
• Transient - The alarm is suppressed by the Transient alarm

suppression type.
• Parent Alarm - The alarm is suppressed by the Parent Alarm

suppression type.
Table continued…
124
Table 20 - Items on the Alminhpriority Row Edit dialog box (continued)

Items Description
• Parent Control - The alarm is suppressed by the Parent Control

suppression type. This type of alarm inhibit is directly related to an
operator command.
• Inhibited - This option indicates the database’s alarm inhibit flag is

true. If the event is for an ‘abnormal’ alarm or state change, the alarm
inhibit type will be ‘Inhibited’ only if the database point’s ‘Inhibit
abnormal alarm’ flag is true. If the event is for ‘normal’ alarm or state
change, the alarm inhibit type will be ‘Inhibited’ only if the database
point’s ‘Inhibit normal alarm’ flag is true.
• Test Mode - The alarm is suppressed because the point is in an

active test mode set.
Priority Type the priority level value that you want to assign to this priority Type.
If there is more than one alarm inhibit type in effect for an alarm, the
event that is generated will record the alarm inhibit type with the highest
Priority number. A higher value in the Priority field indicates a higher
priority and is more likely to be recorded as the cause of the alarm being
inhibited. The default priorities are as follows:
• 0 - Undefined
• 4 - Unknown
• 8 - App Specific
• 12 - Transient
• 16 - Parent Alarm
• 20 - Parent Control
• 24 - Inhibited
• 28 - Test Mode
Related Information
Select dialog boxes on page 10
125
Analog table
15 Analog table
Analog records are used to represent a floating point value. The analog value is stored in the
curval field and is often expressed as a measured value such as pressure or voltage. Analog
records are located in the Analog table and are configured using the Analog Row Edit dialog
box.
Figure 105 - Analog Table Edit
In addition, analog records can be configured for:
• Conversion of a raw telemetry value into a value in engineering units
• First order smoothing of the raw input value
• Setpoint command processing
• Complex alarm and event processing on the current analog value
• Historical data collection of the current value by exception and at periodic intervals
• Current value averaging for the current and previous communications statistics on the
primary or alternate paths
• Attachment to an ACE routine for calculations or control
From ezXOS, an analog record can be:
• Manually overridden with a value, or enabled to use the telemetry/calculated value again
• Tagged to inhibit setpoint commands
• Commanded to send a new setpoint value
An analog record can also have its alarms inhibited/enabled and its alarm limits changed.
126
Analog table
15.1 Main Tab Analog Row Edit

The Main tab in the Analog Row Edit dialog box is used to set up the basic properties of the
record such as groups, datasets and input types.
Figure 106 - Main tab in the Analog Row Edit dialog box
The Analog Row Edit dialog box also gives the user access to the historical database via the
Historical and PI Historical buttons. Refer to the table below for field descriptions and
instructions on how to configure the editable fields.
Table 21 - Items on the Main tab in the Analog Row Edit dialog box
Items Description
Name Click the ellipsis (...) button and select the name of the Analog record
from the Analog Select dialog box.
Description Type a description of the record. The Description can be up to 47
characters in length. This field is for information purposes only and can
be used to describe the record, its association with other points, or any
other textual information. The Name and Description configured for a
record appear in the summary tables in ezXOS.
Point Type Click the drop-down arrow and select the type of point that this record is
representing. The choices are:
Table continued…
127
Analog table
Table 21 - Items on the Main tab in the Analog Row Edit dialog box (continued)
Items Description
• telemetered - The record represents an actual measuring device. If

this is selected, you must configure the Remote field and specify
which remote record the device is associated with.
Telemetered data is only fresh when there is good connectivity to the
point’s associated remote and the telemetered value has not been
manually overridden.
• manual entry - The record uses a fixed, manually entered value that
has no associated measuring device. The value you want to use
must be entered using the manual override on the Analog Control
dialog box or Multistate Control dialog box (refer to the Operation
and Control Reference for details)
This data is always fresh.
• calculated - The analog value is computed by an application. For

instance, an ACE config record might be defined with this analog or
multistate record as its output point. If a control routine is desired,
only the aceconfig and acecode records need to be defined. There
will not be an associated output calculated point (i.e., no analaog or
multistate point).
These points are fresh if the calculation routine has successfully run
and all or some (configurable) input parameters are fresh and the
calculated value has not been manually overridden.
Remote Click the ellipsis (...) button and select the name of the remote
associated with this record from the Remote Select dialog box. This field
must be configured if the Point Type is set to telemetered.
Dataset Click the ellipsis (...) button and select the name of the dataset you
want to associate with this record from the Dataset Select dialog box.
A dataset contains privileges assigned for each system and mode. Once
a record is assigned to a data set value, the dataset can only be
changed to a value for which the system has a privilege record. A
record’s dataset can not be changed in such a way that the system can
no longer access the record.
Calculate Select the check box to calculate the average for the current and
Averages previous primary or alternate statistics. You can make these averages
available for reports, displays, and applications by specifying the field
name along with the following:
avg.[primary|alternate].[current|previous]
Table continued…
128
Analog table
Table 21 - Items on the Main tab in the Analog Row Edit dialog box (continued)
Items Description
The following example selects the name and current average for the
primary statistics of analog points, whose remote is DWN1:
select name, avg.primary.current from analog
where rtu=”DWN1”
If you require averages over longer time periods, click Historical....
Replication Type a deadband value. Whenever the analog value moves beyond this
Deadband value, the value is replicated to other hosts via the function subscription
ANALOGRT.
Priority Display Specify the graphic you want to be associated with the priority display
button on an ezXOS control panel.
Historical... Click the button to open the Collect Table Edit dialog box that can be
used to configure historical data collection.
PI Historical... Click the button to open the PI Table Edit dialog box and begin
configuring PI records.
Related Information
Collect table on page 166
Group table on page 188
Message table on page 202
Remote table on page 269
129
Analog table
15.2 Input tab Analog Row Edit

The Input tab in the Analog Row Edit dialog box is used to configure analog inputs. This tab
allows you to define the details of an input such as the data type, value limits, filter information
and if the values are converted into engineering units.
Figure 107 - Input tab in the Analog Row Edit dialog box
When configuring manually-entered analog points, you must select the Has Input check box on
the dialog box to allow programmed or manual setting of the record’s current value field,
otherwise the fields are greyed out.
fields.
130
Analog table
Table 22 - Items on the Input tab in the Analog Row Edit dialog box
Items Description
Has Input Select the check box to allow the setting of the analog point’s current
value field.
Use the drop down menu to select the type of information that is
provided by the outstation.
Input Coordinates Type the coordinates where the data is mapped within the remote. This
mapping depends on the protocol used.
Some protocols use registers to allocate data in remote memory, others
use a definition of the point or file number for access. Representative
data mappings and point configuration are described for various
protocols in the RealTime Reference.Refer to your specific remote or
protocol documentation for a definition of the data mappings and to
determine the remote’s input/output data location in memory.
If you are using modbus, you must define poll ranges that cover the
input/output records before configuring the input and output coordinates.
Refer to the modbus documentation in the RealTime Reference for
information on configuring poll ranges.
Convert raw to Select the check box to convert the inputs from this point to engineering
EGU units.
An analog field device acquires its data as a raw instrument electrical
value and transfers the value to its remote. At the remote, this value is
changed into a digital value based on the communication protocol used.
For example, in the MICRO/1C MODBUS protocol, the signal from a
pressure controller that starts as an amperage between 4 and 20 mA is
changed to a string of bits that represents a number between -4096 and
+4095.Usually this raw number needs to be converted to engineering
units (for example, barrels per hour). Sometimes the remote receives
the value in engineering units, in which case no conversion is
necessary. Refer to your remote’s documentation to see if this is the
case for your remotes.
Minimum (raw) Type the instrument’s lower raw operating limit.
The EGU range represents the range of rate values expected for the
point. This range should be set regardless of whether or not the rate is
telemetry (an analog input), or calculated based on pulse counts over
time (a pulse input).
Maximum (raw) Type the instrument’s upper raw operating limit.
Minimum (EGU) Type the lowest measurable value of the instrument in engineering
units.
Table continued…
131
Analog table
Table 22 - Items on the Input tab in the Analog Row Edit dialog box (continued)
Items Description
For example, if a temperature instrument is rated as measuring between

-40 °C and 160 °C, set the Minimum (EGU) to -40 and set the Maximum
(EGU) to 160.
The EGU values are used in EGU conversion as well as in the Analog
Control dialog box (refer to the Operation and Control Reference).
Maximum (EGU) Type the highest measurable value of the instrument in engineering
units.
For example, if a temperature instrument is rated as measuring between
-40 °C and 160 °C, set the Minimum (EGU) to -40 and set the Maximum
(EGU) to 160.
The EGU values are used in EGU conversion as well as in the Analog
Control dialog box (refer to the Operation and Control Reference).
Exception Type the amount by which an acquired value must change before the
Deadband value is sent to the host.
This field provides a report by exception method of acquiring data rather
than acquiring data with every Omnicomm scan. Analog data changes
constantly with the fluctuations in process conditions. Instead of
constant updates of tiny changes, which congest the lines, the data is
transferred to the host only when a specified deadband region has been
exceeded. This method can only be used if the remotes support analog
reporting by exception.Since the decision of whether or not to upload
the data is made by the remote, the deadband value is downloaded to
the remote in raw units. The exception deadband indicates the amount
by which an acquired value must change before the value is sent to the
host. For example, a deadband value of 10 means that only values at
least 10 raw counts higher or lower than the last value sent to the host
are transferred.
Apply Linear Filter Select the check box to apply a filter to the telemetry/calculated values
to smooth out brief fluctuations. The equation for the filter is:
Vfilter = (Vcurrent * K) + [Vprevious * (1-K)]
Where:
Vfilter is the filtered value
Vcurrent is the current unfiltered value
Vprevious is the filtered value from the previous Omnicomm scan
K is the filter constant
132
Analog table
15.3 Output tab Analog Row Edit

The Output tab in the Analog Row Edit dialog box is used to configure analog output
commands. This tab allows you to define the details of an output such as the data type, value
and setpoint limits and if the values are converted into engineering units.
Figure 108 - Output tab in the Analog Row Edit dialog box
fields.
Table 23 - Items on the Output tab in the Analog Row Edit dialog box
Ite Description
ms
Ha Select the check box to allow the configuration of output commands for analog points.
s
Table continued…
133
Analog table
Table 23 - Items on the Output tab in the Analog Row Edit dialog box (continued)
Ite Description
ms
Ou
tpu
t
Ou Click the drop-down arrow and select the appropriate data format for the acquired analog
tpu data. The data format that is used is dependent on the device used to acquire data. Refer
t to the remote or protocol documentation for a definition of analog input data-type.Some
Ty of the data-types currently supported include: M1C analog (Micro 1C), float, unsign 16
pe int, signed 16 int, unsign 32 int, and signed 32 int. Schneider Electric can integrate other
data-types into the system upon request.
Ou Type the coordinates where the data is mapped within the remote. This mapping
tpu depends on the protocol used.
t
Some protocols use registers to allocate data in remote memory, others use a definition
Co
ord of the point or file number for access. Representative data mappings and point
ina configuration are described for various protocols in the RealTime Reference.Refer to your
tes specific remote or protocol documentation for a definition of the data mappings and to
If you are using modbus, you must define poll ranges that cover the input/output records
before configuring the input and output coordinates. Refer to the modbus documentation
in the RealTime Reference for information on configuring poll ranges.
Co Select the check box to convert the outputs from this point to engineering units.
nv
An analog field device acquires its data as a raw instrument electrical value and transfers
ert
ra the value to its remote. At the remote, this value is changed into a digital value based on
w the communication protocol used. For example, in the MICRO/1C MODBUS protocol, the
to signal from a pressure controller that starts as an amperage between 4 and 20 mA is
EG changed to a string of bits that represents a number between -4096 and +4095. Usually
U this raw number needs to be converted to engineering units (for example, barrels per
hour). Sometimes the remote receives the value in engineering units, in which case no
conversion is necessary. Refer to your remote’s documentation to see if this is the case
for your remotes.
Mi Type the instrument’s lower raw operating limit.
ni
The EGU range represents the range of rate values expected for the point. This range
mu
m should be set regardless of whether or not the rate is telemetry (an analog input), or
(ra calculated based on pulse counts over time (a pulse input).
w)
Ma Type the instrument’s upper raw operating limit.
xi
The EGU range represents the range of rate values expected for the point. This range
mu
m should be set regardless of whether or not the rate is telemetry (an analog input), or
(ra calculated based on pulse counts over time (a pulse input).
w)
Mi Type the lowest measurable value of the instrument in engineering units.
ni
mu For example, if a temperature instrument is rated as measuring between -40 °C and 160
m °C, set the Minimum (EGU) to -40 and set the Maximum (EGU) to 160.
Table continued…
134
Analog table
Table 23 - Items on the Output tab in the Analog Row Edit dialog box (continued)
Ite Description
ms
(E The EGU values are used in EGU conversion as well as in the Analog Control dialog box
GU
(refer to the Operation and Control Reference).
)
Ma Type the highest measurable value of the instrument in engineering units.
xi
For example, if a temperature instrument is rated as measuring between -40 °C and 160
mu
m °C, set the Minimum (EGU) to -40 and set the Maximum (EGU) to 160.
(E The EGU values are used in EGU conversion as well as in the Analog Control dialog box
GU
(refer to the Operation and Control Reference).
)
Set Type the lowest setpoint that can be issued.
poi
nt
Lo
w
Li
mit
Set Type the highest setpoint that can be issued.
poi
nt
Hig
h
Li
mit
Co Type the amount of time (in seconds) that a value can be outside the setpoint tolerance
m limits before the system generates a command failure alarm.
ma
nd
Ti
me
out
Set Type the amount the setpoint command is allowed to fluctuate.
poi
nt A setpoint command will be considered successful when the analog input value reaches
Tol the setpoint value plus or minus the tolerance value.
era
nc
e
Lo Select the check box to record successful commands in the event log.
g
Co Unsuccessful commands always generate alarms and are logged regardless of whether
m or not this check box is selected.
ma
nd
Su
cc
es
s
NOTE: EGU limits are not checked if the Minimum (EGU) and Maximum (EGU) fields are both
set to zero.
135
Analog table
15.4 Alarming tab Analog Row Edit

The Alarming tab in the Analog Row Edit dialog box allows you to set alarm conditions for the
analog record being configured.
Figure 109 - Alarming tab in the Analog Row Edit dialog box
Support is provided for a number of alarm conditions for analog and flow rate points, including:
• Instrument failure checking
• High/Low operating-range checking
136
Analog table
• HighHigh/LowLow operating-range checking
• Rate-of-Change checking
• Creep Detection or instrument-deviation checking
• Flatline Alarming checking
Each of these alarm conditions can be configured and enabled or disabled independently. You
can set the conditions in the point’s record, or in the point’s ezXOS control panel via the Alarm
Limits window in ezXOS.
fields.
Table 24 - Items on the Alarming tab in the Analog Row Edit dialog box
Items Description
Instrument Fail Select the check box to generate an alarm when an instrument failure
Check occurs.
An alarm is only generated if the analog point is connected with an RTU
capable of sensing instrument failures.
Alarm Deadband Type the deadband value for the analog point.
This value controls the sensitivity of the high and low alarms. For more
information, refer to “Deadbands”.
HiHi/LowLow Select the check box to edit the HighHigh and LowLow alarm limits.
Alarm Check Refer to “Alarm Limits” for more information.
Hi/Low Alarm Select the check box to edit the High and Low alarm limits. Refer to
Check “Alarm Limits” for more information.
HiHi Alarm Limit Type the HighHigh alarm limit for the analog point.
Hi Alarm Limit Type the High alarm limit for the analog point.
Lo Alarm Limit Type the Low alarm limit for the analog point.
LoLo Alarm Limit Type the Low Low alarm limit for the analog point.
Enable ROC Alarm Select the check box to enable the Rate of Change (ROC) alarm. If the
ROC exceeds the Rate of change limit, an alarm is generated.
Refer to “Rate of Change Checks” for more information.
Rate of change Type the maximum allowable rate of change (engineering units per
limit second).
Creep Detection Select the check box to enable Creep Detection alarm. If the analog
value creeps out of its calibrated state by a value that exceeds the
Deviation Alarm Limit, an alarm is generated.
Refer to “Creep Detection” for more information.
Deviation Alarm Type the maximum deviation value (engineering units) that is acceptable
Limit before calibration deteriorates.
Flatline Alarming Select the check box to enable Flatline Alarming. If the analog value
does not change within the Timeout value (min), an alarm is
generated.
Table continued…
137
Analog table
Table 24 - Items on the Alarming tab in the Analog Row Edit dialog box (continued)
Items Description
Timeout value Type the maximum about of time (minutes) that can pass without the
(min) analog value changing.
Alarm Click the button to open the Alarm Suppression (Almsuppression) Table
Suppression Edit dialog box, and configure Almsuppression records associated with
this record.
Related Information
Alarm Suppression table on page 118
15.5 Inhibits tab Analog Row Edit

The Inhibits tab in the Analog Row Edit dialog box allows you to inhibit events and alarms
caused by state changes such as change of state from normal to off-normal and vice versa.
Figure 110 - Inhibits tab in the Analog Row Edit dialog box
The Operator can also inhibit alarms generated from analog, rate, and status records through
the points’ ezXOS control panels. For remote records, the operator can put a remote offscan but
cannot actually disable alarming for all points.
While the user can inhibit alarm generation through ezXOS, only the system administrator can
inhibit event logging through the Advanced Database Editor (ADE).
The following table lists conditions that determine normal and off-normal states.
138
Analog table
Table 25 - Normal and Off-normal state determinants

Table Condition/Determinant
Analog Analog alarm limits (refer to “Alarm Limits”)
Connection Alarms that are usually related to the following:
• Modem failure (connection lost, unable to establish connection)
• Configuration errors (cannot assign device)
• Dialup line communication errors

Rate Rate alarm limits (refer to “Alarm Limits”)
Remote No-reply timeouts, security errors, short messages, and illegal
messages (Normal alarms are generated and logged.)
In the analog record, the analog alarm limits configured in the Alarming tab determines the
Normal and Off-normal states. Refer to the table below for field descriptions and instructions on
how to configure the editable fields.
Table 26 - Items on the Inhibits tab in the Analog Row Edit dialog box
Items Description
Off-Normal Alarm Select the check box to inhibit off-normal alarming. The system will not
generate an alarm when the point changes from a normal state to an off-
normal state.
Normal Alarm Select the check box to inhibit normal alarming. The system will not
generate an alarm when the point change from an off-normal state to a
normal state.
Off-Normal Log Select the check box to inhibit off-normal logging. The system will not
log an event when the point changes from a normal state to an off-
normal state.
Normal Log Select the check box to inhibit normal logging. The system will not log
an event when the point change from an off-normal state to a normal
state.
139
Analog table
15.6 RVE tab Analog Row Edit

The RVE tab in the Analog Row Edit dialog box is used to configure the checking of the point’s
rule sets. Any commands for the point are intercepted by the Rules Validation Engine, which
determines if a command is allowed to proceed or not.
Figure 111 - RVE tab in the Analog Row Edit dialog box
Table 27 - Items on the RVE tab in the Analog Row Edit dialog box
Items Description
Rules Set Select the desired record from the list of configured records in the
RVE Rules Set table.
Rules Set Enabled? Select this checkbox to enable checking of the selected rule set
when a point is commanded.
Alarm on Rule Failure? Select this checkbox to cause alarms to be generated if a rule in
the rule set is violated.
Event on Rule Failure? Select this checkbox to cause events to be generated if a rule in
Timeout (ms) Type the number of milliseconds to allow RVE rule checking to
complete. If this field is set to zero, no RVE timeout is configured;
however any timeout set for BLT components will still apply.
Severity Use the drop-down box to set the severity associated with alarms
generated by RVE. The default severity is “high”.
140
Analog table
NOTE: RVE rule checking is bypassed on fnputs issued from a command line. RVE rule
checking is only performed on commands that are issued through the RVE BLT or the
Analog Control Panel.
141
Area of Responsibility
16 Area of Responsibility
OASyS DNA has a layered approach to access control. An Area of Responsibility (AOR) is one
method of control used in ADE to enhance security.
Setting up authorization and access management in the RealTime database is a combination of

careful planning and relatively straight-forward configuration. Although shown in figure below as
discrete layers, each of the layer’s components interact with one another to determine specific
sets of data access.
Figure 112 - Access Control Layers
16.1 Groups
Groups are used to link devices that should be monitored and operated together. Groups are
assigned to telemetered points (analog, rate, status, multistate, and custom tables) and the
remote devices to which those points are assigned.
This relationship is typically established by listing all of the different views (or areas) that must
be present on the system, and then grouping together all devices not split by an area boundary.
Because of this, groups generally link devices that are located in close proximity to each other.
Groups are further assigned to Areas, which provide the geographical area system views that
are required at each operator station. Essentially, Groups make points within the devices that
are related visible to the operator. The operator station will include all groups belonging to the
Area of Responsibility at that station.
The Group table is used to associate individual telemetry points with areas of responsibility. A
group record provides a logical grouping of remotes and attached end-devices.
• Group assignments are specified for each remote in the Remote table and for each field
device in either the Analog, Rate, Status, Multistate, or other custom table. Any field device
whose data is gathered by any of the RealTime tables (remote, analog, rate, or status) can
belong to only one group.
• A group may belong to a number of areas. To indicate that a telemetry point belongs to all
areas of responsibility, you must not specify a group name. If you do not specify a group or
specify a group that is not referenced by any AOR Area, the telemetry point appears in all
142
table summaries on all operator stations even if no view areas are selected. Alarms from
these telemetry points are sent to all operator stations configured to receive system alarms.
NOTE: Using NMC, it is possible to create an AOR Group called GlobalAccess and not
associate it with any AOR Areas.
Each group record also specifies a spooler to which alarms and messages are sent. The
spooler can be one or more of the following:
• Direct connection to printer

• Connection to printer on an ezXOS PC
• A file
For more information, refer to “Spooler table”.
If only one group record is defined in your system, all event messages are printed through the
specified spooler, which can address up to 10 printers. Additional AOR groups, which reference
other printers on the system, may be defined. If records that are already associated with
remotes and other end-devices are linked to these additional AOR groups, the event messages
concerning these remotes and end-devices are routed accordingly. Any or all groups can
specify the same printer.
Related Information
Spooler table on page 297
16.1.1 Example: Group Configuration in Relation to Field Devices

The configuration of AOR Groups allows you to link several field devices that should be seen
and controlled together. Primarily, AOR affects who can see the data from specific field devices
on station displays. This example explains how the AOR Group configuration corresponds to
the field devices they are grouping.
The figure below displays a station display that represents equipment in the field and how it has
been grouped for viewing and control. AOR Groups are assigned to Areas, which are used to
configure the Areas Of Responsibility necessary for monitoring and controlling the equipment in
the field.
143
Figure 113 - AOR Assignment and Corresponding Groups
This example shows how groups associate several field devices along a particular line segment.
Group1, Group 2, and Group 3 are created to link all the field devices assigned to them. The
Groups are then placed in Areas which are assigned to operators, simplifying their task load by
limiting the station displays they can see. Furthermore, Authorities and Permissions will be used
to affect whether the equipment belonging to the AOR is controllable or merely viewable by an
operator.
As shown above, groups can be used to break up a line segment geographically. Group 1 links
the field devices on the north side of the line: all points on Line1A and Line1B belong to this
group. Group 2 links all of the points associated with the switch, a device that connects the
north and south side of the line. Group 3 links the field devices on the south side of the line; all
points on Line2A and Line2B belong to this group. The groups that comprise an AOR will
generally correspond to a particular geographical area in the field; however any given group can
belong to two or more Areas. In other words, Areas of Responsibility (AORs) can overlap.
The figure above shows that Group 1 and Group 2 belong to the Area AOR North. Group 2 also
belongs to the Area AOR South, which contains the switch and the south side of the line
belonging to Group 3. Area AOR North is assigned to one operator, and Area AOR South is
assigned to the other operator. Permissions would be used to determine whether the Area can
be controlled by the operator to which it is assigned. This example assumes that both operators
have control over the Switch, but only one side of the line segment.
NOTE: DNAPermissions could be used to assign Viewer status to either operator for the Area
they do not control, in order to give them both the ability to see the entire line.
144
16.2 LegacyAOR Mode

LegacyAOR mode is an option for AOR configuration that allows you to assign areas and
groups as you have always done. You will have to switch to this mode from AOR mode if you
want to restore the old method of configuration.
NOTE: Run the GetAORMode BLT to determine in which mode your system is currently
running.
In LegacyAOR mode, tableSecurity is adjusted so that users with sufficient authority can modify
the AOR-related tables. Configuration of areas of responsibility is performed with these AOR-
related RealTime tables (area, group, groupAreaJoin, and xoscontrol) through ADE or iSQL.
Configuration in LegacyAOR maintains all configuration options that were available in Columbia.
You can have twenty groups per area, and areas can contain both controllable and non-
controllable groups.
If you prefer the LegacyAOR method of configuration, it is important to make the decision to
switch to LegacyAOR mode immediately after installation, prior to any AOR configuration. This
is because LegacyAOR mode is fundamentally different from AOR mode in both how and where
the data is configured. ToggleAORMode is the program that you will use to switch into (and out
of) LegacyAOR mode.
LegacyAOR mode enables you to master and maintain your AOR configuration in RealTime
instead of requiring that you learn how to duplicate it in AOR mode, for which configuration is
performed through the NMC and mastered in AD LDS. LegacyAOR mode also enables you to
maintain your current process for AOR configuration, since using the NMC instead of RealTime
tables may require different personnel to perform AOR configuration tasks.
Eventually, after running in LegacyAOR mode, you may want to switch to AOR mode because it
offers more sophisticated configuration options. While in LegacyAOR mode, the data in the
RealTime tables is frequently synchronized with AD LDS by AORLegacySync. This replication
of data enables you to use ToggleAORMode to switch back to AOR mode. Using LegacyAOR
mode first can facilitate changing to the new method of configuration because all of your AOR
data has already been replicated to the AD LDS format by the time you initiate a mode flip.
NOTE: Perform a savedata and text_save before performing a flip to LegacyAOR mode.
NOTE: To read more about AOR mode and its configuration options, look at NMC
documentation.
16.3 Implications of Changing to LegacyAOR Mode

You should change to LegacyAOR mode prior to any configuration. However, if any
configuration has been performed in the NMC there is a possibility this data will be lost.
Before switching to LegacyAOR mode, you should consider the following aspects of your
system:
• Transfer of data between AD LDS and RealTime.
• AORSynchronization and timing of configuration changes.
• The future mode flip into AOR mode.
The process that transfers data from AD LDS to the RealTime tables is AORSynchronization.
AORSynchronization occurs every fifteen minutes by default, so if recent changes have occured
145
in AD LDS they may not yet be synchronized to the RealTime tables. For this reason, it is
recommended that you manually run AORSynchronization prior to changing to LegacyAOR
mode. This can be done by performing an Update RealTime AOR in either the AOR Areas or
AOR Groups folders in the NMC.
There are considerable differences in the way AOR is configured in AD LDS and the way it is
done in RealTime. RealTime masters AOR data when a flip to LegacyAOR mode occurs and
the configuration is performed in ADE. In ADE, areas can be configured to contain twenty
groups (either controllable or non-controllable). This causes areas that have controllable and
non-controllable attributes. These records have to be split when data is transfered to AD LDS.
In AD LDS, areas are either controllable or non-controllable.
NOTE: Check the AORSynchronization.log file and the oasErrLog file prior to changing to
LegacyAOR mode. You will be notified if there were any problems running
AORSynchronization.
16.3.1 How Data is Transferred in LegacyAOR Mode

The transfer of data in LegacyAOR mode is facilitated by the AORLegacySync executable.
When the system is in LegacyAOR mode, configuration is done in RealTime through ADE. If
configuration changes are made while in LegacyAOR mode, an executable called
AORLegacySync will periodically synchronize the changes made to RealTime with AD LDS.
The AORLegacySync executable maintains a cache of both AD LDS and RealTime data. The
executable is informed of changes to the RealTime database through PubSub publications and
will re-read the database. If a change has occured, AORLegacySync will convert the new data
from a RealTime structure into an AD LDS structure the next time it runs, and then transfer the
data to AD LDS.
NOTE: When performing a failover, the AORLegacySync executable will refresh itself
whenever the machine goes HOT, in case PubSub has been disrupted by the failover.
16.3.2 AORLegacySync
AORLegacySync is a tool that transfers AOR modifications from RealTime to AD LDS in order
to keep the two synchronized.
AORLegacySync can be set to perform data transfers at periodic intervals.
• This transfer period is stored in the <DataDirectory>config\Registry
\RealTime.xml registry file.
• The variable for the transfer period is an integer called

“AOR_LEGACY_TRANSFER_DELAY”. It is commented out in the RealTime.xml file by
default.
• The default value for the integer is 120. The value is in seconds.
To modify the length of the transfer period:
Procedure
1. Toggle the AOR mode to LegacyAOR.

2. Navigate to the <DataDirectory>\config\Registry location. Open RealTime.xml.
3. In the RealTime.xml file, locate the following variable and uncomment it to set it.
<Value Name="AOR_LEGACY_TRANSFER_DELAY">120</Value>
146
Change the "120" value as desired.

4. Restart RealTime.
16.3.3 LegacyAOR View

When operating a system in LegacyAOR mode, you will need to add the LegacyAOR View to
modify RealTime AOR data using ADE. Once the LegacyAOR view has been added to ADE,
you will be able to add, edit, view and delete area, group, and xoscontrol records.
To access the records in the LegacyAOR view using ADE, you must first update the
DNATreeLayoutSchema.xml file so that the LegacyAOR view option will become visible in the
View menu drop-down.
Figure 114 - LegacyAOR in the View menu
Procedure
1. Navigate to <TelventRoot>\config\ADE\TreeLayout\7.6\Baseline\RealTime\.
2. Open the DNATreeLayoutSchema.xml file in a code editor and add the following code:
<Views ViewType="LegacyAOR" ToolTipText="List of AOR tables">

<Tables Type="Table"
Label="Area"
TableName="area"
PrimaryKeyField="name"
DescriptionField=""
UseDistinct="false"
CanOpenTable="true"
CanOpenRecord="true"
FromClause="FROM "area""
WhereClause=""/>
Label="Group"
TableName="group"
PrimaryKeyField="name"
DescriptionField=""
UseDistinct="false"
CanOpenTable="true"
FromClause="FROM "group""
WhereClause=""/>
147
Label="AOR Control"
TableName="xoscontrol"
PrimaryKeyField="area"
DescriptionField=""
UseDistinct="true"
CanOpenTable="true"
CanOpenRecord="false"
FromClause="FROM "xoscontrol""
WhereClause="">
Label="Users"
TableName="xoscontrol"
PrimaryKeyField="accessname"
DescriptionField=""
UseDistinct="false"
CanOpenTable="true"
FromClause="FROM "xoscontrol""
WhereClause="WHERE "area" = '{0}'"/>
</Tables>
</Views>
3. Click Save.
You must now merge the custom ADE view and AOR tables to the baseline schema:
4. Close all instances of ADE.
5. Open the MSDOS command prompt as an administrator.
6. Type DNATreeLayoutSchemaMerge.exe -p ADE and press Enter.
7. Type DBEditDisplaySchemaMerge.exe and press Enter.
8. Open ADE and ensure the LegacyAOR option is available from the View menu drop-down.
16.4 ToggleAORMode
ToggleAORMode is the application that enables you to switch from AOR mode to LegacyAOR
mode. This mode flip is initiated when ToggleAORMode is run from the MS-DOS Command
Prompt.
ToggleAORMode should be run on the Hot RealTime machine at the global system master. To
determine which system is the global system master you can use System Properties in NMC
and identify the system that owns the DistribuSyS Global Tables.
NOTE: You must have DNA System Administration privileges in order to run a mode flip. If you
do not, the program will abort and log the following message: " Attempt to run
ToggleAORMode by a user that is not a DNA System Administration
member".
ToggleAORMode executes the following actions every time it is run:
• Checks that you are authorized to initiate a mode flip and verifies that you are using the
correct system to do so.
• Notifies you of the current mode.
• Offers a warning about changing modes.
• Asks for confirmation prior to initiating.
• Attempts to complete the mode flip.
• Performs a savedata on the hot global master machine.
148
When the system is leaving AOR mode, it first updates the table security configuration in
RealTime and then attempts to complete the mode flip. Messages are printed inside the
command prompt that notify you which actions are occuring as the program runs. It will notify
you when the mode flip has succeeded.
After a flip occurs, you will get an OASyS Historical event, a Windows System Event, and
confirmation of completion in the oasErrLog. If you are missing one of these forms of
confirmation, the attempt to change modes may have failed and you will need to run
ToggleAORMode again.
NOTE: After a mode flip to LegacyAOR, remember to update ADE by manually adding the
LegacyAOR View so you can access AOR-related RealTime tables.
16.4.1 Changing Modes with ToggleAORMode

ToggleAORMode is used to change between AOR mode and LegacyAOR mode. Follow the
procedure below to initiate a mode flip.
Procedure
1. Open a Command Prompt.

ToggleAORMode needs to be run on the Hot RealTime machine on the Global Master
System by a user with System Administration permissions.
2. Enter toggleaormode.
Step Result: The system will identify the mode in which it is currently running and offer a
warning about the mode flip. It will then prompt you to confirm the flip by entering y for Yes or
n for No.
3. Enter y.
Step Result: The system will proceed to attempt a mode flip. As it does this, command line
messages will appear to notify you of the progress. Be careful to read these messages and
monitor the process. Mode flips have the potential to fail and/or cause AOR data loss. Upon
notification of failure you can retry the mode flip by restarting ToggleAORMode.
NOTE: If the mode flip fails, you will be notified with a message similar to the following:
"Unable to toggle the mode. Reason: Exception of type
'System.Exception' was thrown." Different reasons are given to help you
troubleshoot completion of the mode flip.
16.5 Fixing tableSecurity Configuration in LegacyAOR Mode

The configuration of tableSecurity records happens first, before switching masters, when you
flip to LegacyAOR mode. It is possible that an exception can occur and the tableSecurity will
prevent you from accessing AOR-related tables. If this occurs, you will need to fix the
tableSecurity manually.
Table Security records affect your ability to modify AOR data through the RealTime tables (area,
group, groupAreaJoin, and xoscontrol). In LegacyAOR mode, Table Security is configured to
allow you to modify records if you have the appropriate privileges. There is a problem with the
tableSecurity configuration if you are in LegacyAOR mode and cannot access the AOR-related
tables.
149
During a mode flip to LegacyAOR, you will be notified of an error in changing tableSecurity with
warning messages in the following locations:
• MS-DOS Command Prompt
• oasErrLog
The message will tell you the current mode in which the system is operating. If you are in
LegacyAOR mode, you must manually fix tableSecurity configuration so it matches LegacyAOR
mode tableSecurity configuration.
16.5.1 Configuration of Table Security Records in LegacyAOR Mode

If an error occurs while performing a mode flip to LegacyAOR mode, you will have to fix the
Table Security records manually in ADE before you can access the AOR-related RealTime
tables.
While in LegacyAOR mode, your Table Security configuration should match the example below.
Table 28 - LegacyAOR mode Table Security configuration

Table Read Group Write Group
area DNA Permission -

Config_Database
group DNA Permission -

Config_Database
groupAreaJoin DNA Permission -

Config_Database
xoscontrol DNA Permission - DNA Permission -

Config_Database Config_Database
16.6 Illegal Flips

Changing from AOR mode to LegacyAOR mode a second time is considered an illegal flip.
There are reasons to stay in AOR mode and problems occur if the system flips between either
AOR mode or LegacyAOR mode multiple times.
ToggleAORMode is designed to only allow two mode flips for your system in total. The decision
to move forward to AOR mode technology must be a final decision. When an illegal flip is
attempted a message appears to inform you in the following locations:
• The MS-DOS Command Prompt.
• oasErrLog.
• Windows warning-level event registered with the message.
ToggleAORMode then closes itself to prevent this mode flip.
150
16.7 Troubleshooting Mode Flips to LegacyAOR

If your system behaves in a way that is not expected for the mode, or seems to have problems
with respect to AOR, you will need to troubleshoot by reading log files and exploring
configuration in ADE.
The differences between LegacyAOR mode and AOR mode require different approaches to
troubleshooting. To verify the mode in which you are running, use the GetAORMode BLT call.
NOTE: You should always check the tableSecurity records and make sure they match the
mode in which you are running. The expected configuration for LegacyAOR mode
appears in Fixing tableSecurity Configuration in LegacyAOR Mode.
Log Files
There are log files for all of the processes related to the transfer of data between AD LDS and
RealTime. You will need to check these files when you are troubleshooting problems related to
a mode flip. AORLegacySync handles the transfer of data from RealTime to AD LDS.
AORSynchronization transfers data from AD LDS to RealTime. Both processes actively run on
the hot Global RealTime master machine. When checking log files, they should be checked on
the same machine.
There are several log files that will record messages related to problems in AOR:
• oasErrLog should be examined for AD LDS exceptions and reports about locks on AOR
tables.
• AORLegacySync.log should be examined for messages related to operating in LegacyAOR

mode.
• AORSynchronization.log should be examined for messages related to operating in AOR

mode.
• Windows System Event log should be examined for AOR related messages.
• OASyS Historical Event log should be examined for AOR related messages.
ToggleAORMode Troubleshooting
If you cannot use this program to initiate a mode flip, make sure you are running it as a user
who is a member of the DNA System Admins group. Also, make sure you are running the
program from the hot RealTime server on the global master system.
NOTE: Communications with AD LDS can be "flaky". If you are getting messages that tell you
ToggleAORMode has been unable to change the mode, try running it again after
confirming that you are running it as described above.
LegacyAOR Mode Troubleshooting
It is possible that the AORLegacySync process can encounter difficulties, including throwing
exceptions. If problems occur in LegacyAOR mode, toggleDebug can be used on the
AORLegacySync process. After you turn debugging on, you will want to look at the
AORLegacySync.log file.
If you notices messages related to exceptions while operating in LegacyAOR mode in this log,
you should do a publish to refresh caches and see if the messages in the log are resolved. To
do this you:
151
1. Open Multipublisher.
2. Publish something to <system name>.realtime.aorlegacysync.refreshcache.

The value you publish is not important. It is the act of publishing that forces the
AORLegacySync.exe to refresh its caches. Finally, you can publish to <system
name>.realtime.aorlegacysync.dumpcache. The output will appear in
AORLegacySync.log, which you can read for clues to problems with AOR configuration.
NOTE: AORLegacySync takes two minutes to transfer data between RealTime and AD LDS by
default. If data you have configured is not showing up immediately, wait for the cache
refresh to occur.
LegacyAOR Mode Configuration
When you are operating in LegacyAOR mode, your configuration is performed in RealTime
tables through ADE. Add LegacyAOR to the View menu in ADE if it is not already available, so
that you can configure RealTime. If there is a problem with the way AORLegacySync is
transferring data to AD LDS, troubleshoot by examining the configuration of the following tables:
Table 29 - AOR-related Tables and Expected Configuration

Table Configuration
groupAreaJoin This table should have matching group slots and group controls when
compared to the configuration for the area table.
xoscontrol There should be no duplicates for xoscontrol records. Sometimes, you may
have two records for the same area/user because there are three formats
(user,<system_domain>\dna_existing_user> and
<dna_existing_user@<system_domain>). You should make sure that
only one record exists for an area's Group Control and User Control. The
recommended format to use in xoscontrol records is user@domain.
NOTE: The oasErrLog will have messages if the users/groups configured in xosconrol records
are invalid. Look for messages similar to the following: "Invalid
xoscontrol.accessname("+<invalid name>+") for area.<area name>".
NOTE: If groups and areas do not appear in ezXOS as they are configured, restart ezXOS so it
can refresh its area list.
152
Xoscontrol table
17 Xoscontrol table
Xoscontrol records are stored in the Xoscontrol Table Edit dialog box.
Figure 115 - Xoscontrol Table Edit
153
Xoscontrol table
To open the Xoscontrol Table Edit dialog box:
1. Double-click AOR Control in the Advanced Database Editor window.
17.1 Xoscontrol Row Edit

The Xoscontrol Row Edit dialog box is used to configure the xoscontrol records.
Figure 116 - Xoscontrol Row Edit dialog box
fields.
Table 30 - Items on the Xoscontrol Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the Xoscontrol
record from the Select dialog box.
If the Type is configured as User Control, a UserList Select dialog box
appears with a list of users to choose from.
If the Type is configured as Group Control, a GroupList Select dialog

box appears with a list of groups to choose from.
Type Click the drop-down arrow and select the control type.
Table continued…
154
Xoscontrol table
Table 30 - Items on the Xoscontrol Row Edit dialog box (continued)

Items Description
Area Click the ellipsis button (...) and select the area to which control access
is permitted.
On Login Select the check box to enable control of the area on login.
155
Application table
18 Application table
Application records are used to represent data from third-party applications. Application records
are located in the Application table and are created and edited using the Application Row Edit
dialog box.
Figure 117 - Application Table Edit
The open architecture of OASyS DNA allows data to be extracted from its databases via third
and fourth generation languages, such as C and SQL. The data can then be entered into
custom-developed applications or third-party applications, such as spreadsheets and simulation
packages.
The Application table is a simple, generic table that does not require the high overhead of the
larger, more complex tables. Unlike the Analog, Status, and Rate tables, the Application table
supports string variables; however, it does not provide any eventing or alarming options.
An application record may be used for a number of purposes:
• It can hold a global variable for use within application programs (ACE, or perl scripts). The
variable can be a string, numeric, and/or boolean value. For example, if many calculated
records need to share a weekly computed factor, then the factor can be updated in the
application record and used by all of the calculated records.
• It can hold a calculated value. This value can be calculated by an ACE program attached to
the record, or it can be set by a Perl script run using the Job Scheduler (jsh). The ACE
programs and Perl scripts can perform alarming and eventing on the application record. For
example, a Perl script can be periodically invoked by making the job scheduler query the
RealTime SQL server and find out if more than five casual users are connected. If this is the
case, the program can update the application string value to indicate that the server is
normal or overused for casual use, and then generate the appropriate alarm and event
messages.
• It can contain a trigger for an ACE control program. For example, the application record
might be used to invoke an emergency shutdown program that triggers programs that are
attached to many status and analog devices and places them in the shutdown position.
156
Application table
Related Information
Job Scheduler table on page 191
18.1 Main tab Application Row Edit

The Main tab in the Application Row Edit dialog box is used to configure the basic
characteristics of an application record.
Figure 118 - Main tab on the Application Row Edit dialog box
This dialog box also provides access to the historical database via the Historical and PI
Historical buttons. Refer to the table below for field descriptions and instructions on how to
configure the editable fields.
Table 31 - Items on the Main tab in the Application Row Edit dialog box
Items Description
Name Click the ellipsis button (...) and select the name of the application
record from the Application Select dialog box.
Group Click the ellipsis button (...) and select the name of the group this record
belongs to from the Group Select dialog box.
Dataset Click the ellipsis button (...) and select the name of the dataset you want
to associate with this record from the Dataset Select dialog box.
Table continued…
157
Application table
Table 31 - Items on the Main tab in the Application Row Edit dialog box (continued)
Items Description

18.2 Values tab Application Row Edit

The Values tab in the Application Row Edit dialog box is used to assign variables to the
application record.
Figure 119 - Values tab on the Application Row Edit dialog box
If assigning global variables to the record (which other records and programs can access),
choose the appropriate values field. The selection includes float, integer, string, and boolean.
DB(“application”, EXEC_DBKEY$, “fltvalue”)
DB(“application”, EXEC_DBKEY$, “strvalue”)
DB(“application”, EXEC_DBKEY$, “boolvalue”)
This field can also be configured as an ACE input to a routine
The following table lists the internal field names in the Application table.
158
Application table
Table 32 - Internal field names for the Application table

Internal Field Name Description
flag.fresh The flag can be manipulated by the calculation function. The
default value is no, which means the data is not fresh. It is set to
no on system startup.
ftvalue This is the floating point value.
strvalue This is the text string that can contain up to 80 characters.
boolvalue This is the boolean value.
fields in the Values tab in the Application Row Edit dialog box.
Table 33 - Items on the Values tab in the Application Row Edit dialog box
Items Description
Floating Point If the global variable is a float, type the appropriate value in this field.
Value
Integer Value If the global variable is an integer, type the appropriate value in this field.
String Value If the global variable is a string, type the appropriate value in this field.
Boolean Value Select the check box to set the boolean value to true.
159
Area table
19 Area table
Area records are used to define the different views of the system. Area records are located in
the Area table and are configured using the Area Row Edit dialog box.
Figure 120 - Area Table Edit
An area consists of a collection of groups. Areas are not required to be mutually exclusive, and
a group can be assigned to more than one area. This enables the creation of different types and
sizes of areas, ranging from system overview areas that cover large portions of the system, to
station level areas that focus on individual telemetry locations.
A group may or may not be controllable within an area. Such distinctions are configured when
assigning the groups to an area. This means that within her area of control, the operator may
not be able to control devices associated with a group outside her area of control (unless the
same group is controllable within a second area over which she has control). This is useful for
configuring supervisory areas, with which a user may be able to see alarms, but not
acknowledge them. It is also useful for allowing an operator to see alarms from devices that are
adjacent to his area of responsibility, while preventing him from acknowledging or controlling
those devices.
If an alarm originates within an area that is not currently selected for control by any active
ezXOS station, it is sent to all active ezXOS stations that are configured to receive non-covered
alarms. This ensures that every telemetry device alarm is sent to at least one ezXOS station,
assuming the System Administrator has configured at least one active ezXOS station to receive
non-covered alarms.
Related Information
160
Area table
19.1 Main tab Area Row Edit

The Main tab in the Area Row Edit dialog box is used to configure basic properties of the area
record. The fields in this tab help determine that the groups represented in this area are always
covered by an Operator.
Figure 121 - Main tab in the Area Row Edit dialog box
fields in the Main tab in the Area Row Edit dialog box.
Items Description
Name Click the ellipsis button (...) and select the name of the area record from
the Area Select dialog box.
Enable Alarm Select the check box to send non-covered alarms from this area to a
Cover Checking designated workstation. This check box should be selected unless the
record is for an area that controls insignificant devices or duplicates
coverage of other areas that already have alarm cover checking
enabled.
Check-in Timeout Type a timeout value (seconds) to indicate how often the system should
(sec) check that at least one Operator workstation capable of controlling this
area is online. A value of 45 seconds or more is recommended.
161
Area table
Table 34 - Items on the Values tab in the Application Row Edit dialog box (continued)
Items Description
If no workstation is found, the alarms associated with this area are

considered non-covered.
The acceptable range for this field's value is between 25 and 65,535. A
value of 0 is not valid.
19.2 Groups tab Area Row Edit

The Groups tab in the Area Row Edit dialog box defines which groups make up the area record.
Figure 122 - Groups tab on the Area Row Edit dialog box
fields in the Groups tab in the Area Row Edit dialog box.
162
Area table
Items Description
Group Click the ellipsis button (...) and select the group record you want to add
to this area from the Group Select dialog box.
Controllable Select the check box to have the control rights over this area include
control rights over the group. If the check box is not selected, the group
is viewable but not controllable.
Related Information
19.3 Adding groups to an area record

Use the Groups tab on the Area Row Edit dialog box to add groups to an area. Up to 20
groups may be added to each area.
Before you begin

An area must be defined before you can add groups to the record. Use the Main tab in the Area
Row Edit dialog box to define an area.
Procedure
1. Click the ellipsis button (...) in the Group field on the Area Row Edit dialog box.
Step Result: The Area Select dialog box appears.

2. Select the name of the group you want to add to the area record.
3. Click Accept.
4. (Optional) Beside the name of the newly added group, select Controllable to have the
control rights over this area include control over the group.
If the check box is not selected, the group is viewable but not controllable.
5. Repeat steps 1 - 4 as needed.
163
Circuit table
20 Circuit table
Circuit records are used to prevent Omnicomm from sending multiple messages over different
connections where these messages would collide or interfere with each other. Circuit records
are located in the Circuit table and are created and edited using the Circuit Row Edit dialog
box
Figure 123 - Circuit Table Edit
A connection is a path from Omnicomm to a single port on one remote. In the case of multi-
dropped remotes, the same connection is used to communicate with any of the remotes.
A single circuit consists of one or more physical connections. Two physical connections are in
the same circuit if they either directly or associatively conflict with each other. You can associate
a connection with a circuit record to prevent Omnicomm from sending multiple messages over
different connections where these messages would collide or interfere with each other.
Omnicomm will never attempt to perform more than one operation at a time over a single circuit,
regardless of the number of connections in that circuit.
An example of direct conflict is a leased line and a dialup both going to the same single ported
remote. Separate commands cannot be sent down the two lines without colliding when they
reach the single remote port.
An example of associative conflict would be two single ported remotes, both sharing the same
leased line but each with its own dialup line as well. The two dialup lines do not conflict with
each other, but each line conflicts with the leased line. Hence, they must grouped in the same
circuit.
Related Information
Connection table on page 171
164
Circuit table
20.1 Circuit Row Edit

The Circuit Row Edit dialog box is used to configure the basic characteristics of a circuit
record. Circuit records are associated with connections through the Connection Row Edit
dialog box.
Figure 124 - Circuit Row Edit dialog box
fields.
Table 36 - Items on the Circuit Row Edit dialog box

Items Description
record from the Circuit Select dialog box.
165
Collect table
21 Collect table
Collect records are used to configure the collection of data from the Analog, Rate, Remote and
Status tables. Collect records are located in the Collect table and are configured using the
Collect Row Edit dialog box.
Figure 125 - Collect Table Edit
The collection of some types of data (such as event messages and communication statistics)
and their transfer into the Historical database is performed automatically. However, the
collection of data from analog, rate, remote, and status tables can be configured.
166
Collect table
21.1 Collect Row Edit

Data collection into the Historical database is configured through the Collect Row Details
dialog box.
Figure 126 - collect Row Details dialog box
Through this dialog box, you can select the records and fields from which to collect data. These
fields are referred to as “fields on collect”. Refer to the table below for field descriptions and
Table 37 - Items on the Collect Row Details dialog box

Items Description
record from the Collect Fields dialog box. If this is a new record, you
have to specify the field in the Collect Fields PopUp dialog box.
Collect Type Click the drop-down arrow and select the method you want to use to
collect data from the record. The choices are:
• sample - Data is collected at periodic intervals. If this type is
selected, you must configure the Collect Period field.
• offline - Data is not collected. This setting can be used when you
want to stop collecting data temporarily without losing other settings.
• exception - Data is collected only when there is a significant change.

If this type is selected, you must configure the Deadband field. For
more information, refer to “Data Collection by Exception”.
Collect Period Click the drop-down arrow and select the time interval data should be
collected in if the Collect Type is set to sample.For example, to collect
every half hour, enter 30 and minute. The interval must be between one
minute and 60 minutes (inclusive) and must divide the hour evenly (for
example: one minute, five minutes, six minutes, 20 minutes, etc.). The
Collect Every: fields cannot be set beyond an hour.
Number of Periods Type the number of periods that should pass before data is collected.
Table continued…
167
Collect table
Table 37 - Items on the Collect Row Details dialog box (continued)

Items Description
This field is only configured if data is collected at set intervals (i.e.,

Collect Type is set to sample). For example, to collect every half hour,
enter 30 and then select the time period in the Collect Period field.
Deadband Type a deadband value to indicate the amount the acquired value must
change from the previous value before the new value is collected and
sent to the Historical database.
This field is only configured if the Collection Type is set to exception.
Enable Summary Select the check box to enable summarization of the data in the timeline
and accum database for the record.
Fast Trend only Select the check box to collect up to 200 RealTime values within a
circular buffer; it also collects a sample at the top of the hour.
This is only supported when the Type field is set to exception and the
Summary check box is not selected.
21.2 Data collection by exception

When a collect record is configured to collect data by exception, data is only collected when
there is a significant change.
To collect data by exception, set the Collection Type field in the Collect Row Edit dialog box to
exception. Data will only be collected if any of the following is true:
• The value has increased or decreased by an amount greater than or equal to the value in
the Deadband field.
• The data’s quality status has changed.
• The time is the start of the hour.
Collecting data on an exception basis usually requires less disk space. Collecting data by
exception from the RealTime database into the Historical database is similar to, but independent
of, reporting data by exception from remotes into RealTime.
NOTE: Regardless of whether data from a point is set to be collected periodically or by
exception, data is collected from the point at least once an hour, at the start of the hour.
21.3 Configuring a new collection entry

A collection entry can be configured for an analog, rate, remote or status record.
Procedure
1. Open the appropriate Collect Row Edit dialog box.

2. Click the arrow next to the Name field to open the Collect Select dialog box.
3. Select a field by clicking a row entry. This automatically loads the selected field into the
Name field on the Collect Row Edit dialog box.
4. Select the collection type.
168
Collect table
• Select sample to collect data at periodic intervals.
• Select offline to temporarily stop collecting data.
• Select exception to collect data only when there is significant change.

5. If Collection Type is set to sample, type the collection interval in the Collect Every field.
6. If Collection Type is set to exception, type a Deadband value that is the amount by which
the acquired value must change before a new value is collected.
7. Select Enable Summary if required.
8. Click Add.
Related Information
Collect Row Edit on page 167
21.4 Configuring an existing collection entry

A collection entry can be configured for an analog, rate, remote or status record.
Procedure
1. Open the appropriate Collect Row Edit dialog box.

2. Select the collection entry by clicking the row header of the field.
3. Perform the necessary changes..
4. Click Modify.
Related Information
Collect Row Edit on page 167
21.5 Deleting collection entries

Deleting collection entries is identical to the general procedure of deleting rows (records).
Procedure
1. Open the Collect Table Edit dialog box.

2. Select the desired row(s).
3. Click Table > Delete Row.
5. Click Yes in the Confirmation dialog box to save the changes to the database.
6. Click Yes in the Delete Row Confirmation dialog box. A check mark appears under the
Record Deletion column for each of the deleted rows.
Result
The collection process will delete the selected row(s) from the database.
NOTE: The delete is only immediate if there is no collect data pending to be written to the
Historical database. If there is pending data, the record is deleted once the data has
been written to the Historical database, and the delete might take around a minute to
complete.
169
Collect table
Related Information
Deleting records on page 47
170
Connection table
22 Connection table
Connection records are used to define connections that are used to communicate with remote
devices. Connection records are located in the Connection table and are configured using the
Connection Row Edit dialog box.
Figure 127 - Connection Table Edit
A connection is a communication channel from the host to a remote. In Omnicomm-specific

terms, a connection is a successful TCP/IP connection between Omnicomm and a terminal
server port.
Communication lines, which are managed by one or more Omnicomm processes, move data
between the host computer and the remote. Omnicomm processes are responsible for initiating
queries and moderating the communication medium. The associated connection record defines
the parameters for the communication lines.
Before configuring the Connection table, ensure that the appropriate entries exist in the host file
of the RealTime Services machine for the physical host that the connection will use. For more
information, refer to “Physical Connection Edit tab Connection Row Edit”.
Related Information
Physical Connection Edit tab Connection Row Edit on page 179
171
Connection table
22.1 Main tab Connection Row Edit

The Main tab in the Connection Row Edit dialog box is used to configure the basic properties
of a connection record. The fields in this tab define the connections and determine what type of
Omnicomm process and connection protocols are used.
Figure 128 - Main tab in the Connection Row Edit dialog box
fields in the Main tab in the Connection Row Edit dialog box.
Table 38 - Items on the Main tab in the Connection Row Edit dialog box
Items Description
Name Click the ellipsis button (...) and select the name of the connection
record from the Connection Select dialog box.
Table continued…
172
Connection table
Table 38 - Items on the Main tab in the Connection Row Edit dialog box (continued)
Items Description
Message Click the ellipsis button (...) and select the message associated with the
record from the Message Select dialog box.
The default message for a connection record is conmsg.
Omnicomm Click the ellipsis button (...) and select the Omnicomm process
Process associated with this connection from the Omnicomm Select dialog box.
Connection Click the drop-down arrow and select the name of the protocol driver
Protocol used with this connection. The choices are:
• No Protocol
• MODBUS
• OPC Client
Circuit Click the ellipsis button (...) and select the name of the circuit to which
this connection belongs from the Circuit Select dialog box.
If no circuit is selected, Omnicomm assumes the connection is
independent of all other circuits, for example, point-to-point IP
connection.
Issue Integrity Select the check box to request an integrity update whenever a
Update connection is established.
Automatically
Enable Connection Select the check box to enable connection FEP.
FEP
This applies only if a front-end processing driver has been developed for
the project.
Protocol Specific Type any additional parameters that may be required for the protocol
Configuration driver selected in the Connection Protocol field.
173
Connection table
22.2 Scan Edit tab Connection Row Edit

The Scan Edit tab in the Connection Row Edit dialog box is used to configure details of a
connection record. The fields in this tab help determine the communication mode and time limits
associated with the connections, pole-cycles and delay times.
Figure 129 - Scan Edit tab in the Connection Row Edit dialog box
fields in the Scan Edit tab in the Connection Row Edit dialog box.
Table 39 - Items on the Scan Edit tab in the Connection Row Edit dialog box
Items Description
Comm. Mode Click the drop-down arrow and select the communication mode used by
your system. Choices are:
• Host Poll - In host poll mode, communication is initiated and
controlled by the host. This is the common master-subordinate
polling mode. A communications poll cycle is a series of requests
Table continued…
174
Connection table
Table 39 - Items on the Scan Edit tab in the Connection Row Edit dialog box (continued)
Items Description
from the host computer to each of the on-scan remotes for data
gathered from telemetered devices.
The system typically does round-robin polling where the entire list of
remotes for a given connection is scanned in sequence.
In certain instances, the communications poll cycle time may need

adjustment. You can do this by adding delays either to certain
remotes or to the entire connection. You can also set up delays to
compensate for the inherent deficiencies in the communication
process.
• Remote Poll - In remote poll mode, the remote initializes normal

communications with Omnicomm. Instead of Omnicomm requesting
updates, the remote sends the update. Remote poll mode carried out
over a dial connection is referred to as cry-out mode.
• Listen Only - In listen only mode, the host interprets data, but
neither exerts control nor polls for data. This mode is often used
when one SCADA system is being replaced by another. The old
SCADA system still controls the system, but the new one listens to
the connections and accumulates data. The new system’s data can
then be compared with the data from the old system to ensure that
they are identical.
• Cry-Out - Cry-out mode is used in conjunction with a cry-out

connection. The actual methodology of this mode varies with the
protocol and the behavior expected by the protocol driver. Cry-out
mode is typically used with installations that have periodic
communication with a field device that “dials in” when a significant
event or alarm condition happens.
NOTE: Communication modes are configured on a project-by-project

basis. You can only select the modes used by your system.
No communication Type the value in seconds.
timeout (sec)
This field is dependent on the Comm. Mode selection.
If the Comm. Mode field is set to Host Poll, Remote Poll or Listen
Only, the value of this field is one factor in determining the maximum
time that is given to a remote to respond via the connection in question.
If any polled remote using this connection fails to respond within the
configured time, a No-Reply alarm is generated against the remote.
Reasonable settings for this field are 30 to 60 seconds on a leased line,

and 90 to 120 seconds or more on a dial-out circuit. Some remotes may
take several minutes to reply to the host. For Remote Poll and Listen-
only, if no data has been read on this connection for that time period, all
the active remotes on the connection will be marked as NO REPLY.
Table continued…
175
Connection table
Items Description
When Comm. Mode is set to Cry-Out, this field is used for a different
purpose. In cry-out communication mode, remotes dial in (or cry-out) to
the host. The fact that there are no remotes dialing in does not indicate
a failure condition. To ensure that the dial-in modem on the connection
is not in a confused state, which might prevent remotes from dialing in,
the modem is initialized if no incoming calls are received within the time
period specified in this field. The No Communication Timeout field is
set to a time interval wherein the host waits for a remote to dial in before
the attached modem is initialized (i.e., the modem is sent a connect
command sequence). The user-configurable initialization command (the
connect command sequence) typically forces a hangup followed by
auto-answer reconfiguration. A typical setting for this field is 3600
seconds (one hour). It is not recommended to set this field to a value
over 32000 seconds.
Maximum time to Type the maximum time (in seconds) required to establish a connection.
Connect (sec) The connection is between the Omnicomm process and the terminal
server's TCP/IP port. It does not include modems or remotes. If the
indicated time has expired and no connection has been established, the
system generates an alarm and declares the connection failed. A typical
setting is 10 seconds.
Reconnection- Type the delay time (in seconds) before attempting the next connection.
delay Time (sec) This delay only applies to temporary connections. A permanent
connection should always be connected unless it has no remotes.
Maximum Type the number of times that Omnicomm will attempt to open the same
Reconnect Tries connection before failing over to another connection.
Omnicomm will try to reconnect after the Maximum time to Connect
(sec) time has expired. Typical Maximum Reconnect Tries are 2 and
3.
Minimum Poll- Type the minimum time delay between the beginning of one poll cycle
cycle Time (sec) and the start of the next poll cycle. The system will wait if a Minimum
Poll Cycle Time delay is configured and the actual Omnicomm poll cycle
completes before the minimum poll cycle time expires. This time delay is
specified to:
• Reduce the load on the central processing unit
• Minimize phone line charges that are based on traffic or the amount
of data sent
In the figure below, A, B and C represent different remotes, if you set the
minimum poll cycle time to 60 seconds and the poll cycle takes only 10
seconds, then there is a 50 second wait at the end of the cycle.
Table continued…
176
Connection table
Items Description
Figure 130 - Poll cycle with a remote no-response delay
Number of Poll Type the number of times the system should retry obtaining data from a
Retries remote if the initial query fails. For example, if you type 3, the system
sends up to three additional queries to the remote. If the system has not
received any data after the configured number of retries, it continues to
poll at intervals defined in the No Response Delay field within the
remote record. For more information, refer to “Scan Parameters tab
Remote Row Edit”. This applies to poll attempts only – not to other types
of command requests.
Delay Between Type the delay time between polling remotes on a round-robin basis.
Remotes (ms) This delay only takes effect between remote records on a single
communication line and does not impact between poll cycles. Use the
field as required, as some field devices require “dead” time between
requests before they listen for the start of the next message. The field
indicates the delay time between successive polls. This delay before the
next poll:
Table continued…
177
Connection table
Items Description
• Allows the host to receive and ignore any garbage bytes, which may
have been placed on the line when a remote dropped the carrier
• Reduces the load on the host by preventing retires (i.e., repeated

queries from the host in a single poll)
• Minimizes telephone line charges if they are based on the amount of

data transmitted
• Allows radios to change into transmit or receive state
• Reduces the load on the central processing unit

Communication Type the delay time you want to allow for additional overhead required
Delay Time (ms) by the communications media (radio keying times or VSAT delays).The
field specifies the maximum expected delay for communication media
that have inherent delays (e.g., slow remotes, slow modems, poor
communications lines, or satellite transmissions). This delay:
• Allows for propagation delay, such as satellite transmission time
• Allows for slower-than-optimal communication rates by certain

communication lines
• Allows radios to change into a transmit or receive state
Some typical delay values are:
• Slow remote delay: 20-200 milliseconds
• Slow modem delay: 150 milliseconds
• Satellite delay: 5000 (depends on the type of satellite link)
• Poor line delay: depends on line quality
Related Information
Scan Parameters tab Remote Row Edit on page 274
178
Connection table
22.3 Physical Connection Edit tab Connection Row Edit

The Physical Connection Edit tab in the Connection Row Edit dialog box is used to configure
the connection type of a connection record. You can configure a network, dial or cry-out
connection.
Figure 131 - Physical Connection Edit tab in the Connection Row Edit dialog box
NOTE: When configuring the connection records for dial connection, dial connection delays
must be considered. Refer to “Dial connection delays” for more information.
fields in the Physical Connection Edit tab in the Connection Row Edit dialog box.
Table 40 - Items on the Physical Connection Edit tab in the Connection Row Edit dialog
box
Items Description
Connection Type Click the drop-down arrow and select the connection type used by your
system. The selection you make may affect the availability of other
fields. Connection types are:
Table continued…
179
Connection table
box (continued)
Items Description
• Network - This is the most commonly used connection type. In a

network connection, the host is always connected to the remote via a
TCP/IP connection. With leased line, for instance, the connection
may go through a terminal server. This type of connection is used
when remotes are connected through a terminal server via leased-
line modems or radios OR when remotes are directly connected
through a terminal server via an RS-232 connection.
• Network UDP - This connection type is chosen for a remote that is

directly connected to a WAN or LAN (for example, 10 base T). For
this type of connection, a remote must have an IP address.
• Dial - In a dial connection, the host connects to the remote via a dial-
out modem. A dial connection requires a modem record in
conjunction with a connection record in order to form a complete
connection. A dial connection defines the phone number used to
obtain a communication path, behaviors such as dial retries and time
to wait for auto answer, and the preferred modem bank (Mbank)
record to be used for a modem.
At the time the connection is established, a dynamically associated

modem is obtained from the preferred bank of modems to form a
complete dial connection.
• Cry-Out - This connection type is a dial-in connection that allows the

remote to initiate the dial connection. This is similar to a dial
connection except that the preferred modem bank and modem must
be configured as a cry-out. In this type of connection, it is the field
device, no the host, that controls the establishing of a communication
path.
Term. Server/Host Type the terminal server, host name, or an IPv4/ IPv6 address.
Name
For a Network or Network UDP connection, this field contains the host
name of the terminal server or remote. The host name must be defined
in the DNS or the %SystemRoot%\system32\drivers\etc\hosts file in the
RealTime machines.
Port Number Type the specific port connection for the line at the terminal server or
remote. This port definition varies depending on the brand of the
terminal server. For example:
port number = 2000+(100*port)
For example, Port 4 on the terminal server has a port number of 2400.
Default Signal Click the ellipsis button (...) and select an existing signal configuration
Configuration from the Sigconfig Select dialog box. This field is critical for all
connection types.
A dial connection, for instance, uses the default signal configuration
defining the connection between the modem in the field and the remote
Table continued…
180
Connection table
box (continued)
Items Description
(i.e. when the baud rate is determined at the modem, it uses the baud
rate that was set in the signal configuration).
Before you can use the modem, this field must match that of the modem
record.
The default signal configuration is also important for connections that do

not require modem configuration, such as leased-line multi-drop modem
connections or direct-connected RS-232 line connections. The default
signal configuration must match the bit-rate speed of the remotes that
are using the connection. This match is critical: communication timeout
values are calculated by multiplying the expected data length by the bit-
rate speed. The wrong input value could cause the rejection of valid
responses.
Temporary Select the check box to indicate that this connection is closed as soon
Connection as the minimum number of poll cycles have been completed and that
there are no outstanding command requests.
Delay between Type the time delay (in seconds) between temporary connections. This
Temp Connections field is only enabled if Temporary Connection is selected.
Min. # of Poll Type the minimum number of poll cycles required before the connection
Cycles Before releases its modem and closes. This field is used with temporary
Release connections or dial connections that have round-robin polling enabled.
Preferred Modem Click the ellipsis button (...) and select a preferred modem bank for the
Bank connection from the Mbank Select dialog box. For more information,
refer to “Modem bank table”.
Dial Telephone # Type the dial telephone number of the remote, prefaced by a t for tone
or p for pulse.
Use a comma (,) to indcate a pause. For example, a pause might be
required after dialing 9 to reach an outside line (e.g., t9, 3035551212)
Before you can dial using the connection, the modem connection strings
must be defined in the modem records.
# of Dial- Type the number of times to attempt dialing the phone number before
connection Retries declaring failure.
Max. # of Dial- Type the number of connection failure that should occur before the
connection Failure system generates a dial connection failure alarm/event.
Auto-answer Type a delay (in seconds) during which the modem in the field can
Timeout (sec) answer the phone call. This is the amount of time to wait for a response
after sending a dial string, which is the Telno string as defined in the
Commands tab in the Modem Row Edit dialog box.
Related Information
Modem bank table on page 198
181
Connection table
22.4 Inhibits tab Connection Row Edit

The Inhibits tab in the Connection Row Edit dialog box allows you to inhibit events and
alarms associated with the connection record.
Figure 132 - Inhibits tab in the Connection Row Edit dialog box
You may inhibit alarms and events resulting from changes to normal or off-normal states.
Normal and off-normal states for a connection are determined by alarms that are related to the
following:
The table below lists some typical delay values.
182
Connection table
Table 41 - Typical transmitter/receiver extra time

Type of Delay Typical Extra Time Comments
(Milliseconds)
slow remote 20 to 200
slow modem 150
satellite 5000 Depends on the type of satellite link
poor line ? Depends on line quality
fields in the Inhibits tab in the Connection Row Edit dialog box.
Table 42 - Items on the Inhibits tab in the Connection Row Edit dialog box
Items Description
normal state.
normal state.
normal state.
state.
22.5 Sample connection record configuration

A connection record is where you configure the delays and timeouts that apply to a connection.
The sample provided shows example configurations for a connection record using a permanent
leased, temporary dialup and permanent VSAT connection.
The Main tab in the Connection Row Edit dialog box is used to configure settings associated
with the speed of the connection. The Scan Edit tab is used to determine communication mode
and time limits associated with connections, pole-cycles and delay times. The Physical
Connection Edit tab is used to configure the connection type.
The following tables provide sample field settings for three different kinds of connections
(leased line, dialup and VSAT) in the Scan Edit and Physical Connection Edit tabs.
NOTE: The examples in this section use host poll, the common master-subordinate polling
mode.
183
Connection table
Table 43 - Sample Scan Edit tab field settings for the connection record
Sample Scan Edit tab field settings
ADE Field Perm. Temp. Perm. Notes
Leased Dialup VSAT
Comm. Mode Host Poll Host Poll Host Poll
Max. Time to 60 120 60 This is the maximum overall time required
Connect for a connection to be established. It is
usually higher for a dial connection
because the host has to dial and then wait
for the modem in the field to answer. It
tends to be lower for VSAT, since the
connection is usually to a local VSAT
router.For dial connections, if this timeout
and several other timeouts in the modem
and connection records do not meet certain
criteria, the host may dial the remote
continuously. For more information, refer to
“Dial Connection Delays”.This field is also
used with dial connections as a timeout for
modem reservations. If the system does
not obtain a modem before this timeout
expires, it generates an alarm.
Reconnectio 30 30 30 When a connection attempt fails, this
n-delay Time number represents the delay before the
next attempt is made.For a temporary
connection, this is the amount of time
between when a connection is closed and
when it is re-established.
Min. Poll- 15 0 30 This value, configurable for host poll mode
cycle Time only, is the minimum time between the
beginning of one poll cycle and the
beginning of the next poll cycle. You can
configure it to minimize communication
charges based on traffic or amount of data
transferred. Since VSAT charges are based
on the amount of data transferred, this time
is generally longer for VSAT connections to
reduce the frequency of poll data
commands.Dialup configurations typically
use the remote scheduler to poll at specific
times during the day, rather than using the
“poll-cycle” round-robin method. For more
information, refer to “Remote scheduled
events configuration”.
Number of 2 3 2 This field is configurable for host poll mode
Poll Retries only. It specifies the number of times the
host should retry obtaining data from a
remote if the initial query fails.The number
of poll retries is usually higher for dial
connections, since they are most likely to
get a noisy line. The number of retries
should be large enough to prevent
nuisance alarms, but not so large that
Table continued…
184
Connection table
Table 43 - Sample Scan Edit tab field settings for the connection record (continued)
Sample Scan Edit tab field settings
Leased Dialup VSAT
Omnicomm holds onto the line for too long
a time, which results in high line charges.
Delay 25 0 50 For host poll mode only, this delay
Between distributes polls around the poll cycle.
Remotes When using microwave radios, this delay
(ms) can be configured to account for keying
times.The lower limit for this field is zero;
use it as desired.
Communicati 1000 1000 5000 This is the maximum, additional overhead
on-delay required because of delays inherent in the
Time (ms) communications medium. It is always
higher for VSAT to account for propagation
delay.
Table 44 - Sample Physical Connection Edit field settings for a connection record
Physical Connection Edit tab field settings
Leased Dialup VSAT
Connection Network Dial Network Leased-line and VSAT configurations
Type commonly use the network connection
type. This connection type is used when
remotes are connected to the host through
a terminal server via leased-line modems
or radios, or when remotes are connected
directly through a terminal server via
RS-232 connection.Dial configurations use
the dial connection type. This connection
type is used when remotes are connected
to the host via dial-out modem. Dial
connections require that you configure both
connection and modem records.
Port Number 2300 N/A 2100 For leased-line and VSAT connections, this
is the specific port connection for the line at
the terminal server (or remote for TCP/IP-
connected remotes). The port number
varies depending on the brand of terminal
server.For temporary dial connections, the
port number is stored in the modem record,
as a modem may be used for more than
one connection.
Dial N/A 14035551 N/A A dial telephone number is required for dial
Telephone # 212 connections only. This number is
configured in the connection record rather
than the modem record because, in many
case, modems are dynamically allocated
and can be used to dial many different
connections. Note that before you can dial
Table continued…
185
Connection table
(continued)
Leased Dialup VSAT
using a connection, the modem connection
strings must be defined in the modem
record. The contents of the Dial Telephone
# field are inserted in place of the %s
placeholder in the connect command string
for the modem.
# of Dial- N/A 2 N/A For dial and cry-out connections only, this
connection is the number of dial attempts made before
Retries the host declares the connection “failed.”If
this timeout and several other timeouts in
the modem and connection records do not
meet certain criteria, a situation could arise
in which the host dials the remote
continuously.
Max. # of N/A 5 N/A For dial and cry-out connections only, this
Dial- is the number of consecutive dial
connection connection failures that must occur before
Failure the system generates a failure alarm.
When the number of failures exceeds this
threshold, the system generates only one
alarm. No further alarms are generated
while the dial connection remains in the
failed state.
Auto-answer N/A 30 N/A This timeout – configurable for dial
Timeout (sec) connections only – is the number of
seconds allowed for the modem in the field
to answer a call. (i.e., the amount of time
the host waits for a response after sending
a dial string.) This delay is added to the
delay configured for a dial command in the
Timeout field of the Modem Command
Configuration dialog box. Refer to “Sample
modem record configuration”.
If this timeout and several other timeouts in
the modem and connection records do not
meet certain criteria, a situation could arise
in which the host dials the remote
continuously.
Temporary No Yes No A temporary connection is closed as soon
Connection as the minimum number of poll cycles is
completed provided there are no
outstanding command requests.
Min. # of Poll N/A 2 N/A For temporary connections or dial
Cycles connections, this is the minimum number of
Before poll cycles that must be completed before
Release
Table continued…
186
Connection table
(continued)
Leased Dialup VSAT
Omnicomm releases the modem and
closes the connection.
Default 7N1200s 7E9600s 8N4800s Default signal configuration is critical for all
Signal Config 2 1 1 connection types.For leased-line, multi-
drop modem connections or direct RS-232
line connections, the default signal
configuration must match the bit-rate speed
of the remotes that are using the
connection. This allows the host to
calculate communication timeout values.A
dial connection uses the default signal
configuration that defines the connection
between the modem in the field and the
remote. Note that the default signal
configuration in the connection record must
match the one in the modem record before
the modem can be used.
Related Information
Sample modem record configuration on page 227
Dial connection delays on page 229
Configuring a remote scheduled event on page 282
187
Group table
23 Group table
Group records are contained by the Group table and are configured using the Group Row Edit
dialog box. Group records are used to define collections of devices that should be viewed/
controlled together.
Figure 133 - Group table
A group record is assigned to all records associated with this collection of devices, which are
generally in close proximity to each other within a given geographical area. This area-group
relationship is typically established by listing all of the different views (or areas) that must be
present on the system and then grouping together all devices not split by an area boundary. The
collection of devices will have a variety of points that correspond to analog, status, rate,
multistate, and remote records. All of these records are assigned to the same group record for
the devices to which they belong, creating groups of data.
When views are required by station and geographical area, then the group is used to display the
devices that can be controlled at each operating station. The operating station includes all
groups in the geographical areas that they are supposed to monitor.
The Group table is used to associate individual telemetry points the collections of devices,
which are then associated with areas of responsibility. The group record provides a logical
grouping of remotes and attached end-devices.
• Group assignments are specified for each remote in the Remote table and for each field
device in a RealTime table such as the Analog, Rate, or Status table. Any field device whose
data is gathered by a RealTime table (remote, analog, rate, or status) can belong to only one
group.
• A group may belong to multiple areas. To indicate that a telemetry point belongs to all areas
of responsibility, you must specify group 0 in the appropriate record (remote, analog, status,
rate, etc.). If you specify group 0, meaning no group is configured, the point’s record appears
188
Group table
in all table summaries on all operator stations even when no view areas are selected. Alarms
from these points are sent to all operator stations configured to receive system alarms.
Each group record also specifies a spooler to which alarms and messages are sent. The
spooler can be one or more of the following:
• A direct connection to a printer
• A connection to a printer on an ezXOS PC
• A file
If only one group record is defined in your system, all event messages are printed through the
specified spooler, which can address up to 10 printers. Additional group records, which
reference other printers on the system, may be defined. If records that are already associated
with remotes and other end-devices are linked to these additional group records, then the event
messages concerning these remotes and end-devices are routed accordingly. Any or all groups
can specify the same printer.
23.1 Group Row Edit

The Group Row Edit dialog box is used to configure a group record. This dialog box defines the
group record and the spooler.
Figure 134 - Group Row Edit dialog box
fields in the Group Row Edit dialog box.
189
Group table
Table 45 - Items on the Group Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the group record
from the Group Select dialog box.
Spooler Click the ellipsis button (...) and select the name of the spooler record
you want to use from the Select dialog box. A spooler record exists for
every RealTime database printer in the system.
190
Job Scheduler table
24 Job Scheduler table

Job scheduler (jsh) records are used to schedule commands for execution. Jsh records are
located in the Jsh table and are configured in the Jsh Row Edit dialog box.
Figure 135 - Jsh table
You can run any ACE or C program on a periodic basis through the Jsh table. Jsh records are
automatically created whenever periodic execution is selected. These records appear with the
text “System use only - Do not delete/modify” in the Description field.
191
Job Scheduler table
24.1 Jsh Row Edit

The Jsh Row Edit dialog box is used to configure the schedule and command details of a task
that needs to be executed.
Figure 136 - Jsh Row Edit dialog box
fields in the Jsh Row Edit dialog box.
Table 46 - Items on the Jsh Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the jsh record from
the Select dialog box.
Table continued…
192
Job Scheduler table
Table 46 - Items on the Jsh Row Edit dialog box (continued)

Items Description
Configure Click the button to open the JSH Schedule dialog box. This dialog box
Scheduled Time... is used to set the date and time a command will run or set the command
to run periodically.
Refer to “Configuring the schedule of a task” for more information.
Month This field states which month the command will run. Click Configure
Scheduled Time... to edit this value.
Day This field states which day the command will run. Click Configure
Time This field states the time when the command will run. Click Configure
RSI This field states the periodic interval at which the command will run.
Click Configure Scheduled Time... to edit this value.
Command Type Click the drop-down arrow and select the command type. The choices
are:
• SCRIPT - This is the most common choice. This works for Perl
commands as well as ACE and C programs.
• C/BASIC
Command Type the command to be executed or click the ellipsis button (...) and
select a command from the Schedule Command Edit Form dialog box.
The format depends on the type of the command. Enter it as it would be
entered from the MS-DOS command prompt.
Service Location Click the drop-down arrow and select the RealTime service on which the
command should be executed. The choices are:
• Hot - The command is executed on a hot RealTime service.
• Standby - The command is executed on a standby RealTime

service.
• Both - The command is executed on both services.
Table continued…
193
Job Scheduler table
Table 46 - Items on the Jsh Row Edit dialog box (continued)

Items Description
Command Type the command argument.
Argument
If the C program uses a single integer argument (i.e., a parameter), the
argument can be passed through the Argument field. Programs that use
multiple arguments or non-integer arguments must be invoked as script
commands, and the parameters must be passed on the command line.
ACE routines can be invoked using fnput.

Enable Execution Select the check box to activate the command. This should be done
after the scheduling is set up.
When the specified time occurs, the command is sent to the process or
script. The command executes the program and passes any configured
parameters into the program’s variables. A value is obtained or a control
functions is performed within the system. The transaction occurs every
time the configured time has elapsed.
Related Information
Configuring the schedule of a task on page 194
24.1.1 Configuring the schedule of a task

Use the JSH Schedule dialog box to configure the date and time you want the command to run.
Before you begin

Access the JSH Schedule dialog box by clicking the Configure Schedule Time button in the
Jsh Row Edit dialog box.
194
Job Scheduler table
Figure 137 - JSH Schedule dialog box
Procedure
1. Select the Run At check box.

Clear the check box if you do not want to configure the command to run at a specific date
and time, and proceed to Step 5.
2. Select the month in which you want the command to run by doing one of the following:
• To choose a particular month, select Month and use the drop-down to select the desired
month in which you want the command to run.
• To have the command run every month, select Every Month.

3. Select the day you want the command to run by doing one of the following:
• To choose a particular day of the week, select Day of Week, and use the drop-down to
select the day.
• To choose a particular date, select Date and type the desired day of the month.
• To choose the last day of the month, select Month End.
• To have the task run every day, select Every Day.

4. Select the time you want the command to run by doing one of the following:
195
Job Scheduler table
• To choose a particular time of day, select Time of Day, and type the time you want the
command to be run.
• To have the task run every hour, select Every Hour at, and type the minutes past the
hour in the Minute field. The command will run every 60 minutes at the specified number
of minutes past the hour.
5. (Optional) Select Repeat Every to run the command periodically.
a) Type the hour in the Hour field.
b) Type the minutes past the hour in the Minute field.

For example, if 1 is entered in the Hour field, and 30 is entered in the Minute field, then
the command runs every 1.5 hours. If 0 is entered in the Hour field, and 30 is entered in
the Minute field, then the command runs every 30 minutes.
If the specified interval in minutes is a factor of 60 (e.g., 1, 2, 5, 6, 10, etc.), the first
execution will be at a time that permits execution at the start of the hour. For instance, if
the current time is 02:53, and the repeat scheduled interval is five minutes, the first
execution is at 02:55.
6. Click Accept to accept the scheduling configurations.
CAUTION: These execution times are local time, so care must be taken for periods when
daylight savings time starts and ends. If jobs must only be run once per day, avoid
scheduling them in the changeover hour. In many locations, requests that are
specified to run at times between 2:00 AM and 3:00 AM on the first Sunday in April
do not execute because of the change to daylights savings time. Requests that are
specified to run at times between 1:00 AM and 2:00 AM on the last Sunday in
October execute twice.
24.2 Job Scheduler and DistribuSyS

Records in the Jsh (job scheduler) table schedule jobs for execution. In a DistribuSyS
environment, each Jsh record has a dataset.
The value of this dataset determines where the record is replicated, as well as the ownership
privileges associated with the record. The ownership privilege controls the systems that are
permitted to execute the job. The dataset also defines the systems that should receive record
configuration changes.
The jsh table treats dataset 0 as a local dataset. The functionality allows you to locally execute
a jsh record with a dataset value of 0, rather than outside of the local services by the RealTime
replication server. All of the other tables treat dataset 0 as an incomplete record definition, and
do not process the record.
When a system is set up initially, all of the jsh records have their dataset values set to 0, and all
of the systems get identical copies of these jsh records. Systems are able to modify their jsh
records to suit their own needs, and those changes are not replicated to other systems. This
means, for example, that only one record is required for the jsh savedata job. Instead of having
one record for each system, this record can be modified on each system as needed. The
advantage is that fewer records are required.
Records for the current system are processed by the job scheduler if one of the following
applies:
196
Job Scheduler table
• The jsh record has a dataset value of 0.
• The privileges that are associated with the jsh record non-zero dataset indicate that it is
owned by the current system.
As calculated telemetry points are configured, the jsh records associated with these telemetered
points (as well as some task control block (TCB) records) are added automatically. Each of
these records has the dataset value of the associated point. For new jsh records not associated
with a point, their datasets are associated with privileges for the current system. In both of these
cases with non-zero datasets, jsh acts like all of the other tables as regards to execution and
replication. The jsh record acts like a typical record, which executes only in the owning system
and replicates changes only to systems that belong to that dataset privilege.
NOTE: It is incorrect to have a jsh record associated with a point on a system that does not
own or use the point.
24.3 Pre-configured job scheduler records

A number of pre-configured job scheduler (jsh) records exist on your system that should not be
deleted.
A number of pre-configured jsh records exist on your system. These contain the warning “Do
not Delete” or “System Use Only - Do not Delete” in the Description field. Schneider Electric
has installed these to perform system operations. Pre-configured records that may exist on your
system are listed in the table below.
Table 47 - Pre-configured jsh records

Record Name Description
SaveDB, SaveDayDB, Save These records periodically back up the RealTime database to
WeekDB the save.dat file.
archive This record periodically archives Historical data.
cleanup This record purges Historical data that are no longer needed.
ALMSUMpurge This record purges the Alarm Summary of acknowledged alarms
when their configured time to remain in the summary after
acknowledgement has expired.
Other pre-configured records that perform specific time-based functions may also exist on your
system.
CAUTION: These pre-configured records should not be deleted. Generally, they should not
even be modified. Although you may need to change the execution times, many
jobs must be executed at specific times. Other jobs, such as archiving, are run
during quiet evening periods to prevent interference with normal operations. Make
sure that all of the system conditions and program requirements are known before
making any changes.
197
Modem bank table
25 Modem bank table

A modem bank (Mbank) is a logical grouping of modems that assigns modems to connections.
Mbank records are located in the Mbank table and are configured in the Mbank Row Edit
dialog box.
Figure 138 - Mbank table
Connections request the use of an unspecified modem from a modem bank. The modem bank
assigns a currently-unused modem to the connection. If there are no modems available at the
time of request, the modem bank places the connection’s request on a queue. The next
available modem is then assigned to the connection.
For dial connections, a modem bank is a set of modems that can be used interchangeably. For
instance, a project may have twenty dial connections but only ten modems. Using modem
banks, the project may opt to assign the first five modems to the first ten connections, and the
next five modems to the remaining connections. The modems will then be assigned,
dynamically, to the connections as needed.
198
Modem bank table
25.1 Main Tab Mbank Row Edit

The Main tab in the Mbank Row Edit dialog box is used to configure the basic properties of an
Mbank record, such as its name and associated group and message records.
Figure 139 - Main tab in the Mbank Row Edit dialog box
fields.
Table 48 - Items on the Main tab in the Mbank Row Edit dialog box
Items Description
Name Click the ellipsis button (...) and select the name of the Mbank record
from the Mbank Select dialog box.
Message Click the ellipsis button (...) and select the mbank message record
associated with this point from the Select dialog box.
Table continued…
199
Modem bank table
Table 48 - Items on the Main tab in the Mbank Row Edit dialog box (continued)
Items Description
The mbank message set indicates the state of the modem bank (e.g.,
LOW MODEMS, NO MODEMS, NORMAL).
Modem Bank Used Select the check box to use the modem bank for dial-in modems
for Cryout (cryout). Selecting this option disables the # Reserved For Commands
field.
Clear the check box to use the modem bank for dial-out modems
(normal connections and commands).
# Reserved for Type the number of modems that are reserved for operator commands.
Commands
If one of these reserved modems is in use, the next available modem in
the modem bank is reserved for commands. This allows Omnicomm to
keep a specified number of modems free to accept operator commands
(such as digital and setpoint commands). This option is not available
with cryout.
Operator commands are accorded the highest priority. For more

information, refer to “Remote connection join table”.
Related Information
Remconnjoin table on page 287
200
Modem bank table
25.2 Inhibits Tab Mbank Row Edit

The Inhibits tab in the Modem Bank (Mbank) Row Edit dialog box allows you to inhibit events
and alarms associated with mbank records
Figure 140 - Inhibits Tab in the Mbank Row Edit Dialog Box
fields.
Table 49 - Inhibits tab in the Mbank Row Edit dialog box

Item Description
Off-Normal Alarm Select the check box to inhibit off-normal alarming. The
system will not generate an alarm when the point changes
from a normal state to an off-normal state.
Normal Alarm Select the check box to inhibit normal alarming. The
system will not generate an alarm when the point changes
from an off-normal state to a normal state.
Off-Normal Log Select the check box to inhibit off-normal logging. The
system will not log an event when the point changes from
a normal state to an off-normal state.
Normal Log Select the check box to inhibit normal logging. The system
will not log an event when the point changes from an off-
normal state to a normal state.
201
Message table
26 Message table
Message records are used to configure the appearance and message text that is applied to
states and alarms viewed in ezXOS. Message records are located in the Message Set table.
Figure 141 - Message Table Edit
The application code that generates an alarm manages all aspects of system alarm
presentation, you have no control over the way these alarms appear. Database alarm
presentation, however, is more flexible. For each record, telemetry tables (e.g. analog, rate,
status) can be configured individually for the following:
• The severity assigned to the alarms
• The message text applied to a state
• The color of the record in any given state
In addition, alarm/event inhibiting allows you to decide whether or not the record generates
alarms and events.
The system administrator level of access allows configuration of ezXOS colors in alarm
summary displays and the annunciation of alarms.
202
Message table
26.1 Message Row Edit

Use the Message Row Edit dialog box to configure the appearance of a state in ezXOS.
Figure 142 - Message row edit dialog box
Message sets can be created as system needs arise; however, baseline message sets should
not be altered because these provide a test set proven to be valid. New message sets can be
created by clicking Functions > Create Message Set on the toolbar.
fields.
Table 50 - Items on the Message Row Edit dialog box

Items Description
Point Number This field represents the record’s slot number in the database. It is a
read-only field and cannot be edited.
Set Name This field defines the unique name of this message set. It is a read-only
field and cannot be edited.
Name This field displays the name of the table record. It is a read-only field
and cannot be edited.
State Name Type the name of the state in the message set.
Table continued…
203
Message table
Table 50 - Items on the Message Row Edit dialog box (continued)

Items Description
Foreground color Click the drop-down arrow and select a color.
This field defines the RealTime color of attach objects, such as devices
and text messages, as they appear on the ezXOS dialog boxes and
windows.
Typical color assignments for alarm severity levels are red for high,
yellow for medium, and green for low severity. If a message state is
severe enough to justify attaching a red color (Foreground color field is
set to red), then the state severity should match this message state
(State Severity field should be set to high). If a message state uses a
color (e.g., magenta, cyan, white) that is not defined for an alarm level, it
is recommended that this message state be assigned a low state
severity level.
State Severity Click the drop-down arrow and select the state severity option you want
associated with this message. The choices are:
• low
• minor
• medium
• major
• high
• critical
Image File Name Click the ellipsis button (...) and select the icon you want to appear with
this message from the Image Selector dialog box.
Raw Value Type the raw value of the multistate record as it would be received from
the remote. This value represents the message state text.
NOTE: This field is only used by multistate. Refer to “Multistate table”
for more information.
Related Information
Image Selector dialog box on page 205
Multistate table on page 230
204
Message table
26.1.1 Image Selector dialog box

The Image Selector dialog box lists all the images and animations that can appear on a
message.
Figure 143 - Image Selector dialog box
205
Message table
26.1.2 Creating Message Sets

You can create a message set through the Functions menu in the toolbar of the Message Row
Edit dialog box.
Figure 144 - Functions Menu for Message Row Edit Dialog Box
Procedure
1. Select Create Message Set from the Functions menu on the Message Row Edit dialog box.
Step Result:
Figure 145 - Create a Message Set Dialog Box
The Create Message Set Dialog Box appears

2. Enter the Name of the Message Set to create in this field.
3. Type the number of messages in the field beside Enter number of Messages in the Set.
4. Click Accept.
Step Result: A new row is added in the Message Set table, which can be viewed through
ADE. Each of the messages in the set will appear as rows in the Message table of the new
Message Set. You can edit the content of a message by double-clicking it and configuring
the message Row Edit dialog box that appears.
206
Message table
26.1.3 Deleting Message Sets

You can delete message sets through the Functions menu in the toolbar of the Message Row
Edit dialog box.
Figure 146 - Functions Menu for Message Row Edit Dialog Box
Procedure
1. Select Delete Message Set from the Functions menu on the Message Row Edit dialog box.
Step Result: The Delete a Message Set

dialog box appears. The message set that was selected in the Message Row Edit will appear
in the Delete the Message Set field by default.
2. Type the name of the message set to delete in the field, if it does not appear as the default.
3. Click Accept.
Step Result: The message set entered will be deleted. Click View > Refreshto confirm the
deletion.
26.2 State message sets

The RealTime database uses message sets to configure the appearance of state-related
messages.
Telemetered tables (analog, rate, remote, connection, and status) rely on the definitions in the
Message table to provide the following:
207
Message table
• Text messages associated with the current state of a point
• Color, which is used with dynamic values in the table summaries and user drawings
• Alarm severity information, which is used in the presentation of alarms in ezXOS
The “base + offset” scheme is used to access various state messages that apply to a given
device. During configuration of a telemetry record, a base message is specified in the Base
Message field. To generate a message, use the record defined in the Base Message field plus
an offset determined by the state of the device.
Message sets are used to define states that apply to particular situations. For example, specific
names for hardware components may be used in defining applicable states for these
components.
NOTE: Alarms may be generated for each of the states in the Message table. The state names
defined in a message set are shown in the alarm and event messages.
The following table shows the message sets that are used.
Table 51 - Typical message sets in the message table

Set used for Sets used for remote Sets used for Sets used for
analog and rate records connection omnicomm
records records records
Base Message analog rtu conmsg omnicomm
Record # 1 Normal No Reply No Connection Inactive
Record # 2 High Normal Connected Startup
Record # 3 High Normal Connected Active
Record # 4 Low Security Error Connecting Shutdown
Record # 5 Deviation Long Message Failed
Record # 6 High-high Short Message Error
Record # 7 Low-low Wrong Remote Retry
Record # 8 Instrument fail Offline Normal
high
Record # 9 Instrument fail SBO Rly Fail Bad Message
low
Record # 10 Rate of Change Database Error Poll Cycle
Record # 11 Off Scan Offline
Record # 12 Illegal Message Config Error
Record # 13 SBO Select Fail Unavailable mdm
Record #14 Line Failure Reservation mdm
Record #15 Hang-up mdm
Record #16 TX Error
Record #17 TX Short
Record #18 RX Error
Record #19 RX Short
Table continued…
208
Message table
Table 51 - Typical message sets in the message table (continued)

Set used for Sets used for remote Sets used for Sets used for
analog and rate records connection omnicomm
records records records
Record #20 RX None
Record #21 Success
26.2.1 Analog and rate messages

Use the Message table to set the message texts for analog and rate alarms.
The following table shows the message text used to indicate analog and rate alarms as set up
in the Message table.
Table 52 - Analog and rate alarm messages

Normal The value is in the acceptable (normal) state
High The value has exceeded the high limit (taking into account the deadband)
Low The value has exceeded the low limit (taking into account the deadband)
Deviation The instrument creep (deviation) limit has been exceeded
Hihi The value has exceeded the high-high limit
Lolo The value has exceeded the Low-low limit
Instrument fail hi The analog/rate instrument’s upper limit has been reached. The upper
limit is configured in the Maximum (raw) field on the Input tab in the
Analog Row Edit dialog box or the Input tab in the Rate Row Edit dialog
box.
Instrument fail low The analog/rate instrument’s lower limit has been reached. The lower limit
is configured in the Minimum (raw) field on the Input tab in the Analog
Row Edit dialog box or the Input tab in the Rate Row Edit dialog box.
ROC The rate at which the change in value has exceeded the specified limit
Related Information
Input tab Analog Row Edit on page 130
Input tab Rate Row Edit on page 257
26.2.2 Remote message set

The first record (i.e., Record #1) in each telemetered point’s message set usually indicates the
condition that is considered normal. However, for the remote set, the second record (i.e.,
Record #2) contains the normal state instead of the first.
This exception to the rule exists because fields containing RealTime data, such as the remote
records’ comsta field, are initialized to zero when the system starts up with a cold start.
Therefore, the communication status summary shows no reply for the remotes until they are
all successfully polled.
209
Message table
26.2.3 Status message set

The base message for status records depends on whether the device is a two-state or a four-
state device.
A two-state device only uses two messages: one state for the normal condition and the opposite
state for the off-normal condition (e.g., open and closed or vice versa). A four-state device may
have an additional transit state when the unit is in the process of performing a state transition,
and an error condition when the unit is not working.
Different message text groups are defined in the Message table according to the type of status
device. The table below lists the messages that are typically used for the different states of a
valve, a pump and a breaker. The text may vary to represent the interpretation of the various on/
open/start or off/close/stop states and the different error or transitional states.
Unless the Normally Open check box on the Input tab in the Status Row Edit dialog box is
selected for the status point, an Open/Running/Trip state of a field device should never be
described as a Close/Off state. For example, if the Close/Off state is used for a valve instead of
the Open/Running/Trip state, the SCADA system interprets the valve state as Close when it is
actually Open. Selecting the Normally Open check box for the status record inverts the sense
when the status raw value is converted to its EGU value.
Table 53 - Status alarm text

Valve
Error The valve is not operating (error).
Open The valve is open.
Close The valve is closed.
Transit The value is in transit from open to closed or from closed to open.
Pump
Error The pump is not operating (error).
Running The pump is operating.
Off The pump is not operating.
Sequence The pump is in transit between running and off, such as ramp up
sequencing.
Breaker
Error The breaker is not operating (error).
Trip The breaker has tripped (no electricity flowing).
Close The breaker has closed (electricity is now flowing).
For two-state status records (i.e., one-bit status) the middle two messages of the message set
are used so that the same message set can be used for one-bit and two-bit status points. The
second message in the set must be for the Open/Start/On/Trip state, and the third message
must be for the Close/Stop/Off state. If the field device does not return a value of 1 to indicate
the Open/Start/On/Trip state, then invert the sense of the status valve.
Related Information
Input tab Status Row Edit on page 304
210
Message table
26.2.4 Message Sets for Commandable Points

There are several words that you should not use when configuring message sets for
commandable points. If the point will be commanded through RVE, you should take special care
to avoid using words that will be interpreted keywords.
RVE recognizes the following words as keywords:
• bypass
• override
• confirmed
• xos
• command
When you command a point through RVE, any of these words will not be registered as part of
the command because they have a separate meaning within RVE.
It is important to avoid using these words when you configure your message sets to prevent this
problem when the message set is used to command a point through RVE.
211
Modem table
27 Modem table
Modem records are used to represent modems that dial to obtain a connection to one or more
remotes. Modem records are located in the Modem table and are configured using the Modem
Row Edit dialog box.
Figure 147 - Modem Table Edit
Omnicomm takes a host-centric view of what constitutes a “modem.” If a modem at the host end
must dial to obtain a connection to one or more remotes, then an Omnicomm record must be
configured for the modem. This applies whether or not the modem dials to the Public Switched
Telephone Network (PSTN) or within some kind of leased network.
All of the modems that are used for real time field communications with remotes are managed
using modem banks. A modem from this bank is assigned to a connection, usually on a
temporary basis, according to the former’s use and intended function.
An Omnicomm record is not configured for the following:
• Any modem attached to a remote unit (e.g., PLC or RTU)
• Any modem at the host end that does not require dialing
This applies to leased-line modems that are either multi-drop or point-to-point and to
combination radio/modems. Although Omnicomm must be correctly configured for these
devices, specific records on a per-radio or per-modem basis are not required. Necessary
configuration parameters reside in the associated connection and remote records.
212
Modem table
27.1 Main tab Modem Row Edit

Use the Main tab in the Modem Row Edit dialog box to set up the basic properties of the
record such as the group, modem bank, dataset and message records associated with the
point.
Figure 148 - Main tab in the Modem Row Edit dialog box
fields.
Table 54 - Items on the Main tab in the Modem Row Edit dialog box
Items Description
Name Click the ellipsis button (...) and select the name of the Modem record
from the Select dialog box.
Modem Bank Click the ellipsis button (...) and select the name of the modem bank
record that this record belongs to from the Mbank Select dialog box.
If this field is empty, the modem is dynamically assigned to any
connection that has an empty Pref. Modem Bank field. For more
Table continued…
213
Modem table
Table 54 - Items on the Main tab in the Modem Row Edit dialog box (continued)
Items Description
information, refer to “Physical Connection Edit tab Connection Row

Edit”.
A modem message set is not used to represent the various modem
states (e.g., connected). This message set is only used to represent
enabled or diabled modems and associated modem alarms.
Enable Cryout Select the check box if this modem is used for cryout.
Modem
The selection affects the options available in the Connect tab in the
Modem Row Edit dialog box. If Enable Cryout Modem is not selected,
the Telno option is removed from the Format drop-down list. The
entries should all be either Command or Baud.
Related Information
Physical Connection Edit tab Connection Row Edit on page 179
214
Modem table
27.2 Communications tab Modem Row Edit

Use the Communications tab in the Modem Row Edit dialog box to set up communication paths
to the modem and its configuration settings.
Figure 149 - Communication tab in the Modem Row Edit dialog box
fields.
Table 55 - Items on the Communications tab in the Modem Row Edit dialog box
Items Description
Terminal Server/ Type the IP addresses of the host terminal server or host computer.
Host Name These must be defined in the terminal server table, or as an entry in the
hosts file of the RealTime machines. Either an IPv4 or an IPv6 address
can be used.
Port Number Type the specific port connection for the line at the terminal server or
remote. This port definition varies depending on the brand of the
terminal server. For example:
Port Number = 2000 + (100*port)
Therefore, port 4 on the terminal server has a Port Number of 2400.
Table continued…
215
Modem table
Table 55 - Items on the Communications tab in the Modem Row Edit dialog box
(continued)
Items Description
Default Signal Click the ellipsis button (...) and select the name of the default signal
Configuration configuration the modem uses from the Sigconfig Select dialog box.
This indicates the maximum baud rate that the modem can use.
NOTE: The Default Signal Configuration entry must match the
default signal configuration of any connections using this
modem.
Modem Baud Map Enter the modem baud map.
Escape Sequence Type the length of the pause (in milliseconds) before an escape
Pre/Post Pause sequence is sent.
(ms)
After the escape sequence is sent, the time specified in this field is the
delay time before a connect, disconnect or check sequence is initiated.
A time of 1500 milliseconds is suggested.
Modem Escape Type the character that is sent three times to create the escape
Character sequence and put the modem into command mode.
The + character is typically used.
Message Type the number of additional bytes that the modem sends back with
Response padding responses.
For example, if the expected response is OK, but the modem actually
sends back <CR> <LF> OK <CR> <LF>, the additional padding value
is 4.
The message response padding can be determined by running SWANA

in “Append ASCII” mode on a dial connection.
Maximum number Type the maximum number of failed dial attempts before the system
of Failures generates a failure alarm or failure event.
To reach this value of failed attempts, typical modem responses must be
received. If upon attempting to dial a remote modem, no responses are
received to the “AT commands” (or whatever has been configured for
your modem), an alarm is generated after one failure regardless of the
value in this field.
216
Modem table
27.3 Commands tab Modem Row Edit

Use the Commands tab in the Modem Row Edit dialog box to configure the connect, disconnect
and check commands for the modem. It is used for both dial and cryout.
Figure 150 - Commands tab in the Modem Row Edit dialog box
The Command tab in the Modem Row Edit dialog box contain the following sections:
• Connect Commands - The fields in this area enable the connect configuration set, which
allows you to configure commands for connecting a modem. This is used for dial and cryout.
To ensure that the modem is hung up before connection is attempted, the first connection
217
Modem table
string (i.e., String to Be Sent) must always be the hang-up sequence (e.g., ATH\015\012\0).
This ensures that the host-swapping of modems and service/system failovers work properly.
• Disconnect Commands - The fields in this area enable the disconnect configuration set,
which allows you to configure commands for disconnecting a modem. This is used for dial
and cryout.
• Check Commands - A no reply response is a loss of carrier or dial connection. The field in
the check command-area enables the check configuration set, which is used when a no
reply response is received from a remote. This is used for dial only. For more information on
valid commands, refer to the modem’s command manual.
fields.
Table 56 - Items on the Commands tab in the Modem Row Edit dialog box
Items Description
String to Be Sent Type the string to send to the modem. It contains characters such as
<CR> (\015), <LF>(\012) and the end-of-string indicator (\0).
Examples:
This command puts a Hayes-compatible modem in command mode: ++

+\0
This command tells a Hayes-compatible modem to hang up: ATH

\015\012\0
Message OK (Optional) Type the expected response from the modem.

String
Example: OK
OK is a normal response to many commands.
Format Click the drop-down arrow and select one of the following formats:
• Unused: This format indicates that the command is not sent. When a
modem is being used, it starts at the first row and continues until it
either arrives at an unused row (successfully) or until it fails to
receive the desired response from a command (failure). This applies
to the connect, disconnect and check configuration sets.
NOTE: Setting the Format to Unused clears its rows and all the
rows below it.
• Command: This format indicates that no interpretation exists on the

string.
• Telno: This format expects the character “%s” in the string as

placeholder for the telephone number (configured in the Physical
Connection Edit tab in the Connection Row Edit dialog box). This
applies to the connect configuration set only.
Table continued…
218
Modem table
Table 56 - Items on the Commands tab in the Modem Row Edit dialog box (continued)
Items Description
• Baud: This format expects the character “%d” as placeholder for the
baud mapping value. This applies to the connect configuration set
only.
• Delay: This format ensures the subsequent format entry is not

performed until a specified duration has elapsed after the previous
one. This can be useful, for example, in accommodating modems
that are slow to change from command mode to data mode. The
delay is limited to 32 seconds.
NOTE: Setting the Format to Delay clears the corresponding

String to Be Sent and Message OK String fields.
Timeout Type the maximum time, in milliseconds, to wait for an expected
response.
For a Telno format, this delay is added to the additional wait time for
auto answer to give the overall delay time.
For a Delay format, the Timeout: column specifies the duration of the
delay.
Typically, the Delay format is used after setting the connect

configuration set’s Telno format and the check configuration set’s “ATO”
string to 1 or 2 seconds.
219
Modem table
27.4 Inhibits tab Modem Row Edit

The Inhibits tab in the Modem Row Edit dialog box allows you to inhibit events and alarms
associated with the modem record.
Figure 151 - Inhibits tab in the Modem Row Edit dialog box
fields.
Table 57 - Items on the Inhibits tab in the Modem Row Edit dialog box
Items Description
normal state.
generate an alarm when the point changes from an off-normal state to a
normal state.
normal state.
an event when the point changes from an off-normal state to a normal
state.
220
Modem table
27.5 RealTime field communications

RealTime field communications often use dial-out or dial-in modems. The primary difference is
that dial-in modems are used by remote field devices while dial-out modems are used by the
host.
A dial-in modem is used by the remote field device to communicate with the project site (host)
regarding alarm conditions.
A dial-out modem is used by the host to communicate with remote field devices. It can be used
for:
• Scheduled infrequent polling of remotes
• Polling of the remotes on demand (in response to a command from a user)
• An alternate communication line for polling the remotes
• A primary communication line or dedicated dial-out line (long-term connection)
27.5.1 Dial-out for scheduled infrequent polling

If a leased line connection to a remote is not economical because the remote requires
infrequent polling, the host can be configured to periodically use a modem to dial-out to the
remote and poll it.
Infrequent, periodic polling of a remote is scheduled in the Remote Scheduler tab for the
remote record.
Related Information
Remote Schedule tab Remote Row Edit on page 280
27.5.2 Dial-out on demand

“Dial-out on demand” means that each poll of a remote is initiated by a command from an
ezXOS workstation operator.
Demand polling may be desirable under the following conditions:
• When commands are being issued to a field device
• When solar/battery-powered remotes are used, and it is desirable to conserve power
• When devices/sites are used infrequently or on a seasonal basis
27.5.3 Dial backup

A modem can also be used as an alternate or redundant communication path to a remote. If a
remote’s primary line of communication degrades, the system can automatically fail over to a
backup modem line.
This is true if the field device is capable of communicating over the primary and alternate
connections simultaneously. Otherwise, the communications must be manually switched by the
operator from the primary connection to the alternate.
NOTE: To switch the remote to an alternate communication path, the operator sends a request
to the remote to switch communications to the alternate path. The operator does not
have to specifically select the modem as the alternate.
221
Modem table
Communications occur on both the primary and alternate line if the alternate connection is
established in automatic mode. The primary line continues polling for a response from the
remote to test the primary connection, but the data that is received is not processed. To inform
the operator of the line conditions, communication status and percentages of successful
communications are maintained for both the primary and alternate paths. The alternate line
polls the remote and processes all received data. Control commands are passed to the remote
through the alternate line.
When the alternate connection is no longer required, automatic failover can disconnect the
modem, or the operator can request the modem to disconnect, making it available for future
use. Communications then resume on the primary line.
27.5.4 Dedicated dial-out

A modem can also be used as the normal communication path (primary or alternate) to one or
more remotes.
27.6 Modem installation and configuration

To install and configure a modem, you must connect the modem to a hardware port, add a new
record to the modem table and, in some situations, configure a modem bank (Mbank) record for
that modem.
During the installation and configuration, the system does the following if it detects modem
errors:
• Generates an alarm
• Marks the connection as offscan
• Marks the modem as out-of-service
Omnicomm and Monitor Mbank control modems by maintaining a current modem state. The
current state of the modem is controlled through user-initiated requests and modem-initiated
signals.
A modem can be in one of eight possible states, as shown in the following table.
Table 58 - Modem states

Modem State Description
Available The modem is available for use.
Out-of-service One of the following is true:
• Omnicomm has detected an unknown error while attempting to use this
modem.
• The modem failed when tested by modem_test.
Disabled The modem has been manually disabled through a user request and made
unavailable for use.
In Progress The host is attempting to dial the connection through the modem.
Connected The host is connected and is executing any commands requested through
the modem.
Table continued…
222
Modem table
Table 58 - Modem states (continued)

Modem State Description
Disconnecting The host is breaking the modem connection or hanging up.
Testing This is set while the modem_test is testing to see if the modem is
functional or not.
Reserved The modem has been reserved for a specific connection, but is waiting for
the appropriate Omnicomm process to begin using the resource.
27.6.1 Hardware connections

Once the database has been configured, the modem must be physically connected to its port at
the host computer. A cable that supports the required signals is needed.
The cable used to connect the modem must be capable of supporting the following signals:
• RNG
• DTR
• XMT
• GND
• RCV
• DCD
• DSR
• RTS
• CTS
The manuals describing the modem and port should specify the correct wiring for the cable.
There should be no twist in the cable’s RCV and XMT pins. The modem should be connected to
the phone line after the database configuration and modem-port connection have been
completed.
27.6.2 Modem operations

Modem operations can be performed using the enable, disable and test commands.
Table 59 - Modem commands

Command Description
Enable This command places a manually disabled or out-of-service modem into an
available state. A modem must be in an available state for a connect
command to be issued.
Disable This command places a modem that is currently available or out-of-service into
a manually disabled state. This effectively removes the modem from service.
Test The frequency for testing is defined in the job scheduler (jsh) record that
contains the modem_test process (for more information, refer to “Testing dial-
out modems via modem_test”). If required, an individual modem can also be
tested. The test process determines the condition of the modem and places the
modem into either an available or an out-of-service state depending on its
condition.
223
Modem table
Related Information
Jsh Row Edit on page 192
Testing dial-out modems via modem_test on page 225
27.6.3 Modem command requirements

A limited and universal set of Hayes commands is used on the modem default configuration to
ensure that the system is compatible with a variety of different modems.
Typically, a modem should function correctly right from the box. If any changes are required to
the modem’s setup, they should be configured and saved using the AT&W command. The only
modem setup required is taken from the appropriate modem configuration.
The controls described in the table below are used when the modem is waiting for a connection.
Table 60 - Default controls

Control Description
+++ This places the modem into command mode. A typical configuration has a 1.5-
second pause before and after issuing this command. The modem should have
a guard time of no more than one second.
ATE0 This places the modem into no-echo mode.
AT&C1 This forces the modem to monitor the true state of Data Carrier Detect (DCD)
from the field modem.
AT&D2 This forces the modem to monitor the true state of Data Terminal Ready (DTR)
from the field modem.
ATH0 This forces the modem to go on-hook or hang-up the phone line.
AT&W This causes the modem to save the current configuration in non-volatile
memory.
ATD This causes the modem to dial a telephone number and attempt to establish
the connection with the field modem.
If a connection cannot be established, an error is reported. Refer to the “Commands tab in the
Modem Row Edit dialog box” for the last 16 responses. If the modem gets an unexpected
response (the usual response is “connect” or “busy”), the modem is declared out-of-service, and
the connection is declared offscan. If a connection is established, the system begins to poll the
remote indefinitely.
Related Information
Commands tab Modem Row Edit on page 217
27.6.4 Ensuring a connection still exists

If the communication status ever changes from the normal state, the system uses default
controls to ensure that a connection still exists.
The default controls are:
• +++
• ATHO
224
Modem table
Refer to “Modem command requirements” for descriptions of the commands. If the modem is
disconnected successfully, it is placed back into an available state. If the modem cannot be
disconnected successfully, it is placed into an out-of-service state.
Related Information
Modem command requirements on page 224
27.6.5 Losing the connection

When the system detects that a modem is being hung-up or the connection is being closed,
default commands are issued.
The default controls are:
• +++
• ATHO
Refer to “Modem command requirements” for descriptions of the commands. If the modem is
disconnected successfully, it is placed back into an available state. If the modem cannot be
disconnected successfully, it is placed into an out-of-service state.
Related Information
Modem command requirements on page 224
27.6.6 Testing dial-out modems via modem_test

The dial-out modem test process, modem_test, is run automatically according to the schedule
defined in the Job Scheduler (jsh) table.
When run automatically, the modem_test process tests a specific modem, or all modems
associated with the modem bank (Mbank) that are either available or out-of-service.
The modem-test process is used to test the availability of a modem, and whether or not it is
responding to commands. This process is only available on non-cryout modems and modem
banks.
Syntax
modem_test [-m modem_name][-b bank_name][-h][-w delay][-l]|-t telno]
Table 61 - mode-test options

Option and Description
parameter
-m modem_name If the -m option is specified and a valid modem name is given, the
modem_test process is run against only that modem.
-m modem_name If the -b option is specified and a valid modem bank name is given, the
modem_test process is run against all the modems in that bank.
-m modem_name This is the delay or wait-time between testing modems in a modem
bank. This is expressed in seconds and is only valid with the -b option.
Table continued…
225
Modem table
Table 61 - mode-test options (continued)

Option and Description
parameter
-m modem_name -l, which stands for local test mode, is the default mode. This mode
tests with the phone number “*”, which usually rings “busy” on most
systems but detects a “no dialtone” structure (same as -t t*).
-m modem_name This mode gives a telephone number (telno), prefixed by t or p for tone
or pulse, for use as the test number.
-m modem_name If the -h option is specified, the modem_test process displays the
syntax/usage message.
Initiating the modem_test process

The modem_test process can be initiated by a command or through the Modem Control
dialog box in ezXOS.
NOTE: The -m and -b options are mutually exclusive, but one must be set. If neither of these
options is specified, the modem_test process is run against all the modems in the
Modem table.
The modem_test process can be initiated in the following three ways:
• fnput mode.modem_name TEST
This command calls modem-test -m modem_name -1
• fnput mbank.bank_name TEST [telno]
This command calls modem-test -b bank_name -w5 -t[telno]. If [telno] is not

provided, it defaults to -1 for local test mode.
• Click Test Modem on the Modem Control dialog box, as explained in the Operation and
Control Reference.
Modem_test actions
Various modem states have different modem_test actions.
Table 62 - modem_test actions for various modem states

Modem States modem_test Action Result
• Available modem-test places the modem • Once the dial attempt has been
in a test state, then attempts to
performed, the modem record is
• Out-of-service dial using the given parameter.
updated with the succeed or fail
time.
• A failure from the available state

causes the state to change to out-
of-service.
• Success from the out-of-service

state causes the state to change
to available.
• Manual Disable No action takes place.
• Disconnecting
226
Modem table
Table 62 - modem_test actions for various modem states (continued)

Modem States modem_test Action Result
• Testing
• Connecting
• Connected
• Any Other State
The test process is invoked either automatically by the Jsh table, or manually from the ezXOS
Modem Control panel. The entry in the Jsh table must contain all appropriate command-line
arguments. The ezXOS command tied to the TEST button on the Modem Control panel uses
the default local test phone number (t*), which detects either a no-dial tone or a busy signal on
numerous telephone networks.
The process uses the following criteria to declare a modem either available or out-of-service:
• The modem must establish a connection to the test modem or get a busy signal
• The modem must then be able to disconnect from the test modem to be declared available.
If either operation fails, the modem is declared out-of-service. This test proves that the dial-out
modem’s phone line is functioning, the modem is accepting and responding to commands, and
the modem is able to transmit and receive signals via the connect tones.
27.6.7 Troubleshooting an out-of-service modem

A modem that is declared out-of-service does not necessarily mean the modem itself is non-
operational.
This procedure should be used when troubleshooting an apparently out-of-service modem.
Procedure
1. Cycle the power on the modem.

2. Ensure that all connections are satisfactory.
3. Ensure that the terminal server is functioning normally.
4. Ensure that the phone line is functioning normally.
5. Use modem_test.
27.7 Sample modem record configuration

To help with modem configuration, sample modem record configuration details are provided for
the Motorola V.3600 series modem and U.S. Robotics Sportster modem.
Modem records are configured only for modems at the host end that must dial to obtain a
connection to one or more remotes. Much of the information required for a dial connection
resides in the modem record.
The tables below provide sample configuration details for a Motorola V.3600 Series modem and
U.S. Robotics Sportster modem. A modem record must be configured to reflect the particular
type of modem that is used.
NOTE: For commands specific to the modem you are using, refer to the manual provided with
the modem.
227
Modem table
Table 63 - Sample modem command configuration - U.S. Robotics Sportster

String to Be Sent Description Message Format Timeout
OK String
Connect
ATH0\015\012 Hang up. OK Command 8000
ATE0\015\012 Don’t echo local characters. OK Command 3000
AT&C1&D2\015\012 Set local modem OK Command 1500
characteristics:
• DCD on while carrier is
present (&C1)
• DTR off causes

disconnection (&D2)
ATDT%s\015\012 Dial (using tone rather than CONNECT Telno 8000
pulse).
Disconnect
ATH0\015\012 Hang up. OK Command 8000
Check
ATO\015\012 Force modem into data mode CONNECT Command 8000
(as opposed to command
mode).
Table 64 - Sample modem command configuration (Motorola V.3000 Series)

String to Be Sent Description Message OK Format Timeout
String
Connect
ATH\015\012\0 Hang up. Command 5000
ATE&C1&D2\015\012\0 Set local modem OK Command 1500
characteristics:
• Local character echo
off (E)
• DCD on while carrier

is present (&C1)
• DTR off causes

disconnection (&D2)
ATDT%s\015\012\0 Dial (using tone rather CONNECT Telno 100
than pulse).
Disconnect
ATH\015\012\0 Hang up. OK Command 8000
Check
ATO\015\012\0 Force modem into data CONNECT Command 5000
mode (as opposed to
command mode).
228
Modem table
27.7.1 Dial connection delays

When configuring delays in the modem and connection records for a dial connection, the
maximum time to connect must exceed the product of the modem and connection timeouts
multiplied by the number of dial retrials.
The following must be true:
where:
• Auto-answer Timeout is configured via the Physical Connection Edit tab in the
• Dial command Timeout is the Timeout value for a dial command configured via the
Commands tab in the Modem Row Edit dialog box.
• # of Dial-connection Retries is configured via the Physical Connection Edit tab in the
• Maximum time to Connect is configured via the Scan Edit tab in the Connection Row
Edit dialog box.
If the maximum time to connect is less than the sum of the specified modem and connection
timeouts multiplied by the number of dial retries, then the host could dial the remote
continuously.
One way to manage dial connection delays is to set the Dial command Timeout to a very small
value, and then type the required delay in the Auto-answer Timeout field. Adding an extra
second to the Maximum time to Connect value also ensures that enough time is allowed.
Related Information
Scan Edit tab Connection Row Edit on page 174
Commands tab Modem Row Edit on page 217
229
Multistate table
28 Multistate table
A multistate record represents up to an 8 bit value indicating up to 256 discrete device input
states/text associations and 8 output command states. Multistate records are located in the
Multistate table and are configured using the Multistate Row Edit dialog box.
NOTE: You can expand the number of output commands from 8 to 256 by performing a
convertdb.
Figure 152 - Multistate Table Edit
The multistate record is similar to a status record. The table below demonstrates the differences
between the status and multistate records.
Table 65 - Comparison between status and multistate records

Field/Command Status Multistate
Data Format Not Applicable Bit FormatEnumeration
Format
Number of Input Bits up to 2 Up to 8
Number of Input States 4 Up to 256
Input Base Message 4 states Up to 256 states
Number of Output 4 8 (convertdb up to 256)
Command States
Table continued…
230
Multistate table
Table 65 - Comparison between status and multistate records (continued)

Field/Command Status Multistate
Output Command Base 2 commands Up to 8 commands
Message (convertdb up to 256)
Command Results Not Applicable Configurable separate from
the command base message.
28.1 Multistate point subtypes

Multistate points have two possible subtypes: bit patterns and enumeration. This is configured in
the Data Format field on the Main tab in the Multistate Row Edit dialog box.
• Bit pattern - Similar to status point configuration, except 8 configured bits instead of 2.
• Enumeration - A single analog register reads as a positive integer value. Each possible
positive integer value has to have an associated text. If a register is of a floating point type,
the system truncates the number to convert it to a decimal. For example, the value 4.997
becomes a 4. If a negative value is received, the value is set to 0.
28.2 Multistate table allowances

The multistate table is flexible and makes allowances, such as allowing seperate message sets
for the output and input values.
The multistate table allows for:
• Separate message sets, defining the text for each state, for the output commands and input
values.
• Output and input message set sizes do not need to match.
• No requirement to configure “placeholders” in the message sets for states that are not used.
(Compared to status functionality which requires 4 states configured for a 1 bit point.)
28.3 Multistate record configuration

A multistate record can be configured to translate raw values and process digital output
commands, state alarms and events, and historical data collection.
The multistate records can be configured for:
• Conversion of the new raw telemetry value into a consistent representation of the device
state.
• Up to 8 digital output command processing (e.g., start pump and verify command execution).
• Complex alarm and event processing on the current state.
• Historical data collection of the current value at periodic intervals and by exception.
• Recording the time in hours that the multistate value represented the active state (for
example, on, open, start, trip) for the current and previous hour, day, and month.
• Attachment to an ACE routine for calculating or control.
From the operator interface, a multistate record can be:
231
Multistate table
• Manually overridden with a value or re-enabled to use the telemetry/calculated value.
• Tagged to inhibit digital output commands.
• Commanded to operate the digital output.
• Configured to have its alarms inhibited or enabled.
28.4 Main tab Multistate Row Edit

The Main tab in the Multistate Row Edit dialog box is used to set up the basic properties of a
record, such as group, dataset and input type.
Figure 153 - Main tab in the Multistate Row Edit dialog box
The Main also gives the user access to the historical database via the Historical and PI
Table 66 - Items on the Main tab in the Multistate Row Edit dialog box
Items Description
Name Click the ellipsis button (...) and select the name of the multistate record
from the Multistate Select dialog box.
Table continued…
232
Multistate table
Table 66 - Items on the Main tab in the Multistate Row Edit dialog box (continued)
Items Description
Input Type Click the drop-down arrow and select the type of point that this record is


multistate point).
Remote Click the ellipsis button (...) and select the name of the remote
must be configured if the Input Type is set to telemetered.
Base Message Click the ellipsis button (...) and select the message associated with the
Table continued…
233
Multistate table
Table 66 - Items on the Main tab in the Multistate Row Edit dialog box (continued)
Items Description
Data Format Click the drop-down arrow and select the multistate subtype used for
this point. The choices are:
• Enumeration Format - The point reads a reguster (whole word)
from the RTU.
• Bit Format - The point reads up to 8 bits from the RTU. It results in
an input of up to 256 states.
28.5 Input tab Multistate Row Edit

The Input tab in the Multistate Row Edit dialog box is used to configure multistate inputs.
Figure 154 - Input tab in the Multistate Row Edit dialog box
fields.
234
Multistate table
Table 67 - Items on the Input tab in the Multistate Row Edit dialog box
Items Description
Has Input Select the check box to allow the setting of the multistate point’s current
value field.
Accumulate Select the check box to record the time (in hours) that the multistate
Runtime input has been in the state specified in the Accumulated State field. It
indicates the time during the current and preceding hour, day, shift, and
month.
Runtime values may be used in a report to determine device
maintenance requirements. For instance, pump maintenance is
performed when a pump runtime value exceeds the maximum runtime
recommended for the month. This could be checked using an SQL
statement, such as the following:
select name from status where run.month.previous > 1.5
Accumulated State Click the ellipsis button (...) and select the state you want to monitor
from the Multistate Message Selector dialog box.
Refer to “Selecting an accumulated state message” for more
information.
Instrument Failure Click the ellipsis button (...) and select the state you want to assign as
the Instrument Failure State from the Multistate Message Selector
dialog box.
Refer to “Selecting an instrument failure state message” for more
information.
SOE Point Select the check box to allow the event messages from this point to
record the time data changes at the remote instead of the time that the
host receives the data.
This will only occur if the information is available.
Bit Pattern Input Click the button to open the Multistate Bit Format Input dialog box and
configure the input bits.
For more information, refer to “Multistate bit format input”.
NOTE: This button is only available if the Data Format field in the
Main tab is set to Bit Format.
Enumerated Input Click the button to open the Multistate Enumerated Input dialog box
and configure RTU register information.
For more information, refer to “Multistate enumerated input”.
Main tab is set to Enumerated Format.
235
Multistate table
28.5.1 Selecting an accumulated state message

Use the Multistate Message Selector dialog box to select an accumulated state message.
Figure 155 - Multistate Message Selector dialog box
The Multistate Message Selector is accessed from the Input tab in the Multistate Row Edit
dialog box.
Procedure
1. On the Input tab in the Multistate Row Edit dialog box, click the ellipsis button (...) next to the
Accumulated State field.
Step Result: The Multistate Message Selector dialog box appears.

2. Select the desired message that is associated with the state.
3. Click Accept.
Result
The selected message appears in the Accumulated State field.
236
Multistate table
28.5.2 Selecting an instrument failure state message

Use the Multistate Message Selector dialog box to select an instrument failure state message.
Figure 156 - Multistate Message Selector Dialog Box
The Multistate Message Selector is accessed from the Input tab in the Multistate Row Edit
dialog box.
Procedure
1. On the Input tab in the Multistate Row Edit dialog box, click the ellipsis button (...) next to the
Instrument Failure State field.
Step Result: The Multistate Message Selector dialog box appears.

3. Click Accept.
Result
The selected message appears in the Instrument Failure State field. The instrument failure
state is used whenever a value is received from the remote that does not have an applicable
state in the input message set.
237
Multistate table
28.5.3 Multistate bit format input

Use the Multistate Bit Format Input dialog box to configure coordinates and bit number of the
record’s input bits.
Figure 157 - Multistate Bit Format Input dialog box
The Multistate Bit Format Input dialog box is accessed by clicking Bit Pattern Input on the
Input tab in the Multistate Row Edit dialog box. Refer to the table below for field descriptions
and instructions on how to configure the editable fields.
Table 68 - Items on the Multistate Bit Format Input dialog box

Items Description
Number of Input Type a value from 1-8 that defines the type of the multistate point.
Bits
For 8-bit devices, input bit 1 (Input #1) is the low-order bit, and input bit
8 (Input #8) is the high-order bit.
Use the following examples to determine how to configure this field:
• 0 - For digital output devices that do not return “command success”

messages. With this setting, no Input# needs to be configured.
• 1 - For two-state devices. With this setting, Bit #1 and Input #1 must
be configured.
• 2 - For four-state devices. With this setting, Bit #1 and Bit #2 and
Input #1 and Input #2 must be configured.
• 3 - For eight-state devices. With this setting, Bit #1, Bit #2, and Bit #3
and Input #1, Input #2 and Input #3 must be configured.
Table continued…
238
Multistate table
Table 68 - Items on the Multistate Bit Format Input dialog box (continued)
Items Description
...
• 8 - For 256-state devices. With this setting, Bit #1-8 and Input #1-8
must be configured.
The Input tab in the Multistate Row Edit dialog box has similar
configuration areas for input values. The input sections configure the
way multistate points reads the input.
Bit These numbers list the sequential number of rows.
Bit in RTU Status Select the check box if this record is monitoring a remote-specific
condition. If this is selected, only the Bit Number field needs to be
configured.
In some protocols, such as TANO, the remote status word (RSW) is an
8-bit status word that is returned to the host. Each bit in this word
represents a remote-specific condition, such as:
• AC power-fail
• bulk power fail in one or more expansion baskets
• unit powered up
• command disabled
• uninitialized
Coordinates Type the coordinates where the data is mapped within the remote. This
Bit Number Type the device’s status bit number.
A single word of RealTime data can encode messages from a number of
status/multistate devices. The Bit Number field points to the device’s
status bit number within that word.
Normally Open Select the check box is your remote does not return a value of 1 to
indicate open.
The system expects a value of 1 to indicate open. When Normally Open
is selected, the bits from the remote are inverted (i.e., 0 is changed to 1
and 1 is changed to 0). If cleared, the bits that are returned from the
remote remain unprocessed.
239
Multistate table
28.5.4 Multistate enumerated input

Use the Multistate Enumerated Input dialog box to configure the remote register information
required to read the data for enumerated format data types.
Figure 158 - Multistate Enumerated Input dialog box
The Multistate Enumerated Input dialog box is accessed by clicking Enumerated Input on
the Input tab in the Multistate Row Edit dialog box. Refer to the table below for field descriptions
and instructions on how to configure the editable fields.
Table 69 - Items on the Multistate Enumerated Input dialog box

Items Description


multistate point).
240
Multistate table
Table 69 - Items on the Multistate Enumerated Input dialog box (continued)

Items Description

28.6 Output tab Multistate Row Edit

Output commands for multistate records are configured using the Output tab for Multistate
Figure 159 - Output tab for Multistate Row Edit dialog box
fields.
241
Multistate table
Table 70 - Items on the Output tab in the Multistate Row Edit dialog box
Items Description
Has Output Select the check box to allow configuration of output commands for
multistate points.
Command Base Click the ellipsis button (...) and select the message record that holds
Message the appropriate command message from the Select dialog box.
Command Results Click the button to open the Multistate Command Results dialog box.
This dialog box allows you to associate the expected resultant input
state for each possible output command for the point.
For more information, refer to “Multistate command results”.
Command Failure Type the command failure timeout value (in seconds). If the command is
Timeout unsuccessful, the system will wait for the timeout period before
generating an alarm.
If the timeout is zero, this feature is diabled.
COS Failure Type the COS timeout value (in seconds). If the device does not change
Timeout state in the time period configured here, an alarm is generated.This is
only applicable to three-state and four-state devices (i.e., devices where
the Number of Input Bits field on the Input tab is set to 2).
If the timeout is zero, this feature is disabled. An alarm is not generated
if the device is already in the commanded state.
Log Command Select the check box to record successful commands in the event log.
Success Unsuccessful commands always generate alarms and are logged
whether or not this is selected.
Bit Pattern Output Click the button to open the Bit Format Output dialog box and
configure the output bits.
For more information, refer to “Multistate bit format output”.
Main tab is set to Bit Format.
Enumerated Click the button to open the Multistate Enumerated Output dialog box
Output and configure RTU register information.
For more information, refer to “Multistate enumerated input”.
Main tab is set to Enumerated Format.
242
Multistate table
28.6.1 Multistate command results

Use the Multistate Command Results dialog box to configure command results.
Figure 160 - Multistate Command Results dialog box
The Multistate Command Results dialog box is accessed by clicking Command Results on
the Output tab in the Multistate Row Edit dialog box. Refer to the table below for field
descriptions and instructions on how to configure the editable fields.
Table 71 - Items on the Multistate Command Results dialog box

Items Description
Command This lists the possible output commands for the multistate point. You can
associate the expected resultant input state for each possible output
command for the point.
Expected Click the ellipsis button (...) and select the expected resultant input state
Resultant State from the Multistate Message Selector dialog box.
243
Multistate table
28.6.2 Multistate bit format output

Use the Bit Format Output dialog box to configure the bit format output.
Figure 161 - Bit Format Output dialog box
The Bit Format Output dialog box is accessed by clicking Bit Pattern Output on the Output
tab in the Multistate Row Edit dialog box. Refer to the table below for field descriptions and
Table 72 - Items on the Multistate Bit Format Output dialog box

Items Description
Command Type The fields in this column list the command type.
Output Type Click the drop-down arrow and select the type of output command. The
choices are:
• Latched - The status point remains toggled after the command is
executed.
• Momentary - The status point is changed only for the duration of the
command signal.
• SBO - Select before operate

Table continued…
244
Multistate table
Table 72 - Items on the Multistate Bit Format Output dialog box (continued)
Items Description

Command Click the drop-down arrow and select one of the following options:
• Energize - Energize the relay coil.
• De energize - De-energize the relay coil.

Timeout (msec) Type the timeout associated with the command (in milliseconds). This is
dependent on the protocol, but this value is typically set to the time
needed to close the contacts for a momentary release.
28.6.3 Multistate enumerated output

Use the Multistate Enumerated Output dialog box to configure the remote register information
required to command multistate points that are in the enumerated format data type.
Figure 162 - Multistate Enumerated Output dialog box
The Multistate Enumerated Output dialog box is accessed by clicking Enumerated Output
on the Output tab in the Multistate Row Edit dialog box. Refer to the table below for field
Table 73 - Items on the Multistate Enumerated Input dialog box

Items Description
choices are:
executed.
command signal.

245
Multistate table
Table 73 - Items on the Multistate Enumerated Input dialog box (continued)

Items Description

28.7 Alarming tab Multistate Row Edit

Use the Alarming tab in the Multistate Row Edit dialog box to configure the alarming
associated with the multistate record. You can configure alarm suppression and select which
states should be considered abnormal.
Figure 163 - Alarming tab in the Multistate Row Edit dialog box
fields.
246
Multistate table
Table 74 - Items on the Alarming tab in the Multistate Row Edit dialog box
Items Description
Sustain COS Select the check box to allow alarms to remain in the Alarm Summary
Alarms window in ezXOS as long as the point remains in the abnormal state.
The alarm beeping stops when the operator acknowledges the alarms,
but they are only removed from the window when the point returns to
the normal state.
If the Sustain COS Alarms check box is cleared, alarms disappear from
the Alarm Summary window as soon as they are acknowledged.
Alarm Click the button to open the Alarm Suppression Table Edit dialog box.
Suppression
Abnormal States Click this button to open the Selected Abnormal States dialog box. You
can choose from ERROR, OPENED, CLOSED and TRANSIT.
28.7.1 Configuring abnormal states

Use the Select Abnormal States dialog box to configure abnormal state alarming.
Figure 164 - Selected Abnormal States dialog box
Abnormal states alarming can be configured for all states that exist in the input message set for
the multistate point.
Procedure
1. On the Alarming tab in the Multistate Row Edit dialog box, click Abnormal States.
Step Result: The Selected Abnormal States dialog box appears.

2. Select the states you want to be recognized as abnormal.
3. Click Accept.
247
Multistate table
28.8 Inhibits tab Multistate Row Edit

Use the Inhibits tab in the Multistate Row Edit dialog box to inhibit alarming or logging of
uncommanded state changes.
Figure 165 - Inhibits tab in the Multistate Row Edit dialog box
Alarms are normally annunciated and displayed in ezXOS; however, for some conditions, it may
be desirable to inhibit specific alarms.
The Inhibits tab allows you to inhibit alarms and logs generated due to uncommanded
changes. Uncommanded changes are those that occur without the user’s intervention. For
example, if someone in the field opens a valve, the change is considered to be uncommanded
since the change did not result from the operator’s action.
NOTE: In a distributed installation, alarm acknowledgement is local to a system and is not

replicated to other systems. Hence, for the same point, an operator on one system
handles alarm acknowledgment completely independent of operators on the other
systems. Alarms are distributed to other systems depending on the alarm configuration
option specified.
fields.
248
Multistate table
Table 75 - Items on the Inhibits tab in the Multistate Row Edit dialog box
Items Description
Inhibit alarming of Select the check box to inhibit alarming when the point undergoes an
uncommanded uncommanded change to an abnormal state.
state changes to
Abnormal states
uncommanded uncommanded change to the normal state.
state changes to
If an unacknowledged abnormal state alarm exists, the change to
Normal states
normal state alarm will occur whether or not this check box is selected.
This ensures that the operator is aware that the point’s alarm state
changed.
Inhibit logging of Select the check box to inhibit logging when the point undergoes an
state changes to
Abnormal states
state changes to
Normal states
28.9 RVE tab Multistate Row Edit

The RVE tab in the Multistate Row Edit dialog box is used to configure the checking of the
point’s rule sets. Any commands for the point are intercepted by the Rules Validation Engine,
which determines if a command is allowed to proceed or not.
Figure 166 - RVE tab in the Multistate Row Edit dialog box
249
Multistate table
Table 76 - Items on the RVE tab in the Multistate Row Edit dialog box
Items Description
250
Omnicomm table
29 Omnicomm table
An Omnicomm record represents an Omnicomm process, which is the communication process
that controls and manager data transfer. Omnicomm records are located in the Omnicomm
table and are configured using the Omnicomm Row Edit dialog box.
Figure 167 - Omnicomm Table Edit
29.1 Omnicomm Row Edit

The Omnicomm Row Edit dialog box is used to configure Omnicomm records and set up the
properties of the communication process.
Figure 168 - Omnicomm Row Edit dialog box
A single Omnicomm process runs for each Omnicomm record. One Omnicomm process is
usually enough. Multiple Omnicomm processes are possible, but this is typically used for
development purposes where totally isolated environments are required to facilitate parallel
251
Omnicomm table
testing among many staff members. Occasionally, a system that has additional Omnicomm
processes running for ongoing testing or development is shipped to the customer.
fields.
Table 77 - Items on the Omnicomm Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the Omnicomm
record from the Omnicomm Select dialog box.
252
Rate table
30 Rate table
Rate records are used to represent a rate or accumulated quantity. Rate records are located in
the Rate table and are configured using the Rate Row Edit dialog box.
Figure 169 - Rate Table Edit
In addition to basic accumulated quantities rate records can be configured for:
• Conversion of a raw telemetry rate value into a value in engineering units
• A first order smoothing filter applied to the raw rate value
• The application of scaling factors to a telemetry pulse input representing an accumulated

quantity (e.g., m3 or kWh)
• A rate calculated from the quantity increment over time, taking into account accumulated
quantity rollover
• An accumulated quantity calculated from a rate multiplied by the time period during which
the rate was constant
• A software accumulated quantity calculated from a telemetry accumulation, but with a
rollover of one million rather than the telemetry rollover value. This is not reset when power
failure at the remote causes the telemetry accumulation to reset to zero
• Complex alarm and event processing on the rate value
• Historical data collection of the current rate by exception and at periodic intervals
• Current and previous primary and alternate quantities (i.e., rate integrations)
• Current and previous primary and alternate average rate
From the operator interface, a rate record can be manually overridden with a value or enabled
to use the telemetry/calculated rate value. Also, a rate record’s alarms can be inhibited or
enabled and its alarm limits changed. For more information on controlling points and field
devices, refer to the Operation and Control Reference.
253
Rate table
30.1 Main tab Rate Row Edit

The Main tab in the Rate Row Edit dialog box is used to set up the basic properties of the
record such as group, dataset and input type.
Figure 170 - Main tab in the Rate Row Edit dialog box
The Main tab in the Rate Row Edit dialog box also gives the user access to the historical
database via the Historical and PI Historical buttons. Refer to the table below for field
Table 78 - Items on the Main tab in the Rate Row Edit dialog box
Items Description
Name Click the ellipsis button (...) and select the name of the Rate record from
the Rate Select dialog box.
Table continued…
254
Rate table
Table 78 - Items on the Main tab in the Rate Row Edit dialog box (continued)
Items Description
must be configured if the Point Type is set to telemetered.
Minimum (EGU) Type the instrument’s lower raw operating limit.
Maximum (EGU) Type the instrument’s upper raw operating limit.
Source of Data Click the drop-down arrow and select the input for the rate device. The
rate table can receive two different inputs: an analog value, which
represents a rate calculated at the remote and/or accumulator and a
pulse input value, which represents the accumulated quantity at the
remote. One is derived from the other if only one type of input is
specified.
The choices for this field are:
• Pulse input - The remote sends a pulse count value representing

the quantity accumulated over time. The change in pulse counts
between rate calculations is used to compute the rate in units per
hour. The system checks for rollover of the pulse counter when
calculating the rate. This option requires you to configure the pulse
inputs.
• Analog input - The remote sends an analog input that represents

the rate in units per hour. This option requires you to configure the
analog inputs.
• Pulse & Analog - The remote sends both analog value (representing
the rate) and pulse count (representing accumulated quantity). This
selection requires you configure both analog and pulse inputs.
Table continued…
255
Rate table
Table 78 - Items on the Main tab in the Rate Row Edit dialog box (continued)
Items Description
Replication Type a deadband value. Whenever the analog value moves beyond this
Deadband value, the value is replicated to other hosts via the function subscription
ANALOGRT.
256
Rate table
30.2 Input tab Rate Row Edit

The Input tab in the Rate Row Edit dialog box is used to configure pulse and analog inputs and
gas rate subtype details.
Figure 171 - Input tab in the Rate Row Edit dialog box
fields.
257
Rate table
Table 79 - Items on the Input tab in the Rate Row Edit dialog box
Items Description
Input Coordinates Type the coordinate values for the pulse input accumulator.
Point Type Click the drop-down arrow and select the data-type of the pulse input
accumulator.
Roll-over value Type the roll-over value.
Accumulators continue to register a count until a certain value is
reached. The accumulator then resets, like a car odometer, and starts
counting again. Type this value, plus one, in the Roll-over value field.
For example, if the roll-over occurs at 999,999, then the value should be
1,000,000.
Time between rate Type the minimum length of time (in seconds) that should elapse
calculations (sec) between rate calculations. The lower the rate, the greater this time
should be in order to increase rate calculation accuracy.
Meter Factor Type a meter factor value to help correct devices that are consistently
inaccurate by the same percentage.
The number entered is multiplied by both the current accumulated value
and the rate calculated from the change in pulse input accumulation.
The Meter Factor is usually very close to 1.
Point Type Click the drop-down arrow and select the data-type of the pulse input
accumulator.
Input Coordinates Type the coordinate values for the pulse input accumulator.
Convert raw to Select the check box to convert the inputs from this point to engineering
EGU units.
An analog field device acquires its data as a raw instrument electrical
value and transfers the value to its remote. At the remote, this value is
changed into a digital value based on the communication protocol used.
For example, in the MICRO/1C MODBUS protocol, the signal from a
pressure controller that starts as an amperage between 4 and 20 mA is
changed to a string of bits that represents a number between -4096 and
+4095.Usually this raw number needs to be converted to engineering
units (for example, barrels per hour). Sometimes the remote receives
the value in engineering units, in which case no conversion is
necessary. Refer to your remote’s documentation to see if this is the
case for your remotes.
Minimum (raw) Type the instrument’s lower raw operating limit.
Maximum (raw) Type the instrument’s upper raw operating limit.
Table continued…
258
Rate table
Table 79 - Items on the Input tab in the Rate Row Edit dialog box (continued)
Items Description

Exception Type the amount by which an acquired value must change before the
Deadband value is sent to the host.
This field provides a report by exception method of acquiring data rather
than acquiring data with every Omnicomm scan. Analog data changes
constantly with the fluctuations in process conditions. Instead of
constant updates of tiny changes, which congest the lines, the data is
transferred to the host only when a specified deadband region has been
exceeded. This method can only be used if the remotes support analog
reporting by exception.Since the decision of whether or not to upload
the data is made by the remote, the deadband value is downloaded to
the remote in raw units. The exception deadband indicates the amount
by which an acquired value must change before the value is sent to the
host. For example, a deadband value of 10 means that only values at
least 10 raw counts higher or lower than the last value sent to the host
are transferred.
Rate Subtype Click the drop-down arrow and select the rate subtype.
A telemetry rate point acquires data in different media such as oil, water,
or gas. The raw rate value that is adjusted to an engineering unit value
may require additional adjustments due to various parameters involved;
therefore, algorithms are provided to compensate for different media.
The Rate Subtype selection indicates which algorithm to use.
The choices are:
• Linear - There is no compensation or further scaling when the flow

rate is obtained.
• Liquid - The flow rate is obtained by taking the square root of the
rate value.
• Gas - The gas measurement requires adjustments for the effects of

temperature and pressure. You must configure the fields in the Gas
Rate Subtype area.
Pressure Analog Click the ellipsis button (...) and select the associated pressure analog
Point record for this rate point from the Analog Select dialog box.
Temperature Click the ellipsis button (...) and select the associated temperature
Analog Point analog record for this rate point from the Analog Select dialog box.
Scaling Factor If you are scaling a gas flow rate, type the gas scaling factor. The value
(Gas) is calculated by the following formula:
where:
Table continued…
259
Rate table
Table 79 - Items on the Input tab in the Rate Row Edit dialog box (continued)
Items Description
k is the gas scaling factor
t is the temperature (measured in °F)
p is the pressure (measured in psi)
r is the uncorrected flow rate
The gas scaling factor (k) should be adjusted until the displayed rate
value is equal to a testing instrument’s rate value at that point.
Scaling Factor If you are scaling a water flow rate, type the water scaling factor that
(Water) converts the raw input value to the appropriate engineering unit value.
30.3 Rate Averages and Integration tab Rate Row Edit

The Rate Averages and Integration tab in the Rate Row Edit dialog box is used to configure the
details associated with calculating rate averaging and integration.
Figure 172 - Rate Averages and Integration tab in the Rate Row Edit dialog box
fields.
260
Rate table
Table 80 - Items on the Rate Averages and Integration tab in the Rate Row Edit dialog box
Items Description
Integration EGU Type the text string label representing the engineering units for the rate
Units integrated over a time period (i.e., quantity units such as barrels or kW).
This string appears in ezXOS displays and is used fr display purposes
only; it has no effect on system calculations.
Rate EGU Units Type the text string label representing the engineering units for the rate
(e.g., barrels/hr or kWh).
This string appears in ezXOS displays and is used for display purposes
only; it has no effect on system calculations.
Enable Select the check box to have the system calculate the total quantity
Integrations (e.g., volume) over a given time period. These hourly accumulated
values are stored in the accum database in Historical. Refer to the
Historical Services documentation for more detail.
Scale Factor Type the scaling factor if Enable integrations is selected and the
Source of Data field on the Main tab is set to Analog Input.
The factor is used to scale the accumulated quantity such that:
where:
t is the time measured in milliseconds
rate is the rate measured in units per hour
For example, the Scaling Factor should be 1.0 if the rate directly
corresponds to hourly accumulated quantity (e.g., barrels per hour).
Enable Averages Select the check box to calculate the averages of the rate for the hour,
day, month and year
Apply Linear Filter Select the check box to apply a filter to the telemetry/calculated values
that smooths out brief fluctuations. The equation used to calculate this
is:
Vfilter = (Vcurrent * K) + [Vprevious * (1-K)]
where:
Vfilter is the filtered value
Vcurrent is the current unfiltered value
Vprevious is the filtered value from the previous Omnicomm scan
Filter Constant Type a filter constant value.
This must be greater than 0 and less than or equal to 1. The smaller the
value, the greater the smoothing (i.e., when the Filter Constant is 1.0,
no filtration is performed).
Enable Software Select the check box to enable the software accumulator.
Accumulator
Table continued…
261
Rate table
Table 80 - Items on the Rate Averages and Integration tab in the Rate Row Edit dialog box
(continued)
Items Description
When a remote is powered on, the Power On bit is set in the remote
status word (RSW), and all the remote’s accumulators are usually reset
to zero. If Enable Software Accumulator is selected, an internal
accumulator value is maintained so it can compensate if a power failure
at the remote resets the value to zero.
To indicate power failure for this option, the remote protocol must be
able to set the remote’s RSW that is stored in the RSW field specifier.
The system reads the RSW and if it detects that power has failed at the
remote, it compensates for the remote’s accumulator.
For example, if the current accumulator value is 123456 and the remote
suffers a power failure, the remote will return an accumulator rate value
of zero and an RSW when the power is restored. On the next poll, if the
remote returns an accumulator rate value of 10, the system updates its
internal software accumulator to 123466 (123456 plus 10).
Scale Factor Type the scaling factor if Enable integrations is selected and the
Source of Data field on the Main tab is set to Analog Input.
The factor is used to scale the accumulated quantity such that:
where:
t is the time measured in milliseconds
rate is the rate measured in units per hour
For example, the Scaling Factor should be 1.0 if the rate directly
corresponds to hourly accumulated quantity (e.g., barrels per hour).
Related Information
Main tab Rate Row Edit on page 254
262
Rate table
30.4 Alarming tab Rate Row Edit

The Alarming tab in the Rate Row Edit dialog box allows you to set alarm conditions for the
rate record being configured.
Figure 173 - Alarming tab in the Rate Row Edit dialog box
Support is provided for a number of alarm conditions for analog and flow rate points, including:
• Instrument failure checking
• High/Low operating-range checking
• HighHigh/LowLow operating-range checking
• Rate-of-Change checking
263
Rate table
• Creep Detection or instrument-deviation checking
• Flatline Alarming checking
Each of these alarm conditions can be configured and enabled or disabled independently. You
can set the conditions in the point’s record, or in the point’s ezXOS control panel via the Alarm
Limits window in ezXOS.
fields.
Table 81 - Items on the Alarming tab in the Rate Row Edit dialog box
Items Description
Instrument Fail Select the check box to generate an alarm when an instrument failure
Check occurs.
An alarm is only generated if the point is connected with an RTU
capable of sensing instrument failures.
Alarm Deadband Type the deadband value for the rate point.
This value controls the sensitivity of the high and low alarms. For more
information, refer to “Deadbands”.
HiHi/LowLow Select the check box to edit the HighHigh and LowLow alarm limits.
Alarm Check Refer to “Alarm Limits” for more information.
Hi/Low Alarm Select the check box to edit the High and Low alarm limits. Refer to
Check “Alarm Limits” for more information.
HiHi Alarm Limit Type the HighHigh alarm limit for the rate point.
Hi Alarm Limit Type the High alarm limit for the rate point.
Lo Alarm Limit Type the Low alarm limit for the rate point.
LoLo Alarm Limit Type the Low Low alarm limit for the rate point.
Rate Of Change Select the check box to enable the Rate of Change (ROC) alarm. If the
Alarm ROC exceeds the Rate of change limit, an alarm is generated.
Refer to “Rate of Change Checks” for more information.
Rate of change Type the maximum allowable rate of change (engineering units per
limit second).
Creep Detection Select the check box to enable Creep Detection alarm. If the value
creeps out of its calibrated state by a value that exceeds the Deviation
Alarm Limit, an alarm is generated.
Refer to “Creep Detection” for more information.
Deviation Alarm Type the maximum deviation value (engineering units) that is acceptable
Limit before calibration deteriorates.
264
Rate table
30.5 Inhibits tab Rate Row Edit

The Inhibits tab in the Rate Row Edit dialog box allows you to inhibit events and alarms cause
by state changes such as change of state from normal to off-normal and vice versa.
Figure 174 - Inhibits tab in the Rate Row Edit dialog box
The Operator can also inhibit alarms generated from analog, rate, and status records through
the points’ ezXOS control panels. For remote records, the operator can put a remote offscan but
cannot actually disable alarming for all points.
While the user can inhibit alarm generation through ezXOS, only the system administrator can
inhibit event logging through the Advanced Database Editor (ADE).
The following table lists conditions that determine normal and off-normal states.
Table 82 - Normal and Off-normal state determinants

Table Condition/Determinant
Analog Analog alarm limits (refer to “Alarm Limits”)
Connection Alarms that are usually related to the following:

Rate Rate alarm limits (refer to “Alarm Limits”)
Remote No-reply timeouts, security errors, short messages, and illegal
messages (Normal alarms are generated and logged.)
265
Rate table
In the analog record, the analog alarm limits configured in the Alarming tab determines the
Normal and Off-normal states. Refer to the table below for field descriptions and instructions on
how to configure the editable fields.
Table 83 - Items on the Rate tab in the Analog Row Edit dialog box
Items Description
normal state.
normal state.
normal state.
state.
266
Xos user attributes Table
31 Xos user attributes Table

Xos user attributes (xosuserattributes) records are used to represent the configurable inactivity
and popup time limits for a user. Xosuserattributes records are located in the Xosuserattributes
table and are configured using the Xosuserattributes Row Edit dialog box.
Figure 175 - Xosuserattributes Table Edit
267
Xos user attributes Table
31.1 Xos user attributes Row Edit

The Xos user attributes (xosuserattributes) Row Edit dialog box is used to configure the logout
and popup timeout for a user.
Figure 176 - xosuserattributes Row Edit dialog box
fields.
Table 84 - Items on the Xosuserattributes Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the user for whom
you want to configure the timeouts.
Logout Timeout Type the maximum number of seconds of inactivity allowed before the
user is automatically logged out of the system.
Popup Timeout Type the maximum number of seconds that a popup window is
displayed before the system automatically closes the window.
268
Remote table
32 Remote table
Data is acquired from remote devices such as RTUs and PLCs. Each remote record provides
configuration details on one remote device. Remote records are located in the Remote table
and are configured using the Remote Row Edit dialog box.
Figure 177 - Remote Table Edit
Acquired data refers to the telemetered data values that measure conditions such as pressure
and temperature in the field. It also includes data sent from the remote site to the system in the
form of text messages that indicate alarm and event conditions. These text messages help to
monitor the process conditions and alert the user to problem situations.
Data and commands are transferred along the connection between the host computer and the
remote device, for example RTU, PLC and between that remote and its attached field devices.
A variety of devices serve as remote processing units (remotes) to process and transfer the field
data back to the host. These include different remote terminal units (RTUs), gas
chromatographs (GCs), programmable logic controllers (PLCs), and flow computers (FCs). The
remote scans the field devices that are mapped into the RealTime database by unique data
input/output coordinates. Data is passed between the remotes and the host computer through a
connection.
269
Remote table
32.1 Main tab Remote Row Edit

The Main tab on the Remote Row Edit dialog box is used to configure the basic properties of
the record such as group, dataset, and communications details.
Figure 178 - Main Tab in the Remote Row Edit Dialog Box
The Main tab on the Remote Row Edit dialog box also gives the user access to the historical
database via the Historical and PI Historical buttons. Refer to the table below for field
Table 85 - Items on the Main tab in the Remote Row Edit dialog box
Item Description
Name Click the ellipsis button (...) and select the name of the
Remote record from the Remote Select dialog box.
Description Type a description of the record. The Description can be
up to 47 characters in length. This field is for information
purposes only and can be used to describe the record, its
association with other points, or any other textual
information. The Name and Description configured for a
Table continued…
270
Remote table
Table 85 - Items on the Main tab in the Remote Row Edit dialog box (continued)
Item Description
Protocol Record Edit... Click the button to edit the remote protocol for the record
For details on editing the protocol, refer to “Using the
Remote to Protocol Form”.
Group Click the ellipsis button (...) and select the name of the
group this record belongs to from the Group Select
dialog box.
Dataset Click the ellipsis button (...) and select the name of the
dataset you want to associate with this record from the
Dataset Select dialog box.
A dataset contains privileges assigned for each system
and mode. Once a record is assigned to a data set value,
the dataset can only be changed to a value for which the
system has a privilege record. A record’s dataset can not
be changed in such a way that the system can no longer
access the record.
Message Click the ellipsis button (...) and select the message
associated with the record from the Message Select
dialog box.
The default message for a remote is RTU.
Priority Display Specify the graphic you want to be associated with the
priority display button on an ezXOS control panel.
Protocol Click the drop-down arrow, and select the name of the
protocol used for communication between this remote and
the host. The drop-down menu lists all of the available
protocols assigned for your project.
NOTE: The same protocol must be defined at both ends
of the communication process (the host and the
remote) to complete the communication cycle.
Address Type the numerical address of the remote. The address is
an integer (e.g., 1, 2, 3, etc.) assigned to the remote
through its field unit configuration.
NOTE: A setup referred to as multi-dropping allows a
number of remotes to share the same
connection. Remotes with the same protocol
must have unique addresses to be multi-
dropped. Remotes with different protocols can
also be multi-dropped.
Enable Communications Failure Select the check box to enable Omnicomm to attempt
communication over a different connection when it fails to
communicate with a remote (failover). Omnicomm will use
the cheapest available connection for this remote as
determined by the Cost Factor.
Table continued…
271
Remote table
Item Description
Historical... Click the button to open the Collect Table Edit dialog box
that can be used to configure historical data collection.
PI Historical... Click the button to open the PI Table Edit dialog box and
begin configuring PI records.
Related Information
Using the Remote to Protocol Form on page 272
32.1.1 Using the Remote to Protocol Form

You can edit the remote protocol for any remote record by using the Remote To Protocol
Form.
The Remote To Protocol Form can be accessed through the Main tab in the Remote Row
Edit dialog box.
Figure 179 - Remote To Protocol Form
Procedure
1. Click the Protocol Record Edit... button.
Step Result: The Remote To Protocol Form appears briefly and displays the name of the
remote record and the protocol to which the remote belongs. The specific protocol Row Edit
dialog box (e.g., Modbus Row Edit dialog box) appears.
2. Edit the protocol record as desired.
3. Click Save.
Result
The new protocol configurations are applied to the remote record.
32.1.2 Cloning a remote in the Remote Row Edit dialog box

The Clone Remote and Protocol function in the Remote Row Edit and Remote Row Details
dialog boxes allows you to clone a remote and its associated protocol record.
Before you begin

To clone a remote, first open the command prompt and run dbeditdisplayschemamerge to
make sure that the custom form is included in the remote forms.
272
Remote table
Procedure
1. Open the Remote Row Edit dialog box of the record you want to clone.
2. Click Functions > Clone Remote And Protocol.
Step Result: The Remote Cloning Form appears.
Figure 180 - Remote Cloning Form
3. Type the desired name of the cloned remote in the New Remote Name field.
4. Click Clone.
What to do next
Make sure the cloned remote/protocol record has been replicated into all associated RealTime
systems.
32.1.3 Cloning a remote in the Table Edit dialog box

The Clone Remote And Protocol function in the Remote Table Edit dialog box allows you to
clone a remote and its associated protocol records.
Before you begin

To clone a remote, first open the command prompt and run dbeditdisplayschemamerge to
make sure that the custom form is included in the remote forms.
Procedure
1. In the Remote Table Edit dialog box, load a single remote record that you want to clone.
If there is more (or less) than one remote record in the Table Edit dialog box when Clone
Remote And Protocol is clicked, an error message will appear.
2. Click Functions > Clone Remote And Protocol.
Step Result: The Remote Cloning Form appears.
Figure 181 - Remote Cloning Form

3. Type the desired name of the cloned remote in the New Remote Name field.
4. Click Clone.
5. Load all the available remote records into the Remote Table Edit dialog box. The newly
cloned remote will be present.
273
Remote table
What to do next
Make sure the protocol data of the cloned remote is the same as the original.
32.2 Scan Parameters tab Remote Row Edit

Use the Scan Parameters tab in the Remote Row Edit dialog box configure the polling
parameters of the remote.
Figure 182 - Scan Parameters tab in the Remote Row Edit dialog box
fields.
Table 86 - Items on the Scan Parameters tab in the Remote Row Edit dialog box
Item Description
Fast Scan Duration (sec) Type the length of time (in seconds) that the remote
should remain on fast scan mode after the system issues
the fastscan function put. Fast scan is a method of
setting a remote to interrogate mode for a set time period.
In interrogate mode, the remote is polled more frequently
than in a normal poll cycle; therefore, updates are
received more quickly. The system automatically places a
remote on fast scan after the former issues an analog
setpoint or digital output command. This ensures that the
command feedback is received as soon as
possible.Remotes can be placed into timed interrogate
mode through the Remote Control dialog box. For more
Table continued…
274
Remote table
(continued)
Item Description
information, refer to the Operation and Control
Reference.Remotes on fast scan mode are not affected
by the RTU Poll Delay setting.
Timeout for Illegal Msg Alarm (sec) Type the number of seconds the system should wait after
an illegal message to generate an illegal message alarm.
If an illegal message exists at the time of the poll, the
remote will shift into the “Illegal Message” state, then wait
the value of Timeout for Illegal Msg Alarm before
generating an alarm. If a subsequent poll does not
contain an illegal message, the remote will return to the
normal state and no alarm will be generated.
Timeout for No-reply Alarm Type the number of seconds the system should wait after
(sec) the remote shifts to the “NO REPLY” state before
If the data is not received from the remote after a
specified number of retries, the remote shifts to the “NO
REPLY” state. If the remote stays in this state for longer
than the Timeout for No-reply Alarm (sec) value, the
system issues a “NO REPLY” alarm.
RTU Poll Delay (HH:MM:SS) Type the time interval that passes between device polls.
Using a poll delay reduces the bandwidth wasted on
remotes that return less important data. The delay can
also help reduce polls of battery-operated remotes.
If the remote is not responding, then the effective RTU

poll delay is the greater of the following two values: RTU
Poll Delay or No Response Delay.
This delay setting is overridden if the remote is placed on

fast scan or interrogate mode (refer to the Operation and
Control Reference for more information). The RTU Poll
Delay is configured for the following reasons:
• To reduce the amount of bandwidth wasted by non-

critical remotes or remotes that transfer data that
rarely change
• To reduce load on the CPU
• To prevent frequent polling of battery-operated

remotes
• To minimize phone line charges that are based on

traffic or amount of data sent
To view an example, refer to “RTU Poll Delay example”

below.
No Response Delay (HH:MM:SS) Type the time interval that passes between poll attempts
after a no response is received from the remote.
Table continued…
275
Remote table
(continued)
Item Description
When no response is received from the remote over the

connection it currently uses, the Omnicomm process
attempts to poll the remote at an interval equal to the
greater of the following two values:
• The value specified in the RTU Poll Delay field
• The value specified in the No Response Delay field
This occurs whether or not the problem is with the remote

itself or its communication path.
Other reasons for adding a No Response Delay are:

• To reduce the amount of bandwidth wasted by non-
critical remotes or remotes that transfer data that
rarely change
• To minimize phone line charges that are based on

traffic or amount of data sent
To view an example, refer to “No Response Delay

example” below.
RTN Alarm Inhibit (poll cycles) Type the number of successful poll cycles that must be
completed before the system issues a return-to-normal
alarm that indicates communication with this remote has
returned to normal from an abnormal state.
This reduces spurious alarming in situations where
communication with a remote is sporadic. Return-to-
normal alarming works similarly to no-reply timeout.
Cryout Modem Bank Click the ellipsis button (...) and select the modem bank
(Mbank) record used by the remote.
This field only needs to be configured for systems or
projects with cryout connections.
RTU Turnaround Time (ms) Type the time (in milliseconds) it takes for the remote to
parse a query (not a command), process it and formulate
a response.
There is no typical value for this field; it can take
anywhere from 1 to 100 milliseconds depending on the
firmware and CPU load of a given brand of remote.
For more information, refer to “RTU turnaround time and

overhead time delays”.
Overhead Processing Time (ms) Type the time (in milliseconds) to be added to the RTU
Turnaround Time to calculate the maximum time
required to receive a response from the remote.
This is used to accommodate remotes that require more
time to execute commands than to respond to data
Table continued…
276
Remote table
(continued)
Item Description
queries. This applies only to some commands that are

sent to the remote (e.g., setpoints, digital outputs).
For more information, refer to “RTU turnaround time and

overhead time delays”.
Protocol Driver Specific Retries This field is only used by certain protocol drivers. If the
driver is not supported by the protocol, this field is
ignored.
RTU Poll Delay example
In the example below, remote A has a poll delay of 60 seconds and is polled only once per
minute. The B and C remotes are polled as often as possible.
Figure 183 - Poll cycle with an RTU Poll Delay
No Response Delay example
In the example below, the remotes are configured identically as follows:

• RTU Poll Delay (HH:MM:SS): 00 01 02
• RTU Poll Delay (HH:MM:SS): 00 01 00
The connection for the example has the following configuration:
• Min. Poll-cycle Time (sec): 20
• Number of Poll Retries: 2
• Delay Between Remotes (ms): 2000
277
Remote table
Figure 184 - Poll cycle with a No Response Delay
The figure above shows that remote B has two retries configured with the remote’s turnaround
time set to 2 seconds. Therefore, two retries are invoked for remote B from the time at which it
fails to send a response.
The time specified by the No Response Dealy field is useful for reducing the time spend waiting
on the communications circuit for remotes that are unlikely to respond. As shows in the
example, if remote B does not respond to the Omnicomm poll, then it does not take its turn
again in the Omnicomm poll until after the time specified in the No Response Delay field has
elapsed.
Related Information
RTU turnaround time and overhead time delays on page 278
32.2.1 RTU turnaround time and overhead time delays

Remote turnaround time and overhead processing time are difficult to estimate without some
background research. There are some checks analysis that you can perform to help you make
more accurate estimates.
In order to make a reasonable estimate, check to see if the remote manufacturer publishes
figures for the response time of queries and commands. Take the time delays that represent the
worst-case delays for the remote in question. It may also be necessary to take into account
such parameters as I/O count or installed CPU speed. Ensure that the figures that you use do
not include the time required for the response bits to be transmitted. This bit transmission time
is already taken into account by relying on the correct setting of the Default Signal
Configuration: field. For more information, refer to “Main tab Remote Row Edit”.
Alternatively, it may be necessary to measure these time delays using either a serial-line
analyzer with a time-stamping feature or a storage oscilloscope. This technique is preferred,
since the documentation for a given remote may not take into account firmware customization,
or may not be able to predict dependencies on field devices that affect the remote’s response
delays. The time to be measured is the delay between the end of the query/command bits and
the start of the response bits.
If it takes more time to process commands than to process queries:
278
Remote table
• Set the remote turn-around time to the longest time required to process a query.
• Set the overhead processing time to the difference between the longest query processing
time and the longest command processing time.
If it takes the same amount of time (within tens of milliseconds) to process commands and
queries:
• Set the remote turn-around time to the longest time required to process a query/command.
• Set the overhead processing time to zero.
If it takes less time to process commands than to process queries:
• Set the remote turn-around time to the longest time required to process a query.
• Set the overhead processing time to zero. This should not be set to a negative value as the
results will be neither predictable nor consistent.
It is acceptable to set these fields for all similar remotes using the worst-case delays for the
slowest type of remote. While such a practice may hinder communication throughput, it entails
less effort than attempting to measure or calculate delays for every remote.
Keep in mind that some remotes do not respond to a command until the command is actually
completed. If a command to close a valve cannot be completed until the valve has made a full
transit, the response might not return until after two minutes or more. This drastic difference
between responses to queries (e.g., dozens of milliseconds) and responses to commands
(several minutes for remotes controlling slow devices) underscores the need to tune the remote
turn-around time and overhead processing time fields accurately. Under such extreme cases, it
is wise to tune these two time parameters on a per-remote basis rather than use the same
values for each remote.
Related Information
Main tab Remote Row Edit on page 270
279
Remote table
32.3 Remote Schedule tab Remote Row Edit

Use the Remote Schedule tab in the Remote Row Edit dialog box to schedule various
requests for data from remotes.
Figure 185 - Remote Schedule tab in the Remote Row Edit dialog box
CAUTION: In many locations, requests specified to run between 2:00 AM and 3:00 AM on the
first Sunday in April do not execute, and requests specified to run between 1:00 AM
and 2:00 AM on the last Sunday in October execute twice. These are the dates
when many locations change from standard time to daylight savings time, and vice
versa. This is due to time comparisons being based on local time.
The remote scheduler ensures that (a) the required remotes are connected, (b) all requests are
processed efficiently, and (c) the highest priority requests are processed first. This includes:
• Scheduling non-critical, low-frequency data requests (e.g., where a connection to a

dedicated line is not cost-effective, and polling using dialup modems is preferred)
• Scheduling periodic commands (e.g., time sync or AGA upload)
The remote scheduler process maps schedule entries in the Remote table to commands that
are issued to remotes at certain times. Any operator-initiated command that does not take a
parameter can be sent through the remote scheduler. Such commands includes polling, but
exclude commands such as setting setpoints and issuing digital commands.
NOTE: Polling is normally done at low priority. Operator commands are always done at the
highest priority. Scheduled commands are done between the lowest and next-to-highest
priority. You can interleave the scheduled commands with polling: they never delay
Operator commands.
The remote scheduler goes through the entire Remote table scanning the schedule entries.
Requests are processed in descending order of priority. Those destined for remotes on
permanent connections are sent to the Omnicomm process for that line. The command is
issued for temporarily connected remotes. If the temporary connection used is a dial
connection, it attempts to secure a modem or post a reservation against the modem bank. If
neither a modem nor a reservation is available, the remote scheduler reschedules the request
280
Remote table
for the next round. If there is an available modem, the connection with the oldest, highest
priority request is connected through this modem.
fields.
Table 87 - Items on the Main tab in the Remote Row Edit dialog box
Item Description
Request Click the drop-down arrow and select the request type.
Up to 15 requests can be setup for each remote. The
system has four predefined requests:
• Command - Selecting this option enables the

Commands field.
• No Command - Selecting this option disables the

scheduled event.
• Poll for Data - This is the normal request to poll the

remote for data.
• Time Sync - This is used for protocols that maintain

time in the remote. The host’s time is sent down to the
remote in order to synchronize the remote’s time with
that of the host.
Priority Click the drop-down arrow and select the scheduled
event’s priority. The choices are:
• Low
• Medium
• High
The priority affects the order the event is placed on the

queue and the order that the connection is made and
modem allocated. Requests are handled in the following
order: high, medium, then low.
• If two requests have the same priority rating and one

of the requests has previously failed, priority is given
to the request that has not been attempted.
• If two requests have the same priority rating and both

requests have previously failed, priority is given to the
older request.
• If two requests have the same priority rating and

neither request has previously failed, priority is given
to the older request.
Table continued…
281
Remote table
Item Description
Command Click the ellipsis button (...) and type a protocol-specific
command string in the Schedule Command Edit Form.
This field is only used if the Request field is set to
Command.
Schedule Click the ellipsis button (...) to open the Remote Schedule
dialog box and configure scheduling for the remote.
Refer to “Configuring a remote scheduled event” for more
information.
32.3.1 Configuring a remote scheduled event

Use the Remote Schedule tab in the Remote Row Edit dialog box to configure a remote
scheduled event.
Procedure
1. Click the Request drop-down arrow and select the appropriate request.
a) Select Command if the request is a protocol-specific command.
b) Select No Command if you are disabling the scheduled event.
c) Select Poll For Data if this is a normal request to poll the remote for data.
d) Select TimeSync if you are using a protocol that maintains time in the RTU (for
synchronization between the host and remote).
2. Click the Priority drop-down arrow and select the scheduled event’s priority.
3. If you are scheduling a command request, click the Command ellipsis button (...) to access
the Schedule Command Edit Form dialog box and schedule a command.
4. Click the Schedule ellipsis button (...) to access the Remote Schedule dialog box.
282
Remote table
Figure 186 - Remote Schedule dialog box
5. Configure the schedule as needed.

6. Click the Accept button.
Result
The scheduling details appear on the event’s row on the Remote Schedule tab in the Remote
283
Remote table
32.4 Inhibits tab Remote Row Edit

Use the Inhibits tab in the Remote Row Edit dialog box to inhibit events and alarms caused by
state changes such as change of state from normal to off-normal and vice versa.
Figure 187 - Inhibits tab in the Remote Row Edit dialog box
Normal and off-normal states for a remote are determined by the following:
• No-reply timeouts
• Security errors
• Short messages
• Illegal messages
fields.
284
Remote table
Table 88 - Items on the Inhibits tab in the Remote Row Edit dialog box
Items Description
normal state.
normal state.
normal state.
state.
Switch Conn Path Select the check box to inhibit the alarm that is generated when a
Alarm communication line switches to a different path.
32.5 Sample remote record configuration

Delays and timeouts that apply to a specific remote are configured in the Remote table. Sample
configurations are provided to help you configure remote records.
The following table shows the field settings for two remotes described as follows:
• Remote 1 monitors field devices that change frequently.
• Remote 2, a slower remote on a poor communication line, monitors values that change
infrequently.
Table 89 - Field settings of a sample remote record

ADE Field Remote 1 Remote 2 Notes
Timeout for 0 45 When you use host poll connection mode, the
No-reply Alarm host polls the remote for the number of times
(sec) specified in the connection record (Number of
Poll Retries field on the Scan Edit tab in the
Connection Row Edit dialog box). If no data
is received from the remote, it goes into the
NO REPLY state. If the remote stays in this
state for longer than the timeout, the system
issues a NO REPLY alarm.Unlike many of the
other values in the Scan Parameters tab in
the Remote Row Edit dialog box, this timeout
is not affected by the speed of the remote. To
eliminate nuisance alarms, the timeout is set
higher for remotes that use communication
lines with poor transmission quality. The field
is typically set to either zero (i.e. not used) or
at least 2.5 or 3 times the Min. Poll-cycle
Time.
RTU Poll Delay 00:00:00 00:05:00 For multi-drop configurations, this delay
(HH:MM:SS) reduces the amount of bandwidth wasted by
Table continued…
285
Remote table
Table 89 - Field settings of a sample remote record (continued)

ADE Field Remote 1 Remote 2 Notes
remotes that transfer less important data or
data that rarely changes. It can be used to
prevent overly frequent polling of battery-
operated remotes or to minimize
communication charges based on traffic or
amount of data sent.Polling for dialed remotes
is often scheduled for specific times of the
day. In such cases, the RTU Poll Delay may
not be used (i.e., it may be set to zero).
No-response 00:00:00 00:10:00 For multi-drop configurations, this delay
Delay reduces the amount of time spent waiting on
(HH:MM:SS) the communications circuit for remotes that
are unlikely to respond. When no response is
received from the remote over a connection,
Omnicomm attempts to poll the remote at an
interval that is the greater of the RTU Poll
Delay and the No-response Delay.
RTU 100 2000 This delay applies to poll for data, upload
Turnaround history and other typical poll requests. It is set
Time (ms) to the longest time required for the remote to
parse a query, process it, and formulate a
response.
Overhead 0 500 This delay applies to commands only
Processing (setpoint, status output). It accommodates
Time (ms) remotes that require more time to execute
commands than to respond to data queries
(i.e., remotes that respond more slowly to
commands than to polls).If the remote takes
longer to process commands than to process
queries, set this delay to the difference
between the longest command processing
time and the longest query processing time. If
the time required to process commands is the
same as or less than the time required to
process queries, set this delay to zero.
Related Information
Scan Edit tab Connection Row Edit on page 174
Scan Parameters tab Remote Row Edit on page 274
286
Remconnjoin table
33 Remconnjoin table
Remote connection (remconnjoin) records represent connections that are configured for a
specific remote. Remconnjoin records are located in the Remconnjoin table and are configured
using the Remconnjoin Row Edit dialog box.
Figure 188 - Remconnjoin Table Edit
The Remconnjoin table can be accessed from the Realtime view in the Advanced Database
Editor or found through the Remote records from the Main view. To open the table or a single
remconnjoin record, you can expand the Remote table as show in the figure below.
Figure 189 - Remconnjoin Table Navigation
287
Remconnjoin table
33.1 Remconnjoin Row Edit

Use the Remote connection (Remconnjoin) Row Edit dialog box to configure the details of a
remote connection such as the cost factor, timeout and test frequency information.
Figure 190 - Remconnjoin Row Edit dialog box
fields.
Table 90 - Items on the Remconnjoin Row Edit dialog box

Item Description
Remote Click the ellipsis button (...) and select the name of the remote that is
associated with this connection from the Remote Select dialog box.
Connection Click the ellipsis button (...) and select the name of the connection record that
is associated with the remote device from the Connection Select dialog box.
Cost Factor Type the cost factor of the connection. This value is a number that indicates
the relative cost of the connection. Higher numbers indicate higher cost of
usage.
Failure Type the length of time (in seconds) that a remote can fail to communicate
Timeout over its current connection before it fails over to the next cheapest
connection. A value of zero disables connection failovers.
Table continued…
288
Remconnjoin table
Table 90 - Items on the Remconnjoin Row Edit dialog box (continued)

Item Description
Inhibit Select the check box for Omnicomm to only pass commands that are sent to
Autopoll Omnicomm (including poll commands) to the remote. The commands also
include those that are sent to Omnicomm by the remote scheduler. Normally,
Omnicomm polls its remote devices regularly, establishing a connection when
necessary.
Good Test Type the time (in minutes) that must pass before the next test poll can be
Frequency issued to this remote over this connection if the remconnjoin status is in a
good state (ie., the State column in the Communication Statistics Summary is
Normal).
Refer to the Operation and Control Reference in the ezXOS user
documentation for more information about the Communication Statistics
Summary.
The actual time may be longer depending on the frequency that the
ConnectionControllerexecutable is scheduled to run. The
ConnectionController executable is started in the run_processes.
When changing the frequency in the ConnectionController, RealTime
must be restarted before the change takes effect.
A value of zero indicates that testing will never occur.

Bad Test Type the time (in minutes) that must pass before the next test poll can be
Frequency issued to this remote over this connection if the remconnjoin status is in a bad
state (ie., the State column in the Communication Statistics Summary is
anything other than Normal).
The actual time may be longer depending on the frequency that the
ConnectionController executable is scheduled to run. The
ConnectionController executable is started in the run_processes.
When changing the frequency in the ConnectionController, RealTime
must be restarted before the change takes effect.
A value of zero indicates that testing will never occur.
33.2 Job scheduler scripts

Job scheduler (jsh) scripts can be used to test and switch connections.
TestConnections, RSI of 1 minute, Argument of “test”
This entry schedules the test polls to the connection/remote pairs. Although the script is run
once a minute, the test polls may be scheduled for longer times on each connection and remote
combination.
SwitchConnections, RSI of 1 minute, Argument of “switch”
This entry schedules the connection controller script to perform connection switch overs on a
periodic basis. Communication to a remote is switched over to a connection providing all of the
following are met:
289
Remconnjoin table
• connection/remote pair is in a good state (i.e., the State column in the Communication
Statistics Summary is Normal)
• connection to the remote has a lower Cost Factor than the one currently in use
• Enable Communications Failover check box on the Main tab in the Remote Row Edit
dialog boxis selected
Related Information
Main tab Remote Row Edit on page 270
290
RVE Rules Set Table
34 RVE Rules Set Table

The Rules Validation Engine (RVE) intercepts commands for analog, status, and multistate
points that are configured to check against rules sets. Rules sets are configured in the
rveruleset table.
Rules are BLT objects, that can be used to customize the conditions under which system points
can be controlled. All rules must first appear in config\BLT\RVE.txt. RVE Rules Set table
records are found under Main on the ADE View menu. Each rules set can contain up to twenty
rules.
A rules set is created in the rveruleset Row Details dialog box. The rule name will appear as it
does in config\BLT\RVE.txt, but without the bobj prefix. When a rules set is configured for
use, it calls to the associated rule library. These checks determine if the command is allowed to
proceed or not.
NOTE: Sample rules can be found in DNA\Realtime\SDK\Examples\RVE.
Figure 191 - RVE Rule Set Row Details dialog box
291
RVE Rules Set Table
Table 91 - Items on the RVE Rules Set Row Details dialog box
Item Description
Name Type a unique name for the rules set.
Description Type a description for the rules set.
Rule # Type the rule as it appears in config\BLT\RVE.txt without a prefix of
bobj. You can assign up to 20 rules to one rules set. They are checked in
the order given by this dialog box.
NOTE: The rveruleset records must be configured before the Rules Validation Engine can be
applied to analog, status, or multistate points. Rules sets are assigned to individual
records in the RVE tab in the Analog, Status, and Multistate Row Edit dialog boxes.
34.1 Parameters of Rule Checking

If a rules set is configured, RVE rule checking will only be performed if the command is issued
through the RVE BLT.
When control displays (CNTL_ANALOG, CNTL_STATUS, and CNTL_MULTISTATE) are used

to command a point, rule checking will be performed; whereas RVE rule checking will be
bypassed on function puts issued from the command line.
Tag checking occurs before RVE rule checking. Prohibitive tags such as "no commands" cause
a command to abort. However, if a warning tag is encountered, you can override it to enable
rule checking to proceed. If a Command Test Override tag is encountered, you will be given an
opportunity to override any lower priority prohibitive tags to enable rule checking to proceed
without interruption from these tags.
As rule checking occurs, you will be notified of any rule violations. However, rule violations can
be overridden if you wish to proceed with the command.
The following logs exist for RVE:
• log\RVEcommand.log
• log\RVEbltcaller.log
• log\BLTHost.RVE.log
34.2 Rule Violation

You will be notified if the RVE prevents a command from being issued with a message in the
RVE Control dialog box.
This message tells you the table, point, and command issued, in addition to providing violation
messages. You can choose to ignore the rule and issue the command by clicking Override. The
example below shows RVE intercepting a setpoint that was issued from the analog control
panel in ezXOS.
292
RVE Rules Set Table
Figure 192 - Violation Message in RVE Control dialog box
293
Signal configuration table
35 Signal configuration table

Correct signal configuration is critical for all connections. For dial connections, the modem bank
uses signal configuration (sigconfig) records to ensure a proper speed match-up between a
connection and a modem. Sigconfig records are located n the Sigconfig table and are
configured in the Sigconfig Row Edit dialog box.
Figure 193 - Sigconfig Table Edit
Omnicomm computes expected remote response “windows” that are largely based on the
remote’s line speed. For this reason, correct signal configuration is critical for non-dial (leased-
line) connections and even for normal fixed-speed connections. For example, if signal
configuration is specified at 9600bps and the remote actually communicated at 1200bps, then
data return would take eight times longer than what Omnicomm expects. Therefore, Omnicomm
will stop “listening” after only one-eighth of the data has been returned and consider the
message to be “short” and possibly compute a CRC error.
The Sigconfig table is used to define communication characteristics for the connection, remote,
and modem tables.
Related Information
Connection table on page 171
Modem table on page 212
Remote table on page 269
294
35.1 Sigconfig Row Edit

Use the Main tab on the Sigconfig Row Edit dialog box to configure the signal configuration
records.
Figure 194 - Main tab on the Sigconfig Row Edit dialog box
fields.
Table 92 - Items on the Sigconfig Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the sigconfig record
from the Row Select dialog box.
The naming convention for a sigconfig record is: <character
size><parity><baud rate>s<start bits> <stop bits>
For example: 7E1200s1

Baud Rate Click the drop-down arrow and select the baud rate that matches the
speed of the connected device.
Weak lines may require a lower baud rate to ensure data is not lost.
Omnicomm uses the baud rate to perform timing calculations. Baud rate
and other fields are used for dynamic configuration.
This corresponds to the <baud rate> variable in the signal configuration

naming convention.
Table continued…
295
Table 92 - Items on the Sigconfig Row Edit dialog box (continued)

Items Description
Parity Click the drop-down arrow and select the type of parity used for the
record. The choices are:
• EVEN
• ODD
• NONE - Parity is not used
This corresponds to the <parity> variable in the signal configuration

naming convention.
Start Bits Type the number of start bits (0, 1 or 2) used in byte framing.
This corresponds to the <start bits> variable in the signal configuration
naming convention.
Stop Bits Type the number of stop bits (0, 1 or 2) used in byte framing.
This corresponds to the <stop bits> variable in the signal configuration
naming convention.
Character Size Type the number of bits used in a byte or the character size. Valid
entries are 7 or 8.
This corresponds to the <character size> variable in the signal
configuration naming convention.
296
Spooler table
36 Spooler table
A spooler record exists for every RealTime database printer in the system. Event messages for
all field devices that are assigned to a specific group are logged to the event spooler. Spooler
records are stored in the Spooler table and configured in the Spooler Row Edit dialog box.
Figure 195 - Spooler Table Edit
For the event messages where no specific group is appropriate, the designated system spooler
is used. The system spooler (default) is designated as spooler 1 at system set-up and some
applications must write to the system spooler (e.g., checkCover and system alarms). Event
messages for specific groups may be set to log to the system spooler or to another spooler as
desired.
297
Spooler table
36.1 Spooler Row Edit

Use the Spooler Row Edit dialog box to configure the basic properties of a spooler record such
as the device to which the printer is connected.
Figure 196 - Devices tab in the Spooler Row Edit dialog box
fields.
Table 93 - Items on the Spooler Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the spooler record
Name Type the name of the physical device to which the printer is connected.
The number associated with the device is the number of the device the
spooler writes to. The device output can be any of the following:
Table continued…
298
Spooler table
Table 93 - Items on the Spooler Row Edit dialog box (continued)

Items Description
• A printer on a workstation or personal computer
Valid device names include “LPT1:” or “COM1:” where LPTx and

COMx are ports connected to printers (e.g., LPT1 is a parallel port
and COM1 is a serial port).
• A spooler log file on a specified host
Device names in the form host:\dir\file or host:\DIR\file

are acceptable. The device name cannot be longer than 31
characters.
System Click the ellipsis button (...) and select the system associated with this
device from the System List dialog box.
36.2 Spooling events to a file

When events are spooled to a file, the log file can fill up with data if it is not emptied periodically.
To ensure old entries are deleted, a job scheduler (jsh) entry should be created.
The jsh entry should invoke the shuffle_file command periodically to prevent the log from
filling up. The command syntax is:
shuffle_file filename number_of_file_copies

The extension 0 is added to the filename to shuffle a file once, 1 to shuffle twice, etcetera.
jsh Name: shuffleDailyLog
Time: 8:00
Command: shuffle_file %CMX_ERRLOG%\spooler1.log 30
Type: SCRIPT
In this example, the daily log recorded in file %CMX_ERRLOG%\spooler1.log is moved each
day to %CMX_ERRLOG%\spooler1.log.0 so that up to 30 previous daily log files are kept in
the system.
Related Information
36.3 Spooler replication and failovers

Within the active system, information is replicated from the hot machine to the standby machine.
This guarantees that messages are not lost within the active system on a service failover.
If the service fails over, the hot machine continues the event logging. The event queue is re-
synchronized periodically via replication. The actual printing of the messages is the
299
Spooler table
responsibility of the spooler at the hot service. The spooler on the standby service idles while it
waits to take over.
There is no guarantee that there will not be message loss on system failover (e.g. failover to the
backup system). It is possible to lose messages since the spooler configuration (i.e. the list of
named physical devices associated with each spooler) is automatically replicated between
different systems, but the state information and the message queue are not.
300
Status table
37 Status table
A status record is used to represent a one-bit or two-bit value indicating discrete device states.
Status records are located in the Status table and are configured using the Status Row Edit
dialog box.
Figure 197 - Status Table Edit
A status record can also be configured for:
• Conversion of the raw telemetry value into a consistent representation of the device state
• Digital output command processing (e.g., start pump and verify command execution)
• Complex alarm and event processing on the current state
• Historical data collection of the current value at periodic intervals and by exception
• Recording the time in hours that the status value represents the active state (e.g., on, open,
start, trip) for the current and previous hour, day and month
From the operator interface, a status record can be:
• Manually overridden with a value or re-enabled to use the telemetry/calculated value
• Tagged to inhibit digital output commands

• Commanded to operate the digital output
A status record can also have its alarms inhibited or enabled.
NOTE: If you require a point with more than 4 states, you can create a multistate point.
301
Status table
37.1 Main tab Status Row Edit

The Main tab in the Status Row Edit dialog box is used to set up the basic properties of the
record, such as group, dataset, and input type.
Figure 198 - Main tab in the Status Row Edit dialog box
The Main also gives the user access to the historical database via the Historical and PI
Table 94 - Items on the Main tab in the Status Row Edit dialog box
Items Description
Name Click the ellipsis button (...) and select the name of the status record
Table continued…
302
Status table
Table 94 - Items on the Main tab in the Status Row Edit dialog box (continued)
Items Description


multistate point).
must be configured if the Input Type is set to telemetered.
Data Format Click the drop-down arrow and select the status subtype used for this
point. The choices are:
• Enumeration Format - The point reads a reguster (whole word)
from the RTU.
• Bit Format - The point reads up to 8 bits from the RTU. It results in
an input of up to 256 states.
Table continued…
303
Status table
Table 94 - Items on the Main tab in the Status Row Edit dialog box (continued)
Items Description
37.2 Input tab Status Row Edit

The Input tab in the Status Row Edit dialog box is used to configure status inputs.
Figure 199 - Input tab in the Status Row Edit dialog box
fields.
304
Status table
Table 95 - Items on the Input tab in the Multistate Row Edit dialog box
Items Description
Has Input Select the check box to allow the setting of the multistate point’s current
value field.
Number of Input Type the status point type.
Bits
For two-bit devices, input-bit 1 (Input #1) is the low-orfer bit, and input-
bit 2 (Input #2) is the high-order bit.
Possible inputs are:
• 0 - Enter this for digital output devices that do not return “command
success” messages. With this setting, neither Input #1 nor Input #2
need to be configured.
• 1 - Enter this for two-state devices. With this setting Input #1 must
be configured.
• 2 - Enter this for four-state devices. With this setting both Input #1
and Input #2 must be configured.
Bit in RTU Status Select the check box if this status record is monitoring a remote-specific
condition.
If this is selected, no other fields on the Input tab need to be configured.
In some protocols like TANO, the remote status word (RSW) is an 8-bit
status word that is returned to the host. Each bit in this word represents
a remote-specific condition, such as: AC powerfail, bulk powerfail in one
or more expansion baskets, unit pwered up, command disabled,
uninitialized.
Bit Number Type the bit number that points to the device’s status bit number within
that word.
A single word of RealTime data can encode messages from a number of
status/multistate devices.
Normally Open Select the check box if your remote does not return a value of 1 to
indicate OPEN.
Table continued…
305
Status table
Table 95 - Items on the Input tab in the Multistate Row Edit dialog box (continued)
Items Description
The system expects 1 to indicate the device is in an open state. When

Normally Open is selected, the bits from the remote are inverted (i.e., 0
is changed to 1; 1 is changed to 0). If Normally Open is cleared, the
bits that are returned from the remote remain unprocessed.
Accumulate Select the check box to record the time (in hours) that the status input
Runtime has been in the state specified in the Accumulated State field. It
indicates the time during the current and preceding hour, day, shift, and
month.
Runtime values may be used in a report to determine device
maintenance requirements. For instance, pump maintenance is
performed when a pump runtime value exceeds the maximum runtime
recommended for the month. This could be checked using an SQL
statement, such as the following:
select name from status where run.month.previous > 1.5
Accumulated State Click the ellipsis button (...) and select the state you want to monitor
from the Accumulated Runtime State dialog box.
Refer to “Selecting an accumulated runtime state” for more information.
SOE Point Select the check box to allow the event messages from this point to
record the time data changes at the remote instead of the time that the
host receives the data.
This will only occur if the information is available.
37.2.1 Selecting an accumulated runtime state

Use the Accumulated Runtime State dialog box to select the accumulated runtime state for a
status record.
Figure 200 - Accumulated Runtime State dialog box
The Accumulated Runtime State is accessed from the Input tab in the Status Row Edit
dialog box.
Procedure
1. On the Input tab, click the ellipsis button (...) next to the Accumulated State field.
Step Result: The Accumulatred Runtime State dialog box appears.

3. Click Accept.
306
Status table
37.3 Output tab Status Row Edit

Use the Output tab in the Status Row Edit dialog box to configure output commands for status
records.
Figure 201 - Output tab in the Status Row Edit dialog box
The Output tab has two similar configuration sections: Command #1 that configures the OPEN
command and Command #2 that configures the CLOSE command.
fields.
307
Status table
Table 96 - Items on the Output tab in the Status Row Edit dialog box
Items Description
Has Output Select the check box to allow configuration of output commands for
status points.
Command Type This field indicates the command type.
choices are:
executed.
command signal.

Command Click the drop-down arrow and select one of the following options:
• Energize - Energize the relay coil.
• De energize - De-energize the relay coil.

Timeout (msec) Type the timeout associated with the command (in milliseconds). This is
dependent on the protocol, but this value is typically set to the time
needed to close the contacts for a momentary release.
Command Failure Type the command failure timeout value (in seconds). If the command is
Timeout unsuccessful, the system will wait for the timeout period before
If the timeout is zero, this feature is diabled.
COS Failure Type the COS timeout value (in seconds). If the device does not change
Timeout state in the time period configured here, an alarm is generated.This is
only applicable to three-state and four-state devices (i.e., devices where
the Number of Input Bits field on the Input tab is set to 2).
If the timeout is zero, this feature is disabled. An alarm is not generated
if the device is already in the commanded state.
Log Command Select the check box to record successful commands in the event log.
Success Unsuccessful commands always generate alarms and are logged
whether or not this is selected.
308
Status table
37.4 Alarming tab Status Row Edit

Use the Alarming tab in the Status Row Edit dialog box to configure the alarming associated
with the status record. You can configure alarm suppression and select which state should be
considered abnormal.
Figure 202 - Alarming tab on the Status Row Edit dialog box
fields.
Table 97 - Items on the Alarming tab in the Status Row Edit dialog box
Items Description
Sustain COS Select the check box to allow alarms to remain in the Alarm Summary
Alarms window in ezXOS as long as the point remains in the abnormal state.
The alarm beeping stops when the operator acknowledges the alarms,
but they are only removed from the window when the point returns to
the normal state.
If the Sustain COS Alarms check box is cleared, alarms disappear from
the Alarm Summary window as soon as they are acknowledged.
Alarm Click the button to open the Alarm Suppression Table Edit dialog box.
Suppression
Abnormal States Click the button to open the Selected Abnormal States dialog box and
set which states should be recognized as abnormal.
Refer to “Configuring abnormal states” for more information.
309
Status table
37.4.1 Configuring abnormal states

Use the Abnormal States Alarms dialog box to configure abnormal state alarming. Abnormal
states can be configured for either of the two conditions a status point can be in: OPEN and
CLOSE.
Figure 203 - Abnormal States Alarm dialog box
You can access the Abnormal States Alarms dialog box through the Alarming tab in the
Status Row Edit dialog box.
Procedure
1. On the Alarming tab, click Abnormal States.
Step Result: The Abnormal States Alarms dialog box appears.

2. Select the state you want to be recognized as abnormal.
3. Click Accept.
310
Status table
37.5 Inhibits tab Status Row Edit

Use the Inhibits tab in the Status Row Edit dialog box to inhibit alarming or logging of
uncommanded state changes.
Figure 204 - Inhibits tab on the Status Row Edit dialog box
Alarms are normally annunciated and displayed in ezXOS. However, for some conditions, it may
be desirable to inhibit specific alarms.
The Inhibits tab allows you to inhibit alarms and logs generated due to uncommanded
changes. Uncommanded changes are those that occur without the user’s intervention. For
example, if someone in the field opens a valve, the change is considered to be uncommanded
since the change did not result from the operator’s action.
NOTE: In a distributed installation, alarm acknowledgement is local to a system and is not

replicated to other systems. Hence, for the same point, an operator on one system
handles alarm acknowledgment completely independent of operators on the other
systems. Alarms are distributed to other systems depending on the alarm configuration
option specified.
fields.
311
Status table
Table 98 - Items on the Inhibits tab in the Status Row Edit dialog box
Items Description
state changes to
Abnormal states
state changes to
If an unacknowledged abnormal state alarm exists, the change to
Normal states
normal state alarm will occur whether or not this check box is selected.
This ensures that the operator is aware that the point’s alarm state
changed.
state changes to
Abnormal states
state changes to
Normal states
312
Status table
37.6 RVE tab Status Row Edit

The RVE tab in the Status Row Edit dialog box is used to configure the checking of the point’s
rule sets. Any commands for the point are intercepted by the Rules Validation Engine, which
determines if a command is allowed to proceed or not.
Figure 205 - RVE tab in the Status Row Edit dialog box
Table 99 - Items on the RVE tab in the Status Row Edit dialog box
Items Description
313
Status table
314
Table Security table
38 Table Security table

Table security records are used to provide security configuration for an entire RealTime table.
Table security records are located in the Table Security table and are configured using the Table
Security Row Edit dialog box.
Figure 206 - Table Security Table Edit
Unlike AOR security where security is configured on a per record basis, table security provides
a method of configuring security on a per table basis. If the table does not have an AOR group,
then table security records are used. However, if the table does have an AOR group (e.g.,
analog, rate, or status), then AOR security is used. If there are any tables with an AOR group in
the Table Security table, that entry is ignored.
The Table Security table lists the RealTime tables and the defined groups that have read or
write access to these tables. It does not include RealTime tables that use AOR Security. A
RealTime table that doesn't use AOR Security and doesn't have an entry in the tableSecurity
table is defaulted to use a Write Group permission of "DNA Permission - Config_Database" and
Read Group permission of "DNA Permission - View".
Normally, the Table Security table configuration does not need to be modified. If the Read
Group entry is empty, the user must have "DNA Permission - View" to read the table. If the
Write Group is empty, the user must have either "DNA Permission - Control_SCADA" or "DNA
Permission - Config_Database" to change data in the table.
Related Information
Area of Responsibility on page 142
315
Table Security table
38.1 Table security records

Use the Table Security Row Edit dialog box to configure the read and write permissions for the
tables associated with each table security record.
Figure 207 - Table Security Row Edit dialog box
fields.
Table 100 - Items on the Table Security Row Edit dialog box
Items Description
Table Name Click the ellipsis button (...) and select the name of the table you want to
configure security settings for from the Row Select dialog box.
Only RealTime tables that do not have AOR security are listed.
Read Group Click the ellipsis button (...) and select the group that has read access to
the table in the Table Name field.
Write Group Click the ellipsis button (...) and select the group that has write access to
the table in the Table Name field.
NOTE: Entries to the Read Group: and Write Group: fields are plain text strings and must
exactly correspond to the configured windows groups. The Table Security Select dialog
box is provided to assist you in providing entries for these fields.
316
Test Mode Set table
39 Test Mode Set table

A test mode set record defines a set of RealTime records that would be directly affected by
testing or maintenance performed on a specific section of the system. Test mode records are
located in the Test Mode Set table and are configured in the Test Mode Set Row Edit dialog
box.
Figure 208 - Test Mode Set Table Edit
When testing or maintenance is being performed on the system, records related to that section
can be placed in “test mode”. Test mode filters any alarms generated by testing activities out of
the Alarm Summary window. This is known as test mode alarm filtering. The alarm state will be
shown in the point summary displays (e.g., Analog Summary) as usual, but these alarm states
cannot be acknowledged if test mode is active.
The Test Mode Set (testmodeset) table shows all the test mode alarm filtering criteria that is
configured for a test mode set record. Test mode criteria can be added, edited, or deleted from
this window.
Test mode set records define test mode sets and indicate if the set should be in or out of test
mode. By grouping records in this way, you can avoid nuisance alarming that occurs during
maintenance and testing from appearing in the Alarm Summary.
317
Test Mode Set table
39.1 Main tab Test Mode Set Row Edit

Use the Main tab on the Test Mode Set Row Edit dialog box to configure the basic settings of
a test mode set record. This tab is where you indicate if test mode should be active and define
the timeout settings.
Figure 209 - Main tab in the Test Mode Set row edit dialog box
fields.
Table 101 - Items on the Main tab in the Test Mode Set Row Edit dialog box
Items Description
Name Click the ellipsis button (...) and select the name of the test mode set
record you want to edit from the Select dialog box, or type a new test
mode set name to create a new record.
Active Select the check box if you want to activate test mode for the records in
this test mode set.
Local Timeout Select the check box if you want to use the local test mode
timeout.Clear the check box to use a global test mode timeout that is
applied to all or a group of test mode sets.
Table continued…
318
Test Mode Set table
Table 101 - Items on the Main tab in the Test Mode Set Row Edit dialog box (continued)
Items Description
NOTE: Global timeout is defined in

<Telvent_Installation_Location>\config\Registy
\RealTime.xml. The name of the variable is
TEST_MODE_TIMEOUT_MINUTES.
Timeout Minutes Type the number of minutes this test mode set can remain active before
timing out.A value of 0 means the test mode set has no expiry.
NOTE: If you are not using local test mode timeout, the system will
use the timeout value configured for the global test mode
timeout.
Group Click the ellipsis button (...) and use the Group Select dialog box to
select the group to which the point belongs.
319
Test Mode Set table
39.2 Test Mode Points tab Test Mode Set Row Edit
Use the Test Mode Points tab in the Test Mode Set Row Edit dialog box to define which records
are included in the test mode set.
Figure 210 - Test Mode Points tab on the Test Mode Set row edit dialog box
fields.
Table 102 - Items on the Pointstab in the Analog Row Edit dialog box
Items Description
Database and Choose up to 50 records to belong to this test mode set.
Point
Click the ellipsis button (...) and configure the Point Selector dialog box
to add a record.
Refer to “Point Selector” for details on how to configure the Point

Selector dialog box.
320
Test Mode Set table
39.3 Point Selector

Use the Point Selector dialog box to locate the record you are adding to a test mode set record.
Figure 211 - Point Selector dialog box
fields.
Table 103 - Items on the Path Selector dialog box

Field Name Description
Table Use the drop-down arrow and select the Table to which your desired
record belongs. Valid options are:
• analog
• multistate
• rate
• remote
• status
NOTE: The tables listed above are the tables enabled for test
mode in baseline. If remote is selected, test mode filtering
is applied to the remote itself and all points configured to
that remote (i.e., analog, status, multistate, and rate).
Record Click the ellipsis button (...). A select dialog box associated with the
Table option you selected appears. Use this dialog box to select the
Record you are adding to the test mode set.
Accept Click Accept to add the record to the test mode set.
Cancel Click Cancel to close the Point Selector dialog box. None of the
changes you have made in the dialog box will be saved or added to
the test mode set.
Help Click Help to open the RealTime Tables user documentation.
321
Xosalmattr Table
40 Xosalmattr Table
The xosalmattr (ezXOS alarm attribute) records are used to assign colors and sound to different
alarm severities. Xosalmattr records are stored in the Xosalmattr table and are configured in the
Xosalmattr Row Edit dialog box.
Figure 212 - Xosalmattr Table Edit
Alarm attributes are assigned so alarm severities are distinct and easily recognizable for the
Operator. The severity of an alarm is indicated by color on various ezXOS alarm summary
windows. A severity level is assigned a specific color, as shown in the following table.
Table 104 - Typical alarm severity color assignment

Severity Level Color Assignment
High Red
Medium Yellow
Low Green
Alarm severity is also indicated by the frequency and duration of beeping. More severe alarms
are typically configured to beep more rapidly. All alarms, regardless of severity, are usually
configured to beep until they are acknowledged.
322
Xosalmattr Table
40.1 Xosalmattr Row Edit

Use the Xosalmattr Row Edit dialog box to configure how alarms are presented in ezXOS.
Figure 213 - Xosalmattr Row Edit dialog box
fields.
Table 105 - Items on the Xosalmattr Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the alarm type from the Select
dialog box.
Audio File Click the ellipsis button (...) and select the sound that plays with this
alarm from the Sound File Select dialog box.
Refer to “Sound File Select dialog box” for more information.
Severity Color Click the drop-down arrow and select the color that is displayed with this
alarm.
For alarms in the Alarms Summary, the number of available severity
levels is pre-defined.
Beep Cycle Time Type the length (in seconds) of the beep cycle.
(secs)
Table continued…
323
Xosalmattr Table
Table 105 - Items on the Xosalmattr Row Edit dialog box (continued)
Items Description
Number of beeps Type the number of beeps that are played per cycle.
Higher priority alarms should have more beeps per second than lower
priority alarms.
Number of Cycles Type the number of times the beep cycle is repeated. The cycle stops
when this number is reached or the user acknowledges the alarm.
For example, setting Number of Cycles to 20 gives a repeat of 20
cycles before the alarm sound disappears (if it goes unacknowledged).
A value of -1, a common setting, results in the alarm cycle continuing

until the alarm is acknowledged.
40.1.1 Sound File Select dialog box

The Sound File Select dialog box lists all the sounds that can be assigned to an alarm.
Figure 214 - Sound File dialog box
324
XOS Color Mapper table
41 XOS Color Mapper table

The information required to map colors to selected numerical values for display purposes is
configured in the XOS Color Mapper table. This table stores XOS color mapper records that are
configured in the XOS Color Mapper Row Edit dialog box.
Figure 215 - Xos Color Mapper Table Edit
Each color is mapped to a range of values that starts with its minimum value and ends at the
value entered as the minimum value for the next color. For example, if the first color entry has a
minimum value of 1, the second entry has a minimum value of 100, and the third entry is 200,
then the range for the first color entry is 1 to 99 inclusive, and the second color range is 100 to
199 inclusive. The range for the third color entry starts at 200 and continues up to the minimum
value of the next entry. If the third color entry is the last color entry, the range continues until it
reaches the upper range limit for that RealTime database record.
325
41.1 XOS Color Mapper Row Edit

Use the XOS Color Mapper Row Edit dialog box to configure custom color map sets for use on
dynamic displays.
Figure 216 - XOS Color Mapper Row Edit dialog box
The XOS Color Mapper Row Edit dialog box allows you to do the following:
• Edit the XOS Color Mapper table, which contains the information required to map colors to
selected numerical values for display purposes.
• Display a list of color map sets in the XOS Color Mapper table
• Search, modify, add, and delete color map sets
NOTE: The values that are assigned in the XOS Color Mapper Row Edit dialog box are used
when the Numeric Mapping color scheme is selected on certain device templates (i.e.,
dynamic polyline, performance plot, and generic device). The object template can be
used to attach a color map set to a specific RealTime point so that particular colors are
associated with the values that are entered in the XOS Color Mapper table.
fields.
Table 106 - Items on the Xosalmattr Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the record from the Select dialog
box.
Maximum Value Click the ellipsis button (...) and select a color from the Color Picker
Select dialog box.
Refer to “Configuring color map sets” for more information.
Color Index Type the value of the color map set.
326
41.1.1 Configuring color map sets

Use the XOS Color Mapper Row Edit dialog box to modify a color map set.
Procedure
1. To change the value of the color map set, type the new number in the Minimum Value field.
OR
Click the Color Index ellipsis button (...) to open the Color Picker dialog box.
Figure 217 - Color picker dialog box
2. On the Color Picker dialog box, select a color by clicking the panel that corresponds to the
desired color.
3. Click Accept.
Result
The selected color and color index number appear on the XOS Color Mapper Row Edit dialog
box.
327
FlexTag Tables
42 FlexTag Tables
Flexible tagging is a feature that allows for greater customization of tags. With flexible tagging
(FlexTag), you can configure the exclusivity of tags, group tags together for mass modifications,
set priorities for FlexTag types, customize tag icons and more.
With flexible tagging, you can also attach multiple tags to a single record. Flexible tagging does
not replace regular tagging. Rather FlexTag can be used instead of regular tagging if set to do
so, but regular tagging is still available.
Flexible tagging can only be used with the Analog, Status, Rate, and Multistate tables.
42.1 Enabling Flexible Tagging

Flexible tagging allows for greater customization of tags. It supplements, not replaces, regular
tagging and can only be used with Analog, Status, Rate, and Multistate tables.
Flexible tagging is a feature that allows for greater customization of tags. With flexible tagging
(FlexTag), you can configure the exclusivity of tags, group tags together for mass modifications,
set priorities for FlexTag types, customize tag icons, and more. With flexible tagging, you can
also attach multiple tags to a single record.
Flexible tagging is not enabled by default. Although the FlexTag Summary can still be accessed
from the ezXOS navigation menu, the system will not acknowledge any FlexTag configuration
changes unless the registry variable is turned on. To enable flexible tagging follow the steps
below.
Procedure
1. Go to: <DataDirectory>\config\Registry\RealTime.xml.
2. Right-click the RealTime.xml file and open it with Notepad.
3. Change <Value Name="USE_FLEXIBLE_TAGGING">FALSE</Value> to <Value
Name="USE_FLEXIBLE_TAGGING">TRUE</Value>.
4. Restart RealTime by shutting it down in the NMC, then starting it again. The next time you
start ezXOS and select the Tags System Display, the FlexTag Summary will appear
instead of the regular Tag Summary.
328
FlexTag Tables
42.2 FlexTagType table

The FlexTagType table defines all of the available tag types that are selectable from the
FlexTag Control dialog box in ezXOS. By configuring the FlexTagType table, you can
customize the priorities, restrictions and icons of FlexTag types.
Figure 218 - FlexTagType Table Edit
Each record in the FlexTagType table assigns a priority, a restriction, and an icon for a particular
tag type. These options may be configured as desired, with these configurations appearing in
the FlexTag Summary window in ezXOS when such tags are selected.
329
FlexTag Tables
42.2.1 FlexTagType Row Edit

Use the FlexTagType Row Edit dialog box to configure the priority and restrictions associated
with this tag. You can also select an image file to use as an icon for each tag type.
Figure 219 - FlexTagType Row Edit dialog box
fields.
Table 107 - Items on the FlexTagType Row Edit dialog box

Items Description
Name Click the ellipsis button (...) and select the name of the FlexTagType
Description Type a description in the field as you want it to appear in the
Description column of the FlexTagType Table Edit dialog box.
Priority Click the drop-down arrow to select the priority value of a tag. If a record
has multiple tags, those with a higher priority will override those of a
lower priority. The priority of a tag will affect where it appears in the
FlexTag Summary in ezXOS, with tags of a higher priority appearing
first.
NOTE: It is important to remember that tags with the Maintenance
restriction change the behavior of tags that have an equal or
lower priority. A No commands tag that is a higher priority
than a Maintenance tag will continue to behave like a No
commands tag. But, a No commands tag that is a lower
priority than a Maintenance tag will behave as though it is a
Warning tag. This is so the testing of maintenance work can
occur on devices without removing tags. You can temporarily
Table continued…
330
FlexTag Tables
Table 107 - Items on the FlexTagType Row Edit dialog box (continued)
Items Description
apply a Maintenance tag, then send a command to the record

to test the functionality of the device.
Restriction Click the drop-down arrow to select a restriction for the tag. The
Restriction field determines the behavior of the tag. The choices are:
• Undefined - A tag with this tag type assumes no pre-programmed
behavior when attached to a record.
• No cmd - Neither the operator nor the application program can issue
any control commands to the record.
• No operator cmds - Operators will not be able to issue any control

commands to a record with this tag type, but the application program
can.
• No program cmds - The operator can issue commands to the
record associated with this tag type, but the application program
cannot.
• Warning - A tag of this type will generate a warning message when

prompted. When a warning message appears, the system presents
the operator an opportunity to cancel the command that prompted it.
The warning message contains the name of the flexTagType record,
along with the name of the tagged record and its associated table.
• Informational - Tags of this type will generate informational

messages. The message contains the name of the flexTagType
record, along with the name of the tagged record and its associated
table.
• Maintenance - Maintenance tags make lower and equal priority

prohibitive tags (such as No Commands) behave like warning tags.
Warning tags will allow the operator to perform an action, but will
generate a warning message beforehand.
Tag Icon Click the ellipsis button (...) to open the Icon Selector dialog box and
select an image file to be used as the icon for the tag.
NOTE: Configuring the tag icon is optional. If you don’t configure a tag
icon, the default icon will be used. The image for the default
icon is determined by the tag type.
331
FlexTag Tables
42.2.2 FlexExclusivity Table

With flexible tagging, you can make any pair of tags mutually exclusive. The FlexTagType1 tag
will always take priority over the FlexTagType2 tag.
Figure 220 - FlexExclusivity Table Edit
If the FlexTagType1 tag exists on a record, you will be unable to add the FlexTagType2 tag. If
you attempt to add the FlexTagType2 tag to a record that contains the FlexTagType1 tag, you
will be presented with an error message. If the FlexTagType2 tag is added to a record first, you
will be able to add the FlexTagType1 tag. Thus, FlexTagType1 and FlexTagType2 are only
mutually exclusive if FlexTagType1 is added first.
Configuring mutually exclusive Flex Tags
Use the FlexExclusivity Table Edit dialog box to configure mutually exclusive Flex Tags.
Figure 221 - FlexExclusivity Table Edit
332
FlexTag Tables
Procedure
1. Click Table > Insert Row.

2. Hover your cursor over the newly created row. A blank button will appear on the right of the
cell.
3. Click the blank button.
Step Result: The Flex Tag Type List Pop Up dialog box appears.
Figure 222 - Flex Tag Type List Pop Up dialog box
4. Select the Flex Tag type to assume the role of FlexTagType1.

5. Click Accept.
Result
A Flex Tag type will have al the other Flex Tag types that it is mutually exclusive with listed
under its FlexTag Type Exclusivity node in the Flexible Tag Type node in ADE. See the
Flexible Tag Type: GeneralInhibit node in the image below for an example.
Figure 223 - ADE: FlexTag Type Exclusivity
333
FlexTag Tables
FlexExclusivity Row Edit

Use the FlexExclusivity Row Edit dialog box to manage the exclusivity rules for any pair of
Flex Tag types.
Figure 224 - FlexExclusivity Row Edit dialog box
fields.
Table 108 - Items on the FlexExclusivity Row Edit dialog box

Items Description
FlexTagType1 Click the ellipsis button (...) to open the FlexTag Type List Pop Up dialog
box.
To select a FlexTag to assume the role of FlexTagType1, select one and
click Accept.
If the tag designated as FlexTagType1 is attached to a record, the

system will not allow you to attach the FlexTagType2 tag. However, if
the FlexTagType2 tag is attached to a record, you will be allowed to
attach the FlexTagType1 tag.
FlexTagType2 Click the ellipsis button (...) to open the FlexTag Type List Pop Up dialog
box.
To select a FlexTag to assume the role of FlexTagType2, select one and
click Accept.
If the tag designated as FlexTagType is attached to a record, the

system will not allow you to attach the FlexTagType2 tag. However, if
the FlexTagType2 tag is attached to a record, you will be allowed to
attach the FlexTagType1 tag.
334
FlexTag Tables
Opening the FlexExclusivity Row Edit dialog box
Use the View menu to open the FlexExclusivity Row Edit dialog box.
Procedure
1. In ADE, click View > System.

2. Expand the Flexible Tag Type table node.
3. Expand the node belonging to the desired row.
4. Expand the FlexTag Type Exclusivity table node.
Figure 225 - ADE: FlexTag Type Exclusivity
5. Double-click the row icon belonging to the desired row.
Result
The corresponding FlexExclusivity Row Edit dialog box appears.
335
Index
Index
A
Analog
alarming 136, 263
inhibits 138
input 130
output 133, 137
record 127, 130, 133, 136–138, 154, 203, 243, 254,
263
P
Perspective 75
Perspective View 76, 78
Pivot and Transfer
color scheme 86
Connect to the target system 88
Perspective 94
Pivot 86, 87
Row Edit 92
Table Edit 91
target dialog box 91
Transfer 86, 90
S
source system 86
T
target system 86
X
xoscontrol
record 154
336
Schneider Electric
49 Quarry Park Blvd SE
Calgary, AB T2C 5H9 - Canada
Phone: 1 (403) 253-8848
www.schneider-electric.com
As standards, specifications, and designs change from time to time,

please ask for confirmation of the information given in this publication.
© Schneider Electric. All Rights Reserved.

Real Timetables

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Real Timetables

Uploaded by

Copyright:

Available Formats

OASyS DNA®

12.2 Importing from Excel into the Almsuppression table...................................................120

24.1 Jsh Row Edit...............................................................................................................192

34.2 Rule Violation..............................................................................................................292

1.1 Database concepts

The RealTime database is specially designed for real-time data processing.

1.2 Failure Avoidance

applet Program underlying a Windows icon

button Typically, a drawing of a push button with a command or option label on

call up To cause to be displayed or to open

confirmation Dialog box containing 1) an advisory or warning message about an action

display To present on the screen; used only as a verb

Table 1 - Terminology (continued)

identifier System code or name for an entity, such as a database record

label Text attached to any option, box, command, etc.

menu List of commands that you can select by clicking

option A choice presented in a dialog boxExample: the Orientation dialog box

record Standard entry in a database table

row Data summary entry that is usually synonymous with a record

select In the context of a checkbox, to select means to place a checkmark in the

unavailable Typically applies to situations where some members of a list of commands or

2.2 Types of displays

2.3 Select dialog boxes

Figure 1 - Ellipsis button

Figure 2 - Select dialog box example (Analog select dialog box)

Table 2 - Items on the select dialog box

2.3.1 Using a select dialog box

Figure 3 - Fields with ellipsis buttons

Figure 4 - Remote select dialog box

2. Select the desired entry.

2.3.2 Select dialog box filters

Figure 5 - Remote select dialog box

Applying filters to select dialog boxes

1. Select Enable Filters on the dialog box.

2.3.3 Editing fields using select dialog boxes

Figure 6 - Ellipsis button

The example below displays the Remote select dialog box.

Figure 7 - Remote Select dialog box

2.3.4 Searching lists in the select dialog box

Figure 8 - Name filter example

2.4 User Customization

You can customize the following:

2.4.1 Setting user settings

Figure 9 - Auto Save Settings

2.4.2 Child form menu

Figure 10 - All Child Forms menu

Minimizing all open forms

• Select Window > All Chid Forms > Minimize.

• Select Window > All Chid Forms > Expand.

• Select Window > All Chid Forms > Close.

2.5 Table View Tasks

The View menu contains the following options:

• Show Row Changes

• Show Row Errors

• Show All Rows

• Clear Find Replace

3 ADE database configuration

ADE displays data in three primary ways:

• a Table Edit view to display records in a single table

• a Row Edit view to display details of a single record

• Record Edit dialog box for single record edit

• Record Details for single record edit

3.1 ADE configuration process

Figure 11 - Schematic diagram of the ADE configuration