SMP DG

e-terracontrol Display Builder Guidelines
This document explains the features and capabilities of

e-terracontrol-based e-terrabrowser displays.
Software Version: e-terracontrol 3.7

Copyright and Proprietary Information
Copyright 2011 ALSTOM Grid Inc. or Affiliate All Rights Reserved.
NOTE: CONTAINS PROPRIETARY INFORMATION OWNED BY ALSTOM GRID INC.

AND/OR ITS AFFILIATES. DO NOT COPY, STORE IN A RETRIEVAL SYSTEM,
TRANSMIT OR DISCLOSE TO ANY THIRD PARTY WITHOUT PRIOR WRITTEN
PERMISSION FROM ALSTOM GRID INC.
__________________________________________________________________
Trademarks
ESCA and HABITAT are registered trademarks of ALSTOM Grid Inc. eterra is a
registered trademark and/or service mark of E-Terra, LLC, licensed for use by
ALSTOM Grid Inc. in connection with its e-terra family of products and services.
Other product and company names in these materials may be trademarks or registered
trademarks of other companies, and are the property of their respective owners. They are
used only for explanation and to the respective owners benefit, without intent to infringe.
Contents
About This Document............................................................................ viii
Purpose....................................................................................................................... viii
Structure of This Document ........................................................................................ viii
For More Information .................................................................................................. viii
Change Summary ......................................................................................................... x
1. Base System Displays .......................................................................... 1

1.1 Conventions ............................................................................................................ 1
1.2 smp_tabular_dset ................................................................................................... 1
1.3 smp_dset ................................................................................................................ 1
1.4 smp60_dset ............................................................................................................ 2
2. Objects and Fields................................................................................ 3

2.1 Qualities Overview .................................................................................................. 3
2.1.1 Effective Qualities .............................................................................................. 3
2.1.2 Self Qualities...................................................................................................... 4
2.1.3 Hierarchical Qualities ......................................................................................... 5
2.2 Tag Bits................................................................................................................... 5
2.3 Tag Colors .............................................................................................................. 6
2.4 Record Types and Their Fields ............................................................................... 7
2.4.1 Accumulator COUNT ...................................................................................... 7
2.4.1.1 Enterable Fields............................................................................................ 7
2.4.1.2 Read-Only Fields .......................................................................................... 7
2.4.1.3 Limited Fields................................................................................................ 8
2.4.2 Accumulator Time ABNCNT, INHCNT, NISCNT, TSTCNT ............................ 8
2.4.2.1 Read-Only Fields .......................................................................................... 8
2.4.3 Alarm ALMQ ................................................................................................... 8
2.4.3.1 Read-Only Fields .......................................................................................... 8
2.4.4 Analog ANALOG............................................................................................. 9
2.4.4.1 Enterable Fields............................................................................................ 9
2.4.4.2 Read-Only Fields ........................................................................................ 10
2.4.4.3 Limited Fields.............................................................................................. 10
2.4.5 Analog Time ABNALG, INHALG, NISALG, TSTALG.................................... 11
2.4.5.1 Read-Only Fields ........................................................................................ 11
2.4.6 Area AREA ................................................................................................... 11
2.4.6.1 Read-Only Fields ........................................................................................ 11
2.4.7 Control CTRL ................................................................................................ 11
2.4.7.1 Read-Only Fields ........................................................................................ 11
2.4.8 CounterMeas COUNTR, COUNTR0, COUNTR1, , COUNTER7 ............. 12
2.4.8.1 Read-Only Fields ........................................................................................ 12
Proprietary See Copyright Page iii

2.4.8.2 Limited Fields.............................................................................................. 12
2.4.9 Data Item DITEM .......................................................................................... 13
2.4.9.1 Enterable Fields.......................................................................................... 13
2.4.9.2 Read-Only Fields ........................................................................................ 13
2.4.10 Data Set DSET, DSET0, DSET1, , DSET7 ............................................ 14
2.4.10.1 Enterable Fields........................................................................................ 14
2.4.10.2 Read-Only Fields ...................................................................................... 14
2.4.10.3 Limited Fields............................................................................................ 15
2.4.11 Data Set Type DSETTYP ........................................................................... 16
2.4.11.1 Read-Only Fields ...................................................................................... 16
2.4.12 Data Source DSRC..................................................................................... 16
2.4.12.1 Read-Only Fields ...................................................................................... 16
2.4.13 Equipment DEVICE .................................................................................... 17
2.4.13.2 Read-Only Fields ...................................................................................... 17
2.4.13.3 Limited Fields............................................................................................ 18
2.4.14 Equipment Group EGRP............................................................................. 18
2.4.14.2 Read-Only Fields ...................................................................................... 18
2.4.15 Equipment Group Time INHEGRP, NISEGRP, TSTEGRP ........................ 19
2.4.15.1 Read-Only Fields ...................................................................................... 19
2.4.16 Event SYSACT ........................................................................................... 19
2.4.16.1 Read-Only Fields ...................................................................................... 19
2.4.17 Items (Global) ITEMS ................................................................................. 20
2.4.17.1 Read-Only Fields ...................................................................................... 20
2.4.18 Limit LIMIT .................................................................................................. 21
2.4.18.2 Read-Only Fields ...................................................................................... 21
2.4.19 ScadaLogEntry MSGLOG........................................................................... 21
2.4.19.1 Read-Only Fields ...................................................................................... 21
2.4.20 Setpoint SETPNT ....................................................................................... 22
2.4.20.2 Read-Only Fields ...................................................................................... 22
2.4.21 StateMeas STATE, HSTATE, ISTATE ....................................................... 22
2.4.21.1 Read-Only Fields ...................................................................................... 22
2.4.21.2 Limited Fields............................................................................................ 23
2.4.22 StateMeasTime ABNDSET, INHDSET, NISDSET, TAGDSET, TSTDSET 23
2.4.22.1 Read-Only Fields ...................................................................................... 23
2.4.23 Station SUBSTN ......................................................................................... 24
2.4.23.2 Read-Only Fields ...................................................................................... 24
2.4.24 Status POINT.............................................................................................. 24
2.4.24.2 Read-Only Fields ...................................................................................... 24
2.4.24.3 Limited Fields............................................................................................ 25
2.4.25 StatusTime ABNPNT, INHPNT, NISPNT, TSTPNT.................................... 26
Proprietary See Copyright Page iv

2.4.25.1 Read-Only Fields ...................................................................................... 26
2.4.26 Tag Placement TAG ................................................................................... 26
2.4.26.2 Read-Only Fields ...................................................................................... 26
2.4.27 Tag Type TAGTYP ..................................................................................... 27
2.4.27.1 Read-Only Fields ...................................................................................... 27
2.4.28 Timer TIMER .............................................................................................. 27
2.4.28.1 Read-Only Fields ...................................................................................... 27
2.4.29 Analog Scale Type SFTYPE....................................................................... 28
2.4.29.1 Read-Only Fields ...................................................................................... 28
2.4.30 Analog Scale Break Point BPITEM............................................................. 28
2.4.30.2 Read-Only Fields ...................................................................................... 28
3. Layouts ................................................................................................ 29
3.1 Composite Keys .................................................................................................... 29
3.1.1.1 Standard Composite Keys .......................................................................... 29
3.1.1.2 Full-Name Composite Keys ........................................................................ 29
3.1.1.3 Short-Name Composite Keys ..................................................................... 30
3.1.1.4 Composite Keys Using Handles and Subscripts......................................... 30
3.1.2 Handling Multi-Level Objects ........................................................................... 31
3.2 Simple Layers ....................................................................................................... 31
3.3 Tabular Layers ...................................................................................................... 31
3.3.1 Tabular Types.................................................................................................. 31
3.3.2 Starting Records .............................................................................................. 32
3.3.3 Textual Queries................................................................................................ 32
3.3.4 Tabular Layouts ............................................................................................... 32
3.3.4.1 Conventions................................................................................................ 32
3.3.4.2 Equipment Groups...................................................................................... 33
3.3.4.3 Stations....................................................................................................... 33
3.3.4.4 Equipment................................................................................................... 33
3.3.4.5 Measurements ............................................................................................ 33
3.3.4.6 Station/Equipment Group Tree ................................................................... 33
3.3.4.7 Controls and Setpoints ............................................................................... 34
3.3.4.8 Limits .......................................................................................................... 34
3.3.4.9 Measurement Lists ..................................................................................... 34
3.3.4.10 Alarms and Events.................................................................................... 34
3.3.4.11 Messages ................................................................................................. 35
3.3.4.12 Tag Placements........................................................................................ 35
3.3.4.13 Tag Types................................................................................................. 35
3.3.4.14 Data Sources ............................................................................................ 35
3.3.4.15 Single-Level Data Sets ............................................................................. 35
3.3.4.16 Recursive Data Sets ................................................................................. 35
3.3.4.17 Recursive Data Sets and Data Items........................................................ 36
3.3.4.18 Recursive Data Sets and CounterMeas.................................................... 36
Proprietary See Copyright Page v

3.3.4.19 StateMeas Lists ........................................................................................ 37
3.3.4.20 Data Set Lists ........................................................................................... 37
3.3.4.21 Advanced Performance Considerations ................................................... 37
4. Commands .......................................................................................... 39
4.1 e-terracontrol Commands ..................................................................................... 39
4.1.1 ACKNOWLEDGE ............................................................................................ 39
4.1.2 ADDTAG .......................................................................................................... 39
4.1.3 CANCEL .......................................................................................................... 39
4.1.4 CLEAR............................................................................................................. 39
4.1.5 CLEARTAGDATA ............................................................................................ 40
4.1.6 COLORINGALL ............................................................................................... 40
4.1.7 DECOLORING................................................................................................. 40
4.1.8 DECOLORINGALL .......................................................................................... 40
4.1.9 EXECUTE ........................................................................................................ 40
4.1.10 FEEDERCOLORING ..................................................................................... 40
4.1.11 INHIBIT, INHIBITA, INHIBITB........................................................................ 40
4.1.12 MASSINHIBIT, MASSENABLE...................................................................... 41
4.1.13 MASSREMOVE, MASSRESTORE................................................................ 41
4.1.14 REFRESH...................................................................................................... 41
4.1.15 REMOVE, REMOVEA, REMOVEB, RESTORE, RESTOREA, RESTOREB. 41
4.1.16 REMOVETAG ................................................................................................ 42
4.1.17 RESET........................................................................................................... 42
4.1.18 SELECT......................................................................................................... 42
4.1.19 SELECTSEQUENCE..................................................................................... 42
4.1.20 TESTMODE ................................................................................................... 42
4.1.21 TOGGLE........................................................................................................ 43
4.1.22 TRACING....................................................................................................... 43
4.1.23 Issuing Controls and Setpoints ...................................................................... 43
4.2 Standard Commands ............................................................................................ 43
4.2.1 COPY............................................................................................................... 43
4.2.2 DELETE........................................................................................................... 43
4.2.3 ENTER............................................................................................................. 43
4.2.4 FILTER ............................................................................................................ 43
4.2.4.1 Adding or Removing Filters......................................................................... 44
4.2.4.2 Setting Filters Using Picgroup Visibility CAMs ............................................ 44
4.2.5 FIND/POSITION .............................................................................................. 44
4.2.5.1 Examples .................................................................................................... 45
4.2.6 INSERT............................................................................................................ 45
4.2.7 MASK............................................................................................................... 45
4.2.8 SORT............................................................................................................... 45
Appendix A. Migrating to e-terracontrol Displays ................................. 46

A.1 Records ................................................................................................................ 46
Proprietary See Copyright Page vi

A.1.1 Determining Available Fields ........................................................................... 46
A.1.2 Station Modeling Differences with e-terraplatform........................................... 46
A.1.3 DEVTYP .......................................................................................................... 46
A.1.4 Communication-Related Record Types........................................................... 47
A.1.5 Alarms and Events .......................................................................................... 47
A.1.6 Multi-Record Picgroups ................................................................................... 47
A.1.7 %SUB% = Handle ........................................................................................... 47
A.2 Tabular Layers...................................................................................................... 48
A.2.1 Multiple Pages ................................................................................................. 48
A.3 Commands ........................................................................................................... 48
A.3.1 Multi-Level FIND/POSITION Commands ........................................................ 48
A.3.2 Sorting Multi-Level Hierarchical Displays......................................................... 48
A.3.3 Permission Tests ............................................................................................. 48
Proprietary See Copyright Page vii

About This Document
This document is supplied as a part of Alstom Grids e-terracontrol
product.
Purpose
This document explains the features and capabilities of e-terracontrol
based e-terrabrowser displays. It should be helpful to anyone seeking to
build e-terracontrol displays.
This document does not describe FG Display basics, nor does it explain
how to use the FG Display Builder. Thus, although extensive experience
building displays for other platforms is not required, a basic knowledge of
display building components and principles is expected.
Structure of This Document
This document is structured in the following manner:
Chapter 1 describes the base set of displays delivered with
e-terracontrol and how they can be useful as a reference to a display
builder.
Chapter 2 features a list of all object types available for e-terracontrol
displays as well as lists of all enterable, read-only, and limited access
fields within each object type.
Chapter 3 provides guidelines for creating successful e-terracontrol
display layouts, including e-terracontrol composite keys, simple layers,
and tabular layers.
Chapter 4 offers a list of e-terracontrol display commands, including
which objects they can be used on, the action of the command, usage
considerations, and examples from the base system displays.
Appendix A provides help to those with previous display building
experience who are new to building e-terracontrol displays.
For More Information
The following documents describe the modeling and configuration
activities for e-terracontrol:
e-terracontrol Reference Manual: Introduction and Configuration
Features non-specific application configuration issues such as
client-server architecture, redundancy, and line switching.
e-terracontrol Reference Manual: Applications Describes the
modeling and configuration activities for the principal applications:
SCADA Server and Process Starter, and the ancillary applications:
Proprietary See Copyright Page viii

Alarm Logger, Alarm Pager, Automatic Database Update, Change
Data Source, Copy History, Space Saver, and Validator.
e-terracontrol Reference Manual: User Interface Applications
Features the applications designed to present information. These
applications include Measurement History, Sequence of Events
(Compiler and Viewer), Simulator, SMP Display Linker, Virtual Charts,
and Alarm Viewer.
e-terracontrol Reference Manual: Interfaces to Field Devices
Features applications designed to retrieve measurements from field
devices such as Remote Terminal Units (RTUs), Programmable Logic
Controllers (PLCs), and Intelligent Electrical Devices (IEDs). These
applications include CFE Reader, CFE Performance Driver, OPC DA
Client, PLC Reader (Modbus Reader and TI Reader), TrueTime
Reader, and Relay Reader.
e-terracontrol Reference Manual: Interfaces to External Systems
Features applications designed to communicate with external systems
such as EMS, DCS, and other SCADA systems. These applications
include ADO/SMP, DDEML/SMP, InterSite Data, Modbus/SMP,
OPC DA Server, PI/SMP, ICCP, and xx2smp.
For other information about e-terracontrol, refer to the following:
e-terracontrol Release Notes
e-terracontrol Programmers Guide Describes the interfaces that
allow external processes to communicate with e-terracontrol.
e-terracontrol Protocol Modeling Guide Provides modeling details for
the e-terracontrol protocol implementations that are supported in the
CFE Reader application.
For more information about designing displays for viewing in
e-terrabrowser, refer to the following:
Display Builder Users Guide An introduction to the concepts,
features, and components of the Display Builder software, along with
instructions for how to use the Display Builder software to build
displays and how to define display components for viewing in
e-terrabrowser.
For more information about e-terrabrowser, refer to the following:
e-terrabrowser Software Installation and Maintenance Guide
Provides information about and instructions for the configuration of the
e-terrabrowser.
e-terrabrowser Users Guide A guide to the use of e-terrabrowser,
the Web technologybased version of e-terrahabitats user interface
processor and command language.
Proprietary See Copyright Page ix

Change Summary
The following changes were made to this document for e-terracontrol 3.7:
Updated the section Equipment DEVICE Read-Only Fields.
Added the sections COLORINGALL, DECOLORING,
DECOLORINGALL, FEEDERCOLORING, and TRACING.
Minor editorial and formatting corrections.
Proprietary See Copyright Page x

1. Base System Displays
A number of displays and display definition files are included with the
default e-terracontrol installation. The sample displays demonstrate the
use of most of the e-terracontrol display features and concepts presented
in this document.
To see records, fields, and commands in action, refer to the sample
displays. It is important to use these sample displays as models,
especially when filtering, sorting, or using any of the SCADA commands.
Also, it should be much easier to obtain valid tabular layouts by basing
new tabular displays on the existing sample displays.
1.1 Conventions
When referencing base system displays, the eset files and the .ddl
extensions are not provided. When an example display is listed as
ALARM_TABULAR in smp_dset, it means that the ALARM_TABULAR
defined in smp_dset.ddl and smp_eset.ddl provides an example of the
concept at hand.
1.2 smp_tabular_dset
The smp_tabular_dset (data set) contains communication displays such
as RTUDirectory, ComState, RtuState, and RtuCheckout. It also contains
a ScaleFactor_Type display. Many of the displays are offered in multiple
versions to make use of handles, names, and full names.
This smp_tabular_dset uses data sets, data items, data sources,
CounterMeas, and numerous SCADA commands.
1.3 smp_dset
The smp_dset contains:
List displays of alarms, events, measurements, tags, tag types, and
SCADA log entries
Abnormal, Inhibit, Not in Service, and Test Mode Measurement List
displays
Abnormal, Inhibit, Not in Service, Tagged, and Test Mode Data Set
List displays
Displays to use in place of pop-ups to add tags or to issue controls and
setpoints
Modeling displays for the station tree, data sets, and data items
The smp_dset uses numerous commands, including SCADA commands
as well as Delete, Insert, Copy, Enter, Filter, Find, and Sort.
Proprietary See Copyright Page 1 Base System Displays

1.4 smp60_dset
Although portions of the smp60 display collection may refer to previous
versions of e-terracontrol, they do still provide excellent examples of
e-terracontrol simple layers, numerous SCADA commands, and the
usage of record types. In addition, there is a large collection of onelines in
this dset.
Proprietary See Copyright Page 2 Base System Displays

2. Objects and Fields
This chapter details the objects and fields that are available for
e-terracontrol displays.
Some of the fields include a description; however, because the
displayable objects and fields are closely tied to existing e-terracontrol
objects, the e-terracontrol Reference Manual set and the e-terracontrol
Programmers Guide are the best places to look for descriptions.
Note: In earlier releases of e-terracontrol and e-terrabrowser, displays
with pictures containing invalid field names caused erratic behavior. If you
notice odd behavior, such as blank field values or field values shifted
between objects, check the field names.
2.1 Qualities Overview
This section lists all available quality field names. There are three different
types of qualities: self; hierarchical; and effective, which is a combination
of self and hierarchical. In many cases, the self and effective qualities
have the same values.
All quality-related fields are available on measurement objects (analogs,
status points, accumulators, state measurements, counter
measurements), as well as their time-oriented counterparts.
A reference to this section is given whenever the following quality fields
are available for a given record type:
Data items only support the Effective/Self qualities (both have the
same value) and the Prep versions of the Effective qualities, e.g.,
PREPABNORMAL, PREPBAD, PREPCOMMANDED, etc.
Equipment groups and their time-oriented counterparts only support
NIS, SELFNIS, HIERNIS, INHIBIT, SELFINHIBIT, HIERINHIBIT,
TESTMODE, SELFTESTMODE, HIERTESTMODE, UNACK, and
SELFUNACK.
2.1.1 Effective Qualities
All qualities are booleans.
Name of Quality Field Name
Abnormal ABNORMAL
Bad BAD, UNREAS
Commanded COMMANDED
Diagnostic Bad DIAGBAD
Forced FORCED
Good GOOD
Inhibited INHIBIT
Limit N LIMITN
Proprietary See Copyright Page 3 Objects and Fields

Limit 1 LIM1
Limit 2 LIM2
Limit 3 LIM3
No Limits NOLIM
Manual REPLACED
Not in Service NIS
Old OLD
Over Range OVERRANGE
Suspect SUSPECT
Tagged There is no difference TAG1, TAG2, TAG3, TAG4
when using TAG1-TAG4.
Not Tagged NOTAG
Test Mode TESTMODE
Unacknowledged UNACK
Bad Time BADTIME
2.1.2 Self Qualities

Abnormal SELFABNORMAL
Bad SELFBAD, SELFUNREAS
Commanded SELFCOMMANDED
Diagnostic Bad SELFDIAGBAD
Forced SELFFORCED
Good SELFGOOD
Inhibited SELFINHIBIT
Limit N SELFLIMITN
Limit 1 SELFLIM1
Limit 2 SELFLIM2
Limit 3 SELFLIM3
No Limits SELFNOLIM
Manual SELFREPLACED
Not in Service SELFNIS
Old SELFOLD
Over Range SELFOVERRANGE
Suspect SELFSUSPECT
Tagged There is no difference SELFTAG1, SELFTAG2, SELFTAG3,
when using TAG1-TAG4. SELFTAG4
Not Tagged SELFNOTAG
Test Mode SELFTESTMODE
Unacknowledged SELFUNACK
Bad Time SELFBADTIME

2.1.3 Hierarchical Qualities
Inhibited HIERINHIBIT
Not in Service HIERNIS
Test Mode HIERTESTMODE
2.2 Tag Bits

This section lists fields associated with tag bits. Tag Bit fields are available
on measurement objects (analogs, status points, accumulators, state
measurements, counter measurements), as well as their time-oriented
counterparts. Tag Bit fields are also available on equipment groups and
equipment group time-oriented record types. Lastly, they are available on
data items.
A composite Tag Bit field (TAGBITS) is available as an integer.
The individual tag bits are available as boolean values, as follows:
Tag Bit Number Field Name
Tag Bit 0 TAG0
Tag Bit 1 TAG1
Tag Bit 2 TAG2
Tag Bit 3 TAG3
Tag Bit 4 TAG4
Tag Bit 5 TAG5
Tag Bit 6 TAG6
Tag Bit 7 TAG7
Tag Bit 8 TAG8
Tag Bit 9 TAG9
Tag Bit 10 TAG10
Tag Bit 11 TAG11
Tag Bit 12 TAG12
Tag Bit 13 TAG13
Tag Bit 14 TAG14
Tag Bit 15 TAG15

2.3 Tag Colors
This section lists fields associated with tag colors. Tag Color fields are
available on measurement objects (analogs, status points, accumulators,
state measurements, counter measurements), as well as their time-
oriented counterparts. Tag Color fields are also available on equipment
groups and equipment group time-oriented record types, as well as
tag placements and tag types.
A Tag Color field (TAGCOLOR) is available as an integer matching
one of the values below.
Additionally, the individual colors are available as boolean values, as
follows:
Color Name Color Value Boolean Field Name
Black 1 COLOR1
Blue 22 COLOR22
Cyan 20 COLOR20
Dark Green 17 COLOR17
Dim Gray 2 COLOR2
Firebrick 5 COLOR5
Gold 15 COLOR15
Goldenrod 11 COLOR11
Gray 3 COLOR3
Green 18 COLOR18
Indian Red 7 COLOR7
Magenta 24 COLOR24
Navy Blue 21 COLOR21
Orange 12 COLOR12
Orange Red 10 COLOR10
Pale Green 19 COLOR19
Pink 8 COLOR8
Plum 25 COLOR25
Red 6 COLOR6
Sienna 9 COLOR9
Slate Blue 23 COLOR23
Tan 13 COLOR13
Wheat 14 COLOR14
White 4 COLOR4
Yellow 16 COLOR16

2.4 Record Types and Their Fields
The following sections detail the record types and their fields.
2.4.1 Accumulator COUNT
The following sections detail the Accumulator COUNT objects.
2.4.1.1 Enterable Fields
Name of Property Field Name Field Type
Name ID Character
Device Name DEVNAME Character
External Name EXTNAME Character
Source Name SRCNAME Character
Maximum MAX Integer
Save Fraction SAVEFRAC Boolean
Scale SCALE Real
2.4.1.2 Read-Only Fields

Support the qualities noted above in the Qualities Overview section.
Support the tag bits noted above in the Tag Bits section.
Support the tag colors noted above in the Tag Colors section.
Short Name SHORTID, Character
SHORTNAME,
NONFULLNAME
Full Name FULLNAME Character
Value DIS Real
Prep Value PREP Real
Raw Value RAWVALUE Real
Fraction FRACTION Real
Selected SELECT Boolean
Time TIME Time/Date
Time Milliseconds TIMEMIL Integer
Device Time DEVTIME Time/Date
Device Time Milliseconds DEVTIMEMIL Integer
Highest Prior. Tag Color TAGCOLOR Integer
Handle HANDLE Integer

2.4.1.3 Limited Fields
Caution: The availability of the following fields is determined by the
display layout. These fields are not available on simple layers such as
onelines. Some display layouts render these fields blank or invalid (for
more details, see the chapter Layouts).

Type Name TYPENAME Character
Note: Enterable
Equipment Name DEVICEID Character
Equipment Type Name DEVTYPID Character
Station Name SUBSTNID Character
2.4.2 Accumulator Time ABNCNT, INHCNT, NISCNT, TSTCNT

The Accumulator Time objects support all of the fields that the
Accumulator (COUNT) record type supports, but the Accumulator Time
fields are read-only. Additional available fields are listed below. These
records are used on the Station list displays (i.e., Abnormal List, NIS List,
Inhibit List, etc.).
Origin USERID Character
Time Time of action TIME Time/Date
causing the measurement to
be added to the list
Text Time TEXTTIME Character
2.4.3 Alarm ALMQ

The following sections detail Alarm ALMQ objects.
Name Name of the object ID Character
the event is related to
SHORTNAME,
NONFULLNAME
Text User-friendly textual TEXT Character
representation of the alarm
Action Text ACTION Character

Alarm Color COLOR Integer
0=Black, 1=Red, 2=Green,
3=Cyan, 4=Blue, 5=Orange,
6=Yellow, 7=Magenta
Priority Zero-based PRIOR Integer
(SCADA server UI is one-
based)
Unack UNACKA Boolean
Abnormal ABNORMALA Boolean
Time TIME Time/Date
Text Device Time TEXTDEVTIME Character
Area 1 Name AREA1 Character
Audio Enabled AUDIOENABLED Boolean
Audio Continuous AUDIOCONTINUOUS Boolean
Wave Filename WAVEFILENAME Character
2.4.4 Analog ANALOG

The following sections detail Analog ANALOG objects.
Name ID Character
Deadband DEADBAND Integer
Raw High RAWHIGH Integer
Raw Low RAWLOW Integer
Engineering High ENGHIGH Real
Engineering Low ENGLOW Real
Reasonability High HIREAS Real
Reasonability Low LOREAS Real
Enterable Setpoint Value P$SETPNT>ENTVAL, Real
P__SETPNT>ENTVAL

SHORTNAME,
NONFULLNAME
Value DIS Real
Prep Value PREP Real
Raw Value RAWVALUE Integer
Last Setpoint Value ENTVAL Real
Has Controls HASCONTROLS Boolean
Limit Count LIMITCOUNT Integer
Time TIME Time/Date


Note: Enterable

2.4.5 Analog Time ABNALG, INHALG, NISALG, TSTALG
The Analog Time objects support all of the fields that the Analog
(ANALOG) record type supports, but the Analog Time fields are read-only.
Additional available fields are listed below (to see how these record types
are used, see the section Measurement Lists in the chapter Layouts).
2.4.6 Area AREA

The following sections detail Area AREA objects.
Name ID Character
2.4.7 Control CTRL

The following sections detail Control CTRL objects.
Name ID Character
SHORTNAME,
NONFULLNAME
Require Select REQSELECT Boolean
Timeout TIMEOUT Integer
Mode of Interlock: INTERLOCKMODE Integer
0 = None or Full Block
1 = Local Mode
2 = Remote Mode

2.4.8 CounterMeas COUNTR, COUNTR0, COUNTR1, , COUNTER7
For more information, see the section Handling Multi-Level Objects in the
chapter Layouts.
Name ID Character
SHORTNAME,
NONFULLNAME
Text Value TEXTDIS Character
Errors ERRORS Integer
Max Errors MAXERRORS Integer
Time TIME Time/Date


Note: Enterable

2.4.9 Data Item DITEM
The following sections detail Data Item DITEM objects.
Name ID Character
Eng Low DIENGLOW Real
Eng High DIENGHIGH Real
Max MAXCNT Integer
Scale SCALE Real
Deadband DEADBAND Integer
Meas. Linkage Name MEASNAME Character
Scan Filter SCANFILTER Integer
Status Bit as String STATUSBIT Character
Negate NEGATE Boolean
Analog Scale Type Name SFTYPENAME Character

Support the Effective and Self qualities noted above in the section
Qualities Overview. Also support the Prep versions of all of the
Effective qualities, e.g., PREPABNORMAL, PREPBAD,
PREPCOMMANDED, etc.
Support the tag bits noted above in the Tag Bits section
Assoc. Type ASSOCTYPE
Bit BIT Integer
Value as Real RDIS Real
Conv. Table Index CONVTABLEINDEX Integer
Prep Value as Real RPREP Real
Raw Value as Real RRAW Real
Raw S Value SRAW Integer
Raw X Value XRAW Integer
Raw MCD Value MCDRAW Integer
Prep Device Time PREPDEVTIME Time/Date
Prep Device Time PREPDEVTIMEMIL Integer
Milliseconds
Slope SLOPE Real
Y-Intercept YINTERCEPT Real

Setpoint Value Value of ENTVAL Real
last issued setpoint (only
valid on analog and setpoint
links)
2.4.10 Data Set DSET, DSET0, DSET1, , DSET7

The number represents the depth of the data set in the tree. For example,
DSET0 resides at the root level, while DSET3 is four layers down (DSET0,
DSET1, DSET2, DSET3) (for more information, see the section Handling
Multi-Level Objects in the chapter Layouts).
Name ID Character
SHORTNAME,
NONFULLNAME
First Item Number FIRSTITEMNUM Integer
Max Errors MAXERRORS Integer
Data Item Count DITEMCOUNT Integer

WebFG App. Name APP Character
Parameter String Comma- PARAMSTRING Character
separated list of the
Param/Value pairs of the
data set
State STATE Integer
State A STATEA Integer
State B STATEB Integer
Composite State COMP Integer
Composite State A COMPA Integer
Composite State B COMPB Integer
Last Failed A LASTFAILEDA Boolean
Last Failed B LASTFAILEDB Boolean
Dual State DUALSTATE Boolean
Errors A ERRORSA Integer
Errors B ERRORSB Integer
Contributes to Parent State CONTPARENT Boolean

Data Set Count DSETCOUNT Integer
Last Load Time LOADTIME Time/Date
Load Count LOADCOUNT Integer
Extended Name EXTENDEDNAME String
The following additional quality fields are provided to give feedback on
whether a portion of the data set is online/offline, inhibited, tagged, or in
test mode.
Composite State Inhibit COMPINHIBIT
Composite State Test Mode COMPTESTMODE
Composite State Tagged COMPTAG
State Inhibit STATEINHIBIT
State Test Mode STATETESTMODE
State Tagged STATETAG
State Commanded STATECOMMANDED
Comm Test Failed STATECOMMTESTFAILED
State A Inhibit STATEAINHIBIT
State A Test Mode STATEATESTMODE
State A Tagged STATEATAG
State A Commanded STATEACOMMANDED
State A Comm Test Failed STATEACOMMTESTFAILED
State B Inhibit STATEBINHIBIT
State B Test Mode STATEBTESTMODE
State B Tagged STATEBTAG
State B Commanded STATEBCOMMANDED
State B Comm Test Failed STATEBCOMMTESTFAILED

more details, see the chapter Layouts.

Data Set Type Name DSETTYPENAME Character
Note: Enterable

2.4.11 Data Set Type DSETTYP
Data set types are supported on a limited basis.
Name ID Character
Alarm/Event Color COLOR Integer
6=Yellow, 7=Magenta
based)
Dual State DUALSTATE Boolean
2.4.12 Data Source DSRC

The following sections detail Data Source DSRC objects.
Name ID Character
State STATE Integer
State A STATEA Integer
State B STATEB Integer
Composite State COMP Integer
Composite State A COMPA Integer
Composite State B COMPB Integer
Last Load Time A LOADTIMEA Time/Date
Last Load Time B LOADTIMEB Time/Date
Last Control Time CTRLTIME Time/Date
Load Count A LOADCOUNTA Integer
Load Count B LOADCOUNTB Integer
Control Count CTRLCOUNT Integer

2.4.13 Equipment DEVICE
The following sections detail Equipment DEVICE objects.
Name ID Character

SHORTNAME,
NONFULLNAME
Topology Enable TOPOLOGY Boolean
Downstream tracing DOWNSTREAM Boolean
Upstream tracing UPSTREAM Boolean
Loop LOOP Boolean
Energization Status NRJSATUS Integer
Live = 0, Dead = 1,
Unknown = 2, Grounded=3
Topology Color COLORTOPO Integer
Black = 1, Blue =22
Cyan = 20,
DarkGreen = 17, DimGray =
2,
Firebrick = 5, Gold =15,
Goldenrod =11,
Gray = 3, Green = 18, Indian
Red = 7, ,Magenta = 24,
NavyBlue = 21,
Orange = 12, OrangeRed =
10,
PaleGreen = 19, Pink = 8,
Plum = 25
Red = 6, Sienna =9,
SlateBlue = 23,
Tan = 13
Wheat = 14, White = 4
Yellow = 16,


Note: Enterable
2.4.14 Equipment Group EGRP

The following sections detail Equipment Group EGRP objects.
Name ID Character

Equipment groups only support Inhibit, NIS, Test Mode, and
Unacknowledged versions of the Effective and Self qualities, along with
the Hierarchical versions of Inhibit, NIS, and Test Mode.

SHORTNAME,
NONFULLNAME
Display DISPLAY Character
Level LEVEL Integer
Parent PARENT Character
Tag Color TAGCOLOR Integer
Text TEXT Character

2.4.15 Equipment Group Time INHEGRP, NISEGRP, TSTEGRP
The Equipment Group Time objects support all of the fields that the
Equipment Group (EGRP) record type supports, but the Equipment Group
Time fields are read-only. Additional available fields are listed below (to
see how these record types are used, see the Measurement Lists section
in the chapter Layouts).
2.4.16 Event SYSACT

For more information about the meanings of these fields, see the Alarms
and Events section.
Name ID Character
SHORTNAME,
NONFULLNAME
Text TEXT Character
Action Text ACTION Character
Event Color COLOR Integer
Priority PRIOR Integer
Abnormal ABNORMALA Boolean
Time TIME Time/Date
Text Device Time TEXTDEVTIME Character

2.4.17 Items (Global) ITEMS

The Items (Global) ITEMS object is currently used in conjunction with
filtering, to provide a way to see which filters are enabled and to enable
new filters based on the current state of the filters. The current state is
represented as a composite value of all enabled filters and is used as a
base when adding or removing individual filters.
For details about the usage of the ITEMS object, see the FILTER
command description in the section FILTER.
All filter fields are booleans, except for the composite filter, which is an
integer.
Name of Filter Field Name Meaning
Composite Filter COMPOSITEFILTER Used when enabling or
disabling individual filters.
Analog Filter Enabled ANALOGFILTER Includes alarms or events
generated by analogs.
Status Filter Enabled POINTFILTER Includes alarms or events
generated by statuses.
Accumulator Filter Enabled COUNTFILTER Includes events or alarms
generated by
accumulators.
StateMeas Filter Enabled STATEFILTER Includes alarms or events
generated by StateMeas.
CounterMeas Filter Enabled COUNTRFILTER Includes alarms or events
generated by
CounterMeas.
Level Filter n Enabled LEVELnFILTER where n Includes Level n data sets
is between 1 and 8. for Data Set List displays.
Priority n Filter Enabled PRIORnFILTER where n Includes Priority n alarms
is between 1 and 8. or events.
Descendent Level Filter DESCLEVELFILTER Includes objects placed
on items below the
current equipment group
level.
This Level Filter THISLEVELFILTER Includes objects placed
on the current equipment
group level.
Acknowledgment Event Filter ACKEVTFILTER Includes events due to
alarm acknowledgment.

Name of Filter Field Name Meaning
Deletion Event Filter CLREVTFILTER Includes events due to
alarm deletion.
Standard Event Filter STDEVTFILTER Includes all events not
due to acknowledgment
or deletion.
2.4.18 Limit LIMIT

The following sections detail Limit LIMIT objects.
Name ID Character
Deadband DEADBAND Real
High HIGH Real
Low LOW Real
Ignore IGNORE Boolean

SHORTNAME,
NONFULLNAME
2.4.19 ScadaLogEntry MSGLOG

Use this object to make a tabular display of the SCADA log (see the
SCADA_LOG display in the section smp_dset as an example).
Note: The MSGLOG record type is specific to the SCADA log. It cannot
be used to make generalized logs.
Message MSG Character
Name ID Character
Severity SEV Character
Time TIME Time/Date
Text Time MSGTIME Character

2.4.20 Setpoint SETPNT
The following sections detail Setpoint SETPNT objects.
Entered Value ENTVAL Real

Name ID Character
SHORTNAME,
NONFULLNAME
High Scale ENGHIGH Real
Low Scale ENGLOW Real
Require Select REQSELECT Boolean
Timeout TIMEOUT Integer
Mode of Interlock: INTERLOCKMODE Integer
0 = None or Full Block
1 = Local Mode
2 = Remote Mode
2.4.21 StateMeas STATE, HSTATE, ISTATE

The StateMeas object is used on Data Set List displays such as the
RTUState display (smp _tabular_dsets RTUSTATE_BYFULLNAME).
Name ID Character
SHORTNAME,
NONFULLNAME

Ancestor Text ANCESTORTEXT Character
State STATE Integer
Time TIME Time/Date

more details, see the chapter Layouts.

2.4.22 StateMeasTime ABNDSET, INHDSET, NISDSET, TAGDSET,

TSTDSET
The StateMeasTime objects support all fields that the StateMeas (STATE)
record type supports, but the StateMeasTime fields are read-only.
Additional available fields are listed below. These record types are used
on the Data Set List displays.
Text TEXT Character

2.4.23 Station SUBSTN

The following sections detail the Station SUBSTN objects.
Name ID Character

2.4.24 Status POINT

The following sections detail the Status Point objects.
Name ID Character
Invert Mask INVERT Integer

SHORTNAME,
NONFULLNAME
Value DIS Integer
S Value SDIS Boolean
X Value XDIS Boolean
MCD Value MCDDIS Boolean

Prep Value PREP Boolean
S Prep Value SPREP Boolean
X Prep Value XPREP Boolean
MCD Prep Value MCDPREP Boolean
Has Controls HASCONTROLS Boolean
Time TIME Time/Date


Note: Enterable
Selected Control SELECTEDCTRL
Selected Control Index SELECTEDCTRLIDX
Text0 From Status Type TEXT00 Character
2.4.25 StatusTime ABNPNT, INHPNT, NISPNT, TSTPNT

The StatusTime objects support all of the fields that the Status (POINT)
record type supports, but the StatusTime fields are read-only. Additional
available fields are listed below.

2.4.26 Tag Placement TAG

The following sections detail the Tag Placement TAG objects.
When making a display for entering tags, you must have a valid
TAGTYPE field, because a valid type is required when entering a tag.
Name ID Character
Placed By PLACEDBY Character
Comment COMMENT Character
Tag Type Name TAGTYPE Character

Precedence PRECEDENCE Integer
Tag Color for valid values, TAGCOLOR Integer
see the section Tag Colors.
Block All Controls BLOCKALLCONTROLS Boolean
Is Indirect ISINDIRECT Boolean
Indirect Object Count INDIRECTOBJECTS Integer
Parent Name TAGPARENT Character
Parent Object Type TAGPARENTTYPE Integer
4=Analog, 5=Status,
6=Accumulator, 19=Data
Set, 37=Equipment Group
Add Time ADDTIME Time/Date
Last Modified Time LASTMODTIME Time/Date

2.4.27 Tag Type TAGTYP
The following sections detail the Tag Type TAGTYP objects.
Support the tag colors noted above in the section Tag Colors.
Name ID Character
Alarm/Event Color COLOR Integer
6=Yellow, 7=Magenta
Tag Color for valid values, TAGCOLOR Integer
see the section Tag
Colors.
based)
Precedence PRECEDENCE Integer
Tag Bit TAGBIT Integer
Control Actions CONTROLACTIONS Character
Block All Controls BLOCKALLCONTROLS Boolean
2.4.28 Timer TIMER

The following sections detail the Timer TIMER objects.
Name ID Character
Interval (ms) INTERVAL Integer
Model Time (ms) MODEL Integer

2.4.29 Analog Scale Type SFTYPE
The following sections detail the Analog Scale Type SFTYPE objects.
Name ID Character
Get as Type ASTYPE Character
Only multi-segment ASTYPE is currently supported.
2.4.30 Analog Scale Break Point BPITEM
The following sections detail the Analog Scale Break Point BPITEM
objects.
Raw RAW Integer
Eng ENG double


3. Layouts
This chapter provides guidelines for creating successful e-terracontrol
display layouts. Information is provided for e-terracontrol composite keys,
simple layers, and tabular layers.
It is especially important to follow the guidelines set forth in the section
Tabular Layers.
3.1 Composite Keys
Composite keys are used to reference a particular object for placement on
a simple layer and to identify the starting record of a tabular layer.
e-terracontrol composite keys can take several different forms. This
section explains how the three following composite keys all reference the
same object:
1. SUBSTN = KIRKLAND
DEVTYPE = XFMR
DEVICE = T1
ANALOG = MVAR
2. HANDLE = 10885
3. ANALOG = Kirkland T1 Mvar
3.1.1.1 Standard Composite Keys
Composite keys can be constructed of multiple lines. Each line contains a
record type:
SUBSTN = KIRKLAND
DEVTYPE = XFMR
DEVICE = T1
ANALOG = MVAR
Simple layer placements generally use standard composite keys.
However, simple layer placements of data sets must use either full-name
or handle/subscript composite keys.
3.1.1.2 Full-Name Composite Keys
Composite keys can be constructed using the full name of the object:
ANALOG = Kirkland T1 Mvar or
DSET = Empax1 Cfe1:0 1 or
DSET2 = Empax1 Cfe1:0 1
Proprietary See Copyright Page 29 Layouts

Full-name composite keys are useful in keysets employing the %fv% or
%ID_RECTYPE% proxy keys.
Full-name composite keys are the recommended method for hard-coding
data set linkages on simple layers.
3.1.1.3 Short-Name Composite Keys
Multi-level data sets can be specified in the starting record composite key
by their short names:
DSET1 = Cfe1:0 or
DSET3 = Douglas
For an example, see RTUSTATE_BYNAME in the smp_tabular_dset.
Note: Only DSET# record types can use short-name composite keys, and
these record types are only valid on tabular layers.
3.1.1.4 Composite Keys Using Handles and Subscripts
A records subscript field that is available using the %SUB% proxy key
contains the e-terracontrol handle of that object. The handles are unique
numeric identifiers for each object. Handles are used in SCADA
commands and composite keys, as described below, to ensure that the
desired object is positively identified.
e-terracontrol displays can use composite keys in the form
HANDLE=SUBSCRIPT.
Note: As used in the discussion of composite keys, the word subscripts
is not related to the Subscripts field of e-terrahabitat records.
The following is an example of a valid key using a handle:
HANDLE = 10885
Handle-based composite keys are useful when calling up a new display
from the current display. If the subscript is available, using a handle-based
composite key can guarantee that the called display has the correct
context. Normally, a keyset on the first display sets a numbered key using
the %SUB% proxy key, and the next display references that key in its
composite key (to see handle-based composite keys in action, see the
Add Tags buttons on the MEASUREMENT_TABULAR display in
smp_dset).
Additionally, as explained earlier, simple placements of data sets must
use either full-name or handle/subscript composite keys. For this reason,
the DSET#_MODELING displays in smp_dset use the
HANDLE=SUBSCRIPT composite key. Another example can be found
in the keyset attached to the COMSTATE_DSET3 picture in the
COMSTATE display within smp_tabular_dset.

Note: Handles are not intended to be hard-coded into displays to statically
link an object. It is not recommended that you hard-code a handle in a
placement on a simple layer or as the starting record of a tabular layer.
3.1.2 Handling Multi-Level Objects
Certain objects, including data sets and CounterMeas, can be
represented in a multi-level form. DSET is a valid record type, but DSET0
through DSET7 are also supported. The same is true for COUNTR
objects.
Multi-level object composite keys based on the object name must be
formatted in the form:
[RECORDTYPE] = [OBJECTS FULL NAME]
For example, DSET3 = LocalTfe Cfe3 1 Douglas is a valid key, but the
following are not:
DSET0=LocalTfe
DSET1=Cfe3
DSET2=1
DSET3=Douglas
3.2 Simple Layers
Placements on simple layers can use any of the composite key styles
listed above, with the exception of the data sets. Data sets cannot be
represented in the standard composite key form.
Additionally, simple placements cannot include limited fields, as
mentioned in the chapter Objects and Fields.
To improve the accuracy and efficiency of simple layer creation, the
SMP Linker application is provided in the standard e-terracontrol
installation. SMP Linker allows drag-and-drop construction of composite
keys on simple layers.
3.3 Tabular Layers
When you are constructing e-terracontrol displays, a finite set of valid
tabular layouts, or layer configurations, is available. Particular objects or
sets of objects can be combined to form tabular layers. In addition, only
certain starting record styles and object configurations produce valid
tabular layouts.
3.3.1 Tabular Types
The only valid tabular types are repeat placements and hierarchical
placements. All other placements, including link list, multi-dimensional,
and indexed, are not supported.

3.3.2 Starting Records
Repeat placements must specify either First or Composite Key for the
First Record Subscript. The Last Record Subscript must be set to
Last.
Hierarchical placements can use either All or Composite Key for the
Starting Record Subscript.
A blank composite key, such as SUBSTN=, refers to the entire
database.
Note: As used in discussing starting records, the word subscripts is not
related to e-terracontrol record subscripts.
3.3.3 Textual Queries
Textual queries are often used when integrating ActiveX controls into
e-terracontrol displays. Valid tabular layers can be converted into textual
queries using the Copy Query option on the Edit menu of the Display
Builder. Any valid tabular layout is valid as a textual query. For an
example, see any of the displays in smp_dset that include a Station
combo box.
3.3.4 Tabular Layouts
As noted in the introduction of this section, a valid tabular layout and
starting record configuration must be selected to form valid
e-terracontrolbased tabular layers. This section describes the record
types and starting records of all valid layouts.
As explained in the Tabular Layers section, tabular displays must use
either full-name composite keys or handle/subscript composite keys.
Note: Only the layouts listed below are valid.
3.3.4.1 Conventions
The variables below (a, b, x, y, and z) represent picgroups containing a
picture of the record type matching the variable.
x = Repeat layer containing only a picgroup of record type x
[x] [y] [z] = Hierarchical layer containing at least one of x, y, or z in any
combination
a b ([x] [y] [z]) = a and b, with at least one of x, y, or z
For example, for a substation measurement, the valid record type
configuration is:
SUBSTN DEVICE ([ANALOG] [POINT] [COUNT])
and a composite key of:
SUBSTN

Therefore, a tabular layer can be constructed that includes stations,
equipment, and at least one type of measurement.
3.3.4.2 Equipment Groups
Record Type Configuration: EGRP
Composite Keys: All (empty or none) or EGRP
Sample Display: Combo box on many of smp_dsets tabular displays
3.3.4.3 Stations
Record Type Configuration: SUBSTN
Composite Keys: All (empty or none)
Sample Display: None
3.3.4.4 Equipment
Record Type Configuration: DEVICE
Composite Keys: SUBSTN
ID Field Contains: Short name
Always Provides Limited Fields: No
3.3.4.5 Measurements
Record Type Configuration: [ANALOG] [POINT] [COUNT]
Composite Keys: EGRP, SUBSTN, or DSRC
ID Field Contains: Full name
Sample Display: smp_dsets MEASUREMENT_TABULAR
3.3.4.6 Station/Equipment Group Tree
Record Type Configurations:
EGRP DEVICE ([ANALOG] [POINT] [COUNT])
EGRP ([ANALOG] [POINT] [COUNT])
SUBSTN DEVICE ([ANALOG] [POINT] [COUNT])
DEVICE ([ANALOG] [POINT] [COUNT])
Composite Keys: EGRP or SUBSTN
Always Provides Limited Fields: Yes

3.3.4.7 Controls and Setpoints
Record Type Configuration: [CTRL] [SETPNT]
Composite Keys: ANALOG or POINT
Sample Display: smp_dsets CONTROL_TABULAR or
SETPOINT_TABULAR
3.3.4.8 Limits
Record Type Configuration: [LIMIT]
Composite Keys: ANALOG
Sample Display: smp_dsets LIMIT_TABULAR
3.3.4.9 Measurement Lists
Measurement list layers provide lists of measurements and equipment
groups that share a common attribute. For example, the INH_TABULAR
display in smp_dset provides a list of all measurements that have been
inhibited.
For Abnormals [ABNALG] [ABNPNT] [ABNCNT]
For Inhibits [INHALG] [INHPNT] [INHCNT] [INHEGRP]
For NISs [NISALG] [NISPNT] [NISCNT] [NISEGRP]
For Test Modes [TSTALG] [TSTPNT] [TSTCNT] [TSTEGRP]
Composite Keys: All (empty or none), EGRP, or SUBSTN
Always Provides Limited Fields: No never provides limited fields
Sample Displays: smp_dsets ABN_TABULAR, INH_TABULAR,
NIS_TABULAR, and TST_TABULAR
Usage Considerations: Measurement list layers can only contain record
types as they are grouped above.
For example, a hierarchical layer containing ABNALG, ABNPNT, and
ABNCNT is valid, while a layer containing ABNALG, INHALG, and
NISALG is not valid.
3.3.4.10 Alarms and Events
Alarms ALMQ
Events SYSACT

Composite Keys: All (empty or none), EGRP, or SUBSTN
Sample Displays: smp_dsets ALARM_TABULAR and
EVENT_TABULAR
3.3.4.11 Messages
Record Type Configuration: MSGLOG
Composite Keys: No key (all records)
Sample Display: smp_dsets SCADA_LOG
3.3.4.12 Tag Placements
Record Type Configuration: TAG
Composite Keys: No key (all records), DSET, DSRC, EGRP, SUBSTN,
DEVICE, ANALOG, COUNT, or POINT
Sample Displays: smp_dsets TAG_TABULAR_BYPOINT and
TAG_TABULAR_BYSTATION
3.3.4.13 Tag Types
Record Type Configuration: TAGTYP
Sample Display: smp_dsets TAGTYPES_TABULAR
3.3.4.14 Data Sources
Record Type Configuration: DSRC
3.3.4.15 Single-Level Data Sets
DSET
DSETy
Composite Keys: No key (all records) or DSETx
3.3.4.16 Recursive Data Sets
Record Type Configuration: DSETa ([DSETb] [DSETc] )

Composite Keys: No key (all records), DSETx, or DSETTYP of root-level
data sets
Sample Display: smp_tabular_dsets COMSTATE or RTUDIRECTORY
Usage Considerations: Including more than one DSET#-based record
type causes a recursive display starting at the starting record. If the
starting record is set to All, or if the composite key is blank, the entire
data set tree is available for display. However, only the data sets of the
levels specified in the display layout are visible.
For example, the RTUDIRECTORY has the layout:
DSET3
DSET99
The starting record is set up to include all records (no composite key for
the starting record). The resulting display is a recursive set of level-three
data sets starting at the root of the data set tree. Thus, all level-three
data sets in the database are displayed. There are no data sets at
level 99, so that picgroup is never displayed.
Note: The recursive data set layout can also be used to display specific
data set trees by linking to different root-level data sets (e.g.,
DSET0=CfeReader or DSET0=OPCServer), or by specifying a
DSETTYP in the composite key. A composite key involving a DSETTYP
results in a display starting with all of the root-level data sets of that type.
Note: Data sets of a data set type with the Filter from ComState Display
option enabled are not returned when using the recursive data set layout.
3.3.4.17 Recursive Data Sets and Data Items
Record Type Configuration: DSETa ([DSETb] [DSETc] ) DITEM
Composite Keys: No key (all records), DSET, or DSRC
Sample Display: smp_tabular_dsets RTUCHECKOUT
3.3.4.18 Recursive Data Sets and CounterMeas
Record Type Configuration:
([DSET(a)] [DSETb] ) ([COUNTR(x)] [COUNTERy] )
Composite Keys: DSET(p)
ID Field Contains: Full name for DSETs and short name for COUNTERs

Sample Display: smp_tabular_dsets RTUSTATE
3.3.4.19 StateMeas Lists
There are two different StateMeas list configurations: Hierarchical
StateMeas and Intrinsic StateMeas. Currently, there is no support for
All StateMeas.
Hierarchical StateMeas HSTATE
Intrinsic StateMeas ISTATE
Composite Keys: DSETx
Sample Display: smp_tabular_dsets RTUSTATE
3.3.4.20 Data Set Lists
Abnormal Data Sets ABNDSET
Inhibit Data Sets INHDSET
NIS Data Sets NISDSET
Tag Data Sets TAGDSET
Test Mode Data Sets TSTDSET
Sample Display: smp_dsets DSET_XXX_TABULAR where XXX is ABN,
INH, NIS, TAG, or TST
3.3.4.21 Advanced Performance Considerations
There may be more records passed through the network from the SCADA
server to a client box running e-terrabrowser Viewer than are represented
on the display. There may be only a few non-displayed records, such as
data set types on a data set display, or many records, as on the
COMSTATE display.
It is even possible to construct the same display in more than one way
with drastically different performance characteristics.
For example, examine a hierarchical display with the starting record
DSET0=Empax1 and the tabular layout:
DSET0
DSET1

This display causes all of Empax1s children data sets recursively down to
the very last level to cross the network.
Alternatively, a display using a simple layer containing a placement for
DSET0=Empax1 combined with a repeat tabular layer of DSET1 records
(with the starting record DSET0=Empax1) produces the same display.
However, only Empax1s direct children are passed through the network.

4. Commands
The following sections detail the supported commands.
4.1 e-terracontrol Commands
e-terracontrol commands are issued using the MAIL command interface.
For example, to inhibit a measurement, a keyset can be created with the
key name SELECT and the command MAIL/USER=SR_ INHIBIT.
4.1.1 ACKNOWLEDGE
Valid Objects: Primarily used with alarms, but valid for data sets,
data sources, measurements, and controls.
Action: Issues a primary acknowledge command for the object. Even
some of the objects listed above may not respond correctly to an
acknowledge command.
Example Display: smp_dsets ALARM_TABULAR
4.1.2 ADDTAG
Valid Objects: Data sets, data sources, stations, equipment, and
measurements.
Action: Adds a tag to the object using values entered into the ID,
TAGTYPE, PLACEDBY, and COMMENT fields.
Usage Considerations: Consider issuing an ENTER command right
before issuing the ADDTAG command to cache any entries on the form. A
valid Tag Type name must be entered prior to issuing the ADDTAG
command.
Example Display: smp_dsets MEASUREMENT_TABULAR display
4.1.3 CANCEL
Valid Objects: Measurements.
Action: Cancels the selection of a measurement.
Example Display: smp_dsets CONTROL_TABULAR
4.1.4 CLEAR
Valid Objects: Primarily used with alarms, but valid for data sets,
data sources, measurements, and controls.
Action: Issues a primary clear command for the object. Even some of the
objects listed above may not respond correctly to an acknowledge
command.
Example Display: smp_dsets ALARM_TABULAR
Proprietary See Copyright Page 39 Commands

4.1.5 CLEARTAGDATA
Valid Objects: Data sets, data sources, stations, equipment, and
measurements.
Action: Clears cached tag entry data.
Usage Considerations: Generally issued after a pop-up to clear any
cached tag data. For example, the POPUP_TAG keyset issues the
command POPUP ADDTAG_POPUP; MAIL/USER=SCADA
CLEARTAGDATA.
Example Display: smp60_dsets KIRKLAND
4.1.6 COLORINGALL
Valid Objects: Equipment.
Action: Send a demand of coloring for all the equipments. This command
is used in Topology processing.
4.1.7 DECOLORING
Action: Send a demand of de-coloring of the equipment. This command
is used in Topology processing.
4.1.8 DECOLORINGALL
Action: Send a demand of de-coloring for all the equipments. This
command is used in Topology processing.
4.1.9 EXECUTE
Valid Objects: Controls and setpoints.
Action: Executes the selected control or setpoint.
Usage Considerations: For more information, see the section Issuing
Controls and Setpoints.
4.1.10 FEEDERCOLORING
Action: Send a demand of feeder coloring of the equipment. This
command is used in Topology processing.
4.1.11 INHIBIT, INHIBITA, INHIBITB
Valid Objects: Data sets, data sources, and measurements.

Action: Inhibits or enables alarms on an object. For dual-state data sets,
either INHIBITA or INHIBITB must be used. For measurements, only
INHIBIT is valid.
Usage Considerations: Issuing any INHIBIT command always toggles
the inhibit state of the alarms on the object. There is no uninhibit
command.
Example Display: smp_dsets MEASUREMENT_TABULAR or
smp_tabular_dsets COMSTATE
4.1.12 MASSINHIBIT, MASSENABLE
Valid Objects: Data sets.
Action: Inhibits or enables alarming on all of the children data sets. For
example, if these commands are issued on a Path data set, all of the
children RTU data sets are inhibited or alarm-enabled.
Usage Considerations: This does not affect the data set that the
command is issued on, only the children.
Example Displays: smp_tabular_dsets COMSTATE and RTUSTATE
displays
4.1.13 MASSREMOVE, MASSRESTORE
Valid Objects: Data sets.
Action: Removes from service or restores to service all of the children
data sets. For example, if this command is issued on a Path data set, all
of the children RTU data sets are removed or restored.
Usage Considerations: This does not affect the data set that the
command is issued on, only the children.
Example Displays: smp_tabular_dsets COMSTATE and RTUSTATE
displays
4.1.14 REFRESH
Valid Objects: Data sets, analogs, statuses, and accumulators.
Action: Issues a demand scan to the writing data source of the active
data set of the object.
Example Display: smp_tabular_dsets RTU_STATE
4.1.15 REMOVE, REMOVEA, REMOVEB, RESTORE, RESTOREA,
RESTOREB
Valid Objects: Data sets, data sources, and measurements.
Action: Removes or restores the object from or to service.

Usage Considerations: Issuing any REMOVE or RESTORE command
always toggles the objects enabled state. There is no difference between
a REMOVE command and a RESTORE command.
Example Displays: smp_tabular_dsets COMSTATE, DATASOURCES,
and RTUDIRECTORY
4.1.16 REMOVETAG
Valid Objects: Tag placements.
Action: Removes the tag placement.
Example Display: smp_dsets TAG_TABULAR_BYPOINT and
TAG_TABULAR_BYSTATION
4.1.17 RESET
Valid Objects: CounterMeas, data sources, and data sets.
Action: For CounterMeas, resets the error count to zero. For
data sources and data sets, resets all of the counter errors.
Example Display: smp_tabular_dsets RTUSTATE and DATASOURCES
4.1.18 SELECT
Valid Objects: ANALOG and POINT.
Action: Selects the measurement for operation.
Usage Considerations: The measurement remains selected until it times
out or a CANCEL is issued.
4.1.19 SELECTSEQUENCE
Valid Objects: CTRL, SETPNT, and LIMITS.
Action: Selects the specific control to be executed, such as TRIP or
CLOSE.
4.1.20 TESTMODE
Valid Objects: Data sets and measurements.
Action: For measurements, adds or removes the object to or from test
mode. For data sets, adds or removes the data set to or from test mode
and recursively repeats the action for all of its children. Placing an object
in test mode effectively inhibits the objects alarms.
Example Display: smp_dsets MEASUREMENT_TABULAR and
smp_tabular_dsets RTUSTATE

4.1.21 TOGGLE
Valid Objects: Statuses.
Action: Toggles the value of a status.
4.1.22 TRACING
Action: Send a demand of tracing of the equipment. This command is
used in Topology processing.
4.1.23 Issuing Controls and Setpoints
For examples of issuing controls and setpoints, see the sample displays.
It is important to note the commands issued when calling up a Control or
Setpoint display or a pop-up picture. smp_dsets CONTROL_TABULAR
display provides an example of issuing controls from a display. The
PROCESSSTARTERS display in smp_dset gives an example of issuing
controls from a POINT picture using the controls external name (e.g.,
%EXTNAME_POINT%.STOP to issue the STOP control on the point).
More examples of issuing controls and setpoints can be found in
smp60_dset.
4.2 Standard Commands
The following sections detail the standard commands.
4.2.1 COPY
For examples of how to use the COPY command, see old modeling
displays. Support is very limited. Not all objects support being copied.
4.2.2 DELETE
For examples of how to use the DELETE command, see old modeling
displays in smp_dset. Support is very limited. Not all objects support being
deleted.
4.2.3 ENTER
For a list of enterable fields, see the section Record Types and Their
Fields. For examples of how to use the ENTER command, see the sample
modeling displays in smp_dset.
4.2.4 FILTER
Only specific filters are supported on e-terracontrol displays. Currently,
Alarm, Event, Measurement List, and Data Set List displays support
filtering (for a list of supported filters, see the Items (Global) ITEMS
section in the chapter Objects and Fields).

Note: e-terracontrol does not support filters constructed using the Filter
button on the e-terrabrowser Viewer. Filters must be formatted in a way
unique to e-terracontrol displays.
4.2.4.1 Adding or Removing Filters
To add a filter to the currently enabled filters, use the following syntax in
the keyset:
FILTER/LAYER=DEFAULT (COMPOSITEFILTER_ITEMS EQ %FV%)
([FILTER_NAME_TO_ADD IS_TRUE)
To remove a filter from the currently enabled filters, use the following
syntax in the keyset:
([FILTER_NAME_TO_ADD IS_FALSE)
For example, to add a filter to include StateMeas on a display, use the
following command:
(STATEFILTER_ITEMS IS_TRUE)
You can also produce CAMs to show the status of a single filter.
For examples of the use of filters, see the ALARM_TABULAR and DSET
list displays in smp_dset.
4.2.4.2 Setting Filters Using Picgroup Visibility CAMs
You can use a Picgroup Visibility CAM to permanently set a filter on a
display. The Visibility CAM must use valid e-terracontrol filters, as listed in
the Items (Global) ITEMS section in the chapter Objects and Fields.
However, rather than applying one of these filter fields to an ITEMS
object, use an object from the body of the tabular layer (e.g.,
ACKEVTFILTER_SYSACT).
It is recommended that you control each filter group from either CAM or a
dynamic filter, but not both. For example, the EVENT_Tabular displays
control event type (Standard, Deletion, Acknowledgment) filters using
CAMs and equipment group and measurement type filters using dynamic
filters.
For examples of using Picgroup Visibility CAMs to influence filters, see the
EVENT_ Tabular displays in smp_dset.
4.2.5 FIND/POSITION
FIND and POSITION commands always return the first matching record.
FIND commands on employing multiple record types are not supported.
For example, FIND DEVICE=1011 is valid, but FIND SUBSTN=Douglas
DEVICE=1011 is not valid.

4.2.5.1 Examples
Find using short names:
FIND DSET3=Douglas
Display/FIND=(DSET3=Douglas) COMSTATE
Position using handles/subscripts (where KEY500 has been set elsewhere
using the %SUB% proxy key):
POSITION DSET3=%KEY500%
Display/POSITION=(DSET3=%KEY500%) COMSTATE
4.2.6 INSERT
For examples using the in smp_dset INSERT command, see old modeling
displays. Support is very limited. Not all objects support being inserted at
this time.
4.2.7 MASK
Use the MASK command to change boolean enterable fields such as
NEGATE_DITEM or SAVEFRAC_COUNT.
For example, the following command toggles the Save Fraction field of an
accumulator:
MASK/TOGGLE=SAVEFRAC
4.2.8 SORT
Sorting commands can be constructed using the e-terrabrowser Viewer
Sort dialog box. You can sort by any of the fields of an object.
Remember that sorting by TEXTTIME fields may sort the times
alphabetically.
There is one limitation on e-terracontrol display sorting: Sorting on
multi-level hierarchical tabular displays is not supported. Only repeat
placements and flat hierarchical placements can be sorted.
For example, in smp_dset, sorting the hierarchical
MEASUREMENT_TABULAR display should work because all record
types are on the same level. However, sorting the
MEASUREMENT_MODELING display does not work because the
equipment is on a different level from the stations, and measurements
reside on a different level from the equipment.

Appendix A. Migrating to e-terracontrol Displays
This appendix provides information about unsupported features. It should
be useful to people with display building experience who are starting
e-terracontrol display building.
A.1 Records
The following sections detail the records.
A.1.1 Determining Available Fields
e-terracontrol does not provide a way to view available records, fields, or
their values. The best way to see which fields are available on an object is
to refer to the chapter Objects and Fields.
A.1.2 Station Modeling Differences with e-terraplatform
e-terraplatform SCADA uses the following fields for internal SCADA and
display linkages:
SUBSTN DEVTYP DEVICE POINT/ANALOG
e-terracontrol uses the following fields:
Substation (EquipmentType) Equipment Measurement
However, EquipmentType is not used in the internal or display linkage
(see the DEVTYP section).
Thus, e-terraplatform has a four-level hierarchy and e-terracontrol has a
three-level hierarchy (to comply with GOMSFE). This leads to problems if
you try to map SUBA LN 113 MW and SUBA CB 113 MW into
e-terracontrol, since they are seen as duplicate points because
EquipmentType is not considered when determining uniqueness.
To solve the naming problem, the database dump file generates data for
e-terracontrol in the form SUBSTN DEVTYP DEVTYP_DEVICE POINT.
The above examples generate two unique points: Suba Ln Ln_113 Mw
and Suba Cb Cb_113 Mw. ISD names for the above points are the same
as the e-terraplatform names: SUBA LN 113 MW and SUBA CB 113 MW.
All displays and controls should work, since they use the ISD name as the
linkage. You should be able to take an e-terraplatform display online,
remove any records and fields that are not supported by e-terracontrol,
and then recompile it and use it on an e-terracontrol database.
A.1.3 DEVTYP
DEVTYP is not a valid record type. It cannot be placed on a simple
display or be used as part of a tabular display.
However, DEVTYP can be used in the composite keys of measurements
(such as when referencing the external name of a measurement).
Proprietary See Copyright Page 46 Migrating to e-terracontrol Displays

Even though DEVTYP records do not exist in e-terracontrol displays, the
following composite key is valid:
SUBSTN = KIRKLAND
DEVTYP = CB
DEVICE = 540C
POINT = D1
A.1.4 Communication-Related Record Types
DSET record types (including DSET0, DSET1, ) make up the
communication hierarchy of e-terracontrol displays. Thus, records types
such as TFE, CHANEL, PATH, and RTUC are not valid on e-terracontrol
displays.
For a valid example, look at the COMSTATE display in the
smp_tabular_dset. Comstate is made up of the record types DSET0,
DSET1, DSET2, and DSET3.
Additionally, only handle and full-name base composite keys are valid for
DSETs. Breaking out a data set by record type does not work.
The following composite key is invalid:
DSET0=LocalTfe
DSET1=Cfe3
DSET2=1
DSET3=Douglas
For more information, see the Handling Multi-Level Objects section in the
chapter Layouts.
A.1.5 Alarms and Events
On e-terracontrol displays, alarms and events are structurally the same
but they use different record types. Alarms use the ALMQ record type,
whereas events use SYSACT.
A.1.6 Multi-Record Picgroups
Picgroups containing multiple pictures with active fields are not supported.
For example, a picgroup containing more than one ANALOG picture, or
an ANALOG picture and a COUNT picture, is not valid on e-terracontrol
displays.
A.1.7 %SUB% = Handle
The subscript of an e-terracontrol record is not related to the
e-terrahabitat subscript.

The subscript of an e-terracontrol record contains the numeric handle of
the object. These handles are unique numeric identifiers for each object.
Although Alstom Grid does not recommend hard-coding handles into
simple displays, they are useful when constructing quick handle-based
composite keys using the %SUB% proxy key.
For an example of using %SUB%, see the keyset in the
COMSTATE_DSET3 picture in smp_tabular_dset.
A.2 Tabular Layers
The only valid tabular types are repeat placements and hierarchical
placements. All other placements, including link list, multi-dimensional,
and indexed, are not supported.
A.2.1 Multiple Pages
e-terracontrol displays cannot separate data into different pages. When
calling up a tabular display, the user gets the entire list of objects.
A.3 Commands
The following sections detail the commands.
A.3.1 Multi-Level FIND/POSITION Commands
FIND commands employing multiple record types are not supported.
For example, FIND DEVICE=1011 is valid, but FIND SUBSTN=Douglas
DEVICE=1011 is not valid.
A.3.2 Sorting Multi-Level Hierarchical Displays
Sorting multi-level hierarchical layers, such as the default layer of the
Measurement Modeling display in smp_dset, does not work.
Sorting repeat layers and flat hierarchical displays, such as the default
layer of the ABN_TABULAR display in smp_dset display, does work.
A.3.3 Permission Tests
Explicit permission tests are not supported. User authorization is implicitly
implemented in the queries and commands. The queries only return
results made up of the objects for which the user has been granted
access; commands are only executed against objects for which the user
has been granted access. To define the authorization scheme, use the
Area and User objects.


SMP DG

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

SMP DG

Transféré par

Droits d'auteur :

Formats disponibles

e-terracontrol Display Builder Guidelines

This document explains the features and capabilities of

Software Version: e-terracontrol 3.7

Copyright 2011 ALSTOM Grid Inc. or Affiliate All Rights Reserved.

NOTE: CONTAINS PROPRIETARY INFORMATION OWNED BY ALSTOM GRID INC.

1. Base System Displays .......................................................................... 1

2. Objects and Fields................................................................................ 3

Proprietary See Copyright Page iii

Proprietary See Copyright Page iv

Proprietary See Copyright Page v

Appendix A. Migrating to e-terracontrol Displays ................................. 46

Proprietary See Copyright Page vi

Proprietary See Copyright Page vii

Proprietary See Copyright Page viii

Proprietary See Copyright Page ix

Proprietary See Copyright Page x

Proprietary See Copyright Page 1 Base System Displays

Proprietary See Copyright Page 2 Base System Displays

Proprietary See Copyright Page 3 Objects and Fields

2.1.2 Self Qualities

Proprietary See Copyright Page 4 Objects and Fields

2.2 Tag Bits

Proprietary See Copyright Page 5 Objects and Fields

Proprietary See Copyright Page 6 Objects and Fields

2.4.1.2 Read-Only Fields

Proprietary See Copyright Page 7 Objects and Fields

Name of Property Field Name Field Type

2.4.2 Accumulator Time ABNCNT, INHCNT, NISCNT, TSTCNT

2.4.3 Alarm ALMQ

Proprietary See Copyright Page 8 Objects and Fields

2.4.4 Analog ANALOG

Proprietary See Copyright Page 9 Objects and Fields

2.4.4.3 Limited Fields

Name of Property Field Name Field Type

Proprietary See Copyright Page 10 Objects and Fields

2.4.6 Area AREA

2.4.7 Control CTRL

Proprietary See Copyright Page 11 Objects and Fields

2.4.8.2 Limited Fields

Name of Property Field Name Field Type

Proprietary See Copyright Page 12 Objects and Fields

2.4.9.2 Read-Only Fields

Proprietary See Copyright Page 13 Objects and Fields

2.4.10 Data Set DSET, DSET0, DSET1, , DSET7

2.4.10.2 Read-Only Fields

Proprietary See Copyright Page 14 Objects and Fields

2.4.10.3 Limited Fields

Name of Property Field Name Field Type

Proprietary See Copyright Page 15 Objects and Fields

2.4.12 Data Source DSRC

Proprietary See Copyright Page 16 Objects and Fields

2.4.13.2 Read-Only Fields

Proprietary See Copyright Page 17 Objects and Fields

Name of Property Field Name Field Type

2.4.14 Equipment Group EGRP

2.4.14.2 Read-Only Fields

Name of Property Field Name Field Type

Proprietary See Copyright Page 18 Objects and Fields

2.4.16 Event SYSACT

Proprietary See Copyright Page 19 Objects and Fields

2.4.17 Items (Global) ITEMS

Proprietary See Copyright Page 20 Objects and Fields

2.4.18 Limit LIMIT