0% found this document useful (0 votes)
478 views46 pages

E-Terracontrol 3.9 Reference Manual - Introduction and Configuration

Uploaded by

OSCAR
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
478 views46 pages

E-Terracontrol 3.9 Reference Manual - Introduction and Configuration

Uploaded by

OSCAR
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 46

e-terracontrol Reference Manual:

Introduction and Configuration

This document describes the system overview, modeling, and configuration activities for
e-terracontrol.

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 ................................................................................................ v
Purpose of This Document ............................................................................................ v
Who Should Use This Document .................................................................................. v
Structure of This Document .......................................................................................... v
For More Information..................................................................................................... v
Conventions ................................................................................................................. vii
Change Summary ....................................................................................................... viii

1. Overview ................................................................................................................. 1
1.1 e-terracontrol Software Product Footprints ............................................................. 1
1.1.1 Plant Data Interface ........................................................................................... 2
1.1.2 Substation Data Server ...................................................................................... 3
1.1.3 Substation Gateway ........................................................................................... 4
1.1.4 Small SCADA Master ......................................................................................... 5
1.1.5 e-terraplatform SCADA Front End Processor .................................................... 6
1.1.6 Typical EMS System Overview .......................................................................... 7
1.2 e-terracontrol Architecture ...................................................................................... 8
1.2.1 e-terracontrol User Interface.............................................................................. 8
1.2.2 Localization ........................................................................................................ 9
1.2.3 e-terracontrol Applications ................................................................................. 9
1.2.4 e-terracontrol Object Data Model .................................................................... 10
1.2.5 e-terracontrol Interfaces .................................................................................. 10

2. System Requirements and Installation .............................................................. 12


2.1 Minimum System Requirements ........................................................................... 12
2.1.1 System Sizing Limitations ................................................................................ 12
2.2 Software Installation Instructions........................................................................... 13
2.2.1 Installation Notes ............................................................................................. 13
2.2.2 IEC61850 Communications Agency ................................................................ 13

3. Guided Tour of e-terracontrol ............................................................................. 14


3.1 Guided Tour .......................................................................................................... 14
3.2 Set Up e-terracontrol ............................................................................................ 14
3.2.1 Practice Using the Kirkland Station Display ..................................................... 16
3.2.2 Alarms .............................................................................................................. 18
3.2.2.1 Setup .......................................................................................................... 18
3.2.2.2 Create an Alarm .......................................................................................... 18
3.2.3 Analog Trends in e-terrabrowser ..................................................................... 21
3.2.3.1 Setup .......................................................................................................... 21
3.2.3.2 Access the Analog Trends from the Measurements Tabular Display.......... 21
3.3 The Process Starter and Modbus.......................................................................... 22
3.3.1 Practice Using the Process Starter .................................................................. 22
3.3.2 Verify the Interaction between SCADA and Modbus ........................................ 26
3.4 The Measurement History Application .................................................................. 27

Proprietary – See Copyright Page iii


3.4.1 View Historical Data ......................................................................................... 28
3.5 Virtual Charts ........................................................................................................ 28
3.5.1 Setup................................................................................................................ 29
3.5.2 The Virtual Chart Display ................................................................................. 29

4. Configuration Notes ............................................................................................. 31


4.1 Client vs. Server Installations ................................................................................ 31
4.1.1 The Remote Logon .......................................................................................... 31
4.2 Redundancy and Line Switching ........................................................................... 32
4.3 Exceptions Handling ............................................................................................. 33

5. Logging and Monitoring ...................................................................................... 36


5.1 Logging ................................................................................................................. 36
5.2 Logging Format ..................................................................................................... 36
5.3 Monitoring Overview ............................................................................................. 37
5.4 Monitoring Configuration ....................................................................................... 37

Figures
Figure 1. e-terracontrol’s Versatility for Multiple Applications .......................................... 1
Figure 2. e-terracontrol as a Plant Data Interface ........................................................... 2
Figure 3. e-terracontrol for a Substation Data Server ...................................................... 3
Figure 4. e-terracontrol as a Substation Gateway ........................................................... 4
Figure 5. e-terracontrol as a Small SCADA Master ......................................................... 5
Figure 6. e-terracontrol as an e-terraplatform SCADA Front End Processor................... 6
Figure 7. Typical EMS System Overview ........................................................................ 7
Figure 8. Overview of e-terracontrol’s Internal System.................................................. 11
Figure 9. Remote Client Logon Dialog Box ................................................................... 31
Figure 10. e-terracontrol Redundancy and Failover ...................................................... 32
Figure 11. e-terracontrol Crash Dialog Box ................................................................... 34
Figure 12. Doctor Watson User Interface ...................................................................... 35

Proprietary – See Copyright Page iv


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 e-terracontrol includes
• To provide configuration and 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 provides an overview of the e-terracontrol system and configurations.
• Chapter 2 describes the minimum system requirements and provides software
installation instructions.
• Chapter 3 offers a “guided tour” of e-terracontrol.
• Chapter 4 covers configuration notes.
• Chapter 5 provides an overview of logging formats and monitoring configurations.

For More Information


For more information about configuring and modeling e-terracontrol, refer to the
following:
• 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. These applications include
Measurement History, Sequence of Events (Compiler and Viewer), Simulator, SMP
Display Linker, Virtual Charts, and Alarm Viewer.
• e-terracontrol Reference Manual: Interfaces to Field Devices – Features
applications designed to retrieve measurements from field devices such as Remote

Proprietary – See Copyright Page v


Terminal Units (RTUs), Programmable Logic Controllers (PLCs), and Intelligent
Electrical Devices (IEDs). These applications include CFE Reader, CFE
Performance Driver, OPC DA Client, PLC Reader (Modbus Reader and TI Reader),
TrueTime Reader, and Relay Reader.
• e-terracontrol Reference Manual: Interfaces to External Systems – Features
applications designed to communicate with external systems such as EMS, DCS, 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 additional 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 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
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).

Proprietary – See Copyright Page vi


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 following conventions are used throughout this document. Commands that are
particular to an operating system are shown with the corresponding prompt symbol.

Command Prompts
Operating Prompt Description
System
Linux % All commands preceded by a percent sign prompt
(%) are issued from a Linux terminal window. Note
that all Linux commands are case sensitive.
Windows > All commands preceded by a greater than sign
prompt (>) are issued from a Windows command
line window.
All Operating The absence of any prompt character before a
Systems command indicates that the command is valid on
all operating systems.

Command Strings
Operating Delimiter Description
System
Linux Italics Text in italics indicates information you must
supply. (*)
Linux [] Text enclosed in square brackets "[ ]" indicates
optional qualifiers, arguments, or data. (*)
All Operating Select When used in command strings, the term “Select”
Systems means placing the pointer over the specified item
and pressing the left (default) mouse button.
(*) Note: All Linux commands are case sensitive and must be typed exactly as
shown.

Proprietary – See Copyright Page vii


Change Summary
The following changes were made to this document for e-terracontrol 3.9:
• Added chapter 5 Logging and Monitoring.
• Minor editorial and formatting corrections.

Proprietary – See Copyright Page viii


1. Overview
This chapter provides an overview of the e-terracontrol system and configurations.

1.1 e-terracontrol Software Product Footprints


Alstom Grid’s e-terracontrol provides the configuration flexibility to meet the changing
needs of a deregulated utility industry. In addition, e-terracontrol can be expanded to
accommodate future functional requirements.
Figure 1 illustrates e-terracontrol’s versatility for multiple applications:

Figure 1. e-terracontrol’s Versatility for Multiple Applications

The next few topics examine each of these functions, one by one.

Proprietary – See Copyright Page 1 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.1.1 Plant Data Interface
Using e-terracontrol, you can make the connection between market participants and
market operators.
e-terracontrol can function in the dual role of generator monitoring and plant control, as
shown in Figure 2.

Figure 2. e-terracontrol as a Plant Data Interface

Proprietary – See Copyright Page 2 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.1.2 Substation Data Server
e-terracontrol provides an open integrated platform for data collection devices, and it
provides open access to substation information via Wide Area Networks / Virtual Private
Networks (WANs/VPNs).
Figure 3 shows a configuration model typically used with e-terracontrol to integrate
substation data sources.

Figure 3. e-terracontrol for a Substation Data Server

Proprietary – See Copyright Page 3 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.1.3 Substation Gateway
e-terracontrol can serve as a protocol converter/data concentrator at communication
nodes. Using e-terracontrol, you can collect data from the plant control system and
make that data available to engineers, operators, and corporate users. Using this data
in real time can lead to more cost-effective use of facilities and resources.
Figure 4 shows e-terracontrol as a substation gateway.

Figure 4. e-terracontrol as a Substation Gateway

Proprietary – See Copyright Page 4 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.1.4 Small SCADA Master
e-terracontrol provides a platform for collection, management, and automation of
distributed SCADA data. It collects data using industry-standard communications
networked to Remote Terminal Units (RTUs), Programmable Logic Controllers (PLCs),
and Intelligent Electronic Devices (IEDs). The data can be archived and managed
locally for use by local applications and users.
Figure 5 shows e-terracontrol as a small SCADA master.

Figure 5. e-terracontrol as a Small SCADA Master

Proprietary – See Copyright Page 5 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.1.5 e-terraplatform SCADA Front End Processor
e-terracontrol is used as the RTU front end processor within the Alstom Grid
e-terrascada system.
The configuration is depicted in Figure 6.

Figure 6. e-terracontrol as an e-terraplatform SCADA Front End Processor

Proprietary – See Copyright Page 6 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.1.6 Typical EMS System Overview

Figure 7. Typical EMS System Overview

Note: The Digi/port expander needs to have network isolation (that is, be separate
from the EMS network) to ensure timely communications.

Proprietary – See Copyright Page 7 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.2 e-terracontrol Architecture
e-terracontrol uses industry-standard products such as PCs, Microsoft Windows, and
off-the-shelf communications products and object software.
You can configure e-terracontrol with dual-redundant PCs using its fail-over
applications. For maximum reliability, Alstom Grid recommends using industrial-grade
computers, probably rack-mounted, with rugged chassis construction.
Windows is an integral part of the development of object technology. e-terracontrol
uses Microsoft’s Component Object Model (COM), a Microsoft specification for an
object-oriented code and data encapsulation method that supports data messaging.
COM is the basis for OLE technologies, and it allows developers to build distributed
applications using Microsoft ActiveX components.
e-terracontrol also uses standard object tool kits to provide a robust system with built-in
extensibility and the flexibility to support a wide range of SCADA applications. The result
is a standardized, low-cost solution for SCADA requirements in a deregulated
environment.

1.2.1 e-terracontrol User Interface


Several user interface applications have been integrated into e-terracontrol. These
applications can be installed on the host machine and/or on remote clients.
• e-terrabrowser Viewer – You can use custom-built displays to view real-time data
and to issue controls where applicable, using the webfgviewer.exe program. You
can build these displays using the standard FG Display Builder.
Note that e-terrabrowser components are not delivered in the e-terracontrol install
executable; however, a separate e-terrabrowser client install is available.
• Virtual Charts – Replaces expensive inflexible hardware chart recorders with this
highly adaptable and portable virtual solution. These charts can be viewed on
workstation monitors, projection screens, or flat-panel displays.
• Measurement History – Allows users to view historical data for one or multiple
points within a specific window of time, and to sort that data by name, time, value, or
quality. In addition, this application provides a means to export this information into a
comma-separated value (.csv) file, which can be imported into a standard
spreadsheet for use in calculations or reports.
The user interface programs mentioned above can be utilized by installing the client on
each remote machine.
Additional ActiveX container applications can be built with languages such as C++ and
Microsoft Visual Basic.

Proprietary – See Copyright Page 8 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.2.2 Localization
Localization of e-terracontrol to non-English languages is available for the SCADA
Server, the Process Starter, and user interface applications.
Language selection is driven by the Windows Regional and Language Locale, with the
following languages being supported:
• English (United States)
• French (France)

1.2.3 e-terracontrol Applications


e-terracontrol applications are built using Microsoft Visual Studio languages. Some
applications, such as InterSite Data, are available from Alstom Grid. Other applications
that observe the e-terracontrol APIs can be supplied by third parties or built by the end
customer.
The SCADA server application is the core of e-terracontrol. SCADA maintains
substation objects that supply system functionality, while e-terracontrol provides basic
SCADA functionality consisting of:
• Persistent analog, status, and accumulator measurements
• Scaling and deadbanding
• Limit checking
• Multiple step controls
• Alarm and event processing
• Trending of historical information
User interface and gateway applications communicate with SCADA in two ways: one is
through an ActiveX automation control interface, while the other is through a
publisher/subscriber controls interface based on TCP/IP sockets.
Multiple interfaces allow multiple access points to a single instance of a SCADA
application. These ActiveX controls can be implemented by the user, or purchased with
a component library for a nominal cost.
Gateway applications transmit data from external systems and devices to the SCADA
application. They use TCP/IP to communicate with SCADA, and they use other
appropriate mechanisms to communicate with the external system or device. Since
gateway applications are separate and discrete, you only need to add the ones you
want.

Proprietary – See Copyright Page 9 Overview


e-terracontrol Reference Manual: Introduction and Configuration
1.2.4 e-terracontrol Object Data Model
The SCADA application is object-oriented, and it contains objects that have SCADA
attributes and functionality. Real-time data is maintained within these objects, so you no
longer need a traditional real-time database. When data is needed, use a method call to
get the data from its resident object.
The Object Data Model is based on important industry-standard object models1. One
goal of the object model was to develop open system communication architecture.
Another goal was to specify protocol requirements to permit interoperability of Intelligent
Electronic Devices in substations, regardless of manufacturer.
One result of the EPRI Research Project RP3599 was the Substation Object Reference
Model, which defines the exchange of information. A second result of this project was
the Generic Object Model for Substation Feeder Equipment (GOMSFE). These
reference models were used at the model analysis level, to build the e-terracontrol
application-level substation data model.
Since e-terracontrol data is represented in object form rather than in traditional attribute
files, the object contains a snapshot of the data at any time. As this data changes, it is
written to a binary file with the extension .sdb (SCADA database).

1.2.5 e-terracontrol Interfaces


User interface and gateway applications communicate with SCADA over the following
interfaces:
• OLE Automation Control Interface – OLE automation provides the easiest
programming interface to SCADA. OLE automation client applications can be built
using Visual Basic or C++. The application can direct SCADA to add, delete, or
modify SCADA objects. It can also issue controls and retrieve measurement data.
• Publisher/Subscriber Control Interface – The publisher/subscriber interface
allows for high-performance data update and automatic refresh. This interface is
based on TCP/IP sockets, and it can run on the same PC or between PCs. This
interface can be accessed using the subscriber control.
• InterSite Data – This is the ISD interface used by the gateway for integration into an
Alstom Grid e-terrahabitat-based SCADA system. The ISD protocol supports both
DECnet and TCP/IP communications. ISD does automatic database
resynchronization, and it supports multi-site configurations. It also supports InterSite
Controls for breaker and relay control execution.
• SCADADevice Control Interface – This is used for a device application to
communicate with SCADA. It allows applications to not only query the SCADA
database, but also to add, delete, or modify SCADA objects. Connection to the
database is configured through DataSources. This interface supports TCP/IP, thus

1
Specifically, the Electric Power Research Institute’s (EPRI) Research Project RP3599 (“Substation
Integration Protection, Control, and Data Acquisition”).

Proprietary – See Copyright Page 10 Overview


e-terracontrol Reference Manual: Introduction and Configuration
offering greater performance and reliability than the OLE Automation Control
Interface.
All of these interfaces allow multiple access points to a single instance of a SCADA
application.
An overview of e-terracontrol’s internal workings is shown in Figure 8.

Figure 8. Overview of e-terracontrol’s Internal System

Proprietary – See Copyright Page 11 Overview


e-terracontrol Reference Manual: Introduction and Configuration
2. System Requirements and Installation
This chapter describes the minimum system requirements and provides software
installation instructions.

2.1 Minimum System Requirements


For the successful installation and use of e-terracontrol, the minimum hardware and
software requirements are as follows:
Hardware:
• 650 MHz Pentium processor
• 512 MB of RAM
• 2 GB of available hard disk space (plus sizing for historical storage)
Software:
• Microsoft Windows 2008 R2
• e-terrabrowser 3.5
It is recommended that you consult with Alstom Grid in regards to your project-specific
hardware and software requirements.

2.1.1 System Sizing Limitations


The maximum system sizing for e-terracontrol is defined by the following
characteristics:
• 100,000 measurements for an EMS front end configuration; 50,000 measurements
in any other configuration.
• 500 network-based connections
A network-based connection is used for each e-terrabrowser connection as well as
for each e-terracontrol application (such as ISD or CFEReader), and each
connection to a network-based field device.
• 256 serial-based field device connections

Proprietary – See Copyright Page 12 System Requirements and Installation


e-terracontrol Reference Manual: Introduction and Configuration
2.2 Software Installation Instructions

2.2.1 Installation Notes


Note: You must install the separate software components in the order presented;
otherwise, dependencies and Windows user interface shortcuts may not be configured
properly.

WARNING: Before you install e-terracontrol, you must install e-terrabrowser.

Note that the user interface application is not packaged within the e-terracontrol
installation kit. It is not required that you install e-terrabrowser on the e-terracontrol
servers, but most systems are configured this way.
Other notes:
• Restart the computer whenever requested by the setup programs.
• Sometimes, the installation program(s) encounter a read-only file and ask what you
want to do. In these cases, be sure to overwrite existing files.
• Prior to upgrading an existing installation of the e-terracontrol product, make and
save copies of software license files, configuration files, and databases.
• Before you install e-terracontrol, you must un-install any previous version.
• Run e-terracontrol.exe and follow the instructions on the screen.

2.2.2 IEC61850 Communications Agency


The IEC61850 Communications Agency is used by the IEC61850Client application, and
it may be optional depending on your installation footprint. If you do not use the
IEC61850 protocol, then this step is not required.
The Communications Agency needs to be installed separately; it is provided within the
e_terracontrol\bin32 directory.
Run Agency_X.Y.X.exe, with “X”, “Y”, and “Z” as version numbers, as documented in
the e-terracontrol Release Notes. Running the Agency executable installs the
IEC61850 Communications Agency software in a folder named “PACiS”. Install the
software in the default folder and follow the instructions, accepting the default values.
The PACiS agency path should be updated in the batch file defined for the
e-terracontrol IEC61850Config application.

Proprietary – See Copyright Page 13 System Requirements and Installation


e-terracontrol Reference Manual: Introduction and Configuration
3. Guided Tour of e-terracontrol
This chapter allows you to practice using the major components of e-terracontrol. This
“guided tour” explores several of the individual applications of e-terracontrol as a brief
introduction to applications detailed later in this document.
We recommend that you complete the guided tour in the order presented. Some of the
later examples require data created by actions in the earlier examples.

3.1 Guided Tour


Most of the examples are based on two hypothetical stations called the Kirkland Station
and the Martdale Station. The guided tour familiarizes you with the components of the
stations and how these components are represented by different applications.
• The Kirkland Simulator uses the SCADADevice control to change the data for the
Kirkland Station.
It shows e-terracontrol working with dynamic data and simulating slight fluctuations
and changes, as well as allowing manual operation.
• The Kirkland Station display is an e-terrabrowser interactive display.
From this display, controls can be issued to the Kirkland Station, and dynamic data
is presented in real time.

Note: Although this “tour” guides you through the basic functionality of e-terracontrol
and e-terrabrowser, it does not go into the complete depth that is necessary for full
mastery. To gain further knowledge of these programs, refer to the detailed content in
the e-terracontrol Reference Manual set.

3.2 Set Up e-terracontrol


e-terracontrol and e-terrabrowser require data in order to be functional and meaningful.
This data can be real or simulated, so we use the 60 Bus SCADA server along with the
Kirkland Simulator to create the necessary sample data.
1. Open e-terracontrol with a sample database, and add yourself as a user.
2. Start the 60 Bus SCADA server with RTUs from the Eterra > e_terracontrol >
Samples start menu.
3. Add yourself as a user using the Add User toolbar button, using the format
“‘domain’\‘user name’”.

Proprietary – See Copyright Page 14 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
4. Grant yourself Read, Write, and Control permissions for every area.
5. Save your database.
6. Open a station simulator.
7. Start the Kirkland Simulator from the Eterra > e_terracontrol > Samples start menu.

Proprietary – See Copyright Page 15 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
3.2.1 Practice Using the Kirkland Station Display
To practice using the Kirkland station display:
1. From the SMP\Samples program group, access the Kirkland Station display by
opening the e-terrabrowser Viewer.
2. From the Stations drop-down menu in the Measurements List window (right pane) of
the e-terrabrowser Viewer, select Kirkland.
Notice that there is now a list of measurements under the Kirkland heading in the
window.
3. Click the Display Kirkland button next to the Stations drop-down menu.

4. Study the components of the display.


Notice the layout and the names of the components.
Notice that, in e-terrabrowser, the Kirkland Simulator and the Kirkland Station
display are different depictions of the same substation.

Proprietary – See Copyright Page 16 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
5. Practice changing the status of data items.
– In the Kirkland Station display, place the pointer over circuit breaker 540c.
Notice that the mouse icon becomes a pointing hand, to indicate a selectable
entity.
– Select the breaker using the left mouse button.

Proprietary – See Copyright Page 17 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
Within the pop-up window:
∗ Click Select.
∗ Click Trip.
∗ Click Execute.
∗ Click OK (to close the pop-up).
Notice that the breaker icon changes to reflect its new open state, and that the
values of MW, MVARS, and MVA on the associated line all drop to zero.
In the Kirkland Simulator, notice that the breaker icon, the MW value, and the
MVAR value changed here as well.
6. In the Kirkland Simulator, close the open breaker (540c) by clicking it.
Notice that the icon turns solid red, to reflect its return to the closed state. Notice that
this change occurs on the Kirkland Station display as well.
7. In the SCADA server, expand the Stations list by clicking the plus sign.
8. Expand the Kirkland list.
9. Take a few minutes to go through the icons in the SCADA server’s Kirkland Station
and match them to their counterparts in the display.

3.2.2 Alarms
Alarms can provide a visual and auditory warning when a measurement goes above or
below a certain level, when a breaker changes status, or in any of several other
situations.
In this section, we set up an alarm to make a sound when the status of a breaker
changes.

3.2.2.1 Setup
Make sure that the SCADA server, the e-terrabrowser client, and the Kirkland Simulator
are all still running.

3.2.2.2 Create an Alarm


To create an alarm:
1. In the SCADA server, expand the equipment groups, expand Kirkland, and then
expand the Cb_540c breaker.
2. Right-click Bkr, and then select Properties.
3. From the Status Type drop-down menu, select
“Bkr, Normally closed, Alarm”.

Proprietary – See Copyright Page 18 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
This sets the breaker to set off an alarm whenever the status of the breaker
changes.
4. Expand Scada Types, and right-click
“Bkr, Normally closed, Alarm”.

Proprietary – See Copyright Page 19 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
5. On the Category tab, make sure that the Enable Audio Alarms check box is
selected.

6. Set off the alarm.


In the e-terrabrowser client display, note the Alarm Banner window. This is where all
alarms are displayed for SCADA.
– In the Kirkland Simulator, open the 540c breaker (the one in the upper left
corner).
This should set off an alarm, which should appear in the Alarm banner. Also, you
should hear a “ding”, audibly notifying you of the alarm.
7. In the Alarm banner, you should notice a red Alarm icon next to the alarm; this
indicates that the alarm has not been acknowledged. Clicking the icon
acknowledges the alarm, and clicking the icon one more time deletes it.

Proprietary – See Copyright Page 20 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
3.2.3 Analog Trends in e-terrabrowser
e-terrabrowser has the ability to display analog trends from within its windows. Although
the trending graphs are not as comprehensive as the Virtual Charts, which are
demonstrated later in this guide, they are still useful.
There are two ways to access the analog trends from within e-terrabrowser.

3.2.3.1 Setup
Make sure that the SCADA server, the e-terrabrowser client, and the Kirkland Simulator
are all still running.

3.2.3.2 Access the Analog Trends from the Measurements Tabular Display
To access the analog trends from the Measurements tabular display:
1. In an e-terrabrowser client display, click the Measurements List toolbar button, then
select Kirkland from the Stations drop-down menu.
2. Scroll down to the Kirkland Ln_540 Mw measurement. Then scroll to the right, and
click the Trend Analog button on the far right.
A graph should pop up in the bottom portion of the window, showing the activity of
the measurement.

Proprietary – See Copyright Page 21 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
3.3 The Process Starter and Modbus
Every time you start an application, you can use the Process Starter to load specific
parameters, qualifiers, working directories, and data files. The Process Starter can also
restart programs, either upon exit or at a regular interval.
This “tour” demonstrates the Process Starter as well as e-terracontrol interacting with
the Modbus Reader and Modbus/SMP.
Modbus/SMP is an application designed to read data from the e-terracontrol database
and act as a Modbus slave. Modbus/SMP then sends data to a Modbus master.
The Modbus Reader acts as a Modbus master, and it is capable of reading from a
Modbus slave and outputting that data to an e-terracontrol database. The way the
Modbus Reader is used in this guide is just one way in which the Modbus Reader can
be used (for more details, see the e-terracontrol Reference Manual: Interfaces to Field
Devices).

3.3.1 Practice Using the Process Starter


The Process Starter is an application that is capable of starting multiple programs all at
once with various command-line parameters and other properties, and keeping them
running in the event that they close.
The Process Starter is also responsible for redundancy between computers using
e-terracontrol, ensuring that programs that close on one computer can automatically
start on a backup computer.
This “tour” only documents the basic capabilities of the Process Starter. For further
details, see the other four documents in the e-terracontrol Reference Manual set.
1. Start the programs to be used in this part of the “tour”.
– Make sure that the 60 Bus SCADA server with RTUs and the Kirkland Simulator
are still running.
– Make sure that the Process Starter service is running.
You can check it by displaying the services console management from Windows
(Start > Settings > Control Panel > Administrative Tools > Services).
– From the e-terracontrol Start menu, start the Process Starter console.
2. Configure a default user.
If this is the first time you have started the Process Starter console, you have to
configure a default user. Processes launched from the Process Starter are executed
in the context of this default user.
The default user is simply a Windows user. For this example, you only need to enter
your domain, login name, and password. When the e-terracontrol process is
launched from the Process Starter, it is executed as if you had launched it directly.

Proprietary – See Copyright Page 22 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
3. Connect to the Process Starter service.
Now, you have to connect the Process Starter console to the service. From the
toolbar, click the Connect button, enter your credentials when prompted, and click
OK.
By default, to be granted access to the Process Starter service, you must be an
Administrator of the machine. For more details, see the e-terracontrol Reference
Manual: Applications.
4. Add a process. When the connection is established, on the Process menu, click
Add.
– In the Name text box, type “e-terracontrol”.
– For the Program field, click the Ellipsis button (…).
– Navigate to the ~\e_terracontrol\bin directory and select the program scada.exe.
– Ensure that the check box is checked.
– In the Restart frame, select the On Exit radio button, and click OK.
The process should appear in the top list box.

5. Start and stop the Process Starter.


– Turn the Process Starter on by clicking Online in the toolbar (the green arrow
pointing upward).
e-terracontrol starts under the security context of the default user. If the program
is closed, the Process Starter restarts the program because of the actions taken
previously. Note that the process is visible.
– Turn the Process Starter off by clicking Offline in the toolbar (the red arrow).

Proprietary – See Copyright Page 23 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
6. Add more processes. Further modify the Process Starter to use Modbus.
– Modify e-terracontrol to automatically open a database when it starts.
∗ For the Parameters field, click the Ellipsis button (…).
∗ Browse to ~\e_terracontrol\Samples\ and select emp60_rtus.sdb.
∗ To save your changes, click OK to the right of the Name field.

– Add a process to start Modbus/SMP.


∗ In the Process Starter, add a new process. Name it “Modbus/SMP”.
∗ For the Program field, click the Ellipsis button (…), browse to
~\e_terracontrol\bin, and select mb2smp.exe.
∗ For the Parameters field, click the Ellipsis button (…), browse to
~\e_terracontrol\Samples, and select mb2smp_modbus_test.txt. This
parameter sets mb2smp.exe to configure itself using the specified text file.
∗ To save your changes, click OK to the right of the Name field.

Proprietary – See Copyright Page 24 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
– Add a process to start the Modbus Reader.
∗ In the Process Starter, add a new process named “Modbus Reader”.
∗ For the Program field, click the Ellipsis button (…), browse to
~\e_terracontrol\bin, and select ModbusReader.exe.
∗ For the Parameters field, type “-n ReliatronicsRTU”. This parameter sets
ModbusReader.exe to configure itself using the ReliatronicsRTU data set in
the e-terracontrol database.
∗ To save your changes, click the OK button (to the right of the Name field).

7. Save and test the new configuration.


– Save your Process Starter configuration to a convenient location of your
choosing.

Proprietary – See Copyright Page 25 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
– Test your Process Starter configuration by clicking the Online button.
If the configuration was performed correctly, three windows should open:
∗ e-terracontrol should open with a database preloaded.
∗ Modbus/SMP should open with data points already visible in the window.
∗ The Modbus Reader should open with three scan groups already, PLC plus
Analog and Status. If you click Analog or Status, you should see data points
already added to the scan groups.

3.3.2 Verify the Interaction between SCADA and Modbus


1. Start the applications.
– With e-terracontrol, Modbus/SMP, and the Modbus Reader running, verify that
everything is communicating properly.
– Open the e-terrabrowser Viewer from the SMP\Samples program group.
– Open the Kirkland Simulator from the SMP\Samples program group.
– Go to the Kirkland Station display (as done previously in this guide) and verify
that the values in the simulator match those in the display.
2. Verify Modbus communications.
– Look at Modbus/SMP. Those values should also match the values in the Kirkland
Simulator.

As you change values in the Kirkland Simulator, you should see those changes
reflected in Modbus/SMP.

Proprietary – See Copyright Page 26 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
– In the Modbus Reader, click the Status Scan group.

– Open and close breakers in the Kirkland Simulator and watch the Modbus
Reader.
After a slight delay, you should see the values in the Status Scan group change.
– Verify that the Modbus Reader is communicating with e-terracontrol.
∗ In the e-terrabrowser Viewer, go to the Martdale Station display. Use the
same method you used for the Kirkland Station display.
∗ Open and close breakers in the Kirkland Simulator and watch the Martdale
Station display. After a slight delay, you should see the breakers in the
Martdale Station display change.
You have now completed the main portion of this guided tour.

3.4 The Measurement History Application


The Measurement History application is designed to read the history files created by
SCADA (.his), and to display the value of the measurements over a specified period of
time.

Proprietary – See Copyright Page 27 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
3.4.1 View Historical Data
The following steps illustrate how to view historical data.

Note: The success of this particular demonstration may depend on how long the
SCADA server and the Kirkland Simulator have been running, because these two
programs are the co-creators of sample historical data.

1. From the e_terracontrol > Samples start menu, start the 60 Bus Measurement
History application.
– The database name and the directory should say “esca60” and
“…\e_terracontrol\samples”, respectively. If they do not, use the Browse button to
find the esca60 history file.
– The Ending field should read the current time and date. If it does not, enter the
current time and date.
– Change the “for” time to 30 minutes.
2. Select the Status radio button, and click Get Names. This should bring up the status
measurements from every station.
By clicking in the message window and pressing the K key, the list automatically
scrolls to the first status beginning with the letter “K”.
From there, you can use the scroll bar, use the arrow keys, or continue typing the
desired status name.
3. From the list, find and select Kirkland 540c Bkr (nothing actually happens when you
select this item, it simply becomes highlighted).
4. To view the history for this status measurement, click Get History.
5. Select the Analog radio button and click Get Names.
6. Select Kirkland 540 Mw, and click Get History. This should represent the megawatt
fluctuations associated with the tripping of the breaker.

3.5 Virtual Charts


This program was developed to replace cumbersome traditional hardware chart
recorders. The program uses software to create virtual strip chart recorders, which can
be viewed using standard computer monitors or projection screens.
This “tour” of the Virtual Charts System (VCS) demonstrates some of its features and
explains how to configure what is displayed.

Proprietary – See Copyright Page 28 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
3.5.1 Setup
• Make sure that the 60 Bus SCADA server and the Kirkland Simulator are both
running.
• Start the VCS application by selecting Kirkland Charts from the e_terracontrol >
Samples menu.
This Start menu item runs the program Charts.exe using the configuration file
Kirkland.txt.

3.5.2 The Virtual Chart Display


There are six charts visible, each displaying different traces. Some charts have multiple
traces.
The x-axis represents the measurement (KV, amps, etc.). The y-axis represents time,
with the most-recent time at the top.
1. From the Edit menu, select Time Range.
The seconds visible is most likely set to 7200 seconds (two hours). Change this
number to 300, but do not click OK yet.
Note: This makes the charts scroll at a rate that you can observe. For a description
of the fields on each tab of the Configuration form, refer to the e-terracontrol
Reference Manual: Applications.
2. Select the Points tab.
One of the six blank charts is highlighted with a purple border; the points listed are
only for this highlighted chart. Selecting a different chart moves the purple border
and presents the points for that chart.
Notice that Chart 0 (the top left chart) contains four ampere measurements, whereas
Chart 5 (the bottom right chart) contains only two KV measurements. The VCS is
highly configurable.
3. To close the Chart Configuration form, click OK.
4. Open a Virtual Charts file.
Use Windows Explorer to open the file
~e_terracontrol\Samples\Kirkland.txt
This is the file that tells Charts.exe what to display. Study this file, and try to
determine what each line does for at least one chart.
5. Zoom in on a chart.
– Double-click any one of the six charts.
– Zoom in so that only that one chart is visible.
– Double-clicking again returns to the six-chart view.

Proprietary – See Copyright Page 29 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
6. Format the charts for printing.
– From the Edit menu, select Colors.
– Click the Printing Defaults button, and then click OK to exit the form.
Notice that the background colors have been inverted.
You can still print a legible hard copy that does not use up too much toner.

Proprietary – See Copyright Page 30 Guided Tour of e-terracontrol


e-terracontrol Reference Manual: Introduction and Configuration
4. Configuration Notes

4.1 Client vs. Server Installations


Of the many individual applications included with e-terracontrol, some are specifically
designed to run on the server/host machine (the machine running the SCADA server),
while others are designed to be used on remote operator consoles, or “clients”, that
connect to SCADA on the server.
In each application’s description, the intended location is included. After you read the
descriptions, it should be clear which configuration is needed for a particular utility.

4.1.1 The Remote Logon


After installation, client applications need to be configured to connect to the server.
When these programs initiate a TCP/IP connection with the server, the Logon dialog
box appears.

Figure 9. Remote Client Logon Dialog Box

To log on, enter a valid user ID and a valid password.


The user identification information (user ID and password) is written to the system
registry after the first successful login. Once the user identification information is
available in the system registry, this dialog box is no longer launched.
However, note that, if a user ID or password is left blank, the blank entry is not stored in
the system registry. As a result, the Logon dialog box reappears every time the
application is started.

Proprietary – See Copyright Page 31 Configuration Notes


e-terracontrol Reference Manual: Introduction and Configuration
The appropriate methods for starting each remote application are included in their
respective descriptions.

4.2 Redundancy and Line Switching


e-terracontrol supports a redundant configuration. There are two aspects to this
functionality:
• Redundancy supported by the Process Starter.
• Line switching supported by the SCADA server application.
Redundancy in e-terracontrol configurations is achieved through a partial
primary/secondary failover scheme. That is, the SCADA Server and Display Server
modules operate in Primary (Online) or Secondary (Offline) roles, but the data
acquisition modules on both systems are always running and are configured and
controlled by the online SCADA server.

Figure 10. e-terracontrol Redundancy and Failover

SCADA is unavailable during the time it takes to perform a failover, which is


approximately 10 seconds. Depending on the functionality of the IED, it may continue to
record events [Sequence of Events (SOE)] even when SCADA is not polling it. When
the IED receives the next poll from SCADA, all event information collected since the
previous poll is passed up to the SOE files in e-terracontrol.
Some non-SOE data is also captured during the failover. For example, if a breaker is
tripped during failover, SCADA recognizes the change in state of the device the first
time it is scanned after the failover.
There are three functional areas involved with redundancy and line switching:
• Changes to the Process Starter, to negotiate the primary/secondary pair (see the
e-terracontrol Reference Manual: Applications).

Proprietary – See Copyright Page 32 Configuration Notes


e-terracontrol Reference Manual: Introduction and Configuration
• Persistent storage of data between a primary/secondary pair of computers. This
applies only to the SCADA database (see the e-terracontrol Reference Manual:
Applications).
• Negotiation of ownership of a resource, by SCADA, between two device
applications, also known as “line switching” (see the e-terracontrol Reference
Manual: Applications).

4.3 Exceptions Handling


It may happen that an e-terracontrol application crashes because of exceptions — for
example, a memory access violation exception. e-terracontrol provides a mechanism to
minimize the crash impact and to enable post mortem analysis.
Depending on the application, the behavior of the exception handler varies:
• For SCADA and ISD, the exception handler is always enabled, and it generates both
a text file and a dump file if the application crashes.
• For any other applications with a graphical interface (except the Process Starter
console), it is possible to configure the way the exception handler must behave via
some command-line arguments. These parameters are:
– /exceptionHandler=disable: In this case, the exception handler will not be
activated if a crash occurs; it is up to the operating system to manage the
exception. This configuration is not recommended except when Alstom Grid has
expressly advised to use this option.
– /exceptionHandler=minidump: In this case, the exception handler generates
both a mini-dump file and a text file if an exception occurs. The operating system
should not be notified that an exception has occurred.
– /exceptionHandler=fulldump: In this case, the exception handler generates
both a dump file and a text file if an exception occurs. The dump file is a mini-
dump file with a lot of information, which can make it very big; it is useful for
managed applications. The operating system should not be notified that an
exception has occurred.
– When no specific parameters are specified, the exception handler is active and it
generates a text file if an exception occurs. The operating system should not be
notified that an exception has occurred. This configuration is the default
configuration.

Note: When an exception occurs in an application where the exception handler is


enabled, a dialog box pops up with information about where to find crash information
when a crash occurs. This Crash dialog box is not modal, and it does not prevent the
Process Starter from restarting the application as soon as it crashes. The Crash dialog
box disappears after approximately 30 seconds.

Proprietary – See Copyright Page 33 Configuration Notes


e-terracontrol Reference Manual: Introduction and Configuration
Figure 11. e-terracontrol Crash Dialog Box

According to the arguments used to configure the exception handler, the following files
may be present in the directory shown by the pop-up dialog box of the exception
handler:
• ApplicationName_MM-dd-YY_hh-mm-ss.managed.log:2 This file contains
information regarding a managed exception, and also information regarding the state
of the process when the exception has been caught. This file should always be
present.
• ApplicationName_MM-dd-YY_hh-mm-ss.unmanaged.log:2 This file contains
information regarding a potential unmanaged exception. If the exception occurs in
the managed part of the application, this file may not exist or may contain no
information at all.
• ApplicationName_MM-dd-YY_hh-mm-ss.managed.dmp:2 This file is a dump file;
it does not contain any readable information unless you use a specific tool such as
WinDbg. This file is only generated if the dump file option is enabled and if the
exception handler has enough information to generate it. Information captured in this
file is relative to the managed part of the application.
• ApplicationName_MM-dd-YY_hh-mm-ss.unmanaged.dmp:2 This file is a dump
file; it does not contain any readable information unless you use a specific tool such
as WinDbg. This file is only generated if the dump file option is enabled and if the
exception handler has enough information to generate it. Information captured in this
file is relative to the unmanaged part of the application. In particular, this file may
contain useful information regarding an unmanaged exception (such as an exception
occurring in an ActiveX control, for example).
By default, the directory of these files should be a subdirectory of the
eterra\e_terraControl\log directory.

2
“ApplicationName” is the name of the application; for example, with CFEReader.exe, “ApplicationName”
is “CFEReader”. MM represents the current month (01 is January and 12 is December). dd represents the
day (from 01 to 31). YY represents the year (04, 05, and so on). hh-mm-ss represents the time of the
crash, with hh as the hour (from 0 to 23), mm as the minute, and ss as the second.

Proprietary – See Copyright Page 34 Configuration Notes


e-terracontrol Reference Manual: Introduction and Configuration
When the exception handler is disabled (i.e., when the application was started with the
command-line argument /exceptionHandler=disable), the exception is handled by the
operating system. In this case, depending on your system configuration, a modal
pop-up may be displayed to let you know that an exception has occurred.

Caution: A modal dialog box can prevent your process from being restarted by the
Process Starter. If you want to avoid this situation, first configure your system to use
Doctor Watson as your default debugger, and then configure your system not to show
a modal dialog box after a crash.

To enable Doctor Watson, you can simply enter the following line as a run command:
drwtsn32 –i
Remember to clear the Visual Notification check box.

Figure 12. Doctor Watson User Interface

Note: The modal dialog box issued by Doctor Watson may not be visible if the
process that crashed was started from the Process Starter as “not visible” (the option
was unchecked).

Proprietary – See Copyright Page 35 Configuration Notes


e-terracontrol Reference Manual: Introduction and Configuration
5. Logging and Monitoring

5.1 Logging
Our systems have grown more distributed and more complex over the years. Along with
complex installations that include multiple sets of front-end processors, new features
and the widespread adoption of multi-datacenter EMS environments have increased the
management burden required to ensure the health of these environments.
As part of the effort to standardize logging across e-terra products, e-terracontrol
produces log messages and writes them to the Windows Event Log. e-terracontrol
writes the messages under the e-terra\Operational channel (summarized as logging
channel). The Instrumentation manifest file is an XML file that contains the elements
that identify the logging provider. e-terracontrol delivers manifest files for the
applications that log in the logging channel. The manifest files have the extension
“.man”.
Each message written to the Windows Event Log can be identified by a unique event
ID. The logging functionality is enabled by default and applications that support the
Windows Event Log will automatically write log messages to the logging channel.

5.2 Logging Format


This section describes the detailed format of the message in the Windows Event Log.
The format is common with other e-terra products, so some fields are irrelevant for
e-terracontrol and are left empty.
EventData elements include the following:
• timeCreated is the time the when the message was generated.
• text is the actual message.
• messageId is the unique event identifier that identifies the message.
• machineName corresponds to the machine name where the message was
generated.
• ProcessID corresponds to the Windows process ID (PID) under which the message
was generated.
• ProcessName is the name of the application under which the message was
generated.
• threadId is the thread identifier under which the message was generated.
• threadName is not used and is left blank.
• username is not used and is left blank.

Proprietary – See Copyright Page 36 Logging and Monitoring


e-terracontrol Reference Manual: Introduction and Configuration
• contextApplication is used to pass arguments to distinguish the application
instances when multiple instances of an application are running on the same
machine.
• contextFamily is not used and is left blank.
• contextGroup is not used and is left blank.
• type is used to distinguish the type of the message; it can be Application, Security,
or Performance.

5.3 Monitoring Overview


e-terracontrol implements health indicators exposed via the e-terra SNMP agent.
Detailed health indicator data must be exposed in an industry-standard way, so that it
can be monitored outside of current application silos. The SNMP agent is a separate
product and it is not part of the e-terracontrol delivery. For information regarding the
monitoring functionality, refer to the Monitoring documentation.

5.4 Monitoring Configuration


A monitor application running as a Windows service aggregates all indicators exposed
by the e-terracontrol applications. This application is referred to as the Monitor
Application service. Each e-terracontrol application connects to the Monitor Application
service and sends health indicators. Monitoring functionality is disabled by default; to

Proprietary – See Copyright Page 37 Logging and Monitoring


e-terracontrol Reference Manual: Introduction and Configuration
enable it, each application that supports monitoring should enable the monitoring
functionality:
• Monitoring Application Service is disabled by default. To use the monitoring
functionality, start the service through the Windows Services Management Console.
The monitoring application configuration file is located under the e-terracontrol
installation's “config” folder and is named “monitoring.properties”. This file exposes
the following configuration properties:
– monitoring.port: The monitoring port is the listening port for incoming connections
from e-terracontrol applications. The default port is 9090. If you change this
setting, configure all e-terracontrol monitoring clients accordingly to reflect the
port number defined here.
– monitoring.core.agent.port: The monitoring Core Agent Port is the listening port
for the Monitoring core agent to connect to. The default value is 6001.
– monitoring.log.debug: Use this property to enable or disable debug traces.
– system.version: The e-terracontrol product version, exposed as an indicator.
– monitoring.filter.apps: The filtering feature for the monitor applications. The filter
should be a list of application names (names defined in the ProcessStarter
configuration) separated by semi-colons. For example:
monitoring.filter.apps = xx2smp;tests
– Filtered applications will not appear in the app server indication on the SNMP
consumer.
• Process Starter Service: Use the ProcessStarter Administration console to enable
monitoring.

The Monitoring Service Listen Port is the server port opened by the monitor
application.
• For all other applications, enable the monitoring functionality through the command
line argument plus the listening port number.
– Scada: “/ENABLEMONITORING /MONITORING_PORT 9091”
– Isd: “/ENABLEMONITORING /MONITORING_PORT 9091”
– Cfereader: “ENABLEMONITORING MONITORING_PORT=9091”
– AlarmPager: “/ENABLEMONITORING /MONITORING_PORT 9091”
– OpcClient: “/ENABLEMONITORING /MONITORING_PORT 9091”
– xx2smp: “-h –j 9091”
– OpcServer: “/ENABLEMONITORING /MONITORING_PORT 9091”

Proprietary – See Copyright Page 38 Logging and Monitoring


e-terracontrol Reference Manual: Introduction and Configuration

You might also like