e-terracontrol Reference Manual:

Interfaces to Field Devices

This document describes the modeling and configuration activities for e-terracontrol.
e-terracontrol includes several applications that provide interfaces to field devices,
including the CFE Reader, the OPC DA Client, the PLC Reader, the TrueTime Reader,
and Relay Reader applications.

Software Version: e-terracontrol 3.9

Document Date: December 9, 2015
Copyright and Proprietary Information

Copyright © 2015 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, REPRODUCE, DISTRIBUTE,
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 ............................................................................................... xi
Purpose of This Document ............................................................................................ xi
Who Should Use This Document .................................................................................. xi
Structure of This Document .......................................................................................... xi
For More Information.................................................................................................... xii
Conventions ................................................................................................................ xiii
Change Summary ....................................................................................................... xiii

1. CFE Reader ............................................................................................................. 1

1.1 CFE Reader-Supported Protocols........................................................................... 1
1.2 Structure of the CFE Reader ................................................................................... 2
1.3 Overview of the Communication Model ................................................................... 2
1.4 Display and Logging Features................................................................................. 4
1.5 CFE Reader Command-Line Arguments ................................................................ 6
1.5.1 Data Source ....................................................................................................... 7
1.5.2 Host(s) ............................................................................................................... 7
1.5.3 Log Settings ....................................................................................................... 7
1.5.4 Enable/Disable ................................................................................................... 8
1.5.5 Server Listen Port .............................................................................................. 9
1.5.6 Port .................................................................................................................. 10
1.5.7 ScadaPort ........................................................................................................ 10
1.5.8 CFGDIR ........................................................................................................... 10
1.5.9 /exceptionhandler=XXX ................................................................................... 11
1.5.10 UseErrorCntToDisconnect ............................................................................. 11
1.6 Starting CFE Reader Using the Process Starter ................................................... 11
1.7 CFE Reader Configuration File ............................................................................. 12
1.8 CFE Reader User Interface ................................................................................... 12
1.8.1 CFE Reader Database Tab.............................................................................. 13
1.8.1.1 CFE Reader Data Set ................................................................................. 14
1.8.1.1.1 Accumulator Type .................................................................................. 16
1.8.1.2 CFE Data Set .............................................................................................. 17
1.8.1.3 Bucket Data Set .......................................................................................... 27
1.8.1.4 Time Device Data Set ................................................................................. 28
1.8.1.5 Port Data Set .............................................................................................. 28
1.8.1.6 RTU Data Set.............................................................................................. 32
1.8.1.7 Scan Group Data Set .................................................................................. 39
1.8.1.8 Card Data Set ............................................................................................. 42
1.8.2 CFE Reader Log Tab ....................................................................................... 46
1.8.3 CFE Reader Communication Log Tab ............................................................. 47
1.8.4 CFE Reader Configuration Tab ........................................................................ 48
1.9 CFE Reader Remote Diagnostic User Interface.................................................... 52
1.9.1 CFE Reader Remote Diagnostic Configuration File ......................................... 52
1.9.2 CFE Reader Remote Diagnostic Display ......................................................... 53
1.10 CFEReader Line Analyzer................................................................................... 58

Proprietary – See Copyright Page iii

 1.10.1 Line Analyzer Design ..................................................................................... 58
1.10.2 Line Analyzer Modules ................................................................................... 59
1.10.3 Using Line Analyzer ....................................................................................... 60
1.10.4 Line Analyzer Server ...................................................................................... 60
1.10.5 Line Analyzer Client ....................................................................................... 61
1.10.5.1 Connect/Disconnect .................................................................................. 62
1.10.5.2 Line Analyzer Client Toolbar ..................................................................... 63
1.10.5.3 Port List ..................................................................................................... 63
1.10.5.4 Min Datagram Size ................................................................................... 64
1.10.5.5 Protocol List .............................................................................................. 64
1.10.5.6 Captured Messages View (Raw/Hex Dump View) .................................... 65
1.10.5.7 Interpreted Messages View ...................................................................... 66
1.10.5.8 Filtering Messages .................................................................................... 67
1.10.6 Writing LogAnalyzer Protocol XML Files ........................................................ 69
1.10.6.1 DOCTYPE Definition ................................................................................. 69
1.10.6.2 Protocol Element....................................................................................... 71
1.10.6.3 Layer Element ........................................................................................... 71
1.10.6.4 Direction Field ........................................................................................... 71
1.10.6.5 If and Else Elements ................................................................................. 71
1.10.6.6 Case Element ........................................................................................... 72
1.10.6.7 Loop Times Element ................................................................................. 72
1.10.6.8 Loops While Element ................................................................................ 73
1.10.6.9 Pad Element ............................................................................................. 73
1.10.6.10 Backward Element .................................................................................. 73
1.10.6.11 Color Element ......................................................................................... 73
1.11 CFE Reader-Specific Counter Measurements .................................................... 74
1.12 CFE Reader Error Log Message Description ...................................................... 74
1.12.1 -CFECONTROL_E_0004 ............................................................................... 74
1.12.2 -CFECONTROL_E_0021 ............................................................................... 75
1.12.3 -CFECONTROL_E_0022 ............................................................................... 76
1.12.4 -PSTRMS_E_0182......................................................................................... 76
1.12.5 -PSTRMS_E_0095......................................................................................... 77
1.12.6 -PSTRMS_E_0042......................................................................................... 77
1.12.7 -PSTRMS_E_0180......................................................................................... 77
1.12.8 -PSTRMS_E_0179......................................................................................... 80
1.12.9 -PSTRMS_E_0250......................................................................................... 80
1.12.10 -PSTRMS_E_0080....................................................................................... 80
1.12.11 -PSTRMS_W_0251...................................................................................... 80
1.12.12 -PSTRMS_E_0252....................................................................................... 81
1.12.13 -PSTRMS_W_0253...................................................................................... 81
1.12.14 -PSTRMS_W_0146...................................................................................... 81
1.12.15 -PSTRMS_W_0147...................................................................................... 81
1.12.16 -PSTRMS_W_0266...................................................................................... 82
1.12.17 -PSTRMS_E_0257....................................................................................... 83
1.12.18 -PSTRMS_E_0302....................................................................................... 83
1.12.19 -PSTRMS_E_0082....................................................................................... 83

Proprietary – See Copyright Page iv

 1.12.20 -PSTRMS_E_0184....................................................................................... 83
1.12.21 -PSTRMS_W_ REQUEST_SKIP _0799 ...................................................... 84
1.12.22 -PSTRMS_E_RTUPOL_0800 ...................................................................... 84

2. DNP Interpreter ..................................................................................................... 85

2.1 DNP Interpreter Command-Line Arguments ......................................................... 85
2.2 Starting DNP Interpreter Using Process Starter .................................................... 85

3. CFE Performance Driver ...................................................................................... 87

3.1 CFE Performance Driver Command-Line Arguments ........................................... 87
3.2 CFE Performance Driver User Interface ............................................................... 88
3.3 cfeperfdata.txt File Format .................................................................................... 89

4. ScanMonitor Application ..................................................................................... 90

4.1 ScanMonitor Command-Line Arguments .............................................................. 90
4.2 SCADA Modeling and Configuration ..................................................................... 91
4.3 ScanMonitor User Interface................................................................................... 91

5. OPC Client Application ........................................................................................ 92

5.1 OPC Data Access Support .................................................................................... 92
5.2 OPC Unified Architecture Support......................................................................... 92
5.3 OPC Client Command-Line Arguments ................................................................ 93
5.4 Starting the OPC Client Using the Process Starter ............................................... 93
5.5 OPC Client User Interface ..................................................................................... 95
5.5.1 OPC Client User Interface – Namespace Tab ................................................. 95
5.5.2 OPC Client User Interface – Status and Statistics Tab .................................... 96
5.5.3 OPC Client User Interface – Log Tab............................................................... 97
5.5.4 OPC Client User Interface – Settings Tab........................................................ 98
5.6 OPC Client Configuration ...................................................................................... 99
5.6.1 Configuration via a SCADA Database ............................................................. 99
5.6.1.1 OPCDS Data Set ...................................................................................... 101
5.6.1.2 OPCServerDS Data Set ............................................................................ 101
5.6.1.3 OPCGroupDS Data Set ............................................................................ 102
5.6.1.4 OPCItemDS Data Set ............................................................................... 105
5.6.1.5 Data Items ................................................................................................ 106
5.6.1.6 Controls and Setpoint Configuration ......................................................... 107
5.6.2 Configuration File ........................................................................................... 110
5.6.2.1 Configuration File Example ....................................................................... 110
5.6.3 OPC UA Certificate Configuration .................................................................. 110
5.6.3.1 Importing a Certificate into the Windows Certificate Store ........................ 111
5.6.3.2 Trusting Client Application Certificates ..................................................... 116
5.7 Viewing Server, Group, and Item Properties ....................................................... 116
5.7.1 Server Properties ........................................................................................... 116
5.7.2 Group Properties ............................................................................................ 117
5.7.3 Item Properties ............................................................................................... 117
5.8 OPC Client in Test Mode .................................................................................... 119
5.8.1 Test Mode Configuration Dialog Box ............................................................. 120

Proprietary – See Copyright Page v

 5.8.2 Changing Server Properties ........................................................................... 121
5.9 OPC Quality to e-terracontrol SCADA Quality Mapping ..................................... 121

6. PLC Reader Applications .................................................................................. 123

6.1 Modbus Reader Application ................................................................................ 123
6.1.1 Modbus Reader Command-Line Arguments .................................................. 123
6.1.1.1 SCADA Source Name ............................................................................... 124
6.1.1.2 SCADA Timeout........................................................................................ 124
6.1.1.3 Modbus Timeout ....................................................................................... 124
6.1.1.4 Update Interval.......................................................................................... 124
6.1.1.5 Configuration File ...................................................................................... 124
6.1.1.6 ScadaPort ................................................................................................. 125
6.1.1.7 e-terracontrol Server Host(s) Designation ................................................ 125
6.1.2 Starting the Modbus Reader Using the Process Starter................................. 125
6.1.3 Modbus Reader User Interface ...................................................................... 126
6.1.3.1 Modbus Reader Menu Bar ........................................................................ 127
6.1.3.2 Communication Parameters Configuration Dialog Box ............................. 128
6.1.3.3 Alarm Configuration Dialog Box ................................................................ 130
6.1.3.4 Scan Group Properties Dialog Box ........................................................... 131
6.1.3.5 PLC Errors ................................................................................................ 134
6.1.4 Data Set Configuration ................................................................................... 134
6.1.4.1 Modbus PLC DS ....................................................................................... 136
6.1.4.2 MB Alarm DS ............................................................................................ 138
6.1.4.3 MB Scan Group DS .................................................................................. 139
6.1.4.4 Modbus Reader-Specific Counter Measurements .................................... 141
6.2 TI Reader ............................................................................................................ 142
6.2.1 TI Reader Command-Line Parameters .......................................................... 142
6.2.2 Starting the TI Reader Using the Process Starter .......................................... 142
6.2.3 TI Reader User Interface................................................................................ 143
6.2.4 TI Reader Menu Bar....................................................................................... 144
6.2.5 Communication Parameters Configuration Dialog Box .................................. 145
6.2.6 Alarm Configuration Dialog Box ..................................................................... 147
6.2.7 Scan Group Properties Dialog Box ................................................................ 148
6.2.8 PLC Errors ..................................................................................................... 150

7. TrueTime Reader Application............................................................................ 151

7.1 TrueTime Reader Command-Line Arguments .................................................... 151
7.2 Starting the TrueTime Reader Using the Process Starter ................................... 152
7.3 TrueTime Reader User Interface......................................................................... 154
7.4 Configuring the TrueTime Device for the F27 Format ......................................... 156
7.5 Adding Measurements to the SCADA Server...................................................... 156

8. Relay Reader Application .................................................................................. 157

8.1 Relay Reader Command-Line Arguments .......................................................... 157
8.2 Host(s) ................................................................................................................ 157
8.3 Log Settings ........................................................................................................ 158
8.4 Enable/Disable .................................................................................................... 158

Proprietary – See Copyright Page vi

 8.5 Starting the Relay Reader Using the Process Starter ......................................... 159
8.6 Relay Reader User Interface ............................................................................... 160
8.6.1 Database Tab ................................................................................................ 160
8.6.2 Log Tab .......................................................................................................... 162
8.6.3 Configuration Tab .......................................................................................... 163
8.6.4 Pass-Through Tab ......................................................................................... 164
8.6.5 Relay Reader Menu Bar................................................................................. 165
8.7 Data Set Configuration ........................................................................................ 165
8.7.1 Defining the Data Set Types for the Relay Reader ........................................ 166
8.7.2 RelayReaderDS ............................................................................................. 168
8.7.3 CommDS ....................................................................................................... 169
8.7.4 RelayDS ......................................................................................................... 171
8.7.5 PollDS ............................................................................................................ 173
8.7.6 PointDS .......................................................................................................... 174

9. IEC61850 Client Interface .................................................................................. 176

9.1 Command Lines .................................................................................................. 176
9.1.1 Data Source ................................................................................................... 176
9.1.2 Host(s) ........................................................................................................... 177
9.1.3 Port ................................................................................................................ 177
9.2 Structure of the IEC61850 Client......................................................................... 177
9.3 Data Set Configuration ........................................................................................ 177
9.4 Indexed Report Configuration ............................................................................. 184
9.5 Static Data Sets vs. Dynamic Data Sets ............................................................. 184
9.6 Troubleshooting a Failed Connection .................................................................. 185

10. IEC61850 Communications Agency ............................................................... 186

10.1 Agency Application ............................................................................................ 186
10.2 Agency Lean.cfg Configuration File .................................................................. 186

11. IEC61850 Configuration Application .............................................................. 187

11.1 User Interface.................................................................................................... 187
11.2 What the Batch File Does ................................................................................. 188
11.3 IEC61850Config Batch File and Error Diagnosis .............................................. 188
11.3.1 Update of Variable Environments ................................................................ 188
11.3.2 Error Diagnosis ............................................................................................ 189

12. IEC61850 Interoperability ................................................................................ 191

12.1 Abstract Communication Service Interface (ACSI) Conformance Statement .... 191
12.1.1 General ........................................................................................................ 191
12.1.2 ASCI Basic Conformance Statement ........................................................... 192
12.1.3 ACSI Models Conformance Statement ........................................................ 193
12.1.4 ACSI Service Conformance Statement ........................................................ 194
12.2 Interoperability Matrix ........................................................................................ 198
12.2.1 MiCOM P40 ................................................................................................. 199
12.2.2 MiCOM P30 ................................................................................................. 203
12.2.3 MiCOM P20 ................................................................................................. 205

Proprietary – See Copyright Page vii

 12.2.4 Alstom Grid .................................................................................................. 207
12.2.5 Other IEDs ................................................................................................... 209

13. Double Point Processing ................................................................................. 214

Figures
Figure 1. CFE Reader Data Hierarchy ............................................................................ 4
Figure 2. CFE Logging Features ..................................................................................... 6
Figure 3. CFE Reader User Interface ............................................................................ 13
Figure 4. CFE Reader Data Set Dialog Box .................................................................. 14
Figure 5. Accumulator Type Dialog Box ........................................................................ 16
Figure 6. CFE Event Log Window ................................................................................. 18
Figure 7. CFE Configuration Data Window ................................................................... 19
Figure 8. PCL Records Window .................................................................................... 19
Figure 9. CFE Statistics Window ................................................................................... 21
Figure 10. PCLTXT Records Window ........................................................................... 23
Figure 11. CFE Data Set Display – Event Log Tab ....................................................... 24
Figure 12. CFE Data Set Display – Event Log per Port Tab ......................................... 25
Figure 13. CFE Data Set Display – Line Analyzer Tab.................................................. 25
Figure 14. CFE Data Set Display – Socket Trace Tab .................................................. 26
Figure 15. Bucket Data Set Dialog Box ......................................................................... 27
Figure 16. Time Device Data Set Dialog Box ................................................................ 28
Figure 17. Port Data Set Dialog Box ............................................................................. 29
Figure 18. Port Communication Statistics Dialog Box ................................................... 31
Figure 19. RTU Data Set Dialog Box............................................................................. 33
Figure 20. RTU Communication Statistics Dialog Box .................................................. 36
Figure 21. RTU Detailed Error Counts Dialog Box ........................................................ 37
Figure 22. Table View of Point Data Window ................................................................ 38
Figure 23. Scan Group Data Set Dialog Box ................................................................. 39
Figure 24. Scan Group Data Set Dialog Box ................................................................. 40
Figure 25. Scan Group Detailed Error Count Dialog Box .............................................. 41
Figure 26. Card Data Set Dialog Box ............................................................................ 42
Figure 27. Measurement Display Dialog Box ................................................................ 45
Figure 28. CFE Reader – Log Tab ................................................................................ 46
Figure 29. CFE Reader – Communication Log Tab ...................................................... 47
Figure 30. CFE Reader – Configuration Tab ................................................................. 48
Figure 31. Communication Diagnostic Tab ................................................................... 54
Figure 32. Logging Control Tab ..................................................................................... 55
Figure 33. Log Tab ........................................................................................................ 57
Figure 34. Relationships Among the Components in the Line Analyzer ........................ 59
Figure 35. Line Analyzer Server Display without a Client Connection ........................... 60
Figure 36. Line Analyzer Server Display with a Client Connection ................................ 60
Figure 37. Line Analyzer Client Login Display ............................................................... 61
Figure 38. Line Analyzer Client Display......................................................................... 62

Proprietary – See Copyright Page viii

Figure 39. Line Analyzer Client Toolbar ........................................................................ 63
Figure 40. Port List Combo Box with a Selected Port.................................................... 63
Figure 41. Min. Datagram Size Field ............................................................................. 64
Figure 42. Protocol List ................................................................................................. 64
Figure 43. Captured Raw Messages View .................................................................... 65
Figure 44. Interpreted Messages View .......................................................................... 66
Figure 45. Empty Filters Dialog Box .............................................................................. 67
Figure 46. Filters Dialog Box with an Empty Filter Line ................................................. 68
Figure 47. Filters Dialog Box with Multiple Filter Rules ................................................. 69
Figure 48. CFE Performance Driver User Interface ...................................................... 88
Figure 49. ScanMonitor User Interface.......................................................................... 91
Figure 50. OPC Client User Interface – Namespace Tab.............................................. 95
Figure 51. OPC Client User Interface – Status and Statistics Tab ................................ 96
Figure 52. OPC Client User Interface – Log Tab ........................................................... 97
Figure 53. OPC Client User Interface – Settings Tab .................................................... 98
Figure 54. OPC Client Data Set Hierarchy .................................................................. 100
Figure 55. OPCDS Data Set Dialog Box ..................................................................... 101
Figure 56. OPCServerDS Data Set Dialog Box ........................................................... 101
Figure 57. OPCGroupDS Data Set Dialog Box ........................................................... 102
Figure 58. OPCItemDS Data Set Dialog Box .............................................................. 105
Figure 59. OPC Client Data Set Hierarchy .................................................................. 109
Figure 60. OPC DA Server Properties Dialog Box ...................................................... 116
Figure 61. OPC DA Group Properties Dialog Box ....................................................... 117
Figure 62. OPC DA Item Properties Dialog Box .......................................................... 118
Figure 63. OPC UA Item Properties Dialog Box .......................................................... 118
Figure 64. Namespace Tab in Test Mode ................................................................... 119
Figure 65. Test Mode Configuration Dialog Box .......................................................... 120
Figure 66. Server Properties Dialog Box ..................................................................... 121
Figure 67. PLC Reader Applications ........................................................................... 123
Figure 68. Modbus Reader User Interface .................................................................. 126
Figure 69. Communication Parameters Configuration Dialog Box – Modbus Reader . 128
Figure 70. Alarm Configuration Dialog Box – Modbus Reader .................................... 130
Figure 71. Scan Group Properties Dialog Box – Modbus Reader ............................... 131
Figure 72. PLC Errors Dialog Box – Modbus Reader .................................................. 134
Figure 73. Modbus Reader Data Set Hierarchy .......................................................... 135
Figure 74. Modbus PLC Data Set ............................................................................... 136
Figure 75. MB Alarm Data Set Dialog Box .................................................................. 138
Figure 76. MB Scan Group Data Set Dialog Box ........................................................ 139
Figure 77. TI Reader User Interface ............................................................................ 143
Figure 78. Communication Parameters Configuration Dialog Box – TI Reader .......... 145
Figure 79. Alarm Configuration Dialog Box – TI Reader ............................................. 147
Figure 80. Scan Group Properties Dialog Box – TI Reader......................................... 148
Figure 81. PLC Errors Dialog Box – TI Reader ........................................................... 150
Figure 82. TrueTime Reader User Interface................................................................ 154
Figure 83. Relay Reader – Database Tab ................................................................... 160
Figure 84. Relay Reader – Log Tab ............................................................................ 162

Proprietary – See Copyright Page ix

Figure 85. Relay Reader – Configuration Tab ............................................................. 163
Figure 86. Relay Reader – Pass-Through Tab ............................................................ 164
Figure 87. Relay Reader Data Set Hierarchy .............................................................. 166
Figure 88. Relay Reader Data Set User Interface ....................................................... 168
Figure 89. Comm Data Set User Interface .................................................................. 169
Figure 90. Relay Data Set User Interface.................................................................... 171
Figure 91. Relay Data Set – Data Items Tab............................................................... 172
Figure 92. Poll Data Set User Interface ....................................................................... 173
Figure 93. Point Data Set User Interface..................................................................... 174
Figure 94. Point Data Set – Data Items Tab................................................................ 175
Figure 95. IEC61850 Client Data Set Tree .................................................................. 178
Figure 96. IEC61850 Device Data Set Window ........................................................... 180
Figure 97. IEC61850 Periodic Read Parameter .......................................................... 181
Figure 98. IEC61850 Client Data Items ....................................................................... 181
Figure 99. IEC61850 Client Control Data Items .......................................................... 182
Figure 100. IEC61850 Client User Interface................................................................ 183
Figure 101. IEC61850 Client Indexed Report.............................................................. 184
Figure 102. IEC61850 Configuration User Interface ................................................... 187

Tables
Table 1. Modules and Associated Codes ...................................................................... 20
Table 2. OPC Quality to e-terracontrol SCADA Quality Mapping ................................ 121
Table 3. Basic Conformance Statement ...................................................................... 192
Table 4. ACSI Models Conformance Statement .......................................................... 193
Table 5. ACSI Service Conformance Statement ......................................................... 194
Table 6. MiCOM P40 ................................................................................................... 199
Table 7. MiCOM P30 ................................................................................................... 203
Table 8. MiCOM P20 ................................................................................................... 205
Table 9. Alstom Grid.................................................................................................... 207
Table 10. Other IEDs................................................................................................... 209
Table 11. S and X in a Single Scan ............................................................................. 214
Table 12. S and X in Different Scans .......................................................................... 214
Table 13. S X X S S X in Single Scan ......................................................................... 215
Table 14. S X, X S, and S X in Different Scans ........................................................... 215
Table 15. S X X S S and X in Different Scans ............................................................. 216
Table 16. S X S and X S X in Different Scans ............................................................. 216
Table 17. S X S S in Single Scan ................................................................................ 217

Proprietary – See Copyright Page x

About This Document
This document is supplied as a part of Alstom Grid’s e-terracontrol product.

Purpose of This Document

This document is intended for use as follows:
• To introduce the reader to the applications that make up e-terracontrol.
• To provide configuration information about the e-terracontrol applications.
• To provide modeling information about the e-terracontrol applications.

Who Should Use This Document

This document is intended for all users of e-terracontrol.

Structure of This Document

This document is structured in the following manner:
• Chapter 1 covers the CFE Reader.
• Chapter 2 describes how to use the DNP Interpreter.
• Chapter 3 covers the CFE Performance Driver.
• Chapter 4 covers the ScanMonitor application.
• Chapter 5 covers the OPC DA Client application.
• Chapter 6 covers the PLC Reader applications: the Modbus Reader and the TI
Reader.
• Chapter 7 covers the TrueTime Reader application.
• Chapter 8 covers the Relay Reader application.
• Chapter 9 covers the IEC61850 Client Interface.
• Chapter 10 covers the IEC61850 Communications Agency.
• Chapter 11 covers the IEC61850 Configuration application.
• Chapter 12 qualifies e-terracontrol’s IEC61850 interface interoperability.
• Chapter 13 describes how e-terracontrol expects bits (S and X) to be sent.

Proprietary – See Copyright Page xi

For More Information
For more information about configuring and modeling e-terracontrol, refer to the
following:
• 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: 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 to the user. 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 External Systems: Features
applications designed to communicate with external systems such as EMS, DCS, or
other SCADA systems. These applications include ADO/SMP, DDEML/SMP,
InterSite Data, Modbus/SMP, OPC DA Server, PI/SMP, ICCP, and XX/SMP.
For more information about e-terracontrol, refer to the following:
• e-terracontrol Release Notes
• e-terracontrol Programmer’s 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.
• e-terracontrol Display Builder Guidelines: Explains the features and capabilities of
e-terracontrol–based e-terrabrowser displays. It should be helpful to anyone
seeking to build e-terracontrol displays.
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 Viewer application.
• e-terrabrowser User’s Guide: Provides a guide to the use of e-terrabrowser, the
Web technology–based version of e-terrahabitat’s user interface processor and
command language.
For more information about designing displays for viewing in e-terrabrowser, refer to the
following:
• Display Builder User’s Guide: An introduction to the concepts, features, and
components of the Display Builder software, along with instructions for how to use

Proprietary – See Copyright Page xii

 the Display Builder software to build displays and how to define display components
for viewing in e-terrabrowser.
For more information about the e-terracontrol/ICCP application, refer to the following:
• e-terracontrol/ICCP User’s Guide: Modeling: Provides instructions for the modeling
of the e-terracontrol/ICCP application.
• e-terracontrol/ICCP User’s Guide: Real-Time Operation: Provides information about
and instructions for the operation of the e-terracontrol/ICCP application.
• e-terracontrol/ICCP Release Notes
For more information about RTUMMU, refer to the following:
• RTU Miscellaneous Message Utility User’s Guide: Details use and user notes for the
Remote Terminal Unit Miscellaneous Messages Utility (RTUMMU).
For more information about security configuration aspects for the XX/SMP application,
refer to the following:
• ProtocolPak Security Configuration User’s Guide: Provides information about the
configuration of the xx2smp application for use in secure networks.

Conventions
The e-terracontrol applications support the keyboard and mouse operations common to
the Microsoft Windows interface.
Any additions to, enhancements of, or departures from standard Windows conventions
are noted in this document.

Change Summary
The following changes were made to this document for e-terracontrol 3.9:
• Updated section 1.5.7 ScadaPort.
• Added section 1.5.10 UseErrorCntToDisconnect.
• Updated section 1.8.1.7 Scan Group Data Set.
• Added section 1.12.21 -PSTRMS_W_ REQUEST_SKIP _0799.
• Added section 1.12.22 -PSTRMS_E_RTUPOL_0800.
• Added section 3.3 cfeperfdata.txt File Format.
• Added a description of the "Scada database name" argument in section 7.1
TrueTime Reader Command-Line Arguments.
• Added chapter 13 Double Point Processing.

Proprietary – See Copyright Page xiii

1. CFE Reader
The CFE Reader application is capable of communicating with RTUs via various
protocols. The application interfaces with one or several Communications Front Ends
(CFEs), which more specifically manage the network layers of the communications, as
well as all protocol-specific processing.
The CFE Reader utilizes the SCADA database to perform the following functions:
• Perform all communications with the RTUs, including scanning, controls,
initialization, and clock synchronization
• Schedule “smart” periodic scanning of the RTUs
• Report data changes and errors to e-terracontrol
• Handle control requests sent by e-terracontrol
• Schedule accumulator freeze and read operations
• Report Sequence of Events logs in the form of text files
• Schedule exploratory scans on failed devices
• Retrieve hourly communication statistics reports
• Provide a user interface to browse the communication model and view the current
raw values of measurements as well as several log reports
The SCADA database objects that are required by the CFE Reader application include:
• A hierarchical collection of data sets that model the CFE Reader’s communication
subsystem (from the CFE Reader itself to the RTU cards)
• The measurement definitions and values associated with the data sets under the
form of data item collections
• Some timers (accumulator timers, statistics) are managed internally by the SCADA
application; the CFE Reader is only notified when they expire, and then it performs
the corresponding operations. Note that these timers must be defined in the Timers
section of the e-terracontrol model as well as assigned on the Timers tab of the
CFE Reader data set type. The name of the timer relationship for each timer must
be specified correctly in order for the CFE Reader to correctly process the timer
notification from SCADA (for details, refer to the e-terracontrol Protocol Modeling
Guide).

1.1 CFE Reader-Supported Protocols

For a full list of protocol implementations that are packaged with CFE Reader, refer to
the e-terracontrol Release Notes and the e-terracontrol Protocol Modeling Guide. The
e-terracontrol Protocol Modeling Guide contains detailed implementation and
configuration documentation for each protocol implementation.

Proprietary – See Copyright Page 1 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.2 Structure of the CFE Reader
The CFE Reader application includes several ActiveX controls that perform its core
functions. The application itself only manages those controls and logs the data that are
of interest to the user.
The controls are:
• SCADADevice: Interfaces with the SCADA application
• CFE Control: Stores the communication model and manages the CFEs
• CFE DiagMsg: Opens the CFEs DEBUG module to retrieve internal information
from the CFEs
The CFE itself is referred to as a STREAMS application. The term “STREAMS” refers to
an architecture that is mainly devoted to protocol translation; it is made up of several
series (STREAMS) of modules, and each of these STREAMS manages the successive
functions of a communications path.

1.3 Overview of the Communication Model

A “data set” is a structure that, in the form of a parameter string, contains all parameters
that model a communications object. The data set collection is organized in a
hierarchical way in order to represent the communication topology.
For e-terraplatform users, a data set type in e-terracontrol corresponds globally to a
record type in e-terraplatform’s COMTOP (COMmunication TOPology) and RTUTOP
(RTU TOPology) databases.
It is important to note that the names of the data set types that are manually defined in
the SCADA application are not required to match the names provided in the following
example. The only exceptions to this rule are the BucketDS and TimeDeviceDS data
sets. If these data sets are not named “BucketDS” and “TimeDeviceDS”, the CFE
Reader application assumes that they represent a CFE based on their parent-child
relationship.
As an example, the following data set types are used to configure the set of available
communications objects. For e-terraplatform users, these are the data set types defined
in that application, if they have been imported from e-terraplatform.
• CFE Reader Data Set: Defines the global settings of a CFE Reader application. For
e-terraplatform users, it corresponds to the TFE record type. Note that more than
one CFE Reader data set can be generated for the same TFE record, since one
CFE Reader data set is generated for each NETSRV referenced by a CHANEL
under a TFE record. One instance of the CFE Reader application must be started for
each CFE Reader data set.
• CfeDS: Contains the configuration parameters for a CFE. In the communications
hierarchy, it is a child of the CFE Reader data set. For e-terraplatform users, it
corresponds to the CHANEL record type.

Proprietary – See Copyright Page 2 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• PortDS: Contains the configuration parameters for a port (either COM or TCP/IP). In
the communications hierarchy, it is a child of the CfeDS. For e-terraplatform users, it
corresponds to the PATH record type.
• DialupDS: Contains the configuration parameters for a dialup master port. In the
communications hierarchy, it is a child of the CfeDS. Dialup ports (DialupDS and
ModemDS) must be modeled under a separate CfeDS from non-dialup ports
(PortDS). For e-terraplatform users, it corresponds to the PATH record type.
• ModemDS: Contains the configuration parameters for a dialup modem port. In the
communications hierarchy, it is a child of the CfeDS. For e-terraplatform users, it
corresponds to the PATH record type.
• RtuDS: Contains the configuration parameters for an RTU. In the communications
hierarchy, it is a child of the PortDS. For e-terraplatform users, it corresponds to the
RTUC record type.
• DrtuDS: Contains the configuration parameters for a dialup RTU. In the
communications hierarchy, it is a child of the DialupDS. For e-terraplatform users, it
corresponds to the RTUC record type.
• ScanGroupDS: Contains the configuration parameters for a scan group within an
RTU. In the communications hierarchy, it is a child of the RtuDS or DrtuDS. For
e-terraplatform users, it corresponds to the ADRS record type.
• CardDS: Contains the configuration parameters for an RTU card. In the
communications hierarchy, it is a child of the ScanGroupDS. For e-terraplatform
users, it corresponds to the CARD record type.
• BucketDS: Defines up to 16 custom counters for errors to be reported at an RTU or
Scan Group level. The name of this data set must be defined as “BucketDS”. For
e-terraplatform users, it corresponds to the BUCKET record type.
• TimeDeviceDS: Identifies a time device (e.g., a TrueTime card or a PC Clock). The
name of this data set must be defined as “TimeDeviceDS”. For e-terraplatform
users, it corresponds to the CHANEL record type applied to a time device. Time
synchronization is performed only when a TimeDeviceDS is modeled under a
CFEReaderDS.
Some of these objects can receive additional parameters in the form of PCL records,
which are in addition to the fields of their record type in e-terraplatform. A PCL record
has a form that does not depend on the communications object; thus, it simply provides
the object with an additional parameter and an associated value. PCL records are not
considered to be communication objects, and so are not defined by a specific data set
in e-terracontrol. They are treated as special parameters with their own format, which
can be added to most of the data sets.
The hierarchy of data that relates to a CFE Reader can be found in Figure 1. This is the
template of the data structure that is displayed on the Database tab of the SCADA
server application (see “SCADA Server Application” in the e-terracontrol Reference
Manual: Applications).

Proprietary – See Copyright Page 3 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 1. CFE Reader Data Hierarchy

For e-terraplatform users, the bold lines represent the data that is downloaded directly
to the CFE Reader application.

1.4 Display and Logging Features

The CFE Reader provides the following display and logging features:
• View of the Communication Model: Each device type has its own window that
displays its configuration parameters. These parameters represent static
communication data; they are usually read-only. The only dynamic data available
are the current status of the device (Online, Offline…), the measurement values, and
some logging/statistics configuration options.
• Log Displays: The CFE Reader logs information about three different displays: the
CFE Reader log (events occurring at the application level), the Comm log (events
occurring while communicating with the CFEs and RTUs), and the CFE Event log
(events occurring in a CFE).

Proprietary – See Copyright Page 4 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• Log Files: The information displayed on each of the screen logs can be stored as
time-stamped log files. In addition, there are three logs that are available only in file
format:
– The Spylog option creates a file named “spylog.dat” that contains the CFE
Reader-CFE messages (written in the CFE-to-TFE protocol).
– CFE’s standard output is directed to the cfecontrol.log file for a WINSTRMS CFE.
– The Line Analyzer (messages exchanged between a CFE and the RTUs) output
is directed to the cfe_line_monitor_<CFE number>_<Line number>.dat file.
• Communication Statistics: The CFE maintains hourly statistics on its
communications with the RTUs. The CFE Reader displays the statistics (number of
attempts, of no-reply errors, of CRC errors, and other errors, communication time
available and communication time used) for each port and RTU. These statistics can
be periodically reset, and they are dumped to daily .CSV (comma-separated-value)
files for further processing. The statistics files are named
“HOURLY_COMM_STATS_yyyymmdd_V2.CSV”.
• Error Counters: A “bucket” represents a list of error definitions that the user has
defined. The Bucket window displays the number of errors (for an RTU or for a Scan
Group) that are being reported for each of these definitions.

Proprietary – See Copyright Page 5 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 Telemetry
CFEReader (VB) / #1
CFECONTROL
#3 Controls/ SCADA DEVICE SCADA SERVER
Setpoints
CFE & RTU Comm. #2 Scada log
#4
#5

CFE
#6

RTU Comm.
#4

#7 Serial
#1: Log Message to SMP
#9 #8
network #2: Log States Changes
#10
B2B and Digi Log Control Requests
Terminal Server Log Timers
#3: CFE control log
#4: CFE communication log
#11 #5: CFE SPY
#6: CFE event log
#7: Line monitor
RTU RTU #8: Socket trace
#9: Port monitor
#10: Wireshark
#11. Other tools

Figure 2. CFE Logging Features

1.5 CFE Reader Command-Line Arguments

A CFE Reader shortcut is not created during the installation of e-terracontrol because
there are required command-line arguments associated with this application. The
application can be launched from the Process Starter application (see “Process Starter”
in the e-terracontrol Reference Manual: Applications), a batch file, a command line, or a
Windows shortcut you create with the appropriate command-line arguments included.
Commas must separate all command-line arguments. However, their syntax is not
case-sensitive.
The following format is valid, where p is the command-line argument switch and
<Argument> is the command-line argument value:
~\cfereader p=<Argument>

Proprietary – See Copyright Page 6 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.5.1 Data Source
A data source in SCADA identifies the subtree of the communication model for which a
CFE Reader is responsible, and which must be downloaded to the CFE Reader at
startup:
datasource=<DataSourceName>
Where:
• <DataSourceName> is the name of an existing data source.
For information about how to add a data source to the SCADA server application, refer
to “Data Source Dialog Box” in the e-terracontrol Reference Manual: Applications.
Note that, for e-terraplatform users, one data source is automatically created for each
NETSRV referenced by a child CHANEL under a TFE record. One instance of the CFE
Reader application must be started for each data source.
This argument is required.

1.5.2 Host(s)
By default, the CFE Reader connects to the SCADA application running on the local
computer. However, in a case where the CFE Reader application does not reside on the
same machine as the SCADA server, the address of the SCADA server must be passed
in the Host1 argument. In a dual-state environment, the Host2 argument is used to pass
the address of the secondary SCADA server. The two SCADA servers must store the
same data source to which the CFE Reader is dedicated. In cases where the host
machines have more than one NIC card, the Host3 and Host4 arguments can be used
to specify the additional IP addresses:
Host1=<HostName, Host2=<HostName2, Host3=<HostName3, Host4=<HostName4>
This argument is optional.

1.5.3 Log Settings

It is possible to configure, through the command line, most of the logging options that
are available from the CFE Reader user interface. For more details about these logging
options, refer to section 1.8.4 CFE Reader Configuration Tab.
These arguments are optional.
The following arguments apply to the CFE Reader log:
• LogDisplay: Specifies whether the events are displayed on the screen or not. The
two possible values are True and False.
• LogFile: Specifies whether the events are written into files. The possible values are
False (no logging to file), True (logging to a single file without file size checking), or a
positive number that represents the maximum size of a log file (in Mb).

Proprietary – See Copyright Page 7 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• LogSev: Specifies which severity(ies) of events are logged. Each severity is
represented by a letter: S (Success), I (Informational), W (Warning), E (Error), and F
(Fatal). The value of the LogSev parameter can be any combination of these five
letters, in any order.
The following arguments apply to the Communications log:
• CommLogDisplay: Specifies whether the events are displayed on the screen or
not. The two possible values are True and False.
• CommLogFile: Specifies whether the events are written into files. The possible
values are False (no logging to file), True (logging to a single file without file size
checking), or a positive number that represents the maximum size of a log file (in
Mb).
• CommLogSev: Specifies which severity(ies) of events are logged. Each severity is
represented by a letter: S (Success), I (Informational), W (Warning), E (Error), and F
(Fatal). The value of the CommLogSev parameter can be any combination of these
five letters, in any order.
The following argument applies to the Spy log:
• Spy: Creates a Spy object for CFE Reader-to-CFE communications. The possible
values are Ind (individual, or single Spy, which writes to a file only at your request)
and Cont (continuous Spy: each message is immediately written to a file).
Example:
logfile=2,logdisplay=false,logsev=swfie,commlogsev=swife,commlogfile=true,spy
=ind

1.5.4 Enable/Disable
The Enable (or Disable) argument forces a number of additional log options, essentially
related to the communications with the SCADA application. For more details about
these options, refer to section 1.8.4 CFE Reader Configuration Tab.
The possible log options are:
• SmpLogState: Logs data set state changes
• SmpLogControl: Logs control requests
• SmpLogTimers: Logs timers
• SmpLogConnections: Logs connections and disconnections with SCADA
• SmpLogRefresh: Logs refresh (i.e., demand scan) requests
• SmpLogMessages: Logs messages from the CFE Reader to e-terracontrol
• CrashOption: If enable=CrashOption is configured, the CFE Reader aborts when
there is a problem in a third-party device driver resulting in a non-functional port-
handling thread within the CFE Reader. The problem port number as well as the

Proprietary – See Copyright Page 8 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 thread ID are output to the CFE Reader log. A minidump file is also created. The
dump file can be analyzed using WinDBG.
To identify the problem thread, the developer or user should follow the following
steps:
!Analyze -v
.ecxr
Go to the View drop-down menu, and select the Processes and Threads item.
Pick up the corresponding thread ID that matches the one showing in the
CFE Reader log file.
To see the thread problem, examine the stack trace.
If disable=CrashOption is configured, CFE Reader does not abort upon detection of
the stalled port condition. Instead, it leaves the port in the Failed state, awaiting
human interaction in order to recover full communications.
• WindowEventViewer: Logs the cfecontrol events to the Window Event Viewer
display. The default value is Disable, i.e., the CFE Reader does not log any event to
the Window Event Viewer display.
These arguments are optional.

1.5.5 Server Listen Port

Server Listen Port is the value to identify which TCP/IP port the CFE Reader should use
to get the message sent by the CFE Reader Remote Diagnostic user interface:
ServerListenPort=<PortValue>
Where:
• PortValue is the port on which the CFE Reader should listen for the message from
the CFE Reader Remote Diagnostic user interface. The default value is 1234.
This argument is optional if there is only one CFE Reader instance per server. This
argument is required if there is more than one CFE Reader per server.
Each CFE Reader instance on a given server must have a unique Server Listen Port. A
non-unique configuration of Server Listen Ports on a server can result in a pop-up box
with System.NullReferenceException pop-up boxes referencing a duplicate Server
Listen Port.
For e-terracontrol 3.4 or later, if this parameter is not defined in the CFE Reader
command-line arguments, the CFE Reader does not open any port to listen for the
message from the CFE Reader Remote Diagnostic user interface.

Proprietary – See Copyright Page 9 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.5.6 Port
Port is the value to identify which TCP/IP port the Remote Terminal Unit Miscellaneous
Messages Utility (RTUMMU) in CFE Reader should use to send and receive the
message through the window socket:
Port=<nnnn>
where:
• nnnn is the desired RTUMMU local port number. The default value is 4000.
This argument is optional if there is only one CFE Reader instance per server. This
argument is required if there is more than one CFE Reader per server.
Each CFE Reader instance on a given server must have a unique RTUMMU local port.
Non-unique configuration of ports on a server can result in a pop-up box with
System.NullReferenceException pop-up boxes referencing a duplicate RTUMMU local
port.
For e-terracontrol 3.4 or later, if this parameter is not defined in the CFE Reader
command-line arguments, the CFE Reader does not open any port through the window
socket to send/receive any message to/from RTUMMU.

1.5.7 ScadaPort
ScadaPort is the value to identify which TCP/IP port the CFE Reader application uses to
communicate with SCADA:
ScadaPort=<portvalue>
where:
• portvalue is the port number through which CFE Reader communicates with
SCADA. The default value is 5020 for NTLM/Kerberos authentication and 7000 for
Certificate-based authentication.
• portvalue should match the port number on which the SCADA server is listening.

Note: If this parameter is configured, the SOE log file will be generated in a
subdirectory named using the port number. This is to separate SOE files for different
Scada instances, if there are multiple Scada instances running.

This argument is optional.

1.5.8 CFGDIR
CFGDIR specifies the directory where the CFE Reader stores/retrieves the CFE Reader
configuration files such as <datasource>_local_items.cfg and alarmconfig.dat.

Proprietary – See Copyright Page 10 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
For e-terracontrol 3.4 or later, the alarmconfig.dat file is stored in the sample directory.
The user needs to copy this file to the CFGDIR directory in order to allow the alarm to
be sent directly from CFE Reader to e-terraplatform.
Also, if CFGDIR is not defined in the CFE Reader command line, a warning message is
issued to indicate that the <datasource>_local_items.cfg file is searched from the Log
directory. In this case, the <datasource>_local_items.cfg file can be accidentally deleted
by other applications.

1.5.9 /exceptionhandler=XXX
where XXX = fulldump or minidump
Allows the Process Starter to generate the fulldump or minidump file when the
CFE Reader crashes for any known/unknown reason.

Note: There should be a space in front of this argument instead of a comma.

1.5.10 UseErrorCntToDisconnect
Skip the RTU line disconnection message at the driver level and instead wait for the
error count to reach its maximum value before disconnecting the RTU.

Caution: Alstom Grid does not recommend using this parameter because it violates
the DNP3 protocol.

Example:
UseErrorCntToDisconnect=true
This argument is optional; default value is false.

1.6 Starting CFE Reader Using the Process Starter

The Process Starter application can start and restart programs as required. This is
useful in situations where it is desired that the CFE Reader application remain
continuously active on certain PCs.
The following procedure outlines the steps necessary to launch the CFE Reader from
the Process Starter.
1. From the e-terracontrol Start menu, open the Process Starter Console application,
and be sure that the Process Starter service is running.
2. Connect the console to the Process Starter service by clicking the Connect button in
the Process Starter Console toolbar.
3. To create a new Process Starter group, proceed to step 4. To add the CFE Reader
application to an existing group, select File > Upload, and choose the desired .psc

Proprietary – See Copyright Page 11 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 file to display the Configuration tab for Processes (see the e-terracontrol Reference
Manual: Applications).

Note: Prior to adding a process to an existing group, you must end all processes
by clicking Stop on the Process Starter toolbar, or via the Actions menu item (see
“Process Starter Console Toolbar” and “Process Starter Console Menu Bar” in the
e-terracontrol Reference Manual: Applications).

4. To create a new Process Starter group, select Processes > Add Process.
The Configuration tab for Processes opens.
5. In the Name, Program, Params, and Directory text boxes, enter the required
information. If you do not know the location of the CFEReader.exe file, click the
Ellipsis button (…) next to the Program text box to browse for the file. Sample values
are as follows:
Name: CFE Reader
Program: C:\eterra\e_terracontrol\bin\cfereader.exe
Params: datasource=Cfereader_Bmtfe_a,host1=PC883,host2=PC354
Directory: C:\eterra\e_terracontrol\bin
6. If desired, select the Minimize check box.
7. If you do not want to see the GUI, uncheck the Visible check box.
8. In the Restart frame, select the On Exit radio button.
9. Click OK, and then save the file.

1.7 CFE Reader Configuration File

Upon initialization, the CFE Reader application searches the local directory for a
configuration file, which is used to set the previously defined global parameters for the
particular data source.
The file name follows the format <datasource>_local_items.cfg (see section 1.8.4 CFE
Reader Configuration Tab).

1.8 CFE Reader User Interface

The CFE Reader application provides an interface between e-terracontrol and the
Streams-based Communications Front End (CFE). This allows e-terracontrol to support
the RTU protocols that exist in the CFE environment.
Selecting an item on the CFE Reader display causes a window containing information
about the selected item to open.
Most static properties of the items cannot be modified within the CFE Reader itself. For
reasons of consistency, changes must be made in the SCADA application. Changes to

Proprietary – See Copyright Page 12 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
SCADA data set parameters are automatically propagated from the SCADA application
to the CFE Reader. It is then necessary for you to force re-initialization of the
communication line affected by the changed parameter. A few changed parameters
(see details below) do not require re-initialization of the communication line.
Any additions to or deletions of data sets require that the CFE Reader reload the
updated database. The CFE Reader reloads the updated database after being exited
and restarted.

Figure 3. CFE Reader User Interface

1.8.1 CFE Reader Database Tab

The Database tab on the CFE Reader main window displays the hierarchy of data for
the modeled CFE Reader.

Proprietary – See Copyright Page 13 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
General configuration information about data sets can be found under “Data Set Dialog
Box” in the e-terracontrol Reference Manual: Applications.

Note: Sample CFE Reader data sources and data sets are available in the
esca60_rtu.sdb SCADA database located in the ~\eterra\e_terracontrol\samples
folder.

1.8.1.1 CFE Reader Data Set

The CFE Reader data set is the top level of the data set hierarchy. Clicking on a CFE
Reader data set member opens the CFE Reader Data Set dialog box (Figure 4).

Figure 4. CFE Reader Data Set Dialog Box

This display provides the ability to configure the hourly communication statistics
functionality. Data set configuration is performed in the SCADA server application (see
“Data Set Dialog Box” in the e-terracontrol Reference Manual: Applications).
The following are included in the CFE Reader Data Set dialog box:
• Current State: Displays the link status (ONLINE, OFFLINE, FAILED, HIER
OFFLINE, INITDONE, or UNKNOWN).
• Heart Beat Rate: Displays the heartbeat rate in seconds. Each heartbeat issues a
periodic scan request to the RTUs.
• Exploratory Rate: Displays the exploratory scan rate on failed devices, in seconds.
• ALE Integrity Rate: Displays the Analog Limit Excursion integrity rate in seconds.
An ALE report is directly transmitted to SCADA as a series of Analog Input changes.

Proprietary – See Copyright Page 14 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 For many RTU protocols, the CFE only retrieves ALE log data when there is no scan
data to be retrieved. This can result in ALE data never being retrieved if the
communication line is overloaded. The ALE Integrity Rate specifies those rates at
which ALE data is retrieved even though the communication line is already loaded
with other data requests.
• SOE Integrity Rate: Displays the Sequence of Events integrity report rate, in
seconds. The report is released as a time-stamped file named
“SOELOG<date>.soe”.
For many RTU protocols, the CFE only retrieves SOE log data when there is no
scan data to be retrieved. This can result in SOE data never being retrieved if the
communication line is overloaded. The SOE Integrity Rate specifies those rates at
which SOE data is retrieved even though the communication line is already loaded
with other data requests.
• RTU Bias Rate: Displays the RTU time bias rate, in seconds. For some RTU
protocols, no time bias requests to the RTU are needed.
• RTU Sync Rate: Displays the RTU time synchronization rate in seconds.
• Hourly Communication Statistics – Disable Dumping to CSV Files: Displays
whether the CSV export is enabled.
If the feature is disabled, the RTU communication statistics that the CFE Reader
retrieves every hour are added to a daily .csv file named
“HOURLY_COMM_STATS_yyyymmdd_V2.CSV”. Each line in this file contains the
following fields: RTU name, hour of the day, number of attempts, number of
No-Reply errors, number of CRC errors, number of other errors, available time
(msec), time used (msec), and date.
• Auto Reset of Hourly Communication Statistics: Displays the current Auto Reset
status for the communication statistics (Never, Daily, or Monthly).
The Auto Reset sets to zero the statistics for all RTUs. If the statistics are reset daily,
the values displayed by the statistics (either in the .csv files, or on a port’s or an
RTU’s Communication Statistics display) only represent the errors that have been
reported during the current day. If they are reset never or monthly (i.e., manually),
each number accounts for all errors that have occurred during this hourly time frame
since the statistics were last reset.
• Reset Hourly Communication Statistics: Sets to zero the hourly communication
statistics for all RTUs. If the “Disable dumping to CSV files” box is checked, all
existing statistics data is lost.

Note: The hourly statistics do not have to be reset for all RTUs at the same time.
The Communication Statistics display enables you to manually reset the statistics
for a single RTU, or for the RTUs of a specific port.

Proprietary – See Copyright Page 15 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.8.1.1.1 Accumulator Type
The properties of the individual accumulator types (Figure 5) as defined in the CFE
Reader data set can be viewed by clicking on the representative item on the hierarchy
tree. Each Scan Group that contains pulse accumulator data must reference one of
these accumulator types.

Figure 5. Accumulator Type Dialog Box

The user-assigned values for the “AccumName_xx” parameter in the CFE Reader data
set are displayed in this window.
The following are included in the Accumulator Type dialog box:
• Key: Displays the name specified as xx in the “AccumName_xx” parameter name
• Freezable: Indicates whether or not a freeze request is issued prior to reading the
measurement
• Reset When Read: Indicates whether or not the accumulator measurement value is
reset to a value of zero after it has been read
• Individual Freeze: Indicates whether the freeze request must be sent to each
accumulator individually, or broadcast to all RTUs on the communication line
For each accumulator, a timer called “xx_Read” (where xx denotes the accumulator
type label) must be defined in the Timers area of the SCADA database. If the Freeze
option is set, an additional timer, “xx_Freeze”, must also be defined.
The freeze and read operations on the accumulators of a given type occur when
SCADA notifies its CFE Readers that the corresponding timer has expired. These
timers must also be assigned to the CFE Reader data set data type in the SCADA
Types subtree of the SCADA database. The assigned relationship name for each
accumulator timer must match the timer name, as described above.

Proprietary – See Copyright Page 16 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.8.1.2 CFE Data Set
The CFE data set is the second level of the data set hierarchy. Clicking on a CFE data
set member opens the CFE Data Set window (Figure 11).

Note: You can only model one CFE data set for each type of CFE.

The CFE display provides the ability to set up the four log options that can be
associated with a given CFE:
• Line Analyzer
• CFE Event Log
• Spy Log
• Socket Trace (TCP/IP only)
The following are included in the upper pane of the display:
• Key: Displays the hierarchical subtree name for the selected CFE
• Current State: Displays the link (ONLINE, OFFLINE, FAILED, HIER OFFLINE,
INITDONE, or UNKNOWN)
• Subscript: Displays the zero-based index value of the CFE within CFE Reader
• CFE Type: Displays the CFE type (WINSTRMS or TSISTRMS). WINSTRMS is the
normal configuration, where the CFE software component runs on the Windows
CPU.
• CFE Server: (TSISTRMS only) – Obsolete
• Firmware Name: (TSISTRMS only) – Obsolete
• Firmware Date: (TSISTRMS only) – Obsolete
• Include in Spy Traffic: Checking this box includes the traffic on this CFE in the spy
buffer.

Note: The Spy Log option must also be enabled on the CFE Reader Configuration
tab (see section 1.8.4 CFE Reader Configuration Tab). If CFE Reader was
launched with the “enable=spylog” command-line argument, this option is enabled
by default.

• Include in Comm Log: This check box can be used to add the CFE to the
Communication Log filter. By default, the Comm Log filter is inactive, which means
that all CFE- or port-level communication events are logged.
In this case, the check box is disabled. If the check box is enabled, the filter is active:
the box must be checked for the Comm log to display the communication events that
relate to this CFE.
• Update Event Log: Updates the statically displayed CFE Event Log window (Figure
6). This button can be identified by the exclamation point icon.

Proprietary – See Copyright Page 17 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• Save: Saves the contents of the CFE Event Log window (Figure 6) to a file that has
the syntax “CFE_n_EventLog_yyyymmdd_HhNnSs.log” (where n denotes the CFE’s
subscript). This button can be identified by the floppy disk icon.
Note that the entire content of the log screen goes to a new file. Thus, if you click
this button several times without clearing or updating the screen between clicks,
duplicate event files are created.
• Clear Log Screen: Clears the contents of the CFE Event Log window (Figure 6).
This button can be identified by the “X” icon.
• View CFE Configuration: Opens the CFE Configuration Data window (Figure 7).
This button can be identified by the magnifying glass icon.
• View CFE Statistics: Opens the CFE Statistics window (Figure 9). This button can
be identified by the paper scroll icon.
• View CFE PCL Records: Opens the PCL Records window (Figure 8).

Figure 6. CFE Event Log Window

Proprietary – See Copyright Page 18 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 7. CFE Configuration Data Window

Figure 8. PCL Records Window

The following button is available at the top of the lower pane (Figure 6):
• Read CFE Event Log: Opens the CFE Event Log display, and sends a DUMP
request to the CFE for displaying the latest events.
The CFE Event log lists events in chronological order.

Proprietary – See Copyright Page 19 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Events are listed using the following syntax:
<Sev>-<Event Label> <module> <port> <Formatted text>
Where:
• <Sev> is a letter specifying the event severity: S = Success, I = Informational, W =
Warning, E = Error, and F = Fatal.
• <Event Label> is the event identifier (e.g., CFE_LINE_OPEN).
• <module> is the number indicating the module in which the event occurred,
preceded by the letter “m” (e.g., m3).
Table 1 lists the modules and their associated codes:
• <port> is the port number preceded with the letter “p” (e.g., p2).
• <Formatted text> is a predefined text string associated with the event type,
completed with parameters that are specific to the current individual event.

Table 1. Modules and Associated Codes

Module Code
1 SWAP
2 MUX
3 RTU
4 LINE
5 ISR
6 DEBUG
7 LISTEN
8 MATCH
9 DIAL
10 TPORT
11 SIM
12 HEAD

The Event log is not automatically refreshed. To update the display, select Update
Event Log in the CFE window.
The CFE Configuration Data window can be viewed by selecting View CFE
Configuration from the Tools menu.

Proprietary – See Copyright Page 20 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
The following are included in the CFE Configuration Data window:
• MESSAGE VERSION: Version number of the protocol that is also shared by non-
STREAMS CFEs
• CFE-TFE VERSION: Version number of the protocol used by the CFEs to dialog
with the CFE Reader
• POLLRATE: CFE I/O Poll Interrupt Rate in milliseconds (not used for WINSTRMS)
• CFE FWID: Date and time when the CFE was built (not used for WINSTRMS)
• Transmission End ISR State Timeouts: Displays the timeouts, in milliseconds, of
the first 16 ports; Interrupt State Routines (ISRs) are used to send and receive data
on the line (not used for WINSTRMS)
The CFE Statistics window (Figure 9) displays the dynamically allocated system
resources currently in use by the CFE. These resources are specific to the STREAMS
architecture. They can be viewed by selecting View CFE Statistics from the Tools menu.

Figure 9. CFE Statistics Window

Proprietary – See Copyright Page 21 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
The following are included in the CFE Statistics window:
Row Headings
• Streams: The full-duplex processing and data transfer path that sequentially links
several modules.
• Queues: A waiting list that distributes messages from one module to the next one.
There are a read and a write queue between successive modules in a stream. A
stream can also be defined as a linked list of queues.
• MBlock (Message Block): The structures that identify the messages in the queue.
They do not contain the actual data, but rather the position of the message in the
queue and a link to related messages.
• DBlock (Data Block): Buffers that contain the actual message data.
• Stacks: The area that is allocated to a queue during its execution. It returns to the
free list once the queue completes its service procedure.
• DBLK Class (Data Block class): Obsolete, since this is not utilized in the
WINSTRMS CFE configuration.
Column Headings
• In Use: The number of resources currently allocated.
• Max: The maximum number of resources allocated at any time.
• Failures: The number of resource allocation failures.
• Total Used: The total number of resources allocated.
• Size: DBLK classes only. The size of a block in bytes. The value entered must be a
multiple of 16.
• Total: DBLK classes only. The maximum number of blocks to build.
PCL Records Window
The PCL Records window (Figure 8) displays the modeled CFE data set PCL records.
The following are included in the PCL Records window:
• PCL Record Name: The name of the modeled PCL record.
• PCL Value: The value of the modeled PCL record.
• PCL IDcode: The ID of the modeled PCL record.
• PCL Flags: The flag value of the modeled PCL record.
The example in Figure 8 is modeled as PCL200=SRCADRS:40.
The PCLTXT Records window (Figure 10) displays the modeled CFE data set PCLTXT
records.

Proprietary – See Copyright Page 22 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 10. PCLTXT Records Window

The following are included in the PCLTXT Records window:

• PCLTXT Record Name: The name of the modeled PCL record.
• PCLTXT Record Text: The value of the modeled PCL record.
Event Log Tab
The CFE logs an event every time a specific step is achieved or an error is
encountered.
If the event matches the CFE Event Log settings (filters by module, port, or severity), it
is stored in the event buffer of the CFE’s Debug module. The buffer is returned to the
CFE Reader when it is full, or when a Dump request is issued by the CFE Reader.
Whereas the Line Analyzer displays protocol-specific RTU-CFE communication
messages, the CFE Event Log displays formatted strings that describe the internal
processing of the CFE.

Proprietary – See Copyright Page 23 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 11. CFE Data Set Display – Event Log Tab

The following are included on the Event Log tab (Figure 11):
• Enable Log to Buffer: Enables or disables the CFE’s logging to the internal event
buffer. If disabled, new events are not displayed in the CFE Event Log display. The
Event log is activated by default.
• Enable Log to File: Enables the event buffer to be stored as a file named
“cfe_event_<CFE number>.dat”. If such a file already exists, it is renamed
“cfe_event_<CFE number>.log”. The event buffer contains more data than the Event
log (display or file). This feature is available only to WINSTRMS CFEs.
• Enable Log to Console: Enables the standard output of the CFE that is the
cfecontrol.log file for WINSTRMS CFEs. The CFE Event logs are written to the file.
• Enable/Disable by Severity: You can select which message severities are sent to
the log by checking the box next to each desired level of severity: Success,
Informational, Warning, Error, and Fatal.
• Enable/Disable by Module: You can enable the Event log on individual module(s)
by selecting the boxes next to MUX, RTU, LINE (activated by default since they
constitute the application level), ISR, LISTEN, and TPORT (physical or transport
layers in the OSI model).

Proprietary – See Copyright Page 24 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 12. CFE Data Set Display – Event Log per Port Tab

The following are included on the Event Log per Port tab:
• Check Box to Enable Event Log for Port: You can select which port(s) are
enabled for event logging.
Line Analyzer Tab
When the CFE line analyzer is enabled, low-level CFE code logs all transmitted and
received RTU data to the Line Analyzer file in the requested format (WINSTRMS CFE).

Figure 13. CFE Data Set Display – Line Analyzer Tab

The following are included on the Line Analyzer tab:

• Check Box(es) to Enable Line Analyzer: You can select which port(s) to enable
for the Line Analyzer by selecting the check box next to the name of the line. The
data retrieved from each line is stored in a separate file named
“cfe_line_monitor_<CFE number>_<Line number>.dat”. Disabling and re-enabling a
line causes the Line Analyzer data to be appended to the file.

Proprietary – See Copyright Page 25 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• Protocol Interpretation: The protocol interpretation should be selected prior to
enabling the Line Analyzer for any given port. From the pull-down menu, you can
select whether protocol interpretation is to be used. Options are RAW (no protocol
interpretation) and INTERPRETED (protocol interpretation used if available in the
selected protocol).
Socket Trace Tab
Enabling the socket trace allows low-level socket events to be sent to the console
(Cfecontrol.log for WINSTRMS CFE).

Figure 14. CFE Data Set Display – Socket Trace Tab

The following is included on the Socket Trace tab:

• Check Box(es) to Enable Socket Trace: You can select which port(s) to enable for
socket trace by selecting the check box next to the name of the line. This only
applies when using TCP/IP.

Proprietary – See Copyright Page 26 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.8.1.3 Bucket Data Set

Figure 15. Bucket Data Set Dialog Box

The following are included in the Bucket Data Set display:

• Key: Displays the hierarchical subtree for the defined item.
• Column Headings
– Description: User-defined counter definitions
– CRXFLAG: The bit mask for the communications errors reported by the ISR
module
– CRXFG2: The bit mask for the communications errors reported by the LINE
module
– CRXPRT: The bit mask for the protocol-specific error types as listed in the
include file cfe*.h. Those files are in the e-terrascada code.
– CHFLG: The bit mask for the CFE errors

Proprietary – See Copyright Page 27 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.8.1.4 Time Device Data Set

Figure 16. Time Device Data Set Dialog Box

The following are included in the Time Device Data Set dialog box:
• Key: Displays the hierarchical subtree for the defined item
• Poll Rate: Rate (in seconds) for checking the state of the time device. This field is
the only one in the database tree that is edited from the CFE Reader itself.
• Current Time: Time stamp as polled from the defined device

1.8.1.5 Port Data Set

The Port data set is the third level of the data set hierarchy. Clicking a Port data set
member opens the Port Data Set dialog box (Figure 17).
This display is read-only. Data set configuration is performed in the SCADA server
application (see “Data Set Dialog Box” in the e-terracontrol Reference Manual:
Applications). Selecting radio buttons and/or check boxes in this window does not affect
the data displayed.

Proprietary – See Copyright Page 28 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 17. Port Data Set Dialog Box

The following are included in the Port Data Set dialog box:
• Key: Displays the hierarchical subtree for the defined item.
• Current State: Displays the link (ONLINE, OFFLINE, FAILED, HIER OFFLINE,
INITDONE, or UNKNOWN).
• Protocol Name: Displays the protocol name. This name (usually the protocol name
preceded by the letter “P”) must exist in the CFE Reader’s table of supported
protocols. Modification of this parameter requires you to force re-initialization of the
communication path.
• CFE Type – Port Type: This frame details the port configuration according to the
CFE type. For a WINSTRMS CFE, a port can only be serial, dialup, or TCP/IP.
Proprietary – See Copyright Page 29 CFE Reader
e-terracontrol Reference Manual: Interfaces to Field Devices
 Modification of this parameter requires you to force re-initialization of the
communication path.
• LineSet: Under a WINSTRMS CFE, it displays whether the port uses a TCP/IP or a
serial connection. Modification of this parameter requires you to force re-initialization
of the communication path.
• Local Data Register: (TSISTRMS only) – Obsolete
• SCC Configuration: (TSISTRMS only) – Obsolete
• SCC Config Parameters: (TSISTRMS only) – Obsolete
• ISR Table: (TSISTRMS only) – Obsolete
• Port Model (WINSTRMS only): Displays the port model type. “Normal” is checked
for a normal (serial or TCP/IP) port. “Dialup Master” is checked for the port that is
used as the parent of all dialup RTUs. “Dialup Modem” is checked for a port that
represents a dialup modem (this port model type has no children RTUs).
• Address (WINSTRMS only): Displays the address of the port. For serial, it is the
com port address (COMx, where x is the port number). For TCP/IP, it is the IP
address, either in full dot notation (xxx.xxx.xxx.xxx) or any recognized name for the
remote host. For a dialup modem port, it is the com port address (COMx) where the
dialup modem is connected. Modification of this parameter requires you to force
re-initialization of the communication path.
• Physical Address: Displays the COM port number that is used for initializing the
SCC chip.
• Port Subscript: Displays the zero-based index value of the port within the subtree.
• Baud Rate: Displays the baud rate in bits per second. Modification of this parameter
requires you to force re-initialization of the communication path.
• Protocol Timeout 1: Displays the protocol-specific timeout #1 in milliseconds.
Modification of this parameter requires you to force re-initialization of the
communication path.
• Protocol Timeout 2: Displays the protocol-specific timeout #2 in milliseconds.
Modification of this parameter requires you to force re-initialization of the
communication path.
• Interbyte Gap Timeout: Displays the interbyte gap, which is the timeout between
two read bytes in milliseconds. Modification of this parameter requires you to force
re-initialization of the communication path.
• Reply Timeout: Displays the No Reply timeout in milliseconds. Modification of this
parameter requires you to force re-initialization of the communication path.
• EOM Delay (bits): Displays the End Of Message delay in bits. This is the number of
bit times to wait before the driver determines that another byte is not arriving.
• Special Support: This function was associated with the obsolete VME-based CFE
(TSISTRMS) configuration.

Proprietary – See Copyright Page 30 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• SOE Time Synchronization: Indicates whether the SOE time synchronization is
performed on all RTUs at once (Broadcast) or separately for each RTU (Individual).
• Static Flag Field (Hex): Displays the static flag as used in SMPDump.
• View Communication Statistics: Opens the Communication Statistics display for
this port.
• View Port PCL Records: Opens the PCL Records window for this port (Figure 8).
• View Port TXT Records: Opens the PCLTXT Records window for this port (Figure
10).
Port Communication Statistics Dialog Box
This display shows the number of errors encountered for all RTUs connected to the
port, on an hourly basis.

Figure 18. Port Communication Statistics Dialog Box

Proprietary – See Copyright Page 31 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
The Port Communication Statistics dialog box includes the following:
Header
• Port: Name of the port
Column Headings
• Hour of Day: The hour of the day
• Attempts: Number of communication attempts for the hour
• No Reply Errors: Number of No Reply errors for the hour
• CRC Errors: Number of Cyclic Redundancy Code errors, also known as BCH
errors, for the hour
• Other Errors: Number of miscellaneous errors for the hour
• % Loading: The approximate percent of available communication time (time that the
line is enabled and available for use) that was used for communications
Buttons
• Update: Updates the display with current statistics from the statistics files. This file is
automatically updated at the end of each hour.
• Reset: Resets the various counts to a value of zero for the RTUs modeled under
this port. If the counts are not reset, the errors reported for a given hour of the day
are added to the errors reported for the same hour of previous days. For more
information about configuring automatic reset on all RTUs, see section 1.8.1.1 CFE
Reader Data Set. By default, CFE Reader resets the statistics daily.

1.8.1.6 RTU Data Set

The RTU data set is the fourth level of the data set hierarchy. Clicking on an RTU data
set member opens the RTU data set dialog box (Figure 19).
This display is read-only. Data set configuration is performed in the SCADA server
application (see “Data Set Dialog Box” in the e-terracontrol Reference Manual:
Applications). Selecting radio buttons and/or check boxes in this window does not affect
the data displayed.

Proprietary – See Copyright Page 32 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 19. RTU Data Set Dialog Box

The following are included in the RTU data set dialog box:
• Key: Displays the hierarchical subtree for the selected data item.
• Current State: Displays the link status (ONLINE, OFFLINE, FAILED, HIER
OFFLINE, INITDONE, or UNKNOWN).
• Skip Integrity Scan After Error: Checked if the integrity scan that is normally done
after an error should be skipped. This is usually set only when scan staggering is
disabled.

Proprietary – See Copyright Page 33 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• Disable Scan Staggering: Checked when the normal load-leveling scan staggering
algorithm is disabled.
• Static Flag (Hex): Displays the static flag as used in SMPDump.
• Activate Address: Displays the RTU activate address. Modification of this
parameter requires you to force re-initialization of the communication path.
• Physical Address: Displays the RTU station address. Modification of this parameter
requires you to force re-initialization of the communication path.
• Freeze Address: Displays the RTU freeze address. Modification of this parameter
requires you to force re-initialization of the communication path.
• RTUc Subscript: Displays the zero-based index value of the RTU within the
hierarchical subtree.
• RTU Model Type: Displays the type of RTU (firmware version). Modification of this
parameter requires you to force re-initialization of the communication path.
• Bucket Name: Displays the name of the bucket, which also must be configured as a
Bucket data set.
• Download Configuration: Indicates whether or not the RTU requires its
configuration downloaded.
• Config File Name: Displays the name of the RTU configuration file, if the Download
Configuration option is checked.
• Time Synchronization: Indicates whether or not the RTU requires time
synchronization.
• MCD Type: Displays the type of Multiple Change Detection:
– RTU reports True MCD: Reports only on multiple change
– RTU reports MCD on Set to Clear
– RTU reports MCD on Clear to Set
– RTU Never reports MCD
– RTU reports MCD on every change: Reports anytime point changes
• Dialup RTU Parameters: These options are visible only for dialup RTUs:
– Seconds to Scan: The maximum number of seconds to scan a dialup RTU after
a connection is established for any reason, before hanging up.
– Num Dialing Retries: Number of times to retry when dialing an RTU is not
successful.
– Wait After Busy: Seconds to wait before retry of dialing if failure is due to a busy
signal on the port.
– Wait After No Answer: Seconds to wait before retry of dialing if failure is due to
no answer from the remote.

Proprietary – See Copyright Page 34 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 – Phone Number: Phone number of dialup RTU.
– Wellness Period: Frequency (seconds) to dial RTU for scanning, starting at the
time specified by the Wellness Model Time.
– Wellness Model Time: The model time used to correlate the dialup wellness
checks to time of day. This is similar to the model time used in SCADA timers.
– Automatic Reconnect: Checked if the CFE Reader should re-dial an RTU that
hangs up before the “seconds to scan” time is over. Unchecked if the RTU is
expected to re-dial when necessary.
• Static Flag: Displays the static flag as used in SMPDump.
• View Communications Statistics: Opens the RTU Communication Statistics dialog
box for the current RTU (Figure 20).
• View Detailed Statistics: Opens the RTU Detailed Error Counts dialog box (Figure
21).
• View Table of Data Points: Opens the Table of Data Points window (Figure 22).
• View RTU PCL Records: Opens the PCL Records window (Figure 8).
• View RTU TXT Records: Opens the PCLTXT Records window (Figure 10).

Proprietary – See Copyright Page 35 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
RTU Communication Statistics Dialog Box
The statistics in the RTU Communication Statistics dialog box (Figure 20) are
cumulative.

Figure 20. RTU Communication Statistics Dialog Box

The following are included in the RTU Communication Statistics dialog box:
Header
• RTU: Name of the RTU
Column Headings
• Hour of Day
• Attempts: Number of communication attempts for the hour
• No Reply Errors: Number of No Reply errors for the hour
• CRC Errors: Number of Cyclic Redundancy Code errors (also called BCH errors)
for the hour
• Other Errors: Number of miscellaneous errors for the hour
• % Loading: The approximate percent of available communication time (time that the
line is enabled and available for use) that was used for communications

Proprietary – See Copyright Page 36 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Buttons
• Update: Updates the display with current statistics from the statistics file. This file is
automatically updated at the end of each hour.
• Reset: Resets the counts to a value of zero for this RTU. If the counts are not reset,
the errors reported for a given hour of the day are added to the errors reported for
the same hour of previous days. For more information about configuring automatic
reset on all RTUs, refer to the section 1.8.1.1 CFE Reader Data Set to configure
automatic reset on all RTUs. By default, CFE Reader resets all statistics daily.
RTU Detailed Error Counts Dialog Box
The RTU must be associated with a bucket (the Bucket Name field in the RTU display)
in order for the RTU Detailed Error Counts dialog box (Figure 21) to contain actual
counters and data.

Figure 21. RTU Detailed Error Counts Dialog Box

The following are included in the RTU Detailed Error Counts dialog box:
Header
• RTU: RTU name

Proprietary – See Copyright Page 37 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Column Headings
• Description: Displays the names of the user-defined error filters as configured in
the Bucket data set
• Count: Displays the error count for the defined filters. The counters do not refer to a
predefined period of time; they continue to accumulate until the counters are reset,
or until the application is closed.
Buttons
• Reset: Resets the counts to a value of zero
• Resume Update or Freeze Screen: Toggles automatic update mode on and off.
When automatic update is ON, the error counts are periodically updated.
Table View of Point Data Window
The Table View of Point Data window (Figure 22) is refreshed every two seconds.

Figure 22. Table View of Point Data Window

The following are included in the Table View of Point Data window:
• Point Name: Displays the point name
• Physical Address: Displays the address of the point within the card

Proprietary – See Copyright Page 38 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• Point Type: Displays the point type (Analog, Status, Control, or Pulse)
• Value: Displays the value of the data point
• Quality: Displays the assigned data point quality
• Deadband: Displays the limit deadband as defined for the data item
• Point Subscript: Displays the zero-based index value of the point
• Bit Index: Displays the zero-based index of the bit within the RTU. This is only
relevant for status points with some protocols.
• Comment: Displays the comment for the point data. To enter a comment, double-
click the desired line. Comments are not saved when the form is closed.
• Freeze Screen: Prevents the screen from refreshing, to give you an opportunity to
review the posted data. When the screen is frozen, the button offers the reverse
functionality (“Resume Update”).

1.8.1.7 Scan Group Data Set

The Scan Group data set is the fifth level of the data set hierarchy. Clicking on a Scan
Group data set member opens the Scan Group Data Set dialog box (Figure 23). If RTU
PCL parameter 451 is defined, clicking on a Scan Group data set tree node opens the
Scan Group Data Set Dialog Box (Figure 24).
This display is read-only. Data set configuration is performed in the SCADA server
application (see “Data Set Dialog Box” in the e-terracontrol Reference Manual:
Applications). Selecting radio buttons and/or check boxes in this window does not affect
the data displayed.

Figure 23. Scan Group Data Set Dialog Box

Proprietary – See Copyright Page 39 CFE Reader
e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 24. Scan Group Data Set Dialog Box

The Scan Group Data Set dialog box includes:

• Key: Displays the hierarchical subtree for the selected data item.
• Current State: Displays the link (ONLINE, OFFLINE, FAILED, HIER OFFLINE,
INITDONE, or UNKNOWN).
• Physical Address: Displays the RTU physical address of the scan group.
Modification of this parameter requires you to force re-initialization of the
communication path.
• Subscript: Displays the zero-based index value of the CFE within CFE Reader.
• Smart Scan Rate: Displays the smart scan rate in seconds.
• Integrity Scan Rate: Displays the integrity scan rate, multiples of the smart scan
rate, in seconds.
• Number of Retries: Displays the number of immediate retries for communication
line errors. Modification of this parameter requires you to force re-initialization of the
communication path.
• Accumulator Name: Displays the accumulator type name as listed in the
CFEControl data set. Blank for non-accumulator Scan Groups.
• Bucket Name: Displays the name of the associated bucket, if any.
• Scan Mode: Indicates whether the scan mode is Dump or Exception. Modification of
this parameter requires you to force re-initialization of the communication path.

Proprietary – See Copyright Page 40 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• Periodic: Indicates whether or not it is a periodic scan group. Modification of this
parameter requires you to force re-initialization of the communication path.
• Direct Operate: Indicates whether or not it is directly operated. Modification of this
parameter requires you to force re-initialization of the communication path.
• Static Flag: Displays the static flag as used in SMPDump.
• Period Name: Displays the name of the timer defined for Periodic scans.
• Integrity Name: Displays the name of the timer defined for Integrity scans.
• View Detailed Error Counts: Opens the View Detailed Error Counts display. This
display can be used only if the Scan Group is associated with a bucket (in the
Bucket Name field).
• View Scan Group PCL Records: Opens the PCL Records window for the scan
group (Figure 8).

Figure 25. Scan Group Detailed Error Count Dialog Box

Scan Group Detailed Error Counts

The following are included in the Scan Group Detailed Error Count dialog box:
• Scan Group: Displays the name of the scan group
• Count: Displays the error count for the defined filters
• Reset: Resets the counts to a value of zero

Proprietary – See Copyright Page 41 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• Update: Updates the display with current error counts. The error counts are updated
every scan but not displayed in this window until Update is clicked (unless automatic
update is enabled).
• Resume Update or Freeze Screen: Toggles automatic update mode on and off.
When automatic update is ON, the error counts are periodically updated.

1.8.1.8 Card Data Set

The Card data set is the sixth level of the data set hierarchy. Clicking on a Card data set
member opens the Card Data Set dialog box (Figure 26).
This display is read-only. Data sets are configured in the SCADA server application (see
“Data Set Dialog Box” in the e-terracontrol Reference Manual: Applications). Selecting
radio buttons and/or check boxes in this window does not affect the data displayed.

Figure 26. Card Data Set Dialog Box

Proprietary – See Copyright Page 42 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
The following are included in the Card Data Set dialog box:
• Key: Displays the hierarchical subtree for the selected data item.
• Current State: Displays the link (ONLINE, OFFLINE, FAILED, HIER OFFLINE,
INITDONE, or UNKNOWN).
• Time Read: Displays the time stamp from the last read.
• Physical Address: Displays the physical address of the card. Modification of this
parameter requires you to force re-initialization of the communication path.
• Card Subscript: Displays the zero-based index value of the card within the
hierarchical subtree.
• Number of Bits per Card: Displays the number of bits per measurement value on
the card. Modification of this parameter requires you to force re-initialization of the
communication path.
• Measurement Type: Displays the type of measurement or control (Control, Analog
Input, Digital Input, and Pulse Input) with measurement-specific options. Only the
measurement type defined in the Scan Group data set appears activated.
Modification of this parameter requires you to force re-initialization of the
communication path:
– Control
∗ Relay
∗ Analog Output
∗ Digital Output
∗ Pulse Width Output
∗ Pulse Train Output
– Analog Input (AI)
∗ Raw Input
∗ Analog Limit Excursion
∗ ADC Reference
– Digital Input (DI)
∗ Scan Group
∗ SOE
∗ Concat
– Pulse Input (PI)
∗ Analog Scan Group
• Relay Parameter 1: Control measurement type only. Displays the protocol-specific
modeling parameter #1:
– CONITEL 2000/2020 and PERT 26/31: Base Time for Raise/Lower controls.

Proprietary – See Copyright Page 43 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 – DNP 3.0: This is the Count field on the Control Relay Output Block used primarily
for PTO operations.
– LG 8979: Pulse count for pulse train output (for SBO) time interval per count.
– HARRIS 5000, TRW S9000: Not currently used.
• Relay Parameter 2: Control measurement type only. Displays the protocol-specific
modeling parameter #2:
– CONITEL 2000/2020 and PERT 26/31: Offset for Raise/Lower controls.
– DNP 3.0: This is the Off Time field used primarily in PTO operations, where
multiple relay sequences are issued.
– LG 8979: On-time duration in msec for PTO.
– HARRIS 5000, TRW S9000: Not currently used.
• Relay Parameter 3: Control measurement type only. Displays the protocol-specific
modeling parameter #3:
– CONITEL 2000/2020, PERT 26/31, HARRIS 5000, TRW S9000: Not currently
used.
– DNP 3.0: This is the Code field in the Control Relay Output Block field, and it
defines the basic relay control mode.
– LG 8979: Off-time duration in msec for PTO.
• Relay Parameter 4: Control measurement type only. Displays the protocol-specific
modeling parameter #4:
– DNP 3.0: If the modeled value is set to 1, the control requests are issued with
NULL code.
– All Others: Not currently used.
• Relay Parameter 5: Control measurement type only. Displays the protocol-specific
modeling parameter #5:
– All: Not currently used.
• Relay Parameter 6: Control measurement type only. Displays the protocol-specific
modeling parameter #6:
– All: Not currently used.
• Download Information: Indicates whether or not the information about a single
measurement type is to be downloaded.
• Static Flag (Hex): Displays the Card static flag as used in SMPDump.
• Measurement Flag (Hex): Displays the Measurement static flag as used in
SMPDump.
• Update: Updates the time read field.

Proprietary – See Copyright Page 44 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• View Card PCL Records: Opens the PCL Records window for the card (Figure 8).
• View Card TXT Records: Opens the PCLTXT Records window for the card (Figure
10).

Figure 27. Measurement Display Dialog Box

Measurement Display Dialog Box

The following are included in the Measurement Display dialog box:
• Key: Displays the hierarchical subtree for the selected data item.
• Quality: Displays the assigned data point quality.
• Physical Address: Displays the address of the point within the card.
• Subscript: Displays the zero-based index value of the point.
• Value: Displays the value of the data point.
• Bit Index (status only): Displays the zero-based index of the bit within the RTU. This
is only relevant for status points with some protocols.
• Deadband: Displays the limit deadband as defined for the data item, where
applicable.
• View Measurement PCL Record: Opens the PCL Records window for the
measurement (Figure 8).
• View Measurement TXT Record: Opens the PCLTXT Records window for the
measurement (Figure 10).

Proprietary – See Copyright Page 45 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.8.2 CFE Reader Log Tab
The CFE Reader Log tab (Figure 28) displays the application errors and informational
log messages that are logged to the console. The CFE Reader log can display up to
900 Event messages.

Figure 28. CFE Reader – Log Tab

The events that originate from the user interface of the CFE Reader are unformatted
text strings. The events that originate from the core component (CfeControl) of the
application follow this syntax:
<Module>_<Event Type>_<Event Number> - <Text>
Where:
• <Module> is the name of a CFE Reader module. CFE Reader is currently
constituted of the following modules: CFECTL (CfeControl), CFE, PORT, RTU,
SCNGRP (Scan Group), CARD, MEAS (Measurement), TIMDEV (Time Device),
BUCKET, SPY, PSTRMS (Pstreams), and CSTRMS (CfeStreams).
• <Event Type> is the type of event: S (Success), I (Informational), W (Warning), E
(Error), or F (Fatal).
• <Event Number> identifies the event among the collection of events for this module.

Proprietary – See Copyright Page 46 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.8.3 CFE Reader Communication Log Tab
The CFE Reader Communication Log tab (Figure 29) displays events relating to the
CFE Reader’s communication with the CFEs.

Figure 29. CFE Reader – Communication Log Tab

The Communication log displays up to 400 messages. The messages follow the same
format as the CFE Reader log, except that each message is preceded by the name of
the object it relates to.
Communication messages relate either to CFE objects (CFE Reader to CFE
communications) or Port objects (CFE to RTU communications).

Proprietary – See Copyright Page 47 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.8.4 CFE Reader Configuration Tab

Figure 30. CFE Reader – Configuration Tab

The following are included on the CFE Reader Configuration tab:

Local Items
Local Items are parameters that the CFE Reader uses to manage its communications
with CFEs, RTUs, and the time device. Unlike the other communication data, these
parameters are local to the application, they can be modified at any time, and they can
be saved as default parameters for the current data source.
• RTS Timeout (msec): Request-to-Send timeout in milliseconds. Value is 60 and
cannot be modified.
• CFE Timeout (heartbeats): The CFE level or Port Level request timeout, in units of
heartbeats.

Proprietary – See Copyright Page 48 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• TSI Timeout (heartbeats): CFE Image download timeout, for a TSISTRMS CFE.
This function is obsolete.
• CTS Delay (msec): Clear-to-Send delay timeout. Used for the Modem Timeout field
in the CFE_SCC_CONFIG_REQ.
• Max RTU Init: Maximum number of initialization attempts made before failing the
RTU. The default value is 1. This value should not be changed unless the
exploratory scan rate should be set to be greater than the RTU init multiplied by the
number of No Reply time outs. Otherwise, a system memory leak occurs due to the
large amount of scan delay in the transmit buffer queue.
• Max Scans: Maximum number of queued scans. A delay is reported if exceeded.
Value is 10 and cannot be modified.
• Rx Buffer Size (bytes): Size of buffer used to receive messages from the CFEs.
• Tx Buffer Size (bytes): Size of buffer used to send messages to the CFEs.
• Max Group Controls: Maximum number of queued controls. CfeControl rejects the
controls and reports an error if the queued controls count exceeds this value.
• Priority for Demand Scan: Used to determine if demand scan should be sent at
regular or special priority. Default is Special.
• Ignore Scan Delay: Used to determine if a delay in the RTU scan response should
be reported as failed or not. If checked, any delayed scan response is ignored and
not reported as failed.
• Save Local Items: Creates a file that contains the current values of the local
configuration parameters. The name of the created file is
“DataSourceName_local_items.cfg”. The saved values become the defaults for the
current data source.
• DownLoad CFE Image: This function is associated with legacy VME-based CFEs,
to configure whether CFE Reader is to download the image file every time the CFE
channel is placed into service. Like the VME-based CFE configuration, this option is
obsolete.
• VME GPS Source: Obsolete
• Ignore NIS SOE: Used to determine if SOE reporting should be suppressed for
points that are Not In Service (NIS) in e-terracontrol. This option can be used to
prevent chattering SOE points from flooding the SOE log.

CFE Reader Log

• Disable Output: Disables the CFE Reader log.
• Log to File: Sends the CFE Reader log output to a file named
“CfeControl<date>_<time>.log”.
• Limit Length to…MB: Limits the size of the CFE Reader log output file to the
number of megabytes specified in the adjacent text box. After the size limit has been

Proprietary – See Copyright Page 49 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 reached, the CFE Reader closes the file, creates a new file, and resumes logging to
the new file.

Note: The size must be specified before you enable the option.

• Severity Filter: Applies only to the events logged by the CFEControl:

– Success: If selected, completion messages are included in the log.
– Informational: If selected, informational messages are included in the log.

Caution: Selecting to log informational messages can hang the CFE Reader
application due to the large volume of messages.

– Warning: If selected, warning messages are included in the log.

– Error: If selected, error messages are included in the log.
– Fatal: If selected, fatal messages are included in the log.
• Module Filter Enabled: If selected, allows the log messages to be filtered according
to their module. Available modules are: CFE Reader (application-level: User
Interface and CfeControl), CFE (CFE, Pstreams, and CfeStreams objects), Port,
RTU, Scan Group, Card (Card and Measurement), and Miscellaneous (Time Device,
Bucket, and Spy objects).

Communication Log
• Disable Output: Disables the Communication log.
• Log to File: Sends the Communication log output to a file named
“COMMLOG<date>_<time>.log”.
• Limit Length to…MB: Limits the size of the Communication log output file to the
number of megabytes specified in the adjacent text box. After the size limit has been
reached, the CFE Reader closes the file, creates a new file, and resumes logging to
the new file.

Note: The file size must be specified before you enable the option.

• Comm Filter Enabled: If selected, communication messages are logged only if their
origin object is listed in the Communication filter.
• Edit Comm Filter: Opens the Comm Filter Editor window. This display lets you
select or deselect individual CFEs and ports as part of the Communication filter.

Note: CFEs and ports can also be individually selected from their own display.

• Severity Filter:
– Success: If selected, completion messages are included in the log.
– Informational: If selected, informational messages are included in the log.

Proprietary – See Copyright Page 50 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 – Warning: If selected, warning messages are included in the log.
– Error: If selected, error messages are included in the log.
– Fatal: If selected, fatal messages are included in the log.

e-terracontrol Log Options

These check boxes allow you to receive a message in the Reader log each time a
certain communication message is received from SCADA. The types of communication
events are:
• State Changes: SCADA informs CFE Reader that an object must change state.
• Control Requests: SCADA requests execution of a control command.
• Timers: A timer elapsed in SCADA. A timer may trigger an accumulator read, for
instance.
• Connections: A connection with SCADA is established or lost.
• Refresh Requests: SCADA issues demand scans.
• Messages to SMP: CFE Reader issues a message to SCADA.

Spy Log
The Spy log contains diagnostic information about the communication between the CFE
Control and the CFE, in the CFE-to-TFE protocol. The messages are time-stamped and
interpreted. The Spy log is made up of a circular buffer; the only output is in the form of
a text file.
Note that, once activated, the Spy log cannot be deactivated.
• Enable Traffic Dump: Enables the Spy log. The Spy log takes the form of a file
named “Cfe_spy.dat”. If such a file already exists, it is renamed “Cfe_spy.log”.
• Continuous Spy Dump: Select to perform continuous dumps of the Spy log
contents. Each time a message is received by the Spy log, it is automatically written
to the file.
• Single Spy Dump: Select to perform a single dump of the Spy log. The content of
the buffer is only dumped to a file upon your request.
• Dump to File: If the Spy log is configured as Single, dumps the content of the buffer
to the file “Cfe_spy.dat”.
If the Spy Log option has been specified in the CFE Reader command line, the option is
automatically selected for all CFEs.
If the Spy log is enabled by selecting Enable Traffic Dump on the Configuration tab, the
file is created but no CFEs are specified. In this case, the Spy log must be activated
individually on the CFE Data Set display.

Proprietary – See Copyright Page 51 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
User Interface
• Restrict Scrolling on Log Displays: When a large amount of data is logged on the
CFE Reader and Communication displays, the scroll bar can malfunction and
significantly impact the application performance. In order to avoid this problem,
select this check box to restrict scrolling and to bring the display back to its idle state
once the user has finished scrolling.
As long as the CTRL key is pressed, the user can use the scroll bar to view any
portion of the log display. However, once the CTRL key is released, CFE Reader
sets the focus back to the top of the message list in order to avoid unnecessary and
CPU-consuming display refreshes.

Note: Because remote monitoring software (e.g., PcAnywhere) can make it difficult
to issue the CTRL keystroke to the monitored application, the “S” key has the
same effect as the CTRL key.

1.9 CFE Reader Remote Diagnostic User Interface

The CFE Reader Remote Diagnostic application provides a user interface for the CFE
Reader that runs outside of the Process Starter.
The CFE Reader Remote Diagnostic user interface can run on the same host machine
as the Process Starter, or it can run on a different machine. It has the same functionality
as the CFE Reader display, except that it runs outside the Process Starter.
The CFE Reader Remote Diagnostic user interface can be used when the CFE Reader
display is configured to not be visible on the desktop.
Only one CFE Reader Remote Diagnostic user interface can be connected to the CFE
Reader at any given time. If a second remote user interface is started while the first one
is running, the user receives an error message indicating that there already exists a
connection between a CFE Reader Remote Diagnostic user interface and CFE Reader.

1.9.1 CFE Reader Remote Diagnostic Configuration File

Upon initialization, the CFE Reader Remote Diagnostic user interface application
searches the local directory for a configuration file, which is used to set the previously
defined global parameters for the CFE Reader application host’s IP address and port
number. The file name is “cfediagui_address.cfg”.
In the contents of the configuration file, each line has one of the following formats:
• IPAddress: XXXXXX
– where XXXXXX is the CFE Reader application host IP address or IP alias.
• Port: YYYY
– where YYYY is the CFE Reader application port number.

Proprietary – See Copyright Page 52 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• The default IP address is set to localhost.
• The default port value is set to 1234.

1.9.2 CFE Reader Remote Diagnostic Display

The following are included in the upper pane of the display:
• CFE Name: The name of the CFE data set that the CFE Reader Remote Diagnostic
application plans to access. From the pull-down list, you can choose which CFE data
set the CFE Reader Remote Diagnostic application plans to access inside the
CFE Reader database.
• IP Address: The IP address of the CFE Reader application host machine. This
value is defined in the CFE Reader Remote Diagnostic configuration file. From the
pull-down list, you can choose the IP address to indicate the CFE Reader application
that the CFE Reader Remote Diagnostic application wants to communicate with.
• Connection Status: Shows the status of the connection between the CFE Reader
Remote Diagnostic application and the CFE Reader application.
• Port: The port number of the CFE Reader application host machine that the CFE
Reader Remote Diagnostic application plans to use to communicate with the CFE
Reader application. This value is defined in the CFE Reader Remote Diagnostic
configuration file. From the pull-down list, the user can choose the port value, to
select which port the CFE Reader Remote Diagnostic application should use to
communicate with the CFE Reader application.

Proprietary – See Copyright Page 53 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 31. Communication Diagnostic Tab

The following items are included on the CFE Reader Remote Diagnostic
Communication Diagnostic tab:
• Check Box(es) to Enable Line Analyzer: Select which port(s) to enable for the
Line Analyzer by selecting the check box next to the name of the line. The data
retrieved from each line is stored in a separate file named “cfe_line_monitor_<CFE
number>_<Line number>.dat”. Disabling and re-enabling a line causes the Line
Analyzer data to be appended to the file.
• Protocol Interpretation: The protocol interpretation should be selected prior to
enabling the Line Analyzer for any given port. Select from the pull-down menu
whether or not protocol interpretation is to be used. Options are RAW (no protocol
interpretation) and INTERPRETED (protocol interpretation used if available in the
selected protocol).
• Check Box(es) to Enable Socket Trace: Select which port(s) to enable for socket
trace by selecting the check box next to the name of the line. This only applies when
using TCP/IP.

Proprietary – See Copyright Page 54 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 32. Logging Control Tab

The following items are included on the CFE Reader Remote Diagnostic Logging
Control tab:
CFE Reader Log
• Disable Event Viewer Output: Disables the output to the Event Viewer.
• Log to File: Sends the CFE Reader log output to a file named
“CfeControl<date>_<time>.log”.
• Limit Length to…MB: Limits the size of the CFE Reader log output file to the
number of megabytes specified in the adjacent text box. After the size limit has been
reached, the CFE Reader closes the file, creates a new file, and resumes logging to
the new file.

Note: The size must be specified before you enable the option.

Proprietary – See Copyright Page 55 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
• Severity Filter: Applies only to the events logged by the CFEControl:
– Success: If selected, completion messages are included in the log.
– Informational: If selected, informational messages are included in the log.

Caution: Selecting to log informational messages can significantly impact CFE

Reader performance due to the large volume of messages.

– Warning: If selected, warning messages are included in the log.

– Error: If selected, error messages are included in the log.
– Fatal: If selected, fatal messages are included in the log.
SMP Log Option
These check boxes allow you to receive a message in the Reader log each time a
certain communication message is received from SCADA. The types of communication
events are:
• State Changes: SCADA informs CFE Reader that an object must change state.
• Control Requests: SCADA requests execution of a control command.
• Timers: A timer elapsed in SCADA. A timer may trigger an accumulator read, for
instance.
• Connections: A connection with SCADA is established or lost.
• Refresh Requests: SCADA issues demand scans.
• Messages to SMP: CFE Reader issues a message to SCADA.
Communication Log
• Log to File: Sends the Communication log output to a file named
“COMMLOG<date>_<time>.log”.
• Limit Length to…MB: Limits the size of the Communication log output file to the
number of megabytes specified in the adjacent text box. After the size limit has been
reached, the CFE Reader closes the file, creates a new file, and resumes logging to
the new file.

Note: The file size must be specified before you enable the option.

• Severity Filter:
– Success: If selected, completion messages are included in the log.
– Informational: If selected, informational messages are included in the log.
– Warning: If selected, warning messages are included in the log.
– Error: If selected, error messages are included in the log.
– Fatal: If selected, fatal messages are included in the log.

Proprietary – See Copyright Page 56 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 33. Log Tab

The CFE Reader Remote Diagnostic Log tab displays events relating to the CFE
Reader’s communication with the CFEs.
The Communication log displays up to 400 messages. The messages follow the same
format as the CFE Reader log, except that each message is preceded by the name of
the object it relates to.
In addition, the CFE Reader Remote Diagnostic Log tab also displays communication
messages indicating whether the CFE Reader remote client has been successfully
connected to the CFE Reader server.
Communication messages can relate to the following:
• CFE (CFE Reader to CFE communications)
• Port objects (CFE to RTU communications)
• Status of the communication link between the CFE Reader remote client and the
CFE Reader server

Proprietary – See Copyright Page 57 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10 CFEReader Line Analyzer
The Line Analyzer functionality can be used to collect the protocol information from the
CFEReader ISR module. It can also be used to interpret the protocol data in a formatted
manner, such as the ASE TestSet LineMonitor view. The CFEReader ISR module has
the capability to export the communication messages into text files when requested. In
addition, the Line Analyzer can be used to collect the protocol data for serial and
network protocols.

1.10.1 Line Analyzer Design

The Line Analyzer uses four different processes to perform its functionality. They are:
• Line Analyzer Server DLL: This DLL is attached to CFEReader. Its function is to
collect communication messages from the CFEReader ISR module and send those
messages to the Line Analyzer server.
• Line Analyzer .NET Managed DLL: This is the managed wrapper DLL, which acts
as an interface between the Line Analyzer server DLL and the Line Analyzer server
module.
• Line Analyzer Server: This module collects the protocol messages from the
CFEReader ISR module, using the Line Analyzer server DLL, and sends those
messages to the Line Analyzer client modules when connected to them. The Line
Analyzer server uses TCP/IP communication to send data to the Line Analyzer
client. For the Line Analyzer client connections, it listens on port 12345 if the default
port is not overridden by the command-line switch Port=<valid port number>.
• Line Analyzer Client: This module is used to display the protocol data in a raw and
formatted manner similar to the ASE TestSet LineMonitor view. The Line Analyzer
client can interpret the protocol messages using the protocol
interpretation/dissection XML files located in the
eterra\e_terracontrol\bin\protocol directory. The rules for writing these files are given
in section 1.10.6 Writing LogAnalyzer Protocol XML Files.
Because the analyzer runs separately from the CFEReader, it does not have a major
impact on the CFEReader’s performance when it accesses the I/O device. In addition,
the client/server structure also allows multiple analyzer clients to connect to one
analyzer server at the same time without any extra overhead. The following figure
suggests the Line Analyzer design and the relations among the different modules.

Proprietary – See Copyright Page 58 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 34. Relationships Among the Components in the Line Analyzer

1.10.2 Line Analyzer Modules

The Line Analyzer modules are installed in the “e-terracontrol\bin” directory as part of
the e-terracontrol installation.
• LineAnalyze.exe: Line Analyzer client program
• LineAnalyzeDLL.dll: CFEReader interface DLL
• LineAnalyzeDLL_NET.dll: Line Analyzer server interface DLL
• LineAnalyzeServer.exe: Line Analyzer server

Proprietary – See Copyright Page 59 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Also, the e-terracontrol installation contains the protocol interpretation files, which are
installed in the “eterra\e_terracontrol\bin\protocol” directory.

1.10.3 Using Line Analyzer

To use the Line Analyzer with the CFEReader, use the following steps:
1. Start the CFEReader.
2. Start the Line Analyzer server.
3. Start the Line Analyzer client.
4. Select the port that needs to be analyzed, and also select the protocol so the Line
Analyzer client can apply the protocol interpretation on the connected port.
To analyze a saved Line Analyzer spy dump file, there is no need to start the Line
Analyzer server. Simply start the Line Analyzer client and open the spy dump file.

1.10.4 Line Analyzer Server

To start the Line Analyzer server, double-click on the LineAnalyzeServer.exe program in
the e_terracontrol\bin directory.
By default, the server listens on port 12345, or the listening port can be specified with
the command-line parameter Port=<valid port number>.
The Line Analyzer server display looks like the following:

Figure 35. Line Analyzer Server Display without a Client Connection

After a client connects to the Line Analyzer server, the display looks like the following:

Figure 36. Line Analyzer Server Display with a Client Connection

Proprietary – See Copyright Page 60 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10.5 Line Analyzer Client
To start the Line Analyzer client, double-click on the LineAnalyze.exe program in the
“e_terracontrol\bin” directory. The user is prompted to enter the user name and
password.

Figure 37. Line Analyzer Client Login Display

The “Host name” refers to the computer where the Line Analyzer server is running.
Since the Line Analyzer server and client use TCP/IP communication, the client can be
running on any computer that has access to the Line Analyzer server.
After you enter the User name, Password, Host name, and TCP Port number, the client
sends a connection message to the Line Analyzer server. The server then sends an
Identification Challenge message to the client, and the client sends an
IDENTIFICATION message back to the server.
In the first block, the IDENTIFICATION message contains a key for a symmetrical
algorithm (Rijndael) encoded with the public key RSA of the server. In the second block,
the message contains the identifier, the password, and the unpredictable data
encrypted with this new key.
After the handshake is successful, the Line Analyzer client window opens, and it looks
like the following:

Proprietary – See Copyright Page 61 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 Connect/Disconnect
Toolbar
Port List

Protocol List

Captured Raw
Messages View

Selected Message
Interpreted View

Figure 38. Line Analyzer Client Display

The Line Analyzer client has two views to monitor two different ports at once.

1.10.5.1 Connect/Disconnect
The Connect/Disconnect toolbar button is used to connect or disconnect communication
with the Line Analyzer server. When connected, the toolbar button looks like the
following:

To disconnect, click the button, which changes to look like the following:

Proprietary – See Copyright Page 62 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10.5.2 Line Analyzer Client Toolbar
The Line Analyzer client uses the toolbar shown below to perform various functions.

Figure 39. Line Analyzer Client Toolbar

These functions are explained in the order in which they are displayed.

Clear: This toolbar button is used to clear all the messages in the Line Analyzer
Raw View screen and in the interpreted view.

Open: This toolbar button is used to open a saved Line Analyzer Spy Trace file.

Save: This toolbar button is used to save the protocol messages in a spy file. The
spy file is in binary format, and it can only be opened by the Line Analyzer client
program.

Export: This toolbar button is used to export the protocol messages into a text file.

Filter: This toolbar button is used to filter specific protocol bytes, and it can also be
used to color them (text or background). Filtering is explained in more detail in
section 1.10.5.8 Filtering Messages.

Show Incoming Datagrams: This toolbar button is used to enable the Line
Analyzer to show the incoming datagrams.

Stop Capture: This toolbar button is used to stop capturing protocol

information (i.e., it stops communication with the Line Analyzer server). To start
capturing protocol information again, select the desired port from the available port
list.

1.10.5.3 Port List

The Line Analyzer client has a combo box to show the list of ports that are currently
captured by the Line Analyzer server. The port list information is sent to the client by the
server during the initial handshake.
When a port is selected, it looks like the following:

Figure 40. Port List Combo Box with a Selected Port

Proprietary – See Copyright Page 63 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10.5.4 Min Datagram Size
This field is used to limit the datagram size. If the input message is less than this field
value, the Line Analyzer ignores the message. The default minimum size is six bytes.

Figure 41. Min. Datagram Size Field

1.10.5.5 Protocol List

A message can be selected from the Captured Messages view; its protocol details are
shown in the interpreted view. The interpretation or dissection of the selected message
depends on the protocol chosen from the protocol list. The protocol list looks like the
following:

Figure 42. Protocol List

Currently, the following protocol interpretations/dissections are possible (the necessary

XML configuration files are installed along with e-terracontrol):
• DNP3 Serial and TCP/IP
• Conitel
• LG8979
• IEC101
• IEC104
• WISP
• RP570
The design of the Line Analyzer permits the extension of the protocol analysis to any
protocol with just a few steps by:
• Adding a few functions to the CFEReader protocol ISR module so that it can send
the raw data to the Line Analyzer server
• Creating a protocol interpretation file, which should be installed in the
eterra\e_terracontrol\bin\protocol directory
The Line Analyzer client searches the “eterra\e_terracontrol\bin\protocol” directory. For
every XML file found in this directory, the client adds a protocol name to the protocol list.

Proprietary – See Copyright Page 64 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10.5.6 Captured Messages View (Raw/Hex Dump View)
The messages received from the Line Analyzer server are shown in the Raw View. In
this view, there is no interpretation; it simply shows the messages as received from the
Line Analyzer server.

Figure 43. Captured Raw Messages View

Proprietary – See Copyright Page 65 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10.5.7 Interpreted Messages View
If a user selects a message from the Captured Messages view and then selects any
protocol other than Hexadecimal dump, the Line Analyzer client analyzes the raw
message according to the protocol XML file and displays the analyzed data in the
Interpreted Messages view, as shown in Figure 44.

Figure 44. Interpreted Messages View

Note that, if the Hexadecimal dump protocol is selected, the message is not interpreted.
Only the selected text is shown in the Interpreted Messages view.

Proprietary – See Copyright Page 66 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10.5.8 Filtering Messages
The Line Analyzer client supports filtering messages using a filtering rule, which can be
defined to color the input datagram.

To open the Filters dialog box, click the Filter button on the toolbar.

Figure 45. Empty Filters Dialog Box

To add a new filter rule, click the Add button in the Filters dialog box. A new, blank
Filter line is added, as shown in Figure 46.

Proprietary – See Copyright Page 67 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 46. Filters Dialog Box with an Empty Filter Line

In this filter window, the Edit box (shown below) is used to enter the protocol bytes to
which this filter rule is applied.

The Terminale check box is used to enable the focus on the defined rule in
the filter’s Edit box.
The Invisible check box is used to disable the datagrams that match with the
bytes entered in the filter rule.

The Foreground (FG) color box is used to define the foreground color of the
messages if the color matches with the bytes entered in this rule.

The Background (BG) color box is used to define the background color of the
messages if the color matches with the bytes entered in this rule.

The Up/Down arrow buttons are used to change the order of the filter rules if
multiple rules are defined in the filter window.

The Minus button is used to delete a filter rule.

An example of a filter window with multiple filter rules is shown below.

Proprietary – See Copyright Page 68 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 47. Filters Dialog Box with Multiple Filter Rules

1.10.6 Writing LogAnalyzer Protocol XML Files

The Line Analyzer client reads the messages and tries to apply the rules defined in the
XML file; the text described in the XML file is displayed in the interpreted view. The rules
are applied to the bytes in the order in which they are received from the server.
Sometimes, bits in a byte are read in reverse order, but the first-in-first-read order is
always maintained.
This section explains how the protocol XML file is written. Before you write the protocol
XML file, the current XML files found in the “eterra\e_terracontrol\bin\protocols” directory
can be used as examples.

1.10.6.1 DOCTYPE Definition

Every protocol interpretation file must have the following DOCTYPE declaration and
public identifiers for the DTD, which can be used to validate the document structure:
<!DOCTYPE protocol [
<!ELEMENT protocol (filters,variables,layer)>
<!ELEMENT filters (filter)*>
<!ELEMENT filter EMPTY>
<!ELEMENT variables (variable)*>
<!ELEMENT variable (value)*>
<!ELEMENT value EMPTY>
<!ELEMENT layer (backward|field|if|layer|loop|pad)*>
<!ELEMENT backward (backward|field|if|layer|loop|pad)*>
<!ELEMENT field ((case)*,default?)>
<!ELEMENT if ((backward|field|if|layer|loop|pad)*,else?)>

Proprietary – See Copyright Page 69 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 <!ELEMENT loop (backward|field|if|layer|loop|pad)*>
<!ELEMENT pad EMPTY>
<!ELEMENT case EMPTY>
<!ELEMENT default EMPTY>
<!ELEMENT else (backward|field|if|layer|loop|pad)*>
<!ATTLIST protocol
name CDATA #REQUIRED>
<!ATTLIST filter
search CDATA #REQUIRED
replace CDATA #REQUIRED>
<!ATTLIST variable
id ID #REQUIRED
name CDATA #REQUIRED>
<!ATTLIST value
name CDATA #REQUIRED
value CDATA #REQUIRED>
<!ATTLIST layer
name CDATA #REQUIRED>
<!ATTLIST backward
nbits CDATA #REQUIRED>
<!ATTLIST field
id ID #REQUIRED
name CDATA #REQUIRED
nbits CDATA #REQUIRED
type
(100ustime|binary|float|int|int_1st_complement|uint|DaysSince80|timestamp|lon
g) "uint"
color (red|orange|green|blue|grey|black) "black"
endianness (big_endian|little_endian) "little_endian">
<!ATTLIST if
expression CDATA #REQUIRED>
<!ATTLIST loop
times CDATA #IMPLIED
while CDATA #IMPLIED
variable CDATA #IMPLIED>
<!ATTLIST pad
nbits CDATA #REQUIRED>
<!ATTLIST case
value CDATA #REQUIRED
description CDATA #REQUIRED
condition CDATA #IMPLIED>
<!ATTLIST default
description CDATA #REQUIRED
condition CDATA #IMPLIED>
]>

Proprietary – See Copyright Page 70 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10.6.2 Protocol Element
The root element of the protocol XML file is protocol, so the protocol definition looks like
the following:
< protocol name=”LG8979”>
--- protocol definitions go here
</protocol>

1.10.6.3 Layer Element

The layer element is used to divide the protocol messages into different groups such as
header, data section, error checking, etc.
< protocol name=”LG8979”>
<layer name=”Header”>
</layer>
<layer name=”Data”>
</layer>
<layer name=”CRC”>
</layer>
</protocol>

1.10.6.4 Direction Field

In protocol data, it is sometimes necessary to find out the direction of the message (i.e.,
Request or Response). So the first byte read by the Line Analyzer client is a direction
byte. The direction field should look like the following:
< protocol name=”LG8979”>
<layer name=”Header”>
<field id="frame_dir" name="direction" nbits="8">
<case value="0x53" description="Master Request"/>
<case value="0x52" description="Remote Reply"/>
<default description="Error Frame"/>
</field>
</layer>
<layer name=”Data”>
</layer>
<layer name=”CRC”>
</layer>
</protocol>

1.10.6.5 If and Else Elements

Based on the input value, if the user wants to display the text, the “if” condition can be
used. The “if” element definition looks like the following:
<if expression ="frame_dir==0x53" >
<pad nbits="2"/>

Proprietary – See Copyright Page 71 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
 <field id="msg_hdr_iack" name="ACK Flag" nbits="1" />
<field id="msg_hdr_imfc" name="Multi Function Code" nbits="4" />
<field id="msg_hdr_ishr" name="Short Response Flag" nbits="1"/>
<else>
<if expression ="frame_dir==0x52" >
<pad nbits="2"/>
<field id="msg_hdr_slg" name="SOE Log Flag" nbits="1" />
<field id="msg_hdr_sch" name="SOE Change Flag" nbits="1" />
<field id="msg_hdr_ind" name="Indication Change Flag" nbits="1" />
<field id="msg_hdr_frz" name="Accumulator Freeze Flag" nbits="1" />
<field id="msg_hdr_con" name="Response Continuation Flag" nbits="1" />
<field id="msg_hdr_eshr" name="Short Response Flag" nbits="1"/>
</if >
</else>
</if>
In this condition, if the input byte value is 0x53, different information is displayed in the
Line Analyzer client’s interpreted view than if the input byte is 0x52.

1.10.6.6 Case Element

The case condition can be used to display information based on the input value. There
is also a way to display the default text.
<field id="baud_rate" name="Baud Rate" nbits="8" >
<case value="0" description="300 Baud"/>
<case value="1" description="600 Baud"/>
<case value="2" description="1200 Baud"/>
<case value="3" description="1800 Baud"/>
<case value="4" description="1250 Baud"/>
<case value="5" description="2400 Baud"/>
<case value="6" description="4800 Baud"/>
<case value="7" description="9600 Baud"/>
<default description="Unknown Baud""/>
</field >

1.10.6.7 Loop Times Element

The loop times element is used to repeat the read operation a specified number of
times. The condition looks like the following:
<loop times="(int)(((data_block_len-2)*8)/24)">
<field id="afr_data1" name="Value" nbits="12" />
<field id="afr_data2" name="Value" nbits="12" />
</loop>

Proprietary – See Copyright Page 72 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.10.6.8 Loops While Element
The loops while element can be used to repeat the read operation until a specified
condition is true. The condition looks like the following:
<loop while="remaining &gt; 2"> <!--To process all the data blocks->
</loop>

1.10.6.9 Pad Element

Sometimes it is necessary to ignore some bits in the protocol data. In that case, the pad
element is used, and no description is displayed for the pad number of bits in the
interpreted view. The pad definition looks like the following:
<if expression="id_t == 1 || id_t == 2 || id_t == 30">
<field id="SPI_sq0" name="Single-point information" nbits="1">
<case value="0" description="OFF"/>
<case value="1" description="ON"/>
</field>
<pad nbits="3"/>
</if>

1.10.6.10 Backward Element

Sometimes it is necessary to read the bits in a byte in reverse order. In that case, the
backward element is used.
<backward nbits="4">
<field id="FUNCTION" name="Function code" nbits="4" color="green">
<case value="0" description="Reset of remote link" condition="PRM ==
1"/>
<case value="0" description="ACK: Positive acknowledgement"
condition="PRM == 0"/>
<case value="1" description="Reset of user process" condition="PRM ==
1"/>
</field>
</backward>

1.10.6.11 Color Element

The color element is used to change the color of the text displayed in the interpreted
view. The allowed colors are red, orange, green, blue, grey, and black.

Proprietary – See Copyright Page 73 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.11 CFE Reader-Specific Counter Measurements
In the SCADA server, the CFE Reader uses two types of counter measurements. The
first type contains the set of counter measurements that contribute to the number of
errors in the data set (in Counter Measurement Type, the Contributes to Error Counter
box is checked). These counter measurements include the following:
• Crc: CRC Checksum Error: This value is increased every time the CFE Reader
gets the error from the computation of the CRC checksum in the response message
sent from the RTU.
• Nrpl: No Reply Error: This value is increased every time the CFE reader does not
receive the response message from the RTU within the No Reply time out.
• Othr: Other Error: This value is increased every time the CFE Reader detects any
other error except the Crc Checksum and No Reply errors, every time it receives the
RTU response message.
These three counter measurements are mandatory for proper CFE Reader functionality,
and they must be modeled in the scan group data sets.
The other type of counter measurement contains the set of counter measurements that
do not contribute to the number of errors in the data set (in Counter Measurement Type,
the Contributes to Error Counter box is not checked). This type includes all the RTU-
specific bucket values. There is a maximum of 16 of these counter measurements per
data set.

1.12 CFE Reader Error Log Message Description

This section provides detailed explanations of the CFE Reader Error Log Messages,
along with suggestions on how to eliminate those error messages.

1.12.1 -CFECONTROL_E_0004
CFEReader state transition is not valid. Previous state = %d to Present state
= %d.
Explanation: Each CFEControl data set has four different states: Offline, Unknown,
Online, and Fail. The state machines of the data set are shown as follows:

Proprietary – See Copyright Page 74 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
This error indicates that the CFEControl data set did not follow the above state
machine.
Action: This is the internal CFEControl error. Record the steps that produced this error,
and report the problem to Alstom Grid customer service for further analysis.

1.12.2 -CFECONTROL_E_0021
No reply timeout on CFE Channel Level queue. CFE ""%s"" is set to FAILED.
Message header = %s. Mgeneric = %d
Explanation: There are two queues in CfeControl: the Channel Level queue and the
Port Level queue. Channel Level consists of the following messages:
• Time Sync Init request message
• Time Stamp request message
• SOE Log request message
This error indicates that there is no reply from the CFE module when the CFEControl
module sends out the above request to the CFE module within the CFE timeout period.
Action: Increase the CFE timeout value defined on the CFE Reader display’s
Configuration tab. Also, turn on the CFE spy, CFE event, and CFE line monitor/socket
trace logs. Send those log files to Alstom Grid customer service for further analysis.

Proprietary – See Copyright Page 75 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.12.3 -CFECONTROL_E_0022
No response from CFE ""%s"" within cfe timeout period. Message header=%s.
Mgeneric = %d
Explanation: There are two queues in CfeControl: the Channel Level queue and the
Port Level queue. Port Level consists of the following messages:
• Smart/Integrity request message
• Control request message
• COM Statistic message
• Etc.
This error indicates that there is no reply from the CFE module when the CFEControl
module sends out the above request to the CFE module within the CFE timeout period.
Action: Increase the CFE timeout value defined on the CFE Reader display’s
Configuration tab. Also, turn on the CFE spy, CFE event, and CFE line monitor/socket
trace logs. Send those log files to Alstom Grid customer service for further analysis.

1.12.4 -PSTRMS_E_0182
CFE ""%s"" reports an invalid State Change for Measurement ""%s""
Explanation: There are five parameters in the Multiple Change Detection (MCD) bits:
OnSet, OnClear, OnMcd, Always, and Never.
• OnSet: RTU Report MCD Point Change from Set to Clear
• OnClear: RTU Report MCD Point Change from Clear to Set
• OnMcd: RTU Report Multiple MCD Point Change
• Always: RTU Report MCD Anytime Point Change State
• Never: RTU Never Report MCD Change
This error indicates that RTU reports the wrong MCD point change.
For example, the RTU model is set to OnSet. If the point measurement changes from
Set to Clear and the MCD bit does not set, the CFE Reader reports an error for this
invalid state change for this measurement. The final measurement value is forwarded to
the e-terracontrol SCADA server.
Action: Because the final measurement value is always forwarded to the e-terracontrol
SCADA server, it is not necessary for the CFE Reader to report this error. In the latest
version of CFE Reader (version 3.4.0 or later), the CFE Reader does not report this
error at all.

Proprietary – See Copyright Page 76 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.12.5 -PSTRMS_E_0095
Port Index %d in the receive pointers does not match with the ones located in
the Port Level queue for CFE ""%s"". Skip the Rx Buffer. Message header=%s
Explanation: In the CFE Reader, every time the request message in the Port Level
queue is sent to the CFE module, the CFE Reader must wait for the reply from the CFE
module. So, for every reply message sent by the CFE module, there must be a request
message waiting in the Port Level queue. If, for some reason, the Port Level queue has
no request message corresponding to the reply message sent from the CFE module,
the CFE Reader logs the error to indicate that there is no matching request message in
the Port Level queue to this reply message in the Port Index. The CFE Reader skips
processing the reply message having the message header specified in the message.
Action: Turn on the CFE spy to record the transactions between CFEControl and the
CFE module. Also, turn on the CFEControl log to record the error message in the file.
Notify Alstom Grid customer service about this error, and send both CFEControl and the
CFE spy logs for further analysis.

1.12.6 -PSTRMS_E_0042
CFEReader failed to send out the RTU initialization on the RTU ""%s""
dataset. Skip attempt #%d.
Explanation: CFE Reader did not get the reply from the RTU after the number of
attempts to send out RTU initialization requests.
Action: This is a communication problem. Verify that the cables, phone line, modem,
etc., are all properly connected.

1.12.7 -PSTRMS_E_0180
""%s"" returned a zero-length MGENERIC before the end of the Rx Buffer. Hex
dump of last non-zero length MSIRHD: %s.
Explanation: Generally, the reply message from the CFE module to CFECONTROL
contains the scan item response header. For example, in the smart (periodic) scan
response, the reply message has the following format:
|--------------------------------------|
| generic message header (MGENERIC) | msgcod = MSSCAN
|--------------------------------------|
| scan item response |
|--------------------------------------|
.
.
.
|--------------------------------------|
| scan item response |
|--------------------------------------|

Proprietary – See Copyright Page 77 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
where the generic message header has the following data structure:
typedef struct mgeneric
{
CFE_UWORD msglen; /* # of bytes in message including */
/* the length word. */
CFE_BYTE msgcod; /* Request/response function code. */
CFE_BYTE msnode; /* Node to be used when sending */
/* response to the host. */
unsigned char msline; /* Comm. line for this request. */
/* Must be in the range 0 - 19. */
CFE_UBYTE msgsts; /* Message status. Flags defined */
/* below. */
CFE_UWORD mserr; /* Error code if the msgsts 'error' */
/* bit is set. Not used if error */
/* bit is clear. */
} MGENERIC;
and the scan item response can have different data structures depending on the
response message.
For example, the analog scan item response has the following format:
typedef struct maesir /* Analog Data Exception Scan Item */
/* response */
{
MSIRHD msirhd; /* Scan item response header */
/*
* Children, type MANLGE, contain the analog data exceptions.
*/
} MAESIR;

typedef struct msirhd

{
CFE_UWORD mlen; /* # of bytes in scan item response */
/* including the length word. */
CFE_UWORD mhid; /* Host identifier of the scan item */
CFE_UWORD msirtu; /* RTU identity. */
CFE_UWORD mstflg; /* Status flags - defined below */
CFE_UWORD mrtype; /* Scan item response type -defined*/
/* below */
CFE_UWORD mfill9; /* Longword alignment fill word. */
/*
* Children are expected containing scan item response data, the format
* is determined by 'mrtype'.
*/
} MSIRHD;
/*--------------------------------------------------------------------------
* Bit meanings for 'mstflg'
*/
#define MINTEG 0x0001 /* 'Integrity scan item response' flag */
#define MCLDST 0x0004 /* RTU cold start detected */

Proprietary – See Copyright Page 78 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
#define MIGNOR 0x0008 /* Report is known to be invalid or old */
#define MSYNCL 0x0010 /* RTU reports a need for Time synchronization. */
#define MPART 0x0020 /* Partial response of a continuation sequence */
/* is received. */
#define MRINIT 0x0040 /* RTU needs initialization */
#define MCFGRT 0x0080 /* RTU needs configuration data. */
#define MCHNER 0x0100 /* MPASSTH report for CHANEL level error */
#define MINITER 0x0200 /* Errors found in RTU Initialization sequence */
#define MRLOCAL 0x0400 /* RTU is in LOCAL Mode
#define MOVFLOW 0x0800 /* IIN2.3 bit --> Buffer over flow indication */

/*--------------------------------------------------------------------------
* Codes for 'mrtype' - this identifies the type and format of the scan item
response.
*/
#define MPASS 0x0001 /* Pass-through/error format */
#define MANEXC 0x0002 /* Analog Data - Exception Format */
#define MSTEXC 0x0004 /* Status Data - Exception Format */
#define MSTDMP 0x0005 /* Status Data - Dump Format */
#define MACCUM 0x0006 /* Accumulator Data */
#define MSOE 0x0007 /* SOE Data */
#define MDIRCT 0x0008 /* Direct Control */
#define MSBOSL 0x0009 /* SBO Select */
#define MSBOEX 0x000A /* SBO Execute */
#define MSETPT 0x000B /* Set Point */
#define MBIAS 0x000C /* Time Bias Response */
#define MACK 0x000D /* RTU acknowledge response */
#define MDBG 0x000E /* Debug line analyzer response. */
#define MRDDMP 0x000F /* Raw Data - Dump Format. */
#define MAGDMP 0x0010 /* Analog Group Data - Dump Format. */
#define MINTRSP 0x0011 /* RTU Initialization response. */
#define MSBORE 0x0012 /* SBO control reset */
#define MRLOW 0x0013 /* Pulse output control */
#define MSETSL 0x0014 /* Set point select */
#define MSETEX 0x0015 /* Set point execute */
#define MLOGIT 0x0016 /* Event log scan item report. */
#define MTIMRSP 0x0017 /* Time initialization response. */
#define MTIMSYN 0x0018 /* Time synchronization response. */
#define MPCLRPT 0x0019 /* Report PCLxxx data to Host */
#define MALE 0x001A /* ALE Data */
#define MALFLT 0x001B /* Floating Point Analog */
#define MADJWEL 0x001C /* Adjust wellness check period for RTU */
#define MCTRLR 0x001D /* Control Response */
#define MTESTR 0x001e /* Test message Response */
and the message length (msglen) in the MGENERIC structure should include the length
of the scan item response. The CFE Reader logs this error if msglen does not include
the scan item response length.
Action: This is a coding error. It should be reported to Alstom Grid customer service for
further analysis.
Proprietary – See Copyright Page 79 CFE Reader
e-terracontrol Reference Manual: Interfaces to Field Devices
1.12.8 -PSTRMS_E_0179
""%s"" returned an invalid or unknown response type: %d.
Explanation: As shown above, the scan item response type has 30 values. If, in the
scan response message, the scan item response type does not match with any of the
scan item response type values, the CFE Reader reports this error with the unknown
response type on the data set.
Action: This is a coding error. It should be reported to Alstom Grid customer service for
further analysis.

1.12.9 -PSTRMS_E_0250
The count of outstanding Smart Scans (%d) on port ""%s"" reached the max
Scans value (%d). Skip Scan on this port.
Explanation: If the number of the smart scan request waiting in the pending list of the
Port Level queue is greater than the max scans value (%d) defined in the CFE Reader,
the CFE Reader reports this error to notify the user that the waiting list is full.
Action: Go to the CFE Reader display’s Configuration tab and increase the Max Scans
value. If the problem still persists, report it to Alstom Grid customer service for further
analysis.

1.12.10 -PSTRMS_E_0080
Scan Delay on Port: ScanGroups that were NAKed will be rescanned once before
moving on.
Explanation: For some reason, if the RTU cannot keep up with the CFE Reader polling
rate (i.e., the CFE Reader sends out the request at a rate where the RTU does not have
enough time to form the reply message), the CFE Reader reports this error to indicate
that there is a scan delay on this port.
Action: There are a few options to resolve this problem:
• Reduce the smart (periodic)/integrity scan rate.
• Increase the baud rate.
• Check the status of the RTU.
• Etc.

1.12.11 -PSTRMS_W_0251
CHANEL %d reports the following warning: \n%s.
Explanation: The CFE module reports the following warning error (%s) on channel
(%d).

Proprietary – See Copyright Page 80 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
Action: Turn on the CFE Event log to record the errors. Send the log to Alstom Grid
customer service for further analysis.

1.12.12 -PSTRMS_E_0252
CHANEL %d reports the following error: \n%s.
Explanation: The CFE module reports the following error (%s) on channel (%d).
Action: Turn on the CFE Event log to record the errors. Send the log to Alstom Grid
customer service for further analysis.

1.12.13 -PSTRMS_W_0253
CHANEL %d reports the following fatal: \n%s.
Explanation: The CFE module reports the following fatal error (%s) on channel (%d).
Action: Turn on the CFE Event log to record the errors. Send the log to Alstom Grid
customer service for further analysis.

1.12.14 -PSTRMS_W_0146
""%s"" returned a ScanGroup index %d (RTU idx=%d) that is not defined in the
CFEReader database. Fail the CFE. Hex dump of MSIRHD: %s.
Explanation: The RTU with index = %d in the CFE data set %s returns the message
having the Scan Group (%d) not defined in the CFE Reader database. The CFE Reader
fails the channel %s when it receives this message.
Action: Check the RTU configuration to make sure it matches with the CFE Reader
database. Turn on the CFE line monitor, CFE event, and CFE spy logs. Collect the
data, and send it to Alstom Grid customer service for further analysis.

1.12.15 -PSTRMS_W_0147
""%s"" returned an invalid message from RTU index %d that has no ScanGroup
data. Hex dump of MSIRHD: %s.
Explanation: The RTU with Index = %d returns the message having the scan group set
to -1 (ff) and mrtype set to any of the following values: MPASS, MINRSP, MLOGIT,
MTIMSYN, MBIAS, MTIMRSP, MACK, MSOE, MALE, MPCLRPT, or MADJWEL. The
CFE Reader fails the channel %s when it receives this message.
Action: This is a CFE module internal problem. Turn on the CFE event and CFE spy
logs to record the error messages. Send the log files to Alstom Grid customer service
for further analysis.

Proprietary – See Copyright Page 81 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.12.16 -PSTRMS_W_0266
RTU no-reply error. Error reported for %s ""%s"" in merflg/mrxflg field (%s)
of MPASS message.
Explanation: This is a communication error. The RTU does not reply for the scan
request issued from scan group %s. The field merflg/mrxflg can be interpreted as
follows:

Bit meanings for “merflg”

#define MNRERR 0x0001 /* 'No Reply' timeout occurred */
#define MCRERR 0x0002 /* CRC error detected */
#define MOTERR 0x0004 /* 'Other error' - any error detected that does not
fall into the above two categories */
#define MDLERR 0x0080 /* DLC Error detected. Not used for EMETCON responses.
*/
#define MCCERR 0x0100 /* CCU error detected. When this bit is set, the scan
item host id should be ignored. The error is attributed to the CCU, not to
any particular scan item. */
#define MNLLDAT 0x1000 /* RTU replied to a dump request will NULL data */
#define MRTUNAK 0x2000 /* RTU replied with NAK response. */
#define MPTOUT 0x4000 /* 'point out of range'. Points in this response were
out of the CFE database range. */
#define MUNKNW 0x8000 /* 'RAFT couldn't interpret this response' */

Bit meanings for “mrxflg”

#define CNRTMO 0x0001 /* 'No Reply' timeout occurred */
#define CRDTMO 0x0002 /* 'RCV rundown' timeout occurred */
#define CTXTMO 0x0004 /* 'Transmit rundown' tmo occurred */
#define CTSTMO 0x0008 /* 'CTS not raised' tmo occurred */
#define CPARTY 0x0010 /* Z8030 reports parity error */
#define CRXFFO 0x0020 /* Z8030 reports Rx FIFO overflow */
#define CFRAME 0x0040 /* Z8030 reports framing error */
#define CNXTMO 0x0080 /* 'Byte not transmitted' tmo */
/* (tx buffer not emptied) */
#define CCDTMO 0x0100 /* 'DCD not asserted' tmo occurred */
#define CRXOVR 0x0200 /* Receive buffer overflow occurred */
#define CRCERR 0x0400 /* SERVIS detected a CRC error */
#define CRXERR 0x0800 /* Receiver hardware error detected */
#define CRTERR 0x1000 /* 'RTU reports error' flag */
#define CBADRP 0x2000 /* SERVIS detected ill-formed resp. */
#define CTINA 0x4000 /* Used for two purposes: */
/* 1.Inaccurate timestamp detected by ISRSOE. Used by TIP.*/
/* 2.Inaccurate elapsed millisecond calculated by ISRSCC when
/* sending SOE time sync request.*/
#define CCUFAL 0x8000 /* CCU error or queuing reset has occurred. */
Action: Check the communication between the RTU and the front end, as well as the
RTU configuration.

Proprietary – See Copyright Page 82 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.12.17 -PSTRMS_E_0257
CFE detected a CRC error in the RTU response. Error reported for %s ""%s"" in
merflg/mrxflg field (%s) of MPASS message.
Explanation: The CFE Reader detects the CRC error in the RTU response from the
scan group %s. merflg = 0x0002
Action: Check the communication between the RTU and the front end.

1.12.18 -PSTRMS_E_0302
Module CFE in port dataset ""%s"" has UP QUEUE FULL. Check the
CFE_PARAM_HIWATER and CFE_PARAM_LOWWATER in cfe_param.h file.
Explanation: The CFE module detected a strong flow of unsolicited messages, which is
causing an overflow of the queue buffer because the HIWATER queue limit is too small.
Action: Check the communication between the RTU and the front end, and, if needed,
increase the increase the HIWATER queue limit.

1.12.19 -PSTRMS_E_0082
CHANEL %d reports following error: ""%s.
Explanation: This message is used by CFE to report an error condition.
Action: Turn on the CFE Event Log to record the errors, and send the log to
Alstom Grid customer support for further analysis.

1.12.20 -PSTRMS_E_0184
CFE "CFE dataset name" failed to enable port "Port1 name" for "Rtu1 name" RTU
Explanation: This message is used by CFE for errors when opening ports. "Failed to
enable" messages in CFEReader are usually related to failed Digi hardware or drivers,
or a failed Monaghan bit-to-byte board, firmware, or power supply.
Action: Check that the FEP can ping the Digi units before power cycling. Cycling power
to these components or reseating cables and cards might help fix the problem. Also,
check the Monaghan power supply voltages (+5V, +12V, and -12V) before power
cycling. The Digi View tool and B2B test tool can be used to check the status of these
devices and run rudimentary tests. Lastly you can try reprogramming or updating the
firmware on these devices.

Proprietary – See Copyright Page 83 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
1.12.21 -PSTRMS_W_ REQUEST_SKIP _0799
"""%s"" for the DataSet ""%s"" is skipped because ""%s""."
Explanation: This warning message is used by CFE Reader to indicate whether
Periodic scan/Integrity scan requests for a particular Scan Group data set were skipped
for some reason (for example, if an RTU is in WaitforOnline state, if an RTU is NIS, if a
Scan Group is NIS, etc.).
Action: Check whether the RTU or Scan Group is NIS, or if the RTU is initialized.

1.12.22 -PSTRMS_E_RTUPOL_0800
"PCL record ""%s"" does not exist for the rtu ""%s""."
Explanation: This error message is used by CFE Reader to indicate that PCL
parameter 451 is not defined in the RTU data set even though all other configurations
for Timed polling is done.
Action: Define PCL parameter 451 in the RTU data set.

Proprietary – See Copyright Page 84 CFE Reader

e-terracontrol Reference Manual: Interfaces to Field Devices
2. DNP Interpreter
When line monitor is enabled in the CFE diagnostics, this application is used to interpret
the DNP line monitor log generated by CFE Reader. This utility reads the line monitor
log information and creates an interpreted file that contains the detailed DNP protocol
information. This utility is needed to interpret the DNP Line Monitor log because CFE
Reader does not support the interpreted mode for DNP protocol.
Currently, CFE Reader only logs the raw DNP bytes into the line monitor log. You can
use this application to analyze the DNP raw protocol data.

2.1 DNP Interpreter Command-Line Arguments

A DNP Interpreter shortcut is not created during the installation of e-terracontrol
because there are command-line arguments associated with this application.
The following format is valid:
dnp_interpreter.exe <Input file name> <Output file name>
Where:
• <Input file name> is the name of the line monitor log file that was created by
CFEReader.
• <Output file name> is the name of the file to create that will contain the detailed DNP
protocol information.

2.2 Starting DNP Interpreter Using Process Starter

To launch the DNP Interpreter from the Process Starter:
1. From the e-terracontrol Start menu, open the Process Starter Console application
and ensure that the Process Starter service is running.
2. Connect the console to the Process Starter service by clicking the Connect button in
the Process Starter Console toolbar.
3. To create a new Process Starter group, proceed to step 4. To add the DNP
Interpreter application to an existing group, select File > Upload, and choose the
desired .psc file to display the Configuration tab for Processes (for more information,
refer to the e-terracontrol Reference Manual: Applications).
4. To create a new Process Starter group, select Processes > Add Process.
The Configuration tab for Processes opens (refer to the e-terracontrol Reference
Manual: Applications).
5. In the Name, Program, Params, and Directory text boxes, enter the required
information. If you do not know the location of the dnp_interpreter.exe file, click the

Proprietary – See Copyright Page 85 DNP Interpreter

e-terracontrol Reference Manual: Interfaces to Field Devices
 Ellipsis button (…) next to the Program text box to browse for the file. Sample values
are as follows:
Name: DNP Interpreter
Program: C:\eterra\e_terracontrol\bin\dnp_interpreter.exe
Params: C:\eterra\e_terracontrol\data\ cfe_line_monitor_Cfecontrol1_CFE_0.dat
C:\eterra\e_terracontrol\data\ DNP_Protocol_details.txt
Directory: C:\eterra\e_terracontrol\bin
6. If desired, select the Minimize check box.
7. If you do not want to see the graphical user interface, uncheck the Visible check box.
8. In the Restart frame, select the On Exit option.
9. Click OK.
10. Save the file.

Proprietary – See Copyright Page 86 DNP Interpreter

e-terracontrol Reference Manual: Interfaces to Field Devices
3. CFE Performance Driver
This application allows you to test performance on a database that normally uses CFE
Reader. It simulates the loading of the SCADA server by means of a user-definable
number of analogs, points, and counts.
This application can be launched from the Process Starter, a batch file, a command line,
or a Windows shortcut you have created with the appropriate command-line parameter
included.

3.1 CFE Performance Driver Command-Line Arguments

A CFE Performance Driver shortcut is not created during the installation of
e-terracontrol because there is a command-line argument associated with this
application.
The following format is valid:
~\cfeperfdriver <DataSourceName> host1=smpa host2=smpb host3=smpc
host4=smpd ScadaPort=5021
Where:
• <DataSourceName> is the name of the data source. This argument is optional.
• The host1, host2, host3, and host4 command-line arguments are used to designate
the host name(s) of the e-terracontrol server(s):
host1=<ComputerName>
host2=<ComputerName>
host3=<ComputerName>
host4=<ComputerName>
<ComputerName> is the name of the computer running the e-terracontrol server.
These IP alias names must be defined in the host file.
• ScadaPort is an optional argument for specifying the port that the SCADA server is
listening on if it is not the default port (5020 for NTLM/Kerberos authentication and
7000 for Certificate-based authentication).
Example: ScadaPort=5025

Proprietary – See Copyright Page 87 CFE Performance Driver

e-terracontrol Reference Manual: Interfaces to Field Devices
3.2 CFE Performance Driver User Interface

Figure 48. CFE Performance Driver User Interface

The following are included in the CFE Performance Driver user interface:
Header
• Send Analogs…Per Second: Indicates the number of analogs per second that are
sent from the application to the SCADA server. If left unchecked, the application
does not send any analogs.
• Send Statuses…Per Minute: Indicates the number of statuses per minute that are
sent from the application to the SCADA server. If left unchecked, the application
does not send any statuses.
• Send Accumulators…Per Second: Indicates the number of accumulators per
second that are sent from the application to the SCADA server. If left unchecked, the
application does not send any accumulators.
• Alarms Per Minute: Indicates the number of analog alarms (Limit Exceeding High
and Low alarms) to be generated in SCADA Server per minute. To generate the
alarms, CFE Performance Driver sends values exceeding the limit (high and low).
If the Send Analogs option is not selected, the application will not send any analog
alarms. Also, the cfeperfdata.txt file should be in the working directory
(C:\Eterra\e_terracontrol\bin).
For more information, see section 3.3 cfeperfdata.txt File Format.

Proprietary – See Copyright Page 88 CFE Performance Driver

e-terracontrol Reference Manual: Interfaces to Field Devices
• Log Changes: Enabling this option instructs the application to display the
measurement load count messages. These messages detail the number
measurement types loaded to the SCADA database on a per-second basis.
• Record History: Enabling this option instructs the application to record history in a
file named ‘CFEPerfDrivHist_<Datasource name>_<System time>.txt’, which is
created in the working directory (C:\Eterra\e_terracontrol\bin). To generate history
for analogs, you must set In Alarm to T in the cfeperfdata.txt file. Refer to section 3.3
cfeperfdata.txt File Format.
• Send Burst of … Analogs … Alg. Alms … Statuses … Accumulators: Use these
controls to send a burst of measurements and Analog alarms to the SCADA server.
For Analog alarms, the cfeperfdata.txt file should be in the working directory. Refer
to section 3.3 cfeperfdata.txt File Format.

Note: This is a demand measurement transfer, versus the previously described

per-second scheduled measurement transfers.

3.3 cfeperfdata.txt File Format

The cfeperfdata.txt file is located in the CFE Performance driver application's working
directory. This file contains the following information for Analog measurements:
• Measurement Name
• Max Value
• Min Value
• T (True) or F (False) indicating whether alarms are generated (In Alarm)
• Limit High
• Limit Low
Fields should be separated by tabs. CFE Performance Driver reads this file at startup
and sends value for violating Analog limits to SCADA Server (you must set In Alarm to
T). A sample file is shown below.
Douglas Cb_1311 Mw 1000 -1000 T 50 0
Douglas Ln_T538 Mvar 1000 -1000 T 100 -100
Douglas Xfmr_T1 Mw 1000 -1000 T 100 0
Douglas Xfmr_T1 Mvar 1000 -1000 T 50 -50
Douglas Xfmr_G1 Mw 1000 -1000 T 200 -200
Douglas Xfmr_G1 Mvar 1000 -1000 T 200 0
Douglas Xfmr_G2 Mw 1000 -1000 T 150 -150
Douglas Xfmr_G2 Mvar 1000 -1000 T 150 0

Proprietary – See Copyright Page 89 CFE Performance Driver

e-terracontrol Reference Manual: Interfaces to Field Devices
4. ScanMonitor Application
ScanMonitor is a separate application that connects to the SCADA server to monitor the
Dataset Cards Integrity Scan. Every minute, the ScanMonitor application iterates
through all of the RTUs. It compares the Last Load Time (as shown on RTUSTATE) on
all of the cards of the periodic scan groups to the integrity rate. If the Last Load Time
indicates that the modeled number of integrity rate periods have passed without a
response from the RTU, the RTU is alarmed.
All of this logic is completely bypassed if the RTU is failed or offline. This logic is also
bypassed if the RTU or scan group changes state within the timeout period – this
prevents false alarms in cases where a path switches or an RTU is removed and
restored.
The ScanMonitor application calculates the integrity rate period based on the values
retrieved in the Dataset parameter string, which is defined in the configuration during
SCADA modeling. The integrity Scan Rate is calculated with the ScanRate and
IntegrityRate parameters defined into the Dataset “ScanGroup” parameters string.

4.1 ScanMonitor Command-Line Arguments

The command-line arguments are:
–DATASOURCE <data source name>: The data source name defined in the
e-terracontrol SCADA server. This argument is required when starting the application.
–MISSED_INTEGRITY_RATE <value>: Number of allowed “missed” Integrity Scan
periods. The default value is 1.
–HOST1 <host1 name>: Host1 name of the e-terracontrol SCADA server.
–HOST2 <host2 name>: Host2 name of the e-terracontrol SCADA server.
–PORT <port number>: Listen port of the e-terracontrol SCADA server. The default
value is 5020 for NTLM/Kerberos authentication and 7000 for Certificate-based
authentication.
–ALARM_MESSAGE <“alarm string”>: The alarm string appears in the Alarm/Event
list value field. The default string is “Integrity Rate Timeout”.
–ALARM_PRIORITY <priority>: Numerical priority value for the alarm. Possible values
are between 1 and 8; the default priority is 1.
–ALARM_COLOR <color>: Numerical color value for the alarm. Possible values are: 0
(black), 1 (red), 2 (green), 3 (cyan), 4 (blue), 5 (orange), 6 (yellow), and 7 (magenta).
The default value is 0.
–EVENT_ONLY: Only generate events, no alarms.
–?: Displays the command-line options.

Proprietary – See Copyright Page 90 ScanMonitor Application

e-terracontrol Reference Manual: Interfaces to Field Devices
Command line example:
~\ScanMonitor.exe -MISSED_INTEGRITY_RATE 5 -DATASOURCE Scanner -ALARM_MESSAGE
"Integrity Scan Timeout" -ALARM_COLOR 1 -ALARM_PRIORITY 2

4.2 SCADA Modeling and Configuration

In the SCADA server model, a new device data source needs to be defined. Under the
“Data Sets” tab of the Data Source properties, CFE Reader data sets should be
assigned with read access. Multiple data sets can be assigned to the same data source.
The name of the data source should then be passed to the ScanMonitor Application in
the command line.
Multiple instances of ScanMonitor, connected to different data sources, can run
simultaneously on the same machine.
In order to avoid false alarms when the ScanMonitor application is restarted, the already
“alarmed” datasets are kept for reference in an XML database in the application working
directory under the name AlarmedDataset_<datasourcename>.xml. This file should not
be manually modified.

4.3 ScanMonitor User Interface

Figure 49. ScanMonitor User Interface

The ScanMonitor user interface displays the log messages generated by the
application. This log is also saved into a file under the application working directory with
the name ScanMonitor_<datasourceName>.txt. When the file size is greater than 5 MB,
a new file is created. The old log file is kept in the same directory, but is renamed with a
concatenated timestamp.

Proprietary – See Copyright Page 91 ScanMonitor Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5. OPC Client Application
OPC provides interoperability in industrial automation through a series of open
specifications that standardize the acquisition and control of process data, alarms, and
event records. Alstom Grid’s OPC Client application is enhanced with the Data Access
(DA) and Unified Architecture (UA) specifications from the OPC Foundation. The OPC
Client can be configured both as a DA client, which communicates with DA servers, and
as a UA client, which communicates with UA servers.

5.1 OPC Data Access Support

The OPC DA specification is an Object Linking and Embedding (OLE) technology for
the Process Control Data Access client. When the OPC Client application acts as a DA
client, it can address the DA specification that defines an interface between client and
server programs to access process data. DA servers provide one or several DA clients
with transparent access to different data sources (e.g., sensors) or data sinks (e.g.,
controllers). For more information, refer to the “OPC DA Server Application” section in
the e-terracontrol Reference Manual: Interfaces to External Systems. Alstom Grid’s
OPC Client can be configured to access several DA servers at the same time.
An example OPC Client DA configuration is included in the emp60_rtus.sdb sample
database. The example is based on two hypothetical stations called the Kirkland Station
and the Redmond Station. This database has an OPC server data source, which reads
the Kirkland measurement values, and an OPC Client data source, which connects to
that OPC server and loads those Kirkland measurement values into analogous
measurements in the Redmond Station.

5.2 OPC Unified Architecture Support

UA is the next generation OPC standard that provides a cohesive, secure, and reliable
cross-platform framework for access to real time and historical data and events. It
provides a path forward from the original OPC communications model (namely
COM/DCOM) to a cross-platform service-oriented architecture (SOA) for process
control, while enhancing security and providing an information model.
The existing OPC Client in e-terracontrol also supports a limited subset of OPC UA.
The below limitations apply to the e-terracontrol OPC UA client implementation:
1. Only the functionality provided by the existing OPC DA client is supported as a UA
client (effectively just the DA specification).
2. Only analog, status point, and accumulator values are loaded in the e-terracontrol
SCADA server.
3. Controls and setpoints received from the SCADA sever are written to the OPC UA
server to specific data items.
4. Reading of scalars is not supported.

Proprietary – See Copyright Page 92 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5. OPC arrays are not supported.
6. Complex data is not supported.
Integrated modeling with e-terrasource is not supported. This is because the
e-terraplatform SCADAMOM is not able to represent general communication Datasets.

5.3 OPC Client Command-Line Arguments

The following is a description of the OPC Client executable command-line arguments,
which can be used when starting OpcClient.exe from the command line or from the
Process Starter.
A sample of the OPC Client command-line parameters is:
OpcClient.exe /host1 smpa /host2 smpb /host3 smpc /host4 smpd /port 5025
/sourcename performancecounter OPCSrc
Where:
• The /host1, /host2, /host3, and /host4 command-line arguments are used to
designate the host name(s) of the e-terracontrol server(s):
/host1 <ComputerName>
/host2 <ComputerName>
/host3 <ComputerName>
/host4 <ComputerName>
<ComputerName> is the name of the computer running the e-terracontrol server.
These IP alias names must be defined in the host file.
• port is an optional argument for specifying the port that the SCADA server is
listening on if it is not the default port (5020 for NTLM/Kerberos authentication and
7000 for Certificate-based authentication).
Example: /port 5025
• The /sourcename command-line argument is used to designate the data source in
the SCADA server’s database that the OPC Client application connects to:
/sourcename <DataSourceName>
where <DataSourceName> is the name of the data source in the SCADA server
database.
• The performancecounter option is used to enable performance counter functionality.

5.4 Starting the OPC Client Using the Process Starter

The Process Starter application can start and restart programs as required. This is
useful in situations where the OPC Client remains continuously active on certain PCs.

Proprietary – See Copyright Page 93 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
 Note: According to the configuration of the Process Starter service, the GUI of the
managed programs (programs launched by the Process Starter service, here the OPC
Client) may be not visible. For more details, refer to the chapter “Configuration of the
Process Starter” in the e-terracontrol Reference Manual: Applications.

1. From the e-terracontrol Start menu, open the Process Starter Console application,
and be sure that the Process Starter service is running.
2. Connect the console to the Process Starter service by clicking the Connect button in
the Process Starter Console toolbar.
3. To create a new Process Starter group, proceed to step 4. To add the OPC Client
application to an existing group, select File > Upload, and choose the desired .psc
file to display the Configuration tab for Processes (see the e-terracontrol Reference
Manual: Applications).

Note: Prior to adding a process to an existing group, you must end all processes
by clicking Stop on the Process Starter toolbar or via the Actions menu item (see
“Process Starter Console Toolbar” and “Process Starter Console Menu Bar” in the
e-terracontrol Reference Manual: Applications).

4. To create a new Process Starter group, select Processes > Add Process.
The Configuration tab for Processes opens (see the e-terracontrol Reference
Manual: Applications).
5. In the Name, Program, Params, and Directory text boxes, enter the required
information. If you do not know the location of the OpcClient.exe file, click the Ellipsis
button (...) next to the Program text box to browse for the file. Sample values are as
follows:
Name: OPC Client
Program: C:\eterra\e_terracontrol\bin32\OpcClient.exe
Params: /host1 smpa /host2 smpb /host3 smpc /host4 smpd /Port <port number>
/sourcename OPCSrc
Directory: C:\eterra\e_terracontrol\bin32
6. If desired, select the Minimize check box.
7. If you do not want to see the GUI, uncheck the Visible check box.
8. In the Restart frame, select the On Exit radio button.
9. Click OK.
10. Save the file.

Proprietary – See Copyright Page 94 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.5 OPC Client User Interface
The user interface for the OPC DA client application is a window with four tabs:
Namespace, Status and Statistics, Log, and Settings.
The Namespace tab allows you to manage the OPC servers, groups, and items. The
Status and Statistics tab provides OPC connection information. A display of the OPC
Client application log is provided on the Log tab. Finally, the Settings tab provides
control of logging.

5.5.1 OPC Client User Interface – Namespace Tab

Figure 50. OPC Client User Interface – Namespace Tab

The following are included on the Namespace tab:

Server and Groups: A listing of the currently configured OPC server and OPC groups.
The connection status is indicated with the traffic light symbol.
• OPC Server: The OPC server object maintains information about the OPC server
and serves as a container for OPC group objects.
• OPC Groups: OPC groups provide a way for clients to organize data. For example,
the group might represent items in a particular operator display or report.
– ItemName: OPC items represent connections to data sources within the server.
The OPC item simply specifies the address of the data, not the actual physical
source of the data that the address references.
– Value: Value of the OPC item
– Status: Status of the OPC item
– Data Type: OPC item’s data type
– Time Stamp: Time stamp of the last OPC item refresh

Proprietary – See Copyright Page 95 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.5.2 OPC Client User Interface – Status and Statistics Tab

Figure 51. OPC Client User Interface – Status and Statistics Tab

The following are included on the Status and Statistics tab:

Status: These parameters are read-only.
• Host1: Host1 name as passed from the command-line argument to the OPC Client
application.
• Host2: Host2 name as passed from the command-line argument to the OPC Client
application.
• Host3: Host3 name as passed from the command-line argument to the OPC Client
application.
• Host4: Host4 name as passed from the command-line argument to the OPC Client
application.
• Source Name: e-terracontrol data source name as passed from the command-line
argument to the OPC Client application.

Proprietary – See Copyright Page 96 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
Statistics
• ServerName: Node name and ProgID of the OPC server to which a connection is
established. This is displayed in the format NodeName:ProgID.
• Conn:Mode – Local or Remote: Connection mode showing whether the OPC
server is running on a local machine or not.
• Status: Current status of the OPC server.
• #Groups: Number of groups the client has added to the OPC server.
• #Items: Number of items the client has added to the OPC server.
• #Item Reads/On Data Changes: Number of data change events received from the
OPC server.
• Ctrl & Setpoint Values Rcvd: Number of controls and setpoints issued to the OPC
server.

5.5.3 OPC Client User Interface – Log Tab

Figure 52. OPC Client User Interface – Log Tab

The Log tab provides a display of the OPC Client application log.
Log filtering is configured on the Settings tab.

Proprietary – See Copyright Page 97 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.5.4 OPC Client User Interface – Settings Tab

Figure 53. OPC Client User Interface – Settings Tab

The following are included on the Settings tab:

Log Parameters
• Log to File: Enables logging to the OPCClient_<datasourceName>_<time>.log file.
The logs are written to the file on 5 minute intervals or when the log reaches 50
entries.
• Log to Display: Enables logging to the Log tab of the user interface.
• Log Debug: Enables logging of debug messages.
• Log Trace: Enables trace logging.
• Log Warnings: Enables logging of warning messages.
• Log Infos: Enables logging of informational messages.
• Log Errors: Enables logging of error messages.
• Max. Log File Size (MB): Maximum file size before opening a new logging file.
• SCADA Device Log: Enables logging of SCADA device events.

Proprietary – See Copyright Page 98 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
Save
• Save the configuration to an XML file with the name
“OPCClient<DataSourceName>.xml”. This file is loaded when the application
restarts.

5.6 OPC Client Configuration

The OPC Client application can only be configured from a SCADA database via data
sets. The following sections detail each configuration option.

5.6.1 Configuration via a SCADA Database

A data set is a structure that contains, in the form of a parameter string, all parameters
that model a communications object. The data set collection is organized in a
hierarchical way:
• OPCDS: Provides the parent data set in the hierarchy.
• OPCServerDS: Contains the configuration parameters for the OPC server. In the
communications hierarchy, it is a child of the OPCDS data set.
• OPCGroupDS: Contains the configuration parameters for the OPC group. In the
communications hierarchy, it is a child of the OPCServerDS data set.
• OPCItemDS: Contains the configuration parameters for the OPC group. In the
communications hierarchy, it is a child of the OPCGroupDS data set.
The hierarchy of data that relates to the OPC Client application is shown in Figure 54.

Proprietary – See Copyright Page 99 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 54. OPC Client Data Set Hierarchy

Proprietary – See Copyright Page 100 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.6.1.1 OPCDS Data Set
Data set configuration is performed in the SCADA server application (see “Data Set
Dialog Box” in the e-terracontrol Reference Manual: Applications).

Figure 55. OPCDS Data Set Dialog Box

There are no parameters required for this data set.

5.6.1.2 OPCServerDS Data Set

Data set configuration is performed in the SCADA server application (see “Data Set
Dialog Box” in the e-terracontrol Reference Manual: Applications).

Figure 56. OPCServerDS Data Set Dialog Box

Proprietary – See Copyright Page 101 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• OPCServerName: The ProgID of the OPC DA server or the endpoint URI of the
OPC UA server.
• OPCServerNode: Node name in which the OPC server is running.
• Explore Rate: Server connection check period. The range of explore rate is from 2
seconds to 9999 seconds.
• OPCServerType: The type of OPC server to which the OPC Client will connect. The
two supported values are “DA” and “UA”. Specify “DA” for connecting to OPC DA
servers and “UA” for connecting to OPC UA servers. If this parameter is not
specified, the default value is “DA”.
• StorePath: The location of the application certificate, which is used to authenticate
with the UA server. This is required only if “OPCServerType” is specified as UA.
Unless the SecurityPolicy of the UA server is set to None, this certificate should be
in the trusted client certificate list on the UA server. For more information, see
section 5.6.3 OPC UA Certificate Configuration.
• NamespaceName: The name of the Namespace in the UA server’s
NamespaceArray. OPC Client will create NodeIds based on this Namespace name.

5.6.1.3 OPCGroupDS Data Set

Data set configuration is performed in the SCADA server application (see “Data Set
Dialog Box” in the e-terracontrol Reference Manual: Applications).

Figure 57. OPCGroupDS Data Set Dialog Box

Proprietary – See Copyright Page 102 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• OPCGroupName: The name of the OPC group in the OPC Client database.
• OPCGroupUpdateRate: The OPC group update rate in milliseconds. This
determines the interval of how often the exception limit is checked. If the exception
limit is exceeded, the CACHE is updated. The server should make a “best effort” to
keep the data fresh. This also affects the maximum rate at which notifications are
sent to the IAdvise sink. The server should never send data to a client at a rate
faster than the client requests.
• OPCGroupDeadBand: The minimum required change in the value of the group’s
OPC items before a change event is generated. The range of the deadband is from
0.0 to 100.0 percent. Deadband only applies to items in the group that have a
dwEUType of Analog available. If the dwEUType is Analog, the EU Low and EU
High values for the item can be used to calculate the range for the item.
• OPCGroupActiveState: True or False value as to whether the OPC Client link to
the server is active for the group OPC items.
• OPCGroupTimeBias: Difference between the server and client time zone in
minutes.
This parameter is optional.
• OPCGroupSuppressTimeChange: True or False value as to whether the OPC
Client suppresses the OPC event when only the timestamp is changed (i.e., no
change in value/quality). If the value is True, it suppresses the OPC event when only
the timestamp is changed. If this parameter is not defined, the default value is False.
• OPCGroupIsSubscribed: True or False value as to whether the OPC Client
registers to receive updates from the server for the OPC Items group. If the value is
False, the OPC Client does not display OPC Items while clicking the OPCGroupDS
tree node. The default value is False.
• OPCDataType: OPC item’s data type:
– 0: VT_EMPTY (nothing)
– 1: VT_NULL (null type)
– 2: VT_I2 (2-byte signed integer)
– 3: VT_I4 (4-byte signed integer)
– 4: VT_R4 (4-byte real)
– 5: VT_R8 (8-byte real)
– 8: VT_BSTR (OLE automation string)
– 16: VT_I1 (signed char)
– 17: VT_UI1 (unsigned char)

Proprietary – See Copyright Page 103 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
 – 18: VT_UI2 (unsigned short)
– 19: VT_UI4 (unsigned long)
– 22: VT_INT (signed machine integer)
– 23: VT_UINT (unsigned machine integer)
– 8194: VT_ARRAY | VT_I2 (array of 2-byte signed integers)
– 8195: VT_ARRAY | VT_I4 (array of 4-byte signed integers)
– 8196: VT_ARRAY | VT_R4 (array of 4-byte reals)
– 8197: VT_ARRAY | VT_R8 (array of 8-byte reals)
– 8200: VT_ARRAY | VT_BSTR (array of OLE automation strings)
– 8208: VT_ARRAY | VT_I1 (array of signed chars)
– 8209: VT_ARRAY | VT_UI1 (array of unsigned chars)
– 8210: VT_ARRAY | VT_UI2 (array of unsigned shorts)
– 8211: VT_ARRAY | VT_UI4 (array of unsigned longs)
– 8214: VT_ARRAY | VT_INT (array of signed machine integers)
– 8215: VT_ARRAY | VT_UINT (array of unsigned machine integers)
The current UA implementation does not have the enhancement to access
OPCDataType Array types from 8194 to 8215; therefore, configuration modeling
cannot include the Array data.

Proprietary – See Copyright Page 104 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.6.1.4 OPCItemDS Data Set
Data set configuration is performed in the SCADA server application (see “Data Set
Dialog Box” in the e-terracontrol Reference Manual: Applications).

Figure 58. OPCItemDS Data Set Dialog Box

The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• OPCDataType: OPC item’s data type. The data type list is provided in section
5.6.1.4 OPCItemDS Data Set.
A single OPCGroupDS or OPCItemDS data set can only contain data items that
reference tags of one specific type (the type specified by the “OPCDataType”
parameter). It is not possible to mix types within a single OPCGroupDS or OPCItemDS
data set.
The OPC Client DA implementation supports the retrieval of OPC array data in addition
to individual tag data. Arrays can be retrieved by specifying the appropriate array type
through the “OPCDataType” parameter. The retrieval of array data requires a specific
format for the Data Item Name fields within the OPCGroupDS or OPCItemDS data set
(as discussed in section 5.6.1.5 Data Items).
String data (VT_BSTR) is treated as special. The first four characters of the string are
extracted, converted to an integer value, and added up. That integer value is loaded as
an analog value. The rest of the string is ignored.
Arrays of strings (VT_ARRAY | VT_BSTR) are also treated as special. For each string
array element, the first four characters of the string are extracted, converted to integer
values, and added up. Those integer values are loaded as analog value elements in the
array.
For string conversion details, refer to the table below:

Proprietary – See Copyright Page 105 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
 String First 4 Chars Value
START 83+84+65+82 314
Start 83+116+97+114 410

• OPCActiveState: A True or False value as to whether the OPC Client link to the
server is active for the OPCItem.
• OPCAnalogScalingEnabled: True or False value indicating whether scaling and
deadbanding should be applied to analog values loaded from the OPC Client. The
parameter defaults to False.
If the value is True, the OPC Client loads values through an interface that applies
raw to engineering scaling and analog deadbanding per the parameters on the
associated data item.

5.6.1.5 Data Items

Data item objects belong to the OPCGroupDS or OPCItemDS data set, and they are
linked to measurement and control objects. Data item parameters include point name,
point index, raw low/high, engineering low/high, deadband, scale, and
measurement/control linkages.
For column descriptions, refer to the “Data Items Tab for Data Set” section in the
e-terracontrol Reference Manual: Applications.
The name of the data item should be different for DA and UA clients.
If the OPC Client application acts as a DA client, you must follow the modeling
guidelines below:
• The Name field for each data item within an OPCGroupDS or OPCItemDS data set
must be set to the fully qualified tag name in the OPC server. The OPC Client uses
this information in order to subscribe to the tag in the OPC server.
An example of a typical data item name is:
Channel_1.Device_1.Speed
Of course, a tag with this exact name must be present within the OPC server.
• A special format must be used for the Data Item Name field when array data is to be
retrieved from the OPC server. Since OPC arrays may contain many entries, you
must specify both the tag of the array and the element of the array that is to be
retrieved.
For an OPCGroupDS or OPCItemDS data set that is used to retrieve array data,
each data item name must include an indication of both the array tag (from where
the data is to be retrieved) and the array index. The format of the Data Item Name
field for array data must be specified as Tag[Index], where Tag is the tag of the array
within the OPC server and Index is the numeric zero-based index of the particular
element to be retrieved from the array.

Proprietary – See Copyright Page 106 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
 An example of the data item name for a typical array element is:
Channel_1.Device_1.Distance[5]
In this example, the tag of the array in the OPC server is
“Channel_1.Device_1.Distance”, and you have specified that the value at index 5 in
this array is to be retrieved (this is the sixth element in the array).
• Regarding the data items within an OPCGroupDS or OPCItemDS data set that is
used to retrieve array data, the following points should be noted:
– It is not necessary to map all elements of an array that is to be retrieved (using
separate data items within the OPCGroupDS or OPCItemDS data set). Rather,
data items only need to be created for the particular elements of the array(s) that
are required.
– Separate data items within the same OPCGroupDS or OPCItemDS data set can
retrieve data from separate elements of distinct arrays in the OPC server (simply
by specifying the appropriate tag and index information in each case).
– Several elements of the same array can be retrieved in a single OPCGroupDS or
OPCItemDS data set. There are no ordering restrictions.
– An OPCGroupDS data set can include multiple OPCItemDS data sets, some of
which retrieve non-array data and some of which retrieve array data.
– When an array of data is received, a single quality flag is provided by the OPC
server. This quality flag is applied to all members of the array when the data is
written to SCADA.
– When an array of data is received, a single time stamp is provided by the OPC
server. This time stamp is applied to all members of the array when the data is
written to SCADA.
For OPCUA clients, the modeling guidelines are below:
• Currently, the OPC UA client only supports the GUID IdType NodeIds in the OPC
UA server. You need to specify the GUID as a data item in the OPCGroupDS or
OPCItemDS dataset.
An example data item name is: {5c1aaed5-98d9-494a-afc9-3e6cbc125a6a}
Some general restrictions on the use of the Data Item Name field are as follows:
• Each data item name must be unique within each OPCGroupDS data set. That is,
mapping the same tag more than once within any OPCItemDS data set under an
OPCGroupDS data set is not permitted. If the same tag must be mapped to different
measurements, each instance of the tag must be placed in a separate
OPCGroupDS data set.

5.6.1.6 Controls and Setpoint Configuration

To execute a control or setpoint through the OPC Client application, you need a special
kind of data set modeling, as described below.
Proprietary – See Copyright Page 107 OPC Client Application
e-terracontrol Reference Manual: Interfaces to Field Devices
First, add a new OPCItemDS data set under the existing OPCItemDS data sets on
which the Status and Analog measurement points are configured. This hierarchy is
shown in Figure 59.
For OPC DA control execution:
1. On the newly added OPCItemDS data set, identify the fully qualified tag name in
OPCServer for the control. This tag should have write permission.
2. Create a data item, and include the tag name identified above in the data item’s
name, as follows: “<Fully qualified tag name in OPCServer>:<value to be written
(0 or 1)>”.
3. Map the control point as a measurement linkage to this data item.
4. On the parent data set (OPCGroupDS or OPCItemDS) of the newly added
OPCItemDS data set, add one more data item with same name as the tag identified
in step 1.
There is no requirement to associate this new data item with a measurement
linkage. If a measurement linkage is associated, a SCADA user can use this
measurement value to verify whether the control is properly issued.
For OPC DA setpoint execution:
1. On the newly added OPCItemDS data set, identify the fully qualified tag name in
OPCServer for the setpoint. This tag should have write permission.
2. Create a data item, and use the tag name identified as the data item’s name.
3. Map the setpoint measurement as a measurement linkage to this data item.
4. On the parent data set (OPCGroupDS or OPCItemDS) of the newly added
OPCItemDS data set, create a data item with the same name as the identified tag
name in the existing OPCItemDS data set from step 1.
There is no requirement to associate this new data item with a measurement
linkage. If a measurement linkage is associated, a SCADA user can use this
measurement value to verify whether the setpoint is properly issued.
For OPC UA control execution:
1. On the newly added OPCItemDS data set, identify the GUID of a node in the OPC
UA Server for the control. This node should have write permission.
2. Create a data item, and include the identified GUID as the data item’s name, as
follows: “<GUID>:<value to be written (0 or 1)>”.
3. Map the control point as a measurement linkage to this data item.
4. On the parent data set (OPCGroupDS or OPCItemDS) of the newly added
OPCItemDS dataset, add one more data item with same name as the GUID
identified in step 1.
There is no requirement to associate this new data item with a measurement linkage. If
a measurement linkage is associated, a SCADA user can use this measurement value
to verify whether the control is properly issued.

Proprietary – See Copyright Page 108 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
For OPC UA setpoint execution:
1. On the newly added OPCItemDS data set, identify the GUID of a node in the OPC
Server for the setpoint. This node should have write permission.
2. Create a data item, and use the identified GUID as the data item’s name.
3. Map the setpoint measurement as a measurement linkage to this data item.
4. On the parent data set (OPCGroupDS or OPCItemDS) of the newly added
OPCItemDS data set, create a data item with the same name as the identified GUID
in the existing OPCItemDS data set from step 1.
There is no requirement to associate this new data item with a measurement linkage. If
a measurement linkage is associated, a SCADA user can use this measurement value
to verify whether the setpoint is properly issued.

Figure 59. OPC Client Data Set Hierarchy

For control and setpoint configurations, it is not necessary to create an OPCItemDS

data set under the existing OPCItemDS data set and map the control and setpoint in
this new data set. The entire data item configurations mentioned in the new data set can
be done in the parent data set as well. If the entire modeling is done in the parent data
set, the following inconvenience can happen:
1. OPC Client creates OPC Items for the controls or setpoints and tries to add a read
subscription for the same in the specified OPC Server.
2. Since the OPC Server does not have this specified tag name or GUID (in case of
control), OPC Client fails to get a subscription. As a result, in the OPC Client
interface, the value for the specified control point is always displayed as “-1” with
“bad” quality.

Proprietary – See Copyright Page 109 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
The advantage of configuring the control measurements in a new OPCItemDS data set
under the existing OPCItemDS data set is that the OPC DA Client application will never
show these items in its user interface. As a result, the user never has to wonder how the
OPCServer discards the subscriptions for the specified points.

Note: For controls, the current OPC Client application only supports the values “0”
and “1”. If a data item is modeled with a value other than “0” or “1”, the OPC Client
application throws the error “OnExecuteControlEx event received for the
dataset::Failed to issue OPC Write : Error in Value”.

5.6.2 Configuration File

Log settings are saved in a configuration file named
“OPCClient<DataSourceName>.xml”. This file is loaded when the application restarts.

5.6.2.1 Configuration File Example

<?xml version="1.0" encoding="utf-8"?>
<LogDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<LogToFile>true</LogToFile>
<LogCount>1000</LogCount>
<LogToDisplay>true</LogToDisplay>
<LogTrace>false</LogTrace>
<LogWarnings>false</LogWarnings>
<LogInformation>false</LogInformation>
<LogErrors>true</LogErrors>
<LogDebug>true</LogDebug>
<MaximumFileSize>3</MaximumFileSize>
<SCADADeviceLog>true</SCADADeviceLog>
</LogDetails>

5.6.3 OPC UA Certificate Configuration

For the OPC UA servers, which demand self-signed certificate authentication, Alstom
Grid’s OPC Client provides a self-signed certificate with the e-terracontrol installation.
This certificate should be imported to the Windows Certificate store. The user
configuring the system should have Administrator privilege.

Proprietary – See Copyright Page 110 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.6.3.1 Importing a Certificate into the Windows Certificate Store
1. From the Windows Run dialog box, enter “mmc” to open the Microsoft Management
Console.

2. On the File menu, click “Add\Remove Snap-in”.

Proprietary – See Copyright Page 111 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
3. In the Available snap-ins list, select the “Certificates” option, and click Add.

4. Select the “Computer account” option to manage the certificate. Click Next.

Proprietary – See Copyright Page 112 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5. Select the “Local computer” option and click Finish.

6. Click OK to close the “Add or Remove Snap-ins” dialog box.

7. Expand the folder “Console Root\Certificates (Local
computer)\Personal\Certificates”.

Proprietary – See Copyright Page 113 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8. Right-click in the middle pane of the MM Console and select “Import”.

9. At the “Certificate Import Wizard”, click Next.

10. Browse to the location of the certificate file “OpcUaCertificate.pfx” (provided with the
installation). Click Next.

11. Enter the provided password for the certificate. Click Next.
12. Select the “Place all certificates in the following store” option and click the Browse
button to select the store location where the certificate is to be placed. Normally the
selected store path is “Personal”. Click Next.

Proprietary – See Copyright Page 114 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
 Note: This store path needs to be specified as the “StorePath” OPCServerDS
dataset parameter on the SCADA server. If the store path is selected as
“Personal”, on the SCADA server, the parameter needs to be specified as
“StorePath= LocalMachine\My” under the OPCServerDS dataset.

13. Click Finish.

Proprietary – See Copyright Page 115 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.6.3.2 Trusting Client Application Certificates
After importing the certificate into the Windows certificate store, the OPC UA server has
to “trust” the imported certificate from the OPCClient application. If the OPC UA server
does not trust this certificate, the connection will not establish. The procedure for
trusting a client certificate varies from server to server. Refer to your server’s
documentation for instructions.

5.7 Viewing Server, Group, and Item Properties

5.7.1 Server Properties

In order to view server properties, use the following steps:
1. On the Namespace tab of the user interface, right-click inside the Server and Groups
Namespace panel.
2. From the pull-down menu, select Server Properties.
The Server Properties window appears for the OPC server.

Figure 60. OPC DA Server Properties Dialog Box

Proprietary – See Copyright Page 116 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.7.2 Group Properties
In order to view group properties, use the following steps:
1. Right-click the appropriate OPC subgroup.
2. From the pull-down menu, select Group Properties.
This action opens the Group Properties window.

Figure 61. OPC DA Group Properties Dialog Box

5.7.3 Item Properties

To use the user interface to add OPC items, use the following steps:
1. Click an OPC group.
2. From the items displayed in the right pane, select an item.
3. Right-click the item.
4. From the pull-down window, click Item Properties.
This action opens the Item Properties window.

Proprietary – See Copyright Page 117 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 62. OPC DA Item Properties Dialog Box

Figure 63. OPC UA Item Properties Dialog Box

Proprietary – See Copyright Page 118 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.8 OPC Client in Test Mode
The application can be initialized in Test mode by appending “TESTMODE” as the last
parameter to the command line during application initialization. This is in addition to the
normal command-line parameters for the OPC Client.
In Test mode, the operator can change the number of data change events that need to
be simulated by changing the value in the Update frequency/min. Also, the operator can
change the active state of the server to inactive and vice versa.
A sample of OPC Client command-line parameters is:
OpcClient.exe /host1 smpa /host2 smpb /sourcename OPCSrc TESTMODE

Figure 64. Namespace Tab in Test Mode

If the application is started in Test mode, a new menu named “TestMode” appears in
the main menu. Selecting the Test Mode menu invokes a dialog box for configuring the
server’s status and update frequency/min in Test mode.

Proprietary – See Copyright Page 119 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.8.1 Test Mode Configuration Dialog Box
Selecting the Test Mode menu invokes the Test Mode Configuration dialog box. This
dialog box lists the entire server and the following details:
• Update Frequency/Min
This is the number of data change event simulations that should happen in a minute
for this server.
• Active State of the Server
This is the current state of the server, which can be active or inactive.

Figure 65. Test Mode Configuration Dialog Box

Selecting the context menu of the selected server brings up a new dialog box. This
dialog box is used for setting the server status and update rate.

Proprietary – See Copyright Page 120 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
5.8.2 Changing Server Properties

Figure 66. Server Properties Dialog Box

This dialog box displays the selected server’s properties. The user can change the
server state from active to inactive, and can also change the update rate.

5.9 OPC Quality to e-terracontrol SCADA Quality Mapping

Below is a table of the OPC quality codes and the e-terracontrol SCADA server quality
codes they are mapped to.

Table 2. OPC Quality to e-terracontrol SCADA Quality Mapping

OPC Quality SCADA Server Quality
Bad Bad
BadCommFailure Bad
BadConfigurationError Bad
BadLastKnownValue Old
BadNotConnected Bad
BadOutOfService Bad
BadSensorFailure Bad
BadWaitingForInitialData Bad
Good Good
GoodLocalOverride Bad
Uncertain Bad
UncertainEUExceeded Bad

Proprietary – See Copyright Page 121 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
 OPC Quality SCADA Server Quality
UncertainLastUsableValue Old
UncertainSensorNotAccurate Bad
UncertainSubNormal Bad

Proprietary – See Copyright Page 122 OPC Client Application

e-terracontrol Reference Manual: Interfaces to Field Devices
6. PLC Reader Applications
The PLC Reader applications act as a communication interface to local devices. They
scan groups, they report the status and date of the last scan, and they provide
measurement values and quality information about a particular group. A log of the
scanning activity is also provided.
The PLC Reader applications include the Modbus Reader (ModbusReader.exe) and the
TI Reader (TIReader.exe).
These applications can be launched from the Process Starter application, a command
line, a batch file, or the installation-supplied Windows shortcut.

Figure 67. PLC Reader Applications

6.1 Modbus Reader Application

The Modbus Reader is used with the Modbus Protocol. It is a “master” application,
which can obtain its configuration from either data sets or configuration files.

6.1.1 Modbus Reader Command-Line Arguments

The following formats are acceptable, where p is the command-line argument switch
and <Argument> is the command-line argument value:
-p
-p <Argument>
-p=<Argument>
/p
/p <Argument>
/p=<Argument>
Multiple command-line arguments must be separated with the space character (“ ”). An
example command-line statement is:
~\ModbusReader.exe -n ReliatronicsRTU -u=1000

Note: In order to preserve backward compatibility, the Modbus Reader application

also accepts the command-line argument used in versions prior to e-terracontrol 3.1.
This applies to the following format:

Proprietary – See Copyright Page 123 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
~\ModbusReader.exe <ConfigurationFileName>

6.1.1.1 SCADA Source Name

The “n” SCADA Source Name command-line argument tells the Modbus Reader
application which data source the application should connect to in the SCADA server
application. This parameter is used only when defining the device configuration via data
set objects. When utilizing configuration file methods via the “-f” parameter, the
configuration file data source parameter is utilized.
-n <DataSourceName>

6.1.1.2 SCADA Timeout

The “s” SCADA Timeout command-line argument tells the Modbus Reader application
how long before it should log that the attempt to connect to SCADA has timed out. The
units are in milliseconds, and the default is 10000 (10 seconds).
-s <Interval>

6.1.1.3 Modbus Timeout

The “m” Modbus Timeout command-line argument tells the Modbus Reader application
how long it should wait before retrying a failed connection to the Modbus device. The
units are in milliseconds, and the default is 10000 (10 seconds).
-m <Interval>

6.1.1.4 Update Interval

The “u” Update Interval command-line argument provides the Modbus Reader
application with the user interface update interval. The interval value should be entered
as milliseconds.
-u <Interval>

6.1.1.5 Configuration File

The “f” Configuration File command-line argument tells the Modbus Reader application
which configuration file is to be used.
-f <ConfigurationFileName>

Proprietary – See Copyright Page 124 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
6.1.1.6 ScadaPort
This is an optional argument for specifying the port that the SCADA server is listening
on if it is not the default port (5020 for NTLM/Kerberos authentication and 7000 for
Certificate-based authentication).
-SCADAPORT=<port>

6.1.1.7 e-terracontrol Server Host(s) Designation

The /host1, /host2, /host3, and /host4 command-line arguments are used to designate
the host name(s) of the e-terracontrol server(s):
/host1 <ComputerName>
/host2 <ComputerName>
/host3 <ComputerName>
/host4 <ComputerName>
where:
• <ComputerName> is the name of the computer running the e-terracontrol server.
These IP alias names must be defined in the host file.

6.1.2 Starting the Modbus Reader Using the Process Starter

The Process Starter application can start and restart programs as required. This is
useful in situations where it is desired that the Modbus Reader remain continuously
active on certain PCs.
1. From the e-terracontrol Start menu, open the Process Starter Console application,
and be sure that the Process Starter service is running.
2. Connect the console to the Process Starter service by clicking the Connect button in
the Process Starter Console toolbar.
3. To create a new Process Starter group, proceed to step 4. To add the Modbus
Reader application to an existing group, select File > Upload, and choose the
desired .psc file to display the Configuration tab for Processes.

Note: Prior to adding a process to an existing group, you must end all processes
by clicking Stop on the Process Starter toolbar or via the Actions menu item (see
“Process Starter Console Toolbar” and “Process Starter Console Menu Bar” in the
e-terracontrol Reference Manual: Applications).

4. To create a new Process Starter group, select Processes > Add Process.
The Configuration tab for Processes opens.
5. In the Name, Program, Params, and Directory text boxes, enter the required
information. If you do not know the location of the ModbusReader.exe file, click the
Ellipsis button (…) next to the Program text box to browse for the file. Sample values
are as follows:
Proprietary – See Copyright Page 125 PLC Reader Applications
e-terracontrol Reference Manual: Interfaces to Field Devices
 Name: Modbus Reader(Master)
Program: C:\eterra\e_terracontrol\bin\ModbusReader.exe
Params: -n ReliatronicsRTU -u=1000
Directory: C:\eterra\e_terracontrol\bin
6. If desired, select the Minimize check box.
7. If you do not want to see the GUI, uncheck the Visible check box.
8. In the Restart frame, select the On Exit radio button.
9. Click OK.
10. Save the file.

6.1.3 Modbus Reader User Interface

Figure 68. Modbus Reader User Interface

The following are included in the Modbus Reader user interface:

Header
In the working folder of the Modbus Reader application, the following four settings can
be persisted in the SMP_ModbusReader.cfg file. Selecting the File > Save
Configuration menu option saves these four settings out to this file, and the Modbus
Reader automatically reads this file on startup.

Proprietary – See Copyright Page 126 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
• Enable Communications to PLC: Toggle ON to enable communication with the
Programmable Logic Controller (PLC). By default, this is toggled ON. This is
intended to aid troubleshooting and testing.
• Enable SCADA Connections: Toggle ON to enable SCADA connection. By default,
this is toggled ON. This is intended to aid troubleshooting and testing.
• Enable Trace: By default, this is toggled OFF. Toggle ON to enable trace. This
enables a more-detailed level of log messages intended for troubleshooting and
testing.
• Log to Disk: By default, this is toggled OFF. Toggle ON to record the log messages
to a disk file. The log file is in the working folder of the Modbus Reader and named
“ModbusReader_DataSourceName.log”, where DataSourceName is the name of the
data source and the Modbus Reader connects to the SCADA server. This log file
name is currently not configurable.
Scan Groups
• Scan Group: The groups specified to be scanned
• Status: Online, Failed, Unknown, or Uninitialized
• Last Scan: The date and time of the last scan
Data Items
• Measurement: The measurement names must match device names of
measurements and controls in SCADA.
• Value: This is the raw value (or the unconverted value, as opposed to the converted
“engineering” value) for each measurement.
• Quality: This is the Modbus Reader’s view of the data quality: U = Uninitialized,
B = Bad, and O = Old. No entry means good quality.
Log: Displays messages

6.1.3.1 Modbus Reader Menu Bar

The non-standard options on the menu bar are as follows:
Edit Menu

Note: When a data set configuration option is selected via the command-line
argument, this menu is disabled.

• Communications: Select to view the Communication Parameters Configuration

dialog box (see section 6.1.3.2 Communication Parameters Configuration Dialog
Box).
• Alarms: Select to view the Alarm Configuration dialog box (see section 6.1.3.3
Alarm Configuration Dialog Box).

Proprietary – See Copyright Page 127 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
Scan Groups Menu
• Insert: Select to insert a group to scan.
• Delete: Select to delete a group that is being scanned.
• Properties: Select to view the Scan Group Properties dialog box (see section
6.1.3.4 Scan Group Properties Dialog Box).
View Menu
• Errors: Select to view the PLC Errors dialog box (see section 6.1.3.5 PLC Errors).

6.1.3.2 Communication Parameters Configuration Dialog Box

Selecting Edit > Communications opens the Communication Parameters Configuration
dialog box (Figure 69).

Note: When a data set configuration option is selected via the command-line
parameter, this menu item is disabled.

Figure 69. Communication Parameters Configuration Dialog Box – Modbus Reader

Proprietary – See Copyright Page 128 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
The following are included in the Communication Parameters Configuration dialog box:
Common Properties
• Bit Packing: Toggle ON to enable bit packing. For example, in Modbus Reader,
32 input coils (bits) from the slave device are packed into two input coils (as 16-bit
values).
• PLC Address: The address that the master (the Modbus Reader) uses to poll the
PLC. The Modbus Reader and the PLC must match.
• Protocol: Select the desired protocol from the list box. The Modbus Reader and the
PLC must match. RTU protocol is recommended.
• Timeout (ms): The time period that the Modbus Reader waits for the PLC to
respond to a poll. One second (1000 ms) is the typical value.
• User Interface Update (ms): The user interface display update/refresh rate. One
second (1000 ms) is the typical value.
• SCADA Source Name: Name of the associated data source in the e-terracontrol
database.
• Control-Enabled Control Device Name: Name of the device where controls are
sent.
• Control-Enabled Status Device Name: Name of the device from which control
feedback is received.
• Control-Enabled Value: 0 for disabled, 1 for enabled.
• Use Serial Communication: When selected, the Modbus Reader uses a serial port
for communication.
• Use Ethernet Communications: When selected, the Modbus Reader uses
Ethernet communication.
Serial Communication Properties
• Baud Rate: Select the desired baud rate from the list box.
• Comm Port: Enter the communications port number that the Modbus Reader should
use to communicate with the PLC.
• Data Bits: Select the data bit convention from the list box.
• Parity: Select the parity from the list box. This is a standard asynchronous
communications parameter. For communications to work properly, the parity setting
of the Modbus Reader and the PLC must match.
• Stop Bits: Select the stop bits from the list box. This is a standard communications
protocol parameter. The Modbus Reader and the PLC must match.
Ethernet Communication Properties
• IP Address/Name: IP address or alias of the slave.

Proprietary – See Copyright Page 129 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
• IP Port: Enter the IP port number that the Modbus Reader should use to
communicate with the PLC.
• IP Header: Select the IP header from the list box. The header provides the size of
the information message being sent.

6.1.3.3 Alarm Configuration Dialog Box

Selecting Edit > Alarms opens the Alarm Configuration dialog box (Figure 70).

Note: When a data set configuration option is selected via the command-line
argument, this menu item is disabled.

Figure 70. Alarm Configuration Dialog Box – Modbus Reader

The following are included in the Alarm Configuration dialog box:

Header
• Area: The area assigned to a console where an alarm can be issued when an event
is posted.
• Category: The default alarm category.
• Exception Definition: The unique name defining an exception to the Alarm utility.
Events posted by Alarm’s clients identify one exception.
• Application Name: The name of the application reading the alarms.
Proprietary – See Copyright Page 130 PLC Reader Applications
e-terracontrol Reference Manual: Interfaces to Field Devices
EMP System 1 and EMP System 2
• Port: The listening port of the PROXYSRV application on e-terraplatform. Modbus
Reader issues alarms when the PLC fails or is restored, and when the OK timer
starts or stops updating.
• Host (1–4): These are the IP node names or addresses of the e-terraplatform
servers with PROXYSRV. They are used to issue alarms to e-terraplatform.

6.1.3.4 Scan Group Properties Dialog Box

Selecting Scan Groups > Properties opens the Scan Group Properties dialog box
(Figure 71).

Figure 71. Scan Group Properties Dialog Box – Modbus Reader

The following are included in the Scan Group Properties dialog box:
• Scan Group Name: The name of the scan group.
• Scan Type: From the drop-down box, select one of the following:
– Status: Reads inputs corresponding to Status objects in SCADA.
– Analog: Reads inputs corresponding to Analog objects in SCADA.
– Accumulator: Reads inputs corresponding to Accumulator objects in SCADA.

Proprietary – See Copyright Page 131 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
 – Control: A set of digital outputs.
– Setpoint: A set of analog outputs.
– OKTimer: A timer input that is incremented by the PLC software. If this stops
incrementing, it indicates that the PLC software is “stuck”, and the Modbus
Reader marks input measurements as bad quality.
– SetTime: Time output to the PLC. The PLC time is set to be the same as the
telemetry PC time.
– Freeze: Writes to the start address in order to freeze accumulators.
– FreezeRead: Writes to the start address, and reads from the end address, to
verify that Freeze was written.
• Time Interval (ms): This is the interval between scans of a scan group with a type
other than control. A 1000 entry directs Modbus Reader to scan every second. A
zero entry means to scan as fast as possible. For controls with translation
Control1to0, this field indicates the time between when a 1 is sent and a 0 is sent.
• Time Base (ms): Defines the base time for scanning a scan group. For example, to
scan two minutes after the hour, set this field to 120,000.
• Start Address: This is the starting address for this scan group. The Modbus Reader
scans from the start to the end address in one request to the PLC. This typically
corresponds to a register number in the PLC.
• End Address: This is the ending address for this scan group.
• Translation Type: From the drop-down box, select one of the following:
– Short: 2-byte unsigned number from 0 to 65536.
– ShortFFFFBad: 2-byte number. FFFF indicates that the value is bad.
– Short1Bit: 2 bytes of 16 individual status bits.
– ShortSignMagnitude: 2-byte number. The most significant digit is a sign bit.
– Short2Bit: 2 bytes of 8 individual status bits. The odd bits (1,3,5,...) are the
quality and the even bits (2,4,6,...) are the value. A 1 in the quality bit indicates
that the following status bit is bad quality.
– Short2sComplement: 2-byte number, 2s Complement.
– ModbusTime: PLC time format.
– Control1to0: For a control, a 1 is written to the PLC, followed later by a 0. The
time interval field specifies the number of milliseconds between the 1 and the 0.
– Control1: A 1 is written to the PLC on a control.
– Control0: A 0 is written to the PLC on a control.
– ControlMask0: Masks a single bit to 0. In response to a control, the Modbus
Reader reads the register, sets one bit of the value to 0, and then writes it back.

Proprietary – See Copyright Page 132 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
 – ControlMask1: Masks a single bit to 1. In response to a control, the Modbus
Reader reads the register, sets one bit of the value to 1, and then writes it back.
– LongUnsigned: Translates two 16-bit PLC registers as a single (longword)
integer.
– FloatMod: Translates the value of the register as an IEEE floating point.
– FloatModRaw: Translates the value of the register as an IEEE floating point, and
writes the value to the e-terracontrol database as a raw value.
– FloatModRaw1e6: Translates the value of the register as an IEEE floating point,
and writes the value to the e-terracontrol database as a raw value. The received
value is multiplied by 106 before it is written to the e-terracontrol database.
– FloatModRaw1e-6: Translates the value of the register as an IEEE floating
point, and writes the value to the e-terracontrol database as a raw value. The
received value is multiplied by 10-6 before it is written to the e-terracontrol
database.
– Float: Translates the value of the register as a floating point, and writes the value
to the e-terracontrol database in engineering units.
– FloatRaw: Translates the value of the register as a floating point, and writes the
value to the e-terracontrol database as a raw value.
– FloatRaw1e6: Translates the value of the register as a floating point, and writes
the value to the e-terracontrol database as a raw value. The received value is
multiplied by 106 before it is written to the e-terracontrol database.
– FloatRaw1e-6: Translates the value of the register as a floating point, and writes
the value to the e-terracontrol database as a raw value. The received value is
multiplied by 10-6 before it is written to the e-terracontrol database.
– ControlMask1to0: In response to a control, the Modbus Reader reads the
register, masks a single bit value to 1, sends this back to the register, waits the
Time Interval, and then masks the value to 0 and writes it back.
• Memory Type: This corresponds to the four Modbus types of memory (registers)
available in the Modbus PLCs.
• Maximum Consecutive Errors: Maximum number of unsuccessful communication
attempts before a failed condition is determined.
• Error Level: Select the level of error messages to be reported from the list box
(0 = None, 1 = Error, 2 = Warning, 3 = Info).
• Override PLC Address: In the Modbus Reader, define the PLC address in the
Edit > Communications dialog box. You can override this address in a scan group.
This feature is needed to support multi-drop PLCs.
• Write-Only Registers: For bitmasked control Scan Groups, disables reading the
register before writing.

Proprietary – See Copyright Page 133 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
6.1.3.5 PLC Errors
Selecting View > Errors opens the PLC Errors dialog box (Figure 72). The rows
correspond to the PLC errors that can be reported from the PLC driver. Continuous
timeout errors indicate that communications with the PLC are faulty. Other errors can
indicate a fault in the PLC rather than in the communications. All error counts are
cumulative.

Figure 72. PLC Errors Dialog Box – Modbus Reader

6.1.4 Data Set Configuration

The data set configuration is applicable when the “-n” (SCADA Source Name) is
supplied as a command-line argument without the “-f” (Configuration File) command-line
argument.

Proprietary – See Copyright Page 134 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
A data set is a structure that contains, in the form of a parameter string, all parameters
that model a communications object. The data set collection is organized in a
hierarchical way:
• ModbusPLCDS: Defines the global settings of the Modbus “slave” device.
• MBAlarmDS: Contains the configuration parameters for the alarms. In the
communications hierarchy, it is a child of the ModbusPLCDS data set.
• MBScanGroupDS: Contains the configuration parameters for a Scan Group. In the
communications hierarchy, it is a child of the ModbusPLCDS data set.
The hierarchy of data that relates to the Modbus Reader application can be found in
Figure 73.

Figure 73. Modbus Reader Data Set Hierarchy

Proprietary – See Copyright Page 135 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
6.1.4.1 Modbus PLC DS
Data set configuration is performed in the SCADA server application (see “Data Set
Dialog Box” in the e-terracontrol Reference Manual: Applications).

Figure 74. Modbus PLC Data Set

The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• General Parameters (Serial and Ethernet)
– BitPacking: Enables bit packing. For example, in Modbus Reader, 32 input coils
(bits) from the slave device are packed into two input coils (as 16-bit counters).
Valid values are True and False.
– PlcAddress: Address that the master (Modbus Reader) uses to poll the PLC.
– Protocol: Selected protocol entered as 0–1.
∗ 0 = ASCII
∗ 1 = RTU
– Timeout: Time period that the Modbus Reader waits for the device to respond to
a poll.
– EthernetMode: Enables Ethernet communications.
∗ True = Ethernet
∗ False = Serial
• Serial Only
– BaudRate: Baud rate entered as 0–14.
∗ 0 = 110 Baud
∗ 1 = 300 Baud

Proprietary – See Copyright Page 136 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
 ∗ 2 = 600 Baud
∗ 3 = 1200 Baud
∗ 4 = 2400 Baud
∗ 5 = 4800 Baud
∗ 6 = 9600 Baud
∗ 7 = 14400 Baud
∗ 8 = 19200 Baud
∗ 9 = 38400 Baud
∗ 10 = 56000 Baud
∗ 11 = 57600 Baud
∗ 12 = 115200 Baud
∗ 13 = 128000 Baud
∗ 14 = 256000 Baud
– CommPort: Communications port number.
– DataBits: Data bit conversion type entered as 0–1.
∗ 0 = 7 bits
∗ 1 = 8 bits
– Parity: Parity entered as 0–2.
∗ 0 = None
∗ 1 = Odd
∗ 2 = Even
– StopBits: Stop bits entered as 0–1.
∗ 0 = 1 bit
∗ 1 = 2 bits
• Ethernet Only
– IPAdrs: IP address or alias of the slave device.
– IPPort: IP port number that Modbus Reader should use to communicate with the
device.
– IPHeader: IP header entered as 0–1. The header provides the size of the
information message being sent.
∗ 0 = Modicon
∗ 1 = None

Proprietary – See Copyright Page 137 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
6.1.4.2 MB Alarm DS
Data set configuration is performed in the SCADA server application (see “Data Set
Dialog Box” in the e-terracontrol Reference Manual: Applications).

Figure 75. MB Alarm Data Set Dialog Box

The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• AlarmArea: Area assigned to a console where an alarm can be issued when an
event is posted.
• AlarmCategory: Default alarm category.
• AlarmException: Unique name defining an exception to the alarm utility.
• AlarmReaderName: Name of the application reading the alarms.
• AlarmPort1: Listening port of the PROXYSRV application on e-terraplatform
system 1.
• AlarmPort2: Listening port of the PROXYSRV application on e-terraplatform
system 2.
• AlarmHost1_1: IP node name or address of the e-terraplatform system 1 – Host 1.
• AlarmHost2_1: IP node name or address of the e-terraplatform system 1 – Host 2.
• AlarmHost3_1: IP node name or address of the e-terraplatform system 1 – Host 3.
• AlarmHost4_1: IP node name or address of the e-terraplatform system 1 – Host 4.
• AlarmHost1_2: IP node name or address of the e-terraplatform system 2 – Host 1.

Proprietary – See Copyright Page 138 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
• AlarmHost2_2: IP node name or address of the e-terraplatform system 2 – Host 2.
• AlarmHost3_2: IP node name or address of the e-terraplatform system 2 – Host 3.
• AlarmHost4_2: IP node name or address of the e-terraplatform system 2 – Host 4.

6.1.4.3 MB Scan Group DS

Data set configuration is performed in the SCADA server application (see “Data Set
Dialog Box” in the e-terracontrol Reference Manual: Applications).

Figure 76. MB Scan Group Data Set Dialog Box

The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• Scan Group Type: Scan group type entered as 0–8.
– 0 = Status
– 1 = Analog
– 2 = Accumulator
– 3 = Control
– 4 = Setpoint
– 5 = OK Timer
– 6 = Set Time
– 7 = Freeze
– 8 = FreezeRead
• TimeBase: Defines the base time (ms) for scanning a scan group.

Proprietary – See Copyright Page 139 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
• TimeInterval: Interval (ms) between scans of a scan group with type other than
control. A zero entry means to scan as fast as possible. For controls with translation
Control1to0, it indicates the time between when a 1 is sent and a 0 is sent.
• Translation: Translation type entered as 0–21.
– 0 = Short (2-byte unsigned number from 0 to 65536)
– 1 = ShortFFFFBad (2-byte number, FFFF indicates that the value is bad)
– 2 = Short1Bit (2 bytes of 16 individual status bits)
– 3 = ShortSignMagnitude (2-byte number; the most significant digit is a sign bit)
– 4 = Short2Bit (2 bytes of 8 individual status bits; the odd bits (1,3,5,...) are the
quality and the even bits (2,4,6,...) are the value. A 1 in the quality bit indicates
that the following status bit is bad quality)
– 5 = ModbusTime (PLC time format)
– 6 = Control1to0 (for a control, a 1 is written to the PLC, followed later by a 0; the
number of milliseconds between the 1 and the 0 is specified by the time interval
field)
– 7 = Control1 (a 1 is written to the PLC on a control)
– 8 = Control0 (a 0 is written to the PLC on a control)
– 9 = ControlMask0 (masks a single bit to 0; in response to a control, the Modbus
Reader reads the register, sets one bit of the value to 0, and then writes it back)
– 10 = ControlMask1 (masks a single bit to 1; in response to a control, the Modbus
Reader reads the register, sets one bit of the value to 1, and then writes it back)
– 11 = LongUnsigned (translates two 16-bit PLC registers as a single (longword)
integer)
– 12 = FloatMod (translates the value of the register as an IEEE floating point)
– 13 = FloatModRaw (translates the value of the register as an IEEE floating point,
and writes the value to the e-terracontrol database as a raw value)
– 14 = FloatModRaw1e6 (translates the value of the register as an IEEE floating
point, and writes the value to the e-terracontrol database as a raw value; the
received value is multiplied by 106 before it is written to the e-terracontrol
database)
– 15 = FloatModRaw1e-6 (translates the value of the register as an IEEE floating
point, and writes the value to the e-terracontrol database as a raw value; the
received value is multiplied by 10-6 before it is written to the e-terracontrol
database)
– 16 = Float (translates the value of the register as a floating point, and writes the
value to the e-terracontrol database in engineering units)

Proprietary – See Copyright Page 140 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
 – 17 = FloatRaw (translates the value of the register as a floating point, and writes
the value to the e-terracontrol database as a raw value)
– 18 = FloatRaw1e6 (translates the value of the register as a floating point, and
writes the value to the e-terracontrol database as a raw value; the received value
is multiplied by 106 before it is written to the e-terracontrol database)
– 19 = FloatRaw1e-6 (translates the value of the register as a floating point, and
writes the value to the e-terracontrol database as a raw value; the received value
is multiplied by 10-6 before it is written to the e-terracontrol database)
– 20 = ControlMask1to0 (in response to a control, the Modbus Reader reads the
register, masks a single bit value to 1, sends this back to the register, waits the
Time Interval, and then masks the value to 0 and writes it back)
– 21 = Short2sComplement (translates 2s complement numbers integer)
• MemoryType: Memory type entered as 0–4.
– 0 = Discrete Coils
– 1 = Input
– 2 = ** Not Used **
– 3 = Input Registers
– 4 = Holding Registers
• LogMessage: Level of error messages to be reported in the log; entered as 0–3.
– 0 = None
– 1 = Error
– 2 = Warning (includes Errors)
– 3 = Informational (includes Errors and Warnings)
• StartAddress: Starting address for the scan group.
• EndAddress: Ending address for the scan group.
• OverridePlcAddress: Sets a different PLC address for the scan group.
• WriteOnly: True or False. Sets whether or not the scan group can be read from.

6.1.4.4 Modbus Reader-Specific Counter Measurements

A counter measurement should be defined in each of the Modbus Reader Scan Group
data sets, in order to fail the data sets and set the data quality to Old when the Modbus
Reader application fails to scan the Scan Group.
This counter measurement must be named “Error” and associated with a Counter
Measurement Type that “Contributes to Error Count”. It is arbitrary what Counter
Measurement Type the counter measurement is associated with, as long as the
“Contributes to Error Count” property is set.
The maximum error count in the data set determines how many errors can accumulate
in the data set before the data set is failed by the SCADA server.

Proprietary – See Copyright Page 141 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
6.2 TI Reader
The TI Reader is used with the TI-505 protocol. It is a “master” application, which can
obtain its configuration only from configuration files.

6.2.1 TI Reader Command-Line Parameters

The configuration file name (and path) can be entered next to the TI Reader executable
on the command line. The configuration file path must be entered relative to the TI
Reader executable.
The following format is accepted:
~\TIReader.exe <ConfigurationFileName>
Example:
c:\eterra\e_terracontrol\bin32\TIReader.exe
E:\Eterra\e_terracontrol\samples\reliatronics.txt

6.2.2 Starting the TI Reader Using the Process Starter

The Process Starter application can start and restart programs as required. This is
useful in situations where it is desired that the TI Reader remain continuously active on
certain PCs.
1. From the e-terracontrol Start menu, open the Process Starter Console application,
and be sure that the Process Starter service is running.
2. Connect the console to the Process Starter service by clicking the Connect button in
the Process Starter Console toolbar.
3. To create a new Process Starter group, proceed to step 4. To add the TI Reader
application to an existing group, select File > Upload, and choose the desired .psc
file to display the Configuration tab for Processes (see the e-terracontrol Reference
Manual: Applications).

Note: Prior to adding a process to an existing group, you must end all processes
by clicking Stop on the Process Starter toolbar or via the Actions menu item (see
“Process Starter Console Toolbar” and “Process Starter Console Menu Bar” in the
e-terracontrol Reference Manual: Applications).

4. To create a new Process Starter group, select Processes > Add Process.
The Configuration tab for Processes opens (see the e-terracontrol Reference
Manual: Applications).
5. In the Name, Program, Params, and Directory text boxes, enter the required
information. If you do not know the location of the TIReader.exe file, click the Ellipsis
button (…) next to the Program text box to browse for the file. Sample values are as
follows:

Proprietary – See Copyright Page 142 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
 Name: TI Reader
Program: C:\eterra\e_terracontrol\bin32\TIReader.exe
Params: E:\Eterra\e_terracontrol\samples\reliatronics.txt
Directory: C:\eterra\e_terracontrol\bin32
6. If desired, select the Minimize check box.
7. If you do not want to see the GUI, uncheck the Visible check box.
8. In the Restart frame, select the On Exit radio button.
9. Click OK.
10. Save the file.

6.2.3 TI Reader User Interface

Figure 77. TI Reader User Interface

Proprietary – See Copyright Page 143 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
The following are included in the TI Reader user interface:
Header
• Enable Communications to PLC: Toggle ON to enable communication with the
Programmable Logic Controller (PLC).
• Enable SCADA Connections: Toggle ON to enable SCADA connections.
Scan Groups
• Scan Group: The groups specified to be scanned
• Status: Online, Failed, Unknown, or Uninitialized
• Last Scan: The date and time of the last scan
Data Items
• Measurement: The measurement names must match device names of
measurements and controls in SCADA.
• Value: This is the raw value (or unconverted value, as opposed to the converted
“engineering” value) for each measurement.
• Quality: This is the TI Reader’s view of the data quality: U = Uninitialized, B = Bad,
and O = Old. No entry means good quality.
Log: Displays messages

6.2.4 TI Reader Menu Bar

The non-standard options on the menu bar are as follows:
Edit Menu
• Communications: Select to view the Communication Parameters Configuration
dialog box (see section 6.2.5 Communication Parameters Configuration Dialog Box).
• Alarms: Select to view the Alarm Configuration dialog box (see section 6.2.6 Alarm
Configuration Dialog Box).
Scan Groups Menu
• Insert: Select to insert a group to scan.
• Delete: Select to delete a group that is being scanned.
• Properties: Select to view the Scan Group Properties dialog box (see section 6.2.7
Scan Group Properties Dialog Box).
View Menu
• Errors: Select to view the PLC Errors dialog box (see section 6.2.8 PLC Errors).

Proprietary – See Copyright Page 144 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
6.2.5 Communication Parameters Configuration Dialog Box
Selecting Edit > Communications opens the Communication Parameters Configuration
dialog box (Figure 78).

Figure 78. Communication Parameters Configuration Dialog Box – TI Reader

The following are included in the Communication Parameters Configuration dialog box:
• Baud Rate: Select the desired baud rate from the list box.
• Comm Port: Enter the communications port number that the TI Reader should use
to communicate with the PLC.
• Data Bits: Select the data bit convention from the list box.

Proprietary – See Copyright Page 145 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
• Parity: Select the parity from the list box. This is a standard asynchronous
communications parameter. For communications to work properly, the parity settings
of the TI Reader and the PLC must match.
• Protocol: Select the desired protocol from the list box. The TI Reader and the PLC
must match.
• Stop Bits: Select the stop bits from the list box. This is a standard communications
protocol parameter. The TI Reader and the PLC must match.
• Timeout (ms): The time period that the TI Reader waits for the PLC to respond to a
poll. One second (1000 ms) is the typical value.
• SCADA Source Name: Name of the associated data source in the e-terracontrol
database.
• Scada Port: Specifies the port that the SCADA server is listening on if it is not the
default port (5020 for NTLM/Kerberos authentication and 7000 for Certificate-based
authentication).
• Host1, Host2, Host3, Host4: Strings specifying host names for the SCADA
connection.
• Control-Enabled Control Device Name: Name of the device where controls are
sent.
• Control-Enabled Status Device Name: Name of the device from which control
feedback is received.
• Control-Enabled Value: 0 for disabled, 1 for enabled.
• User Interface Update (ms): The user interface display update/refresh rate. One
second (1000 ms) is the typical value.

Proprietary – See Copyright Page 146 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
6.2.6 Alarm Configuration Dialog Box
Selecting Edit > Alarms opens the Alarm Configuration dialog box (Figure 79).

Figure 79. Alarm Configuration Dialog Box – TI Reader

The following are included in the Alarm Configuration dialog box:

Header
• Area: The area assigned to a console where an alarm can be issued when an event
is posted.
• Category: The default alarm category.
• Exception Definition: The unique name defining an exception to the Alarm utility.
Events posted by Alarm’s clients identify one exception.
• Application Name: The name of the application reading the alarms.
EMP System 1 and EMP System 2
• Port: The listening port of the PROXYSRV application on e-terraplatform. TI Reader
issues alarms when the PLC fails or is restored, and when the OK timer starts or
stops updating.
• Host (1–4): These are the IP node names or addresses of the e-terraplatform
servers with PROXYSRV. They are used to issue alarms to e-terraplatform.

Proprietary – See Copyright Page 147 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
6.2.7 Scan Group Properties Dialog Box
Selecting Scan Groups > Properties opens the Scan Group Properties dialog box
(Figure 80).

Figure 80. Scan Group Properties Dialog Box – TI Reader

The following are included in the Scan Group Properties dialog box:
• Scan Group Name: The name of the scan group.
• Scan Type: From the drop-down box, select one of the following:
– Status: Reads inputs corresponding to Status objects in SCADA.
– Analog: Reads inputs corresponding to Analog objects in SCADA.
– Accumulator: Reads inputs corresponding to Accumulator objects in SCADA.
– Control: A set of digital outputs.
– Setpoint: A set of analog outputs.
– OKTimer: A timer input that is incremented by the PLC software. If this stops
incrementing, it indicates that the PLC software is “stuck”, and the TI Reader
marks input measurements as bad quality.
– SetTime: Time output to the PLC. The PLC time is set to be the same as the
telemetry PC time.

Proprietary – See Copyright Page 148 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
 – Freeze: Writes to the start address in order to freeze accumulators.
– FreezeRead: Writes to the start address, and reads from the end address to
verify that Freeze was written.
• Time Interval (ms): This is the interval between scans of a scan group with type
other than control. A 1000 entry directs TI Reader to scan every second. A zero
entry means to scan as fast as possible. For controls with translation Control1to0,
this field indicates the time between when a 1 is sent and a 0 is sent.
• Time Base (ms): Defines the base time for scanning a scan group. For example, to
scan two minutes after the hour, set this field to 120,000.
• Start Address: This is the starting address for this scan group. The TI Reader
scans from the start to the end address in one request to the PLC. This typically
corresponds to a register number in the PLC.
• End Address: This is the ending address for this scan group.
• Translation Type: From the drop-down box, select one of the following:
– Short: 2-byte unsigned number from 0 to 65536.
– ShortFFFFBad: 2-byte number. FFFF indicates that the value is bad.
– Short1Bit: 2 bytes of 16 individual status bits.
– ShortSignMagnitude: 2-byte number. The most significant digit is a sign bit.
– Short2Bit: 2 bytes of 8 individual status bits. The odd bits (1,3,5,...) are the
quality and the even bits (2,4,6,...) are the value. A 1 in the quality bit indicates
that the following status bit is bad quality.
– Control1to0: For a control, a 1 is written to the PLC, followed later by a 0. The
time interval field specifies the number of milliseconds between the 1 and the 0.
– Control1: A 1 is written to the PLC on a control.
– Control0: A 0 is written to the PLC on a control.
– ControlMask0: Masks a single bit to 0. In response to a control, the TI Reader
reads the register, sets one bit of the value to 0, and then writes it back.
– ControlMask1: Masks a single bit to 1. In response to a control, the TI Reader
reads the register, sets one bit of the value to 1, and then writes it back.
– LongUnsigned: Translates two 16-bit PLC registers as a single (longword)
integer.
• Memory Type: This corresponds to the 74 TI types of memory (registers) available
in the TI-505 PLCs.
• Maximum Consecutive Errors: Maximum number of unsuccessful communication
attempts before a failed condition is determined.

Proprietary – See Copyright Page 149 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
• Error Level: Select the level of error messages to be reported from the list box
(0 = None, 1 = Error, 2 = Warning, 3 = Info).

6.2.8 PLC Errors

Selecting View > Errors opens the PLC Errors dialog box (Figure 81). The rows
correspond to the PLC errors that can be reported from the PLC driver. Continuous
timeout errors indicate that communications with the PLC are faulty. Other errors can
indicate a fault in the PLC rather than in the communications. All error counts are
cumulative.

Figure 81. PLC Errors Dialog Box – TI Reader

Proprietary – See Copyright Page 150 PLC Reader Applications

e-terracontrol Reference Manual: Interfaces to Field Devices
7. TrueTime Reader Application
The TrueTime Reader application provides a user interface that is capable of reading
time deviation (DTIM), frequency deviation (DHZ), and system frequency (HZ) from
devices configured similarly to the XL-FTM III Frequency and Time Monitor
manufactured by Symmetricom. These measurements are then sent to the SCADA
server application.

7.1 TrueTime Reader Command-Line Arguments

A TrueTime Reader shortcut is not created during the installation of e-terracontrol,
because there are command-line arguments associated with this application. The
application can be launched from the Process Starter, a command line, a batch file, or a
Windows shortcut you have created with the appropriate command-line arguments
included.
The command-line arguments must be separated by a single space. However, it is
important to note that the majority of the command-line arguments are optional.
An example command-line statement is:
~\TrueTimeReader.exe -p=2 -s=9600,n,8,1 -h=None -r=2000
Where:
• Communication Port: The “p” command-line argument tells the TrueTime Reader
which communication port to use. The default value is 1.
-p=<ComPort>
The -p argument is optional.
• Communication Settings: The “s” command-line argument tells the TrueTime
Reader which communication settings to use. The default value is 9600,n,8,1.
-s=<BaudRate>,<Parity>,<Bits>,<StopBits>
The -s argument is optional.
• Handshaking: The “h” command-line argument tells the TrueTime Reader which
handshaking to use. The default value is None.
-h=<Handshaking>
The -h argument is optional.
• Poll Rate: The “r” command-line argument specifies the poll rate in milliseconds to
the TrueTime Reader. The default value is 1000 msec.
-r=<PollRate>
The -r argument is optional.

Proprietary – See Copyright Page 151 TrueTime Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
• ScadaPort: This is an optional argument for specifying the port that the SCADA
server is listening on if it is not the default port (5020 for NTLM/Kerberos
authentication and 7000 for Certificate-based authentication).
Example: -port=5025
• Scada Host: host1, host2, host3, host4
These are the optional arguments to specify the host names on which the
e-terracontrol SCADA server is running.
Example: -host1=SMP1
• Scada database name: sdb
This is an optional argument to specify the Scada database name. It is needed if
there are multiple instances of the e-terracontrol Scada server running on the same
machine. It is not needed if there is only one Scada server running on the computer.
Example: -sdb=d:\eterra\e_terracontrol\samples\emp60_rtus.sdb

7.2 Starting the TrueTime Reader Using the Process Starter

The Process Starter application can start and restart programs as required. This is
useful in situations where it is desired that the TrueTime Reader application remain
continuously active on certain PCs.
1. From the e-terracontrol Start menu, open the Process Starter Console application,
and be sure that the Process Starter service is running.
2. Connect the console to the Process Starter service by clicking the Connect button in
the Process Starter Console toolbar.
3. To create a new Process Starter group, proceed to step 4. To add the TrueTime
Reader application to an existing group, select File > Upload, and choose the
desired .psc file to display the Configuration tab for Processes (see the
e-terracontrol Reference Manual: Applications).

Note: Prior to adding a process to an existing group, you must end all processes
by clicking Stop on the Process Starter toolbar or via the Actions menu item (see
“Process Starter Console Toolbar” and “Process Starter Console Menu Bar” in the
e-terracontrol Reference Manual: Applications).

4. To create a new Process Starter group, select Processes > Add Process.
The Configuration tab for Processes opens (see the e-terracontrol Reference
Manual: Applications).
5. In the Name, Program, Params, and Directory text boxes, enter the required
information. If you do not know the location of the TrueTimeReader.exe file, click the
Ellipsis button (…) next to the Program text box to browse for the file. Sample values
are as follows:

Proprietary – See Copyright Page 152 TrueTime Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
 Name: TrueTime Reader
Program: C:\eterra\e_terracontrol\bin\ TrueTimeReader.exe
Params: -p=2 -s=9600,n,8,1 -h=None -r=2000
Directory: C:\eterra\e_terracontrol\bin
6. If desired, select the Minimize check box.
7. If you do not want to see the GUI, uncheck the Visible check box.
8. In the Restart frame, select the On Exit radio button.
9. Click OK.
10. Save the file.

Proprietary – See Copyright Page 153 TrueTime Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
7.3 TrueTime Reader User Interface

Figure 82. TrueTime Reader User Interface

The following are included in the TrueTime Reader user interface:

Communications
• Com Port: Selectable com port (1–4).
• Baud Rate: Selectable baud rate (110 bps–256,000 bps).
• Parity: Selectable parity (Even, Mark, None, Odd, and Space).
• Bits: Selectable number of data bits (4–8).
• Stop Bits: Selectable number of stop bits (1, 1.5, or 2).
• Handshaking: Selectable handshaking (None, XonXoff, RTS, or RTS/XonXoff).

Proprietary – See Copyright Page 154 TrueTime Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
• Poll Rate: Selectable poll rate (1000 msec–4000 msec).
• OK: Validates communication settings.
• Enable Port: Enables the port communications with the TrueTime device.
• Connect to SCADA: Enables connection to the SCADA server application.
• Read Count: One-second heartbeat. While the application is running, the counter is
incremented one count every second. Provides you with a troubleshooting tool.
• BufLen: Receive buffer length.
• CtrlC: Stops any one-second changing display.
• TimeD Reset: Resets the time deviation to zero.
• F27: Requests data and restarts the display after a CtrlC command has been
issued.
• Format Setting: Formats the string to the F27 format.
Transmit Buffer
• Send: Sends the contents of the buffer to the TrueTime device
• Clear: Clears the contents of the transmit buffer
• Load: Loads a .txt file into the transmit buffer
TrueTime Output
• Local Time: UTC time in seconds through days.
• System Frequency: A user’s locally generated frequency.
• System Time: Hours, minutes, and seconds as defined by a clock running off the
user’s locally generated frequency.
• Time Deviation: Accumulated difference in time between a clock locked to the
locally generated frequency and the precise time of the synchronized clock.
• Time Quality: One-character time quality value as provided by the TrueTime device.
• Frequency Deviation: Instantaneous difference between the locally generated
frequency (typically 50 or 60 Hz) and the precision frequency of the host
synchronized clock.
• Rx String: Complete receive string.
Footer
(See section 7.5 Adding Measurements to the SCADA Server.)
• Station: Station name as defined in the SCADA server.
• Equipment Name: Equipment name as defined in the SCADA server.
• Add Measurements: Adds the DTIM, DHZ, and HZ measurements to the SCADA
server.

Proprietary – See Copyright Page 155 TrueTime Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
7.4 Configuring the TrueTime Device for the F27 Format
This application has been tested to interface with TrueTime XL-DCl (older model) or
Symmetricom XLi (current supported model). These devices need to be configured for
the F27 format so that the time deviation (DTIM), frequency deviation (DHZ), and
system frequency (HZ) measurements can be read by the TrueTime Reader application
and sent to the SCADA server.
The F27 format can be configured using one of two methods:
• TrueTime Device Panel
– Configuration for the F27 format can be performed using the hardware’s keypad
(refer to the device manual for more details).
• TrueTime Reader
– In the user interface, select CtrlC.
– In the user interface, select Format Setting.
– To request measurements from the device, select “F27”.
– Review the Receive Buffer and the Read Count.

7.5 Adding Measurements to the SCADA Server

The TrueTime Reader application can be configured to interface with the SCADA
server.
1. In the Footer section of the user interface, enter the station name.
2. In the Footer section of the user interface, enter the equipment name.
3. Select Add Measurements.
The application adds the station name, equipment name, analog HZ measurement,
analog DTIM measurement, and analog DHZ measurement to the active SCADA
server. If any of these items already exists in the active SCADA server, the
application does not create duplicates.
The analog HZ, DTIM, and DHZ measurements can also be added manually in the
SCADA server application.

Proprietary – See Copyright Page 156 TrueTime Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8. Relay Reader Application
The Relay Reader is used with the Self-Extensible Language (SEL) protocols. It is a
“master” application, which can obtain its configuration from data sets.

Note: The Relay Reader requires a separate license; it is not included in the standard
e-terracontrol delivery. Contact your customer service or sales representative for
delivery of this application. Use of this application also requires that the third-party
SELMASTER.OCX control be installed and registered.

8.1 Relay Reader Command-Line Arguments

Multiple command-line arguments must be separated with a comma. An example
command-line statement is:
~\ RelayReaderVB.exe datasource=SELmeter1
A data source in SCADA identifies the subtree of the communication model for which a
Relay Reader is responsible, and which must be downloaded to the Relay Reader at
startup:
datasource=<DataSourceName>
where:
• <DataSourceName> is the name of an existing data source.
For information about how to add a data source to the SCADA server application, refer
to “Data Source Dialog Box” in the e-terracontrol Reference Manual: Applications.
This argument is required.

8.2 Host(s)
By default, the Relay Reader connects to the SCADA application running on the local
computer. However, in a case where the Relay Reader application does not reside on
the same machine as the SCADA server, the address of the SCADA server must be
passed in the “Host1” argument. In a dual-state environment, the “Host2” argument is
used to pass the address of the secondary SCADA server. The two SCADA servers
must store the same data source to which the Relay Reader is dedicated.
Host1=<HostName1>,Host2=<HostName2>
This argument is optional.

Proprietary – See Copyright Page 157 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.3 Log Settings
Through the command line, it is possible to configure most of the logging options that
are available from the Relay Reader user interface. For more details about these
logging options, refer to section 8.6 Relay Reader User Interface.
These arguments are optional.
The following arguments apply to the Relay Reader log:
• LogDisplay: Specifies whether the events are displayed on the screen or not. The
two possible values are True and False.
• LogFile: Specifies whether the events are written into files. The possible values are
False (no logging to file), True (logging to a single file without file size checking), or a
positive number that represents the maximum size of a log file (in Mb).
• LogSev: Specifies which severities of events are logged. Each severity is
represented by a letter: S (Success), I (Informational), W (Warning), E (Error), and F
(Fatal). The value of the LogSev parameter can be any combination of these five
letters, in any order.
Example: logfile=2,logdisplay=false,logsev=swfie
The Relay Reader maintains statistics on its communications with the relay. These
statistics can be periodically reset, and the hourly values are dumped to daily .csv
(comma-separated-value) files for further processing. The statistics files are named
“HOURLY_COMM_STATS_RR_yyyymmdd_V2.CSV”.

8.4 Enable/Disable
The “enable” (or “disable”) argument forces a number of additional log options,
essentially related to the communications with the SCADA server application. For more
details about these options, refer to section 8.6 Relay Reader User Interface.
The possible log options are:
• SmpLogState: Logs data set state changes
• SmpLogControl: Logs control requests
• SmpLogTimers: Logs timers
• SmpLogConnections: Logs connections with and disconnections from SCADA
• SmpLogRefresh: Logs refresh (i.e., demand scan) requests
• SmpLogMessages: Logs messages from the Relay Reader to SCADA
These arguments are optional.

Proprietary – See Copyright Page 158 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.5 Starting the Relay Reader Using the Process Starter
The Process Starter application (see “Process Starter” in the e-terracontrol Reference
Manual: Applications) can start and restart programs as required. This is useful in
situations where it is desired that the Relay Reader remain continuously active on
certain PCs.
1. From the e-terracontrol Start menu, open the Process Starter Console application,
and be sure that the Process Starter service is running.
2. Connect the console to the Relay Reader by clicking the Connect button in the
Process Starter Console toolbar.
3. To create a new Process Starter group, proceed to step 4. To add the Relay Reader
application to an existing group, select File > Upload, and choose the desired .psc
file to display the Configuration tab for Processes (see the e-terracontrol Reference
Manual: Applications).

Note: Prior to adding a process to an existing group, you must end all processes
by clicking Stop on the Process Starter toolbar or via the Actions menu item (see
“Process Starter Console Toolbar” and “Process Starter Console Menu Bar” in the
e-terracontrol Reference Manual: Applications).

4. To create a new Process Starter group, select Processes > Add Process.
The Configuration tab for Processes opens (see the e-terracontrol Reference
Manual: Applications).
5. In the Name, Program, Params, and Directory text boxes, enter the required
information. If you do not know the location of the RelayReaderVB.exe file, click the
Ellipsis button (…) next to the Program text box to browse for the file. Sample values
are as follows:
Name: Relay Reader(Master)
Program: D:\eterra\e_terracontrol\bin\ RelayReaderVB.exe
Params: datasource = RelayReader
Directory: C:\eterra\e_terracontrol\bin
6. If desired, select the Minimize check box.
7. If you do not want to see the GUI, uncheck the Visible check box.
8. In the Restart frame, select the On Exit radio button.
9. Click OK.
10. Save the file.

Proprietary – See Copyright Page 159 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.6 Relay Reader User Interface

8.6.1 Database Tab

Figure 83. Relay Reader – Database Tab

The following are included on the Database tab for each relay:
• Key: Used internally.
• Device: Name of the relay data set for the associated relay.
• Failures: Number of failed polls (cumulative).
• Attempts: Number of polls to the relay (cumulative).
• Responses: Number of successful responses from the relay (cumulative).
• Baud: Baud rate of the connection to the relay.
• Data Bits: Number of data bits per byte.
• Stop Bits: 1 or 2 stop bits.
• Parity: 0 = None, 2 = Even, 1 = Odd parity.
• Polling: Enabled or disabled. When polling is disabled, the relay is not polled. The
port can be open or closed.

Proprietary – See Copyright Page 160 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
• State: Open or closed. When the port is closed, it is available for other applications
to open and no polling occurs.
• Model: 321, 351, 351S, 387, or 311 to specify the relay model number.
• Protocol: 1 = Faster Metering (aka SEL), 0 = ASCII.
• Port: Port number of the comm port used (e.g., 5 for COMM5).
• Timeout: Time in msec to wait for a response from the relay.
• Retries: The number of consecutive unsuccessful polls before setting the relay
offline.
• Dump: YES if dumping of the hourly communication statistics to a .csv file is
enabled. The file is named “HOURLY_COMM_STATS_RR_yyyymmdd_V2-
host.csv”, where yyyy is the year, mm is the month, dd is the day, and host is the
name of the host where the Relay Reader is running. NO if dumping of the hourly
communication statistics is disabled.
• Exception Interval: Interval in msec between checks for change data from the
ActiveX control polling the relay. Normally set to approximately one half the shortest
poll rate.
• Statistics Interval: Interval in msec between checks for statistics from the ActiveX
control polling the relay. Statistics include poll error statistics and the event counter.
This value should always be longer than the shortest poll cycle.
• Integrity Interval: Interval in msec between integrity checks of the ActiveX control
polling the relay. When the integrity interval expires, data is retrieved from the
ActiveX control for all data points. This value should normally be set to a large
number (several minutes).
Note that this does not override the normal poll interval, so the data is not any
fresher than the last poll.
• Init Timer: Interval in msec to wait for all poll groups to be reported online by the
ActiveX control polling the relay. The initial integrity scan of the ActiveX control is
performed when all poll groups are reported online or when the timer expires,
whichever comes first.
• Event File Enabled?: YES if long event reports from the relay are to be stored in a
file.
• Event File Path: The path to the directory used to store the long event reports. The
long event report files are named using the following convention:
“NAME_MMDDYYHHMMSSMS.log”, where NAME is the device name, MM is the
month, DD is the day, YY is the last two digits of the year, HH is the hour (0–23),
MM is the minute, SS is the second, and MS is the millisecond when the event
occurred.
• Short Event File: The name (including the path) of the file used to record short
event text. Normally, the same file is used for all relays, so that the events are
intermixed in approximate time order.

Proprietary – See Copyright Page 161 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.6.2 Log Tab

Figure 84. Relay Reader – Log Tab

The Log tab displays the Relay Reader log.

The Configuration tab contains options for enabling/disabling various classes of log
messages.

Proprietary – See Copyright Page 162 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.6.3 Configuration Tab

Figure 85. Relay Reader – Configuration Tab

The following are included on the Configuration tab for each relay:
• Disable Output: Check to disable logging to the Relay Reader log.
• Log to File: Check to enable logging of the Relay Reader log to a file. The file is
named “RelayReader_YYYYMMDD_HHMMSS.log”, where YYYY is the year, MM is
the month, DD is the day, HH is the hour, MM is the minute, and SS is the second
that the file was created. The log file is created in the same directory that the Relay
Reader executable is running in.
• Limit Length To: Check to limit the length of the log file. If the specified maximum
length is going to be exceeded, the file is closed and a new log file is opened.
• S - Success: Check to enable logging of success severity messages.
• I - Informational: Check to enable logging of informational messages.
• W - Warning: Check to enable logging of warning messages.
• E - Error: Check to enable logging of error severity messages.
• F - Fatal: Check to enable logging of fatal severity messages.
• Log State Changes: Check to enable logging of data set state changes from the
SCADA server.
• Log Controls: Check to enable logging of control requests from the SCADA server.

Proprietary – See Copyright Page 163 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
• Log Timers: Check to enable logging of timers from the SCADA server.
• Log Connections: Check to enable logging of connection to and disconnection from
the SCADA server.
• Log Refresh Requests: Check to enable logging of data set refresh requests from
the SCADA server.
• Log Messages to SCADA: Check to enable logging of messages sent to the
SCADA server from the Relay Reader.

8.6.4 Pass-Through Tab

Figure 86. Relay Reader – Pass-Through Tab

The following are included on the Pass-Through tab for each relay:
• Key: Used internally.
• Device: Name of the relay data set for the associated relay.
• Status: Indicates the status of any connection to a pass-through client.
• Sent: The number of pass-through messages that have been sent to the relay.
• Received: The number of pass-through messages that have been received from the
relay.
• Connect Time: The time that the most-recent connection to a pass-through client
was established.

Proprietary – See Copyright Page 164 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
• Telnet Port: The telnet port number used to listen for pass-through client connection
requests.
• Maximum Connect Time (Min): Maximum number of minutes that a telnet pass-
through connection is allowed to remain connected. It is automatically disconnected
at the end of the maximum time.
• Inactivity Timeout (Min): Number of minutes that the relay remains in pass-through
mode without user interaction. If this time passes without receiving a command, the
relay drops out of pass-through mode and the normal polling cycle resumes.
• PassThru Interval (msec): Number of milliseconds between calls to
GetPassThruData to retrieve pass-through data responses from the ActiveX control
used to communicate with the relays.
• Auto Send Interval (msec): Number of milliseconds to wait after receiving a valid
command to read relay settings before sending the command to the relay even if no
terminating <CR> has been received.
• PassThru Test Mode: A diagnostic feature that can be used to test the ActiveX
control pass-through mode without using the telnet connection to the pass-through
client.
In addition, the Clear Counters command button can be clicked to clear the
Messages Sent and Messages Rcvd counters.

8.6.5 Relay Reader Menu Bar

The non-standard options on the menu bar are as follows:
View Menu
• Database Tab: Select to view the Database tab.
• Log Tab: Select to view the Log tab.
• Configuration Tab: Select to view the Configuration tab.

8.7 Data Set Configuration

A data set is a structure that contains, in the form of a parameter string, all parameters
that model a communications object. The data set collection is organized in a
hierarchical way.
• RelayReaderDS: The top level of the hierarchy. Only one is allowed.
• CommDS: Defines the global settings of the communication port.
• RelayDS: Defines the global settings of the SEL relay “slave” device. It is a child of
the CommDS data set. The optional “LongEvent” data item in this data set is used to
alarm when long event report files are generated. The optional “Location” data item
in this data set is used to report the location of a fault detected by the relay.

Proprietary – See Copyright Page 165 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
• PollDS: Contains the configuration parameters for a poll group. In the
communications hierarchy, it is a child of the RelayDS data set.
• PointDS: Contains the configuration parameters for a set of data points. In the
communications hierarchy, it is a child of the PollDS data set. The data items in this
data set contain the configuration parameters for the individual data points.
The hierarchy of data that relates to the Relay Reader application can be found in
Figure 87.

Figure 87. Relay Reader Data Set Hierarchy

8.7.1 Defining the Data Set Types for the Relay Reader
As noted above, several data set types must be defined before the data sets for the
Relay Reader data hierarchy can be defined. The types can be manually defined in the
SCADA Types subtree of the SCADA database.
To define a data set type:
1. Using the Insert menu of the e-terracontrol application, select Type from the drop-
down menu.
2. On the next menu, select Data Set Type.
The data set type form appears with two tabs: General and Timers.
3. For each type defined, select the options indicated.

Proprietary – See Copyright Page 166 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
RelayReaderDS
Name: RelayReaderDS
Record:
Before defining the RelayReaderDS type, insert the hourly statistics timers needed into
the timer subtree. Note that the hourly statistics timer must be defined and assigned;
otherwise, no hourly communication line statistics are collected for the Relay Reader.
On the Timers tab, assign the hourly statistics timer to this data set type. Assign a timer
using the following steps:
1. From the Available column, select the timer it.
2. Fill in the Relationship text box.
3. Select the Add box.
For the hourly statistics timer, the relationship must be “Statistics”.
Check the Dual States and MCD Processing options.
CommDS
Name: CommDS
Record: PATH
Do not assign any timers on the Timers tab.
Check the Dual States, Contributes to Parent State, and MCD Processing options.
RelayDS
Name: RelayDS
Record: RTU
Do not assign any timers on the Timers tab.
Check the Contributes to Parent State and MCD Processing options.
Check Analogs and Statuses as Allowed Data Item Types.
PollDS
Name: PollDS
Record: ADRS
Do not assign any timers on the Timers tab.
Check the Contributes to Parent State and MCD Processing options.
PointDS
Name: PointDS
Record: CARD
Do not assign any timers on the Timers tab.

Proprietary – See Copyright Page 167 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
Check Contributes to Parent State.
Check Analogs, Statuses, and Controls as Allowed Data Item Types.

8.7.2 RelayReaderDS
Data set configuration is performed in the SCADA server application (see Figure 88).

Figure 88. Relay Reader Data Set User Interface

For the Relay Reader data set, no parameters should be entered in the Param text box.

Proprietary – See Copyright Page 168 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.7.3 CommDS
Data set configuration is performed in the SCADA server application (see Figure 89).

Figure 89. Comm Data Set User Interface

The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• Baud:
– 1200
– 2400
– 4800
– 9600
– 19200
• PortNum: Communications port number
• DataBits: Data bit conversion type
– 7 = 7 bits
– 8 = 8 bits
• Parity: Parity
– None
– Odd
– Even
• StopBits: Stop bits
– 1 = 1 bit
– 2 = 2 bits
Proprietary – See Copyright Page 169 Relay Reader Application
e-terracontrol Reference Manual: Interfaces to Field Devices
• Exception: Interval for exception checking in msec. Default is 500 msec.
• Statistics: Interval for statistics checking in msec. Default is 10000 (10 seconds).
• Integrity: Interval for integrity checking in msec. A value of 0 disables the integrity
checking. Default is 0.
• InitialRead: Interval to wait for all poll groups to come online before the initial
integrity read of data from the ActiveX control. Default is 60000 (60 seconds).
• TextEventFile: Name and directory path for the file used to store text events.
Normally, this is the same file for all Relay Reader instances. Default to
RelayReaderTextEvents.txt in the current directory.
• TelnetPortBase: The Internet port number that is used to listen for connections from
pass-through clients. The serial port number is added to the TelnetPortBase to
obtain the port number to listen on. If no TelnetPortBase is specified, listen on the
port specified by TelnetPortNum or on the standard telnet port, 23.
• TelnetPortNum: Explicitly specifies the telnet port number used to listen for pass-
through client connection requests. Overrides TelnetPortBase if both are specified.
Default is 23.
• Password: Valid password for a pass-through client. If not specified, no password is
required.
• TelnetMode: Set to ENABLED to enable listening for pass-through connections on
the designated Internet port. If disabled, no pass-through connections are accepted.
Default is DISABLED.
• MaxConnectTime: Maximum number of minutes that a telnet pass-through
connection is allowed to remain connected. It is automatically disconnected at the
end of the maximum time. Default is 10.
• PassThruTMO: Number of minutes that the relay remains in pass-through mode
without user interaction. If this time passes without receiving a command, the relay
drops out of pass-through mode and the normal polling cycle resumes. Default is
1 minute.
• MaxPassWordAttempts: Maximum number of password attempts the client is
allowed before the connection is disconnected due to lack of a valid password.
Default is 2.
• AutoSendInterval: Number of milliseconds to wait after receiving a valid command
to read relay settings before sending the command to the relay even if no
terminating <CR> has been received. Default is 1000 msec.
• PassThruInterval: Number of milliseconds between calls to GetPassThruData to
retrieve pass-through data responses from the Novatech control. Default is 500 ms.
• StatisticsDumpDisabled: Include this parameter to disable the dumping of the
hourly communication statistics. Including this parameter disables the dumping of
the statistics for the port unless the argument for the parameter is “False” or “No”.

Proprietary – See Copyright Page 170 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.7.4 RelayDS

Figure 90. Relay Data Set User Interface

The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• Model: SEL relay model number
– 311
– 321
– 351
– 351S
– 352
– 387
• Protocol: Communications protocol
• FastMeter
• ASCII
– NoReplyTimeout: Time in milliseconds to wait for a response from a relay while
polling.
– Retries: Number of retries (at poll rate) before the device is declared offline by
the Novatech control.
– LongEventReport: Enable or disable long event reporting. If disabled, the event
files are not generated.
∗ Disable
∗ Enable

Proprietary – See Copyright Page 171 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
 – EventFilePath: Directory for storage of long event report files. Enter the directory
path. Defaults to the current directory.
– Password1: Password for Level 1 SEL commands
– Password2: Password for Level 2 SEL commands
An optional data item, with the name “LongEvent”, must be modeled in the Relay data
set in order to alarm when new long event report files are available.
An optional data item, with the name “Location”, must be modeled in the Relay data set
in order to get fault location data reported in an analog in the database. If this item is not
modeled, the fault location is only available in the text event file.

Figure 91. Relay Data Set – Data Items Tab

Proprietary – See Copyright Page 172 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.7.5 PollDS
Data set configuration is performed in the SCADA server application.

Figure 92. Poll Data Set User Interface

The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• GroupName: Scan group name
– Meter
– Event (not supported)
– Fast Meter
– History (not supported)
– Peak
– Demand
– Breaker Wear
• Days: Defines the poll frequency in days for the group.
• Hours: Defines the poll frequency in hours for the group.
• Minutes: Defines the poll frequency in minutes for the group.
• ScanRate: Defines the poll frequency in seconds for the group.
• Msec: Defines the poll frequency adjustment for the group in milliseconds.

Proprietary – See Copyright Page 173 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
8.7.6 PointDS
Data set configuration is performed in the SCADA server application.

Figure 93. Point Data Set User Interface

The following parameters should be entered in the Param text box, with corresponding
values entered in the Value text box:
• Type: Point type
– AI = Analog
– DI = Discrete Status
– DO = Discrete Output
• OutputType: Defines the control type for output points.
– PULSE
– LATCH
Note that the CardDS for output points can be inserted under any of the PollDS data
sets, since the poll rates are ignored for output points.
The details of the points for the Point data set are defined on the Data Items tab. The
name of each data item must match the Point reference address from the relay map.

Proprietary – See Copyright Page 174 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 94. Point Data Set – Data Items Tab

For discrete points, the form is:

point address:bit number (e.g., “133:10”)
For output points, the form is:
direction:point address:bit number (e.g., “Trip:134:3”)
Direction is “close” or “trip”.
The bit number can be omitted for output points that do not refer to a specific bit.

Proprietary – See Copyright Page 175 Relay Reader Application

e-terracontrol Reference Manual: Interfaces to Field Devices
9. IEC61850 Client Interface
The e-terracontrol IEC61850 client application provides e-terracontrol with an interface
to IEC61850-compliant devices.
The IEC61850 client application uses the PACiS Agency application to communicate
with IEC61850 devices.
The SCADA database objects that are required by the IEC61850 client application
include:
• A hierarchical collection of data sets that model the IEC61850 client’s
communication subsystem and IEC61850 device model (from the IEC61850 client
itself to the IEC61850 bricks)
• The measurement definitions and values associated with the data sets, in the form
of data item collections

9.1 Command Lines

IEC61850 client command lines are not necessary for starting the application. In this
case, the default data source loading by the IEC61850 client software is the IEC61850
client source name.
The application can be launched from the Process Starter application (see “Process
Starter” in the e-terracontrol Reference Manual: Applications), a batch file, a command
line, or a Windows shortcut you create with the appropriate command-line arguments
included.
Blank space must separate all command-line arguments. However, their syntax is not
case-sensitive.
The following format is valid, where p is the command-line argument switch and
<Argument> is the command-line argument value:
~\IEC61850client p=<Argument>

9.1.1 Data Source

A data source in SCADA identifies the subtree of the communication model for which an
IEC61850 client is responsible, and which must be downloaded to the IEC61850 client
at startup:
datasource=<DataSourceName>
where:
• <DataSourceName> is the name of an existing data source.
For information about how to add a data source to the SCADA server application, refer
to “Data Source Dialog Box” in the e-terracontrol Reference Manual: Applications.

Proprietary – See Copyright Page 176 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
One instance of the IEC61850 client application must be started for each data source.
This argument is optional.

9.1.2 Host(s)
By default, the IEC61850 client connects to the SCADA application running on the local
computer. However, in a case where the IEC61850 client application does not reside on
the same machine as the SCADA server, the address of the SCADA server must be
passed in the “Host1” argument. In a dual-state environment, the “Host2” argument is
used to pass the address of the secondary SCADA server. The two SCADA servers
must store the same data source to which the IEC61850 client is dedicated.
Host1=<HostName> Host2=<HostName2>
This argument is optional.

9.1.3 Port
By default, the IEC61850 client connects to the SCADA application running on the local
computer with the default port (5020 for NTLM/Kerberos authentication and 7000 for
Certificate-based authentication). A specific port can be set in a command line:
Port=<num port>
This argument is optional.

9.2 Structure of the IEC61850 Client

The IEC61850 client application includes several ActiveX controls that perform its core
functions. The application itself only manages these controls and logs the data that are
of interest to you.
The controls are:
• SCADADevice interfaces with the SCADA application.
• AgencyCtrl uses the PACiS API to interface with the PACiS Agency application; the
PACiS Agency application communicates directly with the IEC61850 field devices.

9.3 Data Set Configuration

SCADA data sets are modeled in the SCADA database, to define the following
information to SCADA and the IEC61850 client application:
• IEC61850 client application information
• IEC61850 device information (Name and MMS ARName)
• IEC61850 device logical devices and bricks to map to SCADA

Proprietary – See Copyright Page 177 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
In addition, a SCADA data source for the IEC61850 client application (type: device)
needs to be modeled. The SCADA data source references a data set defining the
IEC61850 client application; this is similar to CFE Reader modeling.
To support this, the following SCADA data set types need to be added to the
e-terracontrol database:
• IEC61850 clientDS: This SCADA data set type is assigned to the IEC61850 client
data set.
• IEC61850DeviceDS: This SCADA data set type is assigned to the IEC61850 device
data sets.
• IEC61850LogicalDeviceDS: This SCADA data set type is assigned to the IEC61850
logical device data sets.
• IEC61850BrickDS: This SCADA data set type is assigned to the IEC61850 brick
data sets.
Following is an example.

Figure 95. IEC61850 Client Data Set Tree

Proprietary – See Copyright Page 178 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
In the above model, IEC61850clientDS is the IEC61850 client data set that models the
IEC61850 client application. The child data set E1_1350 is the device data set that
models an IEC61850 device to connect to. The CONTROL data set is the
IEC61850LogicalDevice data set. Finally, there are three brick data sets.
Following are descriptions of each data set.

IEC61850 client data set

This data set models the IEC61850 client application. It can be used for managing the
IEC61850 client application. The type is IEC61850clientDS and there are no data items
in the data set.
There are several parameters used to configure the connection to the PACiS Agency
application:
• AgencyHeartbeat
The IEC61850 client monitors the health of the PACiS Agency by receiving
heartbeat messages from the Agency application. This is the frequency (in
milliseconds) of the heartbeats.
• NumMissedHeartbeats
The number of heartbeats that can be missed before the IEC61850 client assumes
that the PACiS Agency application has died.
• HeartbeatMonitor_Freq
Frequency (in milliseconds) that the IEC61850 client checks that it is receiving
heartbeats from the PACiS Agency. Default value is 10000 (10 seconds).
• IEC61850 device data sets
Each IEC61850 device to communicate with has an IEC61850DeviceDS data set
modeled for it. This data set defines the following mapping and communication
parameters for the device:
– ARName: This must match a remote entry (CommonName) in the Lean.cfg file.

Proprietary – See Copyright Page 179 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
Figure 96. IEC61850 Device Data Set Window

IEC61850 logical device data sets

Under each IEC61850 device data set, IEC61850 logical device data sets are modeled
for each logical device in the IEC61850 device that is to be mapped to SCADA.
Logical device object models are specialized groupings of associated bricks that
represent devices, functions, or applications of a specific function or application in the
problem domain — e.g., protection, control, and data acquisition.
The name of the data set is case-sensitive, and it must exactly match the name of the
logical device in the IEC61850 model.
There are no parameters for these data sets.

IEC61850 brick data sets

Brick data sets are used to select the measurements in the IEC61850 device that are to
be mapped to the SCADA database. A brick data set is modeled for each brick in the
IEC61850 device that is to be mapped to the SCADA database.
The name of the data set is case-sensitive, and it must exactly match the name of the
brick in the IEC61850 model.

Proprietary – See Copyright Page 180 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
Periodic Read functionality is used to read a brick periodically. This is used when there
is no Unbuffered report block defined for that brick. The period is given in seconds, and
the parameter to model this functionality is:
PeriodicRead=<Period in Seconds>

Figure 97. IEC61850 Periodic Read Parameter

Individual components of a brick are modeled by adding data items to the data set.
These data items have linkages to measurements. This is the mechanism for mapping
IEC61850 measurements to e-terracontrol measurements.

Figure 98. IEC61850 Client Data Items

Proprietary – See Copyright Page 181 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
Control data items are used to model the controls to be issued to the IEC61850 device.
The Control Items are modeled under the same Data Set Brick as the ST and MX.

Data items should be modeled for each control or setpoint record.

Figure 99. IEC61850 Client Control Data Items

Proprietary – See Copyright Page 182 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
Data item name controls are modeled with the following convention:
CO$<Dataobject>$<value>
Where:
• <DataObject> represents the name of the control, typically the name of the data
object defined under the functional component CO.
• <Value> represents the value of the control. This value can be:
– Close: Send a close command, 1 for BOOL data type or 0x80 for non-BOOL
data type.
– Open: Send an open command, 0 for BOOL data type or 0x40 for non-BOOL
data type.
– Raise: Send a raise command, 0x40. Only valid for tap changer.
– Lower: Send a lower command, 0x80. Only valid for tap changer.
– An integer: When the value is an integer, the value in the data item name is
converted to an integer and sent to the server. This allows you to send a user-
defined control value of an INT32 data type. For example, for a control definition
of a command to “Change Setting of an IED: CO$ChgSg$4”, the value “4” is
sent.
The IEC61850 client application user interface can be used for diagnostic purposes.
This section describes the interface.

Figure 100. IEC61850 Client User Interface

On the left is a tree display of the IEC61850 devices modeled in the e-terracontrol
database. It displays the remote device and the bricks modeled under it.

Proprietary – See Copyright Page 183 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
On the right are details of any item selected in the tree. Current data value, quality, and
time stamps are displayed in the details.

9.4 Indexed Report Configuration

When the IEC61850 client connects to an IEC561850 device that uses an indexed
report, the IEC61850 client application needs to know which index to enable for this
device. The Report Index number is specified using a parameter string at the device
data set level. The parameter string is “IndexReport=<index #>”, where <index #>
represents a valid number. Only one IndexReport parameter string is allowed. To know
what index number is associated with the client, see the IED configuration.
In the following example, the index report number two is configured.

Figure 101. IEC61850 Client Indexed Report

9.5 Static Data Sets vs. Dynamic Data Sets

The IEC61850 client works with static data sets only. The IED should be configured with
a static data set. No dynamic data sets are supported by the IEC61850 client.

Proprietary – See Copyright Page 184 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
9.6 Troubleshooting a Failed Connection
An IEC61850Client connection is properly formed with the server when an association
is started between the client and the server. Sometimes, the Agency may fail to start the
association because of incorrect parameters. When a connection fails to establish, look
at the IEC61850Client log entry in the Agency log file. The Agency log file is located in
the Agency executable folder.
The Agency log file may have the following errors:
• "ERROR inserting 'XXX' object. Max num 3 exceeded."
The MaxDomainPerServer parameter must be increased in the Agency.cfg file. This
value should be larger than the maximum number of Logical Nodes that are defined
in the Data Model.
• "l_ODCLoadModels() ERROR: numServers > hAgencyParam-
>MaxServersPerClient(2)."
The MaxServerPerClient parameter must be increased in the Agency.cfg file. This
value should be larger than the number of Server(s) that are defined in the Lean.cfg
file.
If the disconnection is not detected by the IEC61850Client when the network cable is
unplugged, verify that the rfc1006_keepAlive parameter is present in the Lean.cfg file
under the TP4 specifics parameters.

Proprietary – See Copyright Page 185 IEC61850 Client Interface

e-terracontrol Reference Manual: Interfaces to Field Devices
10. IEC61850 Communications Agency

10.1 Agency Application

The IEC61850 client applications automatically start and stop the Agency application as
needed.
When running, the Agency application places a small icon to the lower right of the
machine’s console. Double-clicking on this icon causes the agency log to be displayed.
A copy of the agency log is also created in the directory where the agency executable
resides (drive:\areva\pacis\UCA2agency\agency.log).

10.2 Agency Lean.cfg Configuration File

The PACiS IEC61850 Agency application uses SISCO’s MMS-LITE for MMS
implementation.
MMS-LITE uses a text file for its “database” that defines the devices to talk to. For each
device, the following data is added to the Lean.cfg file:
Begin_Remote
Common_Name = server1
Psel = 00 00 00 01
Ssel = 00 01
Tsel = 00 01
Transport = TCP
Ip_addr = 204.254.125.149
End_Remote

Proprietary – See Copyright Page 186 IEC61850 Communications Agency

e-terracontrol Reference Manual: Interfaces to Field Devices
11. IEC61850 Configuration Application
Before using the IEC61850 client to communicate with a new device, the device’s model
must be obtained using the IEC61850 Configuration application.

11.1 User Interface

Figure 102. IEC61850 Configuration User Interface

By default, the obtained XML file goes into a new IEC61850WORK subfolder of the
e-terracontrol installation location. The integrator cannot override this location.
All servers connected to the IEC61850 client must be defined on the
IEC61850 Server(s) Definition List.
For each server, you must define the name and the IP address of the server. The server
name is equal to the ARName defined in the IEC61850 device data set in the
configuration of the SCADA device.
All information entered is automatically updated in the Lean.cfg located under the
Agency executable folder.
The stop extraction button allows you to interrupt the Model(s) extraction process for the
selected data model in the list.

Proprietary – See Copyright Page 187 IEC61850 Configuration Application

e-terracontrol Reference Manual: Interfaces to Field Devices
11.2 What the Batch File Does
When the user clicks the Extract Selected Model button, IEC61850 Configuration
extracts the data model from the server and stores the data in an XML file. The name of
the XML file is the concatenation of the ARName of the server and the suffix
_extracted.xml — for example, “C264_extracted.xml”.
This file is transformed using the batch file to generate two files: one for the Agency with
the .dm extension, and one for the IEC61850 client with the .xml extension.
The final names of these files are the ARName of the server plus the extension — for
example, “C264.dm” and “C264.xml”.
All errors detected during the transformation of the model are logged in the Log Event
dialog box of the IEC61850 Configuration application.
The batch is launched after the extract models are done, and it takes the ARName of
the server as a parameter.
The batch file copies the two generated files into their respective folders. These folders
are identified in the batch file. The configuration file with the .dm extension needs to be
in the same folder as the Win32Agency.exe application. The configuration file with the
.xml extension for the IEC61850 client is copied into the IEC6180Models directory.

11.3 IEC61850Config Batch File and Error Diagnosis

11.3.1 Update of Variable Environments

During the e-terracontrol installation, this batch file is copied into the
data\IEC61850Work directory. The batch file needs some environment variable
configuration.
The batch file can be regenerated with the path of the current installation by clicking the
Generate Batch File button on the IEC61850 Configuration application.
Once you have opened the batch file, find the line:
rem SECTION – Set Environment variable
Update the WIN32AGENCY_DIR, ODFOUNDRY_DIR, ETERRACTRLDATA_DIR, and
XSL_XML_DIR variables with your own configuration parameter path.
By default, the section is as follows:
set WIN32AGENCY_DIR="c:\Program Files\AREVA\PACIS\UCA2Agency\exe"

set ODFOUNDRY_DIR="C:\Program Files\AREVA\PACIS\UCA2Agency\odfoundry"

set ETERRACTRLDATA_DIR="D:\eterra\e_terracontrol\Data"
set XSL_XML_DIR="C:\Program Files\AREVA\PACIS\UCA2Agency\odfoundry\xml"
• WIN32AGENCY_DIR points to the win32agency.exe directory.

Proprietary – See Copyright Page 188 IEC61850 Configuration Application

e-terracontrol Reference Manual: Interfaces to Field Devices
• ODFOUNDRY_DIR points to the odfoundry.exe directory.
• ETERRACTRLDATA_DIR points to the e-terracontrol data directory.
• XSL_XML_DIR points to the XML directory.

11.3.2 Error Diagnosis

During the transformation, the following error can occur:

This error is explained in the Foundry log, which is in the IEC61850Work directory.
When this file is open, the error can be formed as follows:
**********************************************************
LOGGING STARTED Thu Jan 12 16:13:53 2006
***********************************************************
00.000s SLOGALWAYS (FO_MAIN.C 198) \
Executing "odfoundry"
Input TDL file : "C264N5.odf"
Configuration file: "align.cfg"
Output "C" file : "C264N5.c"
Output "H" file : "C264N5.h"
00.015s SLOGALWAYS (FO_PARSE.C 1496)
Could not find type “VBSTR9”
00.015s MMS_LOG_NERR (MMS_TDEF.C 1102)
Named type VBSTR9 not found
00.015s SLOGALWAYS (FO_PARSE.C 776)
Fatal error! ASN1->RT conversion err, type “BRCB”
Error at input line 424 (424 in file “C264N5.odf”). Terminated.
To resolve this error “Could not find type ‘VBSTR9’”, the VBSTR9 PrimitiveClass needs
to be added to the PrimClass.xml file. The PrimClass.xml file is part of the Agency
installation, and it can be found in the <agency installation
folder>\UCA2Agency\odfoundry\xml folder.

Proprietary – See Copyright Page 189 IEC61850 Configuration Application

e-terracontrol Reference Manual: Interfaces to Field Devices
This PrimitiveClass node then needs to be added at the end of the PrimitiveClass
nodes, as follows:
<PrimitiveClass Name="RTYP_BSTR9" Description="Bit string"
InternalType="Bstring" Length="9" ClassIndex="33" Sz="6" />
<PrimitiveClass Name="RTYP_OSTR8" Description="Octet string"
InternalType="Ostring" Length="8" ClassIndex="34" Sz="8" />
<PrimitiveClass Name="VOSTR64" Description="Variable octet string"
InternalType="Ovstring" Length="64" ClassIndex="35" Sz="66" />
<PrimitiveClass Name="VBSTR2" Description="Bit string"
InternalType="Bvstring" Length="2" ClassIndex="36" Sz="4" />
<PrimitiveClass Name="VBSTR13" Description="Bit string"
InternalType="Bvstring" Length="13" ClassIndex="37" Sz="4" />
<PrimitiveClass Name="VBSTR9" Description="Bit string"
InternalType="Bvstring" Length="9" ClassIndex="38" Sz="4" />
Make sure that the ClassIndex value is one more than the last ClassIndex value.
Also make sure to define the size of the new PrimitiveClass inserted.

Proprietary – See Copyright Page 190 IEC61850 Configuration Application

e-terracontrol Reference Manual: Interfaces to Field Devices
12. IEC61850 Interoperability
This chapter attempts to more specifically qualify e-terracontrol’s IEC61850 interface
interoperability.

12.1 Abstract Communication Service Interface (ACSI)

Conformance Statement
This section contains the ACSI conformance statement that specifies the device
communication features mapped to a Specific Communication Service Mapping
(SCSM).

12.1.1 General
The following ACSI conformance statements are used to provide an overview and
details about a device claiming conformance with ACSI:
• ASCI basic conformance statement
• ACSI models conformance statement
• ACSI service conformance statement
To specify the communication features mapped to an SCSM, the “value /comments”
give the e-terracontrol IEC61850 client the currently supported statements.

Note 1: The conformance statements of this annex are abstract in the sense that the
ACSI models and their services are mapped to application layer models, services, and
protocols. Additional details on the conformance are defined in the SCSM.
Note 2: For several features, the conformance requirement is implicitly defined with
the common data class contained in part IEC 61850-7-3 and the compatible
LOGICAL-NODE classes and DATA classes contained in part IEC 61850-7-4. For
example, a TrgOp (trigger option) of the value qchg (quality change) of DataAttribute
requires the support of the TrgOpEna (trigger option enabled) qchg of the BRCB or
URCB.

Proprietary – See Copyright Page 191 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
12.1.2 ASCI Basic Conformance Statement
The basic conformance statement is defined in Table 3.

Table 3. Basic Conformance Statement

Client/Subscriber Value/Comments
Client-Server Roles
B11 Server side (of TWO-PARTY- –
APPLICATION-ASSOCIATION)
B12 Client side of (TWO-PARTY- Y
APPLICATION-ASSOCIATION)
SCSMs Supported
B21 SCSM: IEC 6185-8-1 used A-Profile client/server
T-Profile TCP/IP
A-Profile GSE/GOOSE
T-profile GSE/GOOSE
B22 SCSM: IEC 6185-9-1 used N
B23 SCSM: IEC 6185-9-2 used N
B24 SCSM: other N
Generic Substation Event Model (GSE)
B31 Publisher side –
B32 Subscriber side Y Not implemented in
e-terracontrol
Transmission of Sampled Value Model (SVC)
B41 Publisher side –
B42 Subscriber side N

Proprietary – See Copyright Page 192 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
12.1.3 ACSI Models Conformance Statement
The ACSI models conformance statement is defined in Table 4.

Table 4. ACSI Models Conformance Statement

Client/ Server/ Value/Comments
Subscriber Publisher
If Server side (B1) supported
M1 Logical device Y
M2 Logical node Y
M3 Data Y
M4 Data set Y
M5 Substitution Y
M6 Setting group control N
Reporting
M7 Buffered report control Y Not implemented in e-terracontrol
M7-1 sequence-number Y Not implemented in e-terracontrol
M7-2 report-time-stamp Y Not implemented in e-terracontrol
M7-3 reason-for-inclusion Y Not implemented in e-terracontrol
M7-4 data-set-name Y Not implemented in e-terracontrol
M7-5 data-reference Y Not implemented in e-terracontrol
M7-6 buffer-overflow Not implemented in e-terracontrol
M7-7 entryID Y Not implemented in e-terracontrol
M7-8 BufTim Y Not implemented in e-terracontrol
M7-9 IntgPd Y Not implemented in e-terracontrol
M7-10 GI Y Not implemented in e-terracontrol
M8 Unbuffered report control Y
M8-1 sequence-number Y
M8-2 report-time-stamp Y
M8-3 reason-for-inclusion Y
M8-4 data-set-name Y
M8-5 data-reference Y
M8-6 BufTim Y
M8-7 IntgPd Y
Logging N
M9 Log control N

Proprietary – See Copyright Page 193 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 Client/ Server/ Value/Comments
Subscriber Publisher
M9-1 IntgPd
M10 Log N
M11 Control Y
If GSE (B31/32) is supported
GOOSE Y Not implemented in e-terracontrol
M12-1 entryID Y Not implemented in e-terracontrol
M12-2 DataRefInc Y Not implemented in e-terracontrol
M13 GSSE N
If SVC (41/42) is supported
M14 Multicast SVC N
M15 Unicast SVC N
M16 Time Y Time source with required
accuracy is available
M17 File Transfer Y Not implemented in e-terracontrol
c1 will be “M” if support for LOGICAL-DEVICE model has been declared.
c2 will be “M” if support for LOGICAL-NODE model has been declared.
c3 will be “M” if support for DATA model has been declared.
c4 will be “M” if support for DATA-SET, Substitution, Report, Log Control, or Time model has been
declared.
c5 will be “M” if support for Report, GSE, or SMV models has been declared.

12.1.4 ACSI Service Conformance Statement

The ACSI service conformance statement is defined in Table 5 (depending on the
statements in Table 3).

Table 5. ACSI Service Conformance Statement

Services AA:TP/MC Client (C) Server (S) Comments
Server (clause 6)
S1 ServerDirectory TP -
Application association (clause 7)
S2 Associate Y
S3 Abort Y
S4 Release Y
Logical device (clause 8)
S5 LogicalDeviceDirectory TP Y

Proprietary – See Copyright Page 194 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 Services AA:TP/MC Client (C) Server (S) Comments
Logical node (clause 9)
S6 LogicalNodeDirectory TP Y
S7 GetAllDataValues TP Y
Data (clause 10)
S8 GetDataValues TP Y
S9 SetDataValues TP Y
S10 GetDataDirectory TP Y
S11 GetDataDefinition TP Y
Data set (clause 11)
S12 GetDataSetValues TP Y
S13 SetDataSetValues TP Y
S14 CreateDataSet TP N
S15 DeleteDataSet TP N
S16 GetDataSetDirectory TP Y
Substitution (clause 12)
S17 SetDataValues TP Y
Setting group control (clause 13)
S18 SelectActiveSG TP N
S19 SelectEditSG TP
S20 SetSGValues TP
S21 ConfirmEditSGValues TP
S22 GetSGValues TP
S23 GetSGCBValues TP
Reporting (clause 14)
Buffered report control block (BRCB)
S24 Report TP Y Not implemented in
e-terracontrol
S24-1 data-change (dchg) Y Not implemented in
e-terracontrol
S24-2 qchg-change (qchg) Y Not implemented in
e-terracontrol
S24-3 data-update (dupd) Y Not implemented in
e-terracontrol
S25 GetBRCBValues TP Y Not implemented in
e-terracontrol
S26 SetBRCBValues TP Y Not implemented in
e-terracontrol

Proprietary – See Copyright Page 195 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 Services AA:TP/MC Client (C) Server (S) Comments
Unbuffered report control block (URCB)
S27 Report TP Y
S27-1 data-change (dchg) Y
S27-2 qchg-change (qchg) Y
S27-3 data-update (dup Y
S28 GetURCBValues TP Y
S29 SetURCBValues TP Y
c6 declares support for at least one (BRCB or URCB)
Logging (clause 14)
Log control block
S30 GetLCBValues TP N
S31 SetLCBValues TP N
Log
S32 QueryLogByTime TP N
S33 QueryLogByEntry TP N
S34 GetLogStatusValues TP N
c7 declares support for at least one (QueryLogByTime or QueryLogByEntry)
Generic substation event model (GSE) (clause 14.3.5.3.4)
GOOSE-CONTROL-BLOCK
S35 SendGOOSEMessage MC Y Not implemented in
e-terracontrol
S36 GetReference TP Y Not implemented in
e-terracontrol
S37 GetGOOSEElementNumber TP Y Not implemented in
e-terracontrol
S38 GetGoCBValues TP Y Not implemented in
e-terracontrol
S39 SetGoCBValues TP Y Not implemented in
e-terracontrol
GSSE-CONTROL-BLOCK
S40 SendGSSEMessage MC N
S41 GetReference TP N
S42 GetGSSEElementNumber TP N
S43 GetGsCBValues TP N
S44 SetGsCBValues TP N
c8 declares support for at least one (SendGOOSEMessage or SendGSSEMessage)
c9 declares support if TP association is available

Proprietary – See Copyright Page 196 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 Services AA:TP/MC Client (C) Server (S) Comments
Transmission of sampled value model (SVC) (clause 16)
Multicast SVC
S45 SendMSVMessage MC N
S46 GetMSVCBValues TP N
S47 SetMSVCBValues TP N
Unicast SVC
S48 SendUSVMessage TP N
S49 GetUSVCBValues TP N
S50 SetUSVCBValues TP N
c10 declares support for at least one (SendMSVMessage or SendUSVMessage)
Control (clause 16.4.8)
S51 Select Y
S52 SelectWithValue TP Y
S53 Cancel TP Y Not implemented in
e-terracontrol
S54 Operate TP Y
S55 Command- TP Y Not implemented in
Termination e-terracontrol
S56 TimeActivated-Operate TP N
File transfer (clause 20)
S57 GetFile TP Y Not implemented in
e-terracontrol
S58 SetFile TP Y Not implemented in
e-terracontrol
S59 DeleteFile TP Y Not implemented in
e-terracontrol
S60 GetFileAttributeValues TP Y Not implemented in
e-terracontrol
Time (clause 5.5)
T1 Time resolution of internal 10 Nearest negative
clock power of 2 in
seconds
T2 Time accuracy of internal Y T0
clock
Y T1
N T2
N T3
N T4

Proprietary – See Copyright Page 197 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 Services AA:TP/MC Client (C) Server (S) Comments
N T5
T3 supported TimeStamp - 10 Nearest negative
resolution power of 2 in
seconds

12.2 Interoperability Matrix

The following sections specify which devices have been tested with the IEC61850 stack
used by e-terracontrol.
If a device is not listed in this table, or if it is listed but does not have an integration level
of “3”, 61850 interoperability between e-terracontrol and this device might not succeed.
In this case, you should contact Alstom Grid for further assistance.

Proprietary – See Copyright Page 198 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
12.2.1 MiCOM P40

Table 6. MiCOM P40

IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engnc

Level Over Time Etraction Synchro
Ethernet Values

P141 Feeder
Management Relay

P141
3 42B 42B 42B 42B x
Phase2

P142 Feeder
Management Relay 3 350D 350D 350D 350D x
with Autoreclose

P142
3 42B 42B 42B 42B x
Phase 2

P143 Feeder
Management Relay
with Autoreclose
and Check
Synchronizing

P143
3 42B 42B 42B 42B x
Phase2

P144 Feeder
Management Relay
with Autoreclose
for 2CT and delta
VT application
(LADWP-US)

P145 3 35A 35A 35A 35A x

P241 Rotating Machine

Management

P242 Rotating Machine

Management

P243 Rotating Machine

Management

P341 Interconnection
Protection Relay

P342 Generator
Protection Relay

Proprietary – See Copyright Page 199 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engnc

Level Over Time Etraction Synchro
Ethernet Values

P343 Generator
Protection Relay
with Generator
Differential

P344 Generator
Protection Relay
with check
synchronization

P345 Generator
Protection Relay
3 33A 33A 33A 33A x
with check
synchronization

P442 Enhanced Distance

3 45 45 45 45 x
Protection Relay

P443

P444 Enhanced Distance

3 D1.2 D1.2 D1.2 D1.2 x
Protection Relay

P541 Current Differential

Relay

P542 Current Differential

Relay with
Autoreclose

P543 Current Differential

Relay with
Autoreclose, Check 3 54A 54A 54A 54A x
Synchronizing and
Distance

P544 Current Differential

Relay with
Distance Backup
suitable for 2
Breaker
Configurations

P545 Current Differential

Relay with
Distance Backup
suitable for 2
Breaker
Configurations +
Extra

Proprietary – See Copyright Page 200 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engnc

Level Over Time Etraction Synchro
Ethernet Values

P546 Current Differential

Relay with
Distance Backup
suitable for 2
Breaker
Configurations +
GPS

P547 Phase Comparison

3 52A 52A 52A 52A x
Protection

P741 Bus-Bar Protection

(Via
3 D2.2 D2.2 D2.2 D2.2
KITZ20401L15CEE
)

P742 Bus-Bar Protection

(Via
KITZ20401L15CEE
)

P742 Bus-Bar Protection

Phase2 (Via
KITZ27401*1*CEF
)

Bus-Bar Protection
(Via
P743 3 D2.2 D2.2 D2.2 D2.2
KITZ20401L15CEE
)

P746 Bus-Bar Protection 3 30A 30A 30A 30A

P841 Auto-Recloser

P842 Auto-Recloser +
mesch corner

P941 Frequency Relay

with 7 Output
Relays and 8
Digital Inputs

P942 Frequency Relay

with 14 Output
Relays and 8
Digital Inputs

Proprietary – See Copyright Page 201 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engnc

Level Over Time Etraction Synchro
Ethernet Values

P943 Frequency Relay

with 14 Output
Relays and 16
Digital Inputs

Proprietary – See Copyright Page 202 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
12.2.2 MiCOM P30

Table 7. MiCOM P30

IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engnc

Level Over Time Etraction Synchro
Ethernet Values

P130 C

P132 Time-Overcurrent
Protection & 2 613.206 613.206 613.206 613.206 x
Control

P138 Railway Feeder

3 612.02 612.02 612.02 612.02
Protection Relay

P139 Time-Overcurrent
Protection & 2 616.213 616.213 616.213 616.213 x
Control Unit

P430 Compact Distance

Protection Relay

P430 C

P432 EHV Distance

Protection and
Control

P433 Modular Distance

2 612.204 612.204 612.204 612.204 x
Protection Relay

P435 Modular Distance

3 612.204 612.204 612.204 612.204 x
Protection Relay

P436 16 2/3 Hz Railway

Distance Protection
Relay

P437 Full Scheme

Modular Distance 3 612.203 612.203 612.203 612.203 x
Protection Relay

P438 Railway Distance

3 613.00 613.00 613.00 613.00
Protection Relay

P439 Distance Protection

3 615.208 615.208 615.208 615.208 x
and Control

P630 C

Proprietary – See Copyright Page 203 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engnc

Level Over Time Etraction Synchro
Ethernet Values

P631 Two Winding

Transformer
3 621.221 621.221 621.221 621.221 x
Differential
Protection

P632 Two Winding

Transformer
Differential 3 621.221 621.221 621.221 621.221 x
Protection with
Ground Differential

P633 Three Winding

Transformer
Differential 3 621.221 621.221 621.221 621.221 x
Protection with
Ground Differential

P634 Four Winding

Transformer
Differential 3 621.221 621.221 621.221 621.221 x
Protection with
Ground Differential

P638 Railway
Transformer
3 610.00 610.00 610.00 610.00
Differential
Protection

Proprietary – See Copyright Page 204 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
12.2.3 MiCOM P20

Table 8. MiCOM P20

IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Synchro

Level Over Time Etraction
Ethernet Values

P120 Single Phase or

Earth Overcurrent
Relay

P121 Three Phase and

Earth Overcurrent
Relay

P122 Advanced Three

Phase and Earth
Overcurrent Relay

P122C Advanced Three

Phase and Earth
Overcurrent Relay

P123 Expert Three

Phase and Earth
Overcurrent Relay

P124D Dual-powered
overcurrent relay

P124S Self-powered
overcurrent relay

P125 Directional Earth

fault Relay

P126 Three Phase o/c

and Directional E/f
Relay

P127 Three Phase and

Earth Directional
Overcurrent Relay

P127C Three Phase and

Earth Directional
Overcurrent Relay

P210 Three-phase Low

Voltage Motor
Protection Relay

Proprietary – See Copyright Page 205 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Synchro

Level Over Time Etraction
Ethernet Values

P220 Integrated
Protection for
Motors

P225 Motor Protection

Relay

P226C Motor Protection +

feeder Relay

P521 Cable differential

Relay

P821

P921 Voltage Relay

P922 Voltage and

Frequency Relay

P922C Voltage and

Frequency Relay

P922G Voltage and

Frequency Relay
for GTE2666

P923 Voltage and

Frequency Relay
with df/dt

P925

Proprietary – See Copyright Page 206 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
12.2.4 Alstom Grid

Table 9. Alstom Grid

IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engnc

Level Over Time Etraction Synchro
Ethernet Values

M220 Measurement
Centre

M230 Measurement
Centre

M231 Measurement
Centre

M300 Measurement
Centre

M301 Measurement
Centre

M721 Power Quality

M723 Meter

M722 Power Quality

M724 Meter

MS 3000 3 2.22 x

M830 Disturbance
Recorder

M871 PowerServe
NOTE 3 3 610.201 610.201 610.201 610.201 610.201 x
Meter/Recorder

C232 Small Bay

Controller

C434 Bay Controller

C264 Bay Computer

C264C

I400 Digital
Transducers

GEMSTART
V4.3

GEMSTARTV5

Proprietary – See Copyright Page 207 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engnc

Level Over Time Etraction Synchro
Ethernet Values

PS462 Multifunctional
O/C Protection

PS482 Multifunctional
Directional O/C
Protection

VAMP-50 3 V10.38 V10.38 V10.38 V10.38

VAMP-255 3 V10.55 V10.55 V10.55 V10.55

BWATCH Monitoring HV

Proprietary – See Copyright Page 208 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
12.2.5 Other IEDs

Table 10. Other IEDs

IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engc

Level Over Time Etraction Synchro
Ethernet Values

MR TAPCON Voltage
240 regulator
Maschinenfabrik TAPCON Petersen Coil
Reinhausen 3 X X
260 Regulator

TRENCH EFC20 Petersen Coil

3 V1.7 V1.7
Regulator

EBERLE REG-D Voltage IEC:V4 IEC:V4

2
regulator 3 3

EBERLE REG-DP Petersen Coil IEC:V1 IEC:V1

3
Regulator 6 6

SIEMENS 7SD522 Distance

protection

SIEMENS 7SD532 Line diff

3 v4.6 v4.6 v4.6 v4.6
protection

SIEMENS 7SA513

SIEMENS 7UT513

SIEMENS 7UT613 3 v4.6 v4.6 v4.6 v4.6

SIEMENS 7SA522 3 v4.6 v4.6 v4.6 v4.6

SIEMENS 7SA611 Distance

3 v4.6 v4.6 v4.6 v4.6
protection

SIEMENS 7SA612 Distance

protection

SIEMENS 7SD511 Line diff

protection

SIEMENS 7SD610 Line diff

3 v4.6 v4.6 v4.6 v4.6
protection

SIEMENS 7SS522 Busbar

protection

SIEMENS 7SS523 Busbar

protection

Proprietary – See Copyright Page 209 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engc

Level Over Time Etraction Synchro
Ethernet Values

SIEMENS 6MD6 HV Control v4.70.0 v4.70.0 v4.70.0

3
device 3 3 3

SIEMENS 7SJ62 Protection

ABB INSUM

ABB REB500 Busbar

3 v7.32 v7.32 v7.32 x
protection

ABB REL
316_4

ABB RL521 Protection

ABB RED670 3 X X X x

ABB RL551 Protection

VA TECH TAU
200

WAGO 750-315 Small IOs

Controller

SCHNEIDER SEPAM Busbar

100 LD protection

SCHNEIDER SEPAM
1000 S20

SCHNEIDER SEPAM Under voltage

1000 B21 for Bus Section

SCHNEIDER SEPAM Incomers

1000 M41

SCHNEIDER SEPAM MV Feeder

1000 S40

SCHNEIDER SEPAM MV Feeder

1000 S42

SCHNEIDER SEPAM
1000 T87

SCHNEIDER SEPAM
1000 B83

SCHNEIDER SEPAM MV motor

1000+ feeders

Proprietary – See Copyright Page 210 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engc

Level Over Time Etraction Synchro
Ethernet Values

SCHNEIDER SEPAM Diff/Ref for

2000 D22 Transfo feeders

SCHNEIDER SEPAM MV feeders

2000
S36T15

SCHNEIDER SEPAM Feeder

2026-
TZTF-B25

SCHNEIDER SEPAM MV feeders

2035D22

SCHNEIDER SEPAM MV Bus Section

2036KR- riser
W02

SCHNEIDER SEPAM MV Feeder

2036CR-
D22

SCHNEIDER SEPAM MV Feeder

2036-
LRT07

SCHNEIDER SEPAM MV feeders

2036T07

SCHNEIDER SEPAM MV Motor

2036M14

SCHNEIDER SEPAM MV Incomer

2036S02

SCHNEIDER SEPAM 50/51

T07

SCHNEIDER SEPAM Synchro-check

B25

SCHNEIDER SEPAM
M20

SCHNEIDER SEPAM
T20

SCHNEIDER PM500

SCHNEIDER CM4000

Merlin Gerin PM500

Proprietary – See Copyright Page 211 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engc

Level Over Time Etraction Synchro
Ethernet Values

ICE PDZ1-N1 Protective relay

ION 7330 Measurement/

counting unit

ION 8600 power quality

and energy
meter

ION 7500 power quality

and energy
meter

SEL SEL 311L Protective relay

SEL SEL Protective relay

35100%

SEL SEL 321 Protective relay

SEL SEL 421 Protective relay

SEL SEL 351-6 Protective relay

SEL SEL 387 Protective relay

SEL SEL 587-R Protective relay

SEL SEL 487B Protective relay 3 V4.14.2 V4.14.2

GE C30 3 5.61 5.61 5.61

GE C60

GE D60 3 5.02 5.02 5.02

GE F35 3 5.61 5.61 5.61

GE F60 3 5.61 5.61 5.61

GE F650 3 5.2 5.2 5.2

GE G60 3 5.61 5.61 5.61

GE L90

GE M60 3 5.61 5.61 5.61

GE T35 3 5.61 5.61 5.61

GE T60 3 5.61 5.61 5.61

REYROLLE Argus
TAU200

Proprietary – See Copyright Page 212 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
 IEC 61850 (PACiS V4)

Integration Goose Settings Real- D.R. Time Engc

Level Over Time Etraction Synchro
Ethernet Values

Swedish SN-NM-A1 Neutral

2 X X
Neutral manager

Swedish SN-NM-A1 Shunt Reactor

2 X X
Neutral

DYNATROL DS32

Proprietary – See Copyright Page 213 IEC61850 Interoperability

e-terracontrol Reference Manual: Interfaces to Field Devices
13. Double Point Processing
This chapter describes how e-terracontrol expects the bits (S and X) to be sent. It also
provides the results of the scan in CFEReader and the SCADA event display.
In SCADA Server, the double point is configured in two data items: one with S bit and
the other with X bit. e-terracontrol considers the scenario of S and X bit come as a pair
(for example: S X S X S X).
The following tables contain some scenarios and the result in the SCADA event list. The
S bit comes with the device time and the X bit comes without time.

S Bit X Bit State

0 0 MIDPOS
1 0 OPEN
0 1 CLOSED
1 1 ERROR

The scenario in Table 11 shows if S = 0 comes with the Device time and X = 1 comes
without time, the SCADA event list shows CLOSED with the Device time.

Table 11. S and X in a Single Scan

Scan S Bit X Bit CFEReader SCADA Server Events Display
0 (initial state) 1 0 Nothing OPEN
1 0 S = 0 (Device time: time1) Nothing
1 X = 1 (Without time) CLOSED with time1

The scenario in Table 12 shows that S = 0 comes with the Device time in the first scan;
SCADA combines S with the existing X and shows MIDPOS with the Device time. In the
second scan, X = 1 comes without time. So, SCADA combines X with the existing S and
shows CLOSED with SCADA time. Because S and X come in different scans, SCADA
does not pair them and show two states.

Table 12. S and X in Different Scans

Scan S Bit X Bit CFEReader SCADA Server Events Display
0 (initial state) 1 0 Nothing OPEN
1 0 S = 0 (Device time: time1) MIDPOS with time1
2 1 X = 1 (Without time) CLOSED with SCADA time

Proprietary – See Copyright Page 214 Double Point Processing

e-terracontrol Reference Manual: Interfaces to Field Devices
The scenario in Table 13 shows a data change coming in the order S X X S S X (as
pairs). So, SCADA pairs the corresponding S and X and shows the states with
corresponding Device times.

Table 13. S X X S S X in Single Scan

Scan S Bit X Bit CFEReader SCADA Server Events Display
0 (initial state) 1 0 Nothing OPEN
1 0 S = 0 (Device time: time1) Nothing
1 X = 1 (Without time) CLOSED with time1
0 X = 0 (Without time) Nothing
1 S = 1 (Device time: time2) OPEN with time2
0 S = 0 (Device time: time3) Nothing
1 X = 1 (Without time) CLOSED with time3

The scenario in Table 14 shows a data change coming as pairs (S X, X S, and S X) in

different scans. So, SCADA pairs the corresponding S and X and shows the states with
corresponding Device times.

Table 14. S X, X S, and S X in Different Scans

Scan S Bit X Bit CFEReader SCADA Server Events Display
0 (initial state) 1 0 Nothing OPEN
1 0 S = 0 (Device time: time1) Nothing
1 X = 1 (Without time) CLOSED with time1
2 0 X = 0 (Without time) Nothing
1 S = 1 (Device time: time2) OPEN with time2
3 0 S = 0 (Device time: time3) Nothing
1 X = 1 (Without time) CLOSED with time3

The scenario in Table 15 shows a data change coming in the order S X X S S in one
scan and X in the next scan from the RTU. So, SCADA pairs S and X; for the last S (0)
in the first scan it combines S with the existing X (0) and shows MIDPOS with the
Device time. For the X (1) that comes in the next scan, SCADA combines X with the
existing S (0) and shows CLOSED with SCADA time (because X comes without time).

Proprietary – See Copyright Page 215 Double Point Processing

e-terracontrol Reference Manual: Interfaces to Field Devices
Table 15. S X X S S and X in Different Scans
Scan S Bit X Bit CFEReader SCADA Server Events Display
0 (initial state) 1 0 Nothing OPEN
1 0 S = 0 (Device time: time1) Nothing
1 X = 1 (Without time) CLOSED with time1
0 X = 0 (Without time) Nothing
1 S = 1 (Device time: time2) OPEN with time2
0 S = 0 (Device time: time3) MIDPOS with time3
2 1 X = 1 (Without time) CLOSED with SCADA time

The scenario in Table 16 shows a data change that comes in the order S X S in one
scan and X S S in the next scan from the RTU. So, SCADA pairs S and X; for the last S
(1) in the first scan it combines S with existing X (1) and shows ERROR with the Device
time. For the last X (1) comes in the second scan, SCADA combines X with existing S
(0) and shows CLOSED with SCADA time (because X comes without time).

Table 16. S X S and X S X in Different Scans

Scan S Bit X Bit CFEReader SCADA Server Events Display
0 (initial state) 1 0 Nothing OPEN
1 0 S = 0 (Device time: time1) Nothing
1 X = 1 (Without time) CLOSED with time1
1 S = 1 (Device time: time2) ERROR with time2
2 0 X = 0 (Without time) Nothing
0 S = 0 (Device time: time3) MIDPOS with time3
1 X = 1 (Without time) CLOSED with SCADA time

The scenario in Table 17 shows a data change that comes in the order S X S S. This is
an invalid scenario. In this case, SCADA pairs S and X (S = 0 and X = 1) and shows
CLOSED with the Device time. After S = 1 there is another S (0) coming, so SCADA
ignores the S = 1 change. For the last S (0), the formed value is CLOSED (S = 0 and
existing X = 1) with Device time. Because the previous value is CLOSED, SCADA
shows nothing.

Note: The scenarios such as S S S X X X; S X S S; and so on that do not come as

pairs are not recommended by the DNP protocol and are not supported by
e-terracontrol. Following is one of the invalid scenarios.

Proprietary – See Copyright Page 216 Double Point Processing

e-terracontrol Reference Manual: Interfaces to Field Devices
Table 17. S X S S in Single Scan
Scan S Bit X Bit CFEReader SCADA Server Events Display
0 (initial state) 1 0 Nothing OPEN
1 0 S = 0 (Device time: time1) Nothing
1 X = 1 (Without time) CLOSED with time1
1 S = 1 (Device time: time2) Nothing
0 S = 0 (Device time: time3) Nothing (because the previous
state is CLOSED)

Proprietary – See Copyright Page 217 Double Point Processing

e-terracontrol Reference Manual: Interfaces to Field Devices