Baseline Software Platform

SOE Device (Sequence Of Events)

07/2016

www.schneider-electric.com
 Rev. 1.0 (06-07-2016)

Change Control
Rev Date Description

1.0 06-07-2016 Initial revision for Easergy Builder.

Relevant information for the user

As a result of the multiple uses of the product, the personnel in charge of the application and use of this control device
must ensure these usages comply with all safety and performance requirements applicable in each application. The
requirements include the applicable industry-related laws, norms, regulations and standards.
Throughout this manual some notes are included in order to alert the user about specific circumstances:

NOTICE
NOTICE identifies information about practices and circumstances which could result in a malfunction of the equipment..

Restricted Liability
Electrical equipment should be serviced and maintained only by qualified personnel.
No responsibility is assumed by Schneider Electric for any consequences arising out of the use of this manual. This
document is not intended as an instruction manual for untrained persons.
The illustrations, dialog boxes, programming models and examples shown in this manual are intended for exemplary
purposes. As there are installation-specific variables and requirements, Telvent will not be held responsible for the misuse
of the equipment based on the examples herein published.

NOTICE
An inadequate use of the equipment, or misuse by ignoring these specifications, may comprise the system’s security.

It is highly recommendable to backup the application programs frequently using the appropriate storage media to avoid
potential data loss.

The Saitel platform and all its components have been developed in accordance to the requirements for a
quality management system, complying with the ISO 9001 Norm

Document: TE-HG-0000-SOE-S854

Revision / Date: Rev 1.0 / 06-07-2016

File: SOE Device_EN_Rev1.0.pdf

Retention period: Permanent throughout its validation period + 3 years after its
cancellation.

Should the user have any request, problem report or suggestion about the equipment, the following email address is
available:
[email protected]

Configuring SOE 1

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

Table of Contents
Table of Contents .................................................................................................................................................................. 2
Index of Figures..................................................................................................................................................................... 3
Index of Tables...................................................................................................................................................................... 4
Manual Contents ................................................................................................................................................................... 5
Chapter 1. Easergy Builder & SOE .............................................................................................................................. 1-1
1.1 Easergy Builder v1.0.20 ..................................................................................................................................... 1-2
1.1.1 Environment Description ............................................................................................................................ 1-2
1.1.2 Device Catalog ........................................................................................................................................... 1-3
1.2 Introduction to SOE and SOE2........................................................................................................................... 1-4
Chapter 2. SOE (only for Saitel RTUs)......................................................................................................................... 2-1
2.1 SOE Administration ............................................................................................................................................ 2-1
2.1.1 Signal Identification - Coordinates .............................................................................................................. 2-1
2.1.2 Relationship with coreDb............................................................................................................................ 2-1
2.2 Configuring SOE in Easergy Builder................................................................................................................... 2-1
2.3 Output File Structure .......................................................................................................................................... 2-3
2.3.1 Quality Flags .............................................................................................................................................. 2-4
Chapter 3. SOE2 (only for HU250 CPU) ...................................................................................................................... 3-1
3.1 SOE2 Administration .......................................................................................................................................... 3-1
3.1.1 Signal Identification - Coordinates .............................................................................................................. 3-1
3.1.2 Relationship with coreDb............................................................................................................................ 3-1
3.2 Configuring SOE2 in Easergy Builder................................................................................................................. 3-1
3.3 Output File Structure .......................................................................................................................................... 3-3
Glossary ................................................................................................................................................................................A

2 Configuring SOE

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

Index of Figures
Figure 1-1. Baseline software architecture. ........................................................................................................................ 1-1
Figure 1-2. Relation between coreDb and other applications............................................................................................. 1-2
Figure 1-3. Startup window of Easergy Builder. ................................................................................................................. 1-2
Figure 1-4. Easergy Builder interface. ................................................................................................................................ 1-3
Figure 1-5. Catalog device window. ................................................................................................................................... 1-3
Figure 2-1. New Device...................................................................................................................................................... 2-1
Figure 2-2. New SOE Device ............................................................................................................................................. 2-2
Figure 2-3. Configuration of SOE Device ........................................................................................................................... 2-2
Figure 2-1. New Device...................................................................................................................................................... 3-1
Figure 2-3. Four SOE2 Devices for a HU250 CPU............................................................................................................. 3-2
Figure 2-3. Configuration of SOE Device for Easergy T300............................................................................................... 3-2

Configuring SOE 3

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

Index of Tables
Table 1-1. Reference manuals.............................................................................................................................................. 5
Table 1-2. Software versions which this manual applies....................................................................................................... 5
Table 1-3. Hardware/ Software compatibility. ....................................................................................................................... 5
Table 2-1. Coordinate mappings in coreDb ....................................................................................................................... 2-1
Table 2-2 - Local quality bits .............................................................................................................................................. 2-5
Table 2-3 - Quality bits from the Device ............................................................................................................................. 2-5

4 Configuring SOE

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

Manual Contents
I. Objective
This manual provides information about the configuration of the SOE device in Easergy Builder.

II. Arrangement
This manual is divided in the following chapters.

Chapter 1 – Easergy Builder & SOE

This chapter describes the main elements and software architecture of the Baseline Software Platform.It gives a general
description of the tool Easergy Builder and the SOE device.

Chapter 2 – SOE
Description of the user interface implemented in Easergy Builder to manage the events register and storage of signal
changes produced in a RTU handling real time data.

III. Reference Manuals

The following documents, which could be used for further reference, are provided to supplement the information included
in this manual:

Manual’s name Document

Easergy Builder User Manual TE-HG-0000-MSS-S856

Saitel Webtool User Manual TE-HG-0000-MCW-S856

Table 1-1. Reference manuals

IV. Software Versions

The information in this manual applies to software versions listed in the following table and subsequent:

Module Software version (CPU) Pluging version (Easergy Builder)

SOE soeBinC - 10.01.05 SOE – 1.0.9.0

SOE2 soeBinC2 SOE – 1.0.9.0

Table 1-2. Software versions which this manual applies

V. Hardware/Software Compatibility
Controllers supported by the CPU modules of different hardware platforms are the following:

Bin Controller SM_CPU866 SM_CPU866e HU_B/HU_BI HU_A/HU_AF HU 250

Easergy Builder √ √ √ √ √

SOE √ √ × √ ×
SOE2 × × × × √

Saitel Webtool √ √ × √ ×
Table 1-3. Hardware/ Software compatibility.

Configuring SOE 5

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

Chapter 1. Easergy Builder & SOE

The Baseline Software Platform of Schneider Electric is composed by:
 VxWorks & Linux operating systems.
 Real-time applications and its configuration files.
 Configuration, management, supervision and monitorization tools.

NOTICE
Saitel DR basic heads (modules HU_B and HU_BF) don’t load VxWorks nor Linux. They operate with a tailored-made
software which includes the OS, database and applications.

The following figure shows the different applications included in the software platform, as well as additional applications
that implement protocols to upgrade Easergy Builder:

Figure 1-1. Baseline software architecture.

The operating system abstracts the hardware from the software applications and manages the applications in real time. It
integrates the basic protocols to access the remote unit (SFTP, SSH, etc.) and manage multiple users.
The real-time database, named coreDb, is probably the most important element. All the other elements are developed
around coreDb:

Configuring SOE 1-1

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

Figure 1-2. Relation between coreDb and other applications.

coreDb performs the real-time management of RTU signals. This real-time database is associated with data producing
and consuming Devices. Devices are the different data acquisition and processing applications software which access
coreDb.
For more information about the Baseline Software Platform, please consult the manuals “Easergy Builder User Manual”
and “Saitel Webtool User Manual”.

1.1 Easergy Builder v1.0.20

1.1.1 Environment Description
The access to Easergy Builder is done through the Windows® Home Menu, or through the direct access created on the
desktop.

Figure 1-3. Startup window of Easergy Builder.

The initial interface is as follows:

1-2 Configuring SOE

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

Figure 1-4. Easergy Builder interface.

The Easergy Builder image depend on if there is a configuration active or not. For example, the previous figure shows
Easergy Builder when you are editing a configuration:
 1: Information about the active configuration.
 2: Toolbar and main menu.
 3: Edition zone.
 4: Log console
 5: Device catalog
The toolbar, main menu and edition zone will be detailed for each device.

1.1.2 Device Catalog

Editing a configuration, select the tab “Devices” in the zone 2 in order to show information about the devices available in
your PC. At the right of the zone 2 you can see the catalog device window:

Figure 1-5. Catalog device window.

This window shows all configurations that have been stored as a template. More information about this tool in the Easergy
Builder user manual.

Configuring SOE 1-3

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

1.2 Introduction to SOE and SOE2

Events register and storage of signal changes produced in a RTU handling real time data is common in control systems.
There are several ways of defining type and format of output data.
The output type can be classified the following way:
 Stored output: paper, file, etc...
 Non-stored output: sent to a terminal.
The data format is very dependent on the particular needs. Among other criteria, there are the date format, the signal
value format and additional parameters such as source of information, etc.
SOE (soeBinC software) is compatible with Saitel platform and SOE2 with HU250.
There are some different features for each one:
 SOE
o It is compatible with Saitel CPUs (for Saitel DR, only advanced CPU).
o Only one output file is generated for each Device.
o Only one SOE Device can be defined for a RTU.
o The output is written to a circular file which has the format XML.
o The size of this file is limited by the operating system.
 SOE2
o It can generate several files per Device.
o The output files are in a text format. Its structure is detailed later in this manual.
o Up to 4 SOE2 Devices can be defined for a RTU.

SOE2 Device is known by the mnemonic “soe2”. Nevertheless, it is named “soe” by the system. This way, the same
Easergy Builder plugin will be used for SOE and SOE2.

1-4 Configuring SOE

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

Chapter 2. SOE (only for Saitel RTUs)

2.1 SOE Administration
2.1.1 Signal Identification - Coordinates
The point coordinates for the SOE device have the following format:

Coordinate for SOE device NAME:ID

Where:
 NAME: signal name which will be shown in the soe’s output. It allows filtering the changes produced per point.
 ID: Represents an identifier to a list of strings that are used for formatting the output data values.
Two types of strings can be used according to the signal type being represented:
 STATUS type list: list of strings that will be used to replace its numeric value in order to make it more descriptive.
For example, we can assign “OFF” to the value “0” and “ON” to the value “1”. This way, whenever the point
changes its value to 0 or 1, the event will show “OFF” or “ON”.
 ANALOG type list: represents the unit assigned to an analogue value. For example, we could add “Volts”, so if
the value registered is 5.2, then the output data will be “5.2 Volts”.

2.1.2 Relationship with coreDb

Possible Mappings
Once the coordinates’ format is defined, the user needs to determine the point types (according to the coreDb).
The table below includes the possible mappings of SOE points in coreDb, as well as the recommendable alternatives
(grey cells):

Points

Coordinates (ID) STATUS ANALOG COMMAND SETPOINT

STATUS D D

ANALOG D D D D

Table 2-1. Coordinate mappings in coreDb

Empty cells indicate that mapping in the correspondent table is not possible. Cells containing a D indicate that these points
have to be mapped as destination.

2.2 Configuring SOE in Easergy Builder

At the left side in the configuration view of Easergy Builder, you can see the Devices tree for the configuration that you are
defining.
Use the button "Add" or the right-button of the mouse (on the tree) for creating a new Device.

Figure 2-1. New Device

Configuring SOE 2-1

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

Where:
 Type: Type of the new Device. For SOE you must select “Sequence of events”.
 Name: Name of the new Device (Only letter, numbers and ‘_’ character are allowed for the name). Max. 32
characters).
 Description (optional): Description of the new Device.
The new Device will be shown in the tree:

Figure 2-2. New SOE Device

NOTICE
Only one “sequence of events” Device can be configured for each Saitel RTU..

You can double click on the Device (or use the buttom Modify) in order to edit or consult the configuration.

Figure 2-3. Configuration of SOE Device

2-2 Configuring SOE

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

Where:
 Register Qualifier: Sets of a change in signal qualifiers triggers an event (checked) or not (unchecked).
 Register first event: Sets if the first event of signals is registered (checked) or not (unchecked). Unchecking this
field, the initial avalanche won’t be registered. Command and setPoint signals don’t use this field as it registers all
events. The first event will also be registered if value is written in coreDb using the EVENT mode, even if this field
is unchecked.
 Max. Events logged: Maximum number of events in the chronological file. The minimum value is 2065 bytes. IF
a value isn’t indicated, the default value is 2000 events. The value in parentheses corresponds to the maximum
size in memory occupied by the specified number of events.You must ensure that this size does not exceed the
non-volatile memory (NVRAM) device being used.
 Device: Name of the “sequence of events” Device to be configured.
 Status:
o IDs List: List’s ID. It must match the “ID” field of the coordinate.
o Tags: Set of strings separated by “;” that will replace the signal value in the log files. The value ‘0’ will be
replaced by the first string, ‘1’ by the second and so on. If an event is registered with a value that has not an
associated tag, this value will be shown directly.
For the Status IDs, the maximum number of Tags is 10. The symbols <, >, “ and & can’t be used in the field
identificator
 Analog:
o IDs List: List’s ID. It must match the “ID” field of the coordinate.
o Tags: Sets the string that goes with the point value.

You can use button in order to add the new ID with its TAGS to the IDs List.
The log file that will register all events monitored by SOE is a XML file and its name will be: [Device’s name].xml. For
example, for the SOE Device shown in Figure 2-2, the file’s name will be MySOE.xml.

2.3 Output File Structure

SOE implements output to xml files. The format of log files is as follow:
<SOE>
<LOG_FILE_SIZE MAX_CONF_LINES="30" MAX_REAL_LINES="30" />
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST9" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST10" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST1" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST2" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST3" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST4" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST5" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST6" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST7" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST8" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST9" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.660+01:00" LOCAL="N" NAME="ST10" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST2" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST3" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST4" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST5" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST6" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST7" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST8" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST9" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:55:40.610+01:00" LOCAL="N" NAME="ST10" DESC="" VAL="1" QF ="0x00000000" SOURCE="TEST"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST1" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST2" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST3" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST4" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST5" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST6" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST7" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
<EV DATE="2010-03-19T10:56:40.600+01:00" LOCAL="N" NAME="ST8" DESC="" VAL="2" QF ="0x00000000" SOURCE="TEST2"/>
</SOE>

Configuring SOE 2-3

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

The general values in this files are the following:

 LOG_FILE_SIZE
o MAX_CONF_LINES: These parameters contain the maximum amount of event lines configured.
Configuration is retrieved from parameter Max. Events logged (see Figure 2-3) and is translated by soe to
maximum number of event lines. If new configuration is detected with a different size, then the correspondent
file is dumped, creating a new one that overwrites the old one.
o MAX_REAL_LINES: When the log storage (nvRam in SAITEL for example) runs out of memory, it is posible
that log files are smaller than the maximum size configured. If this is the case, this parameter is modified with
the number of events that soe was able to write. The goal of this feature is to notify the binController that it
should not write more events than MAX_REAL_LINES. At initial state, MAX_CONF_LINES and
MAX_REAL_LINES will be equal.
For each event, a line with the tag “EV” is included. It has the following attributes:

 DATE: Date, time (UTC) and UTC offset, of the registered event. The storage format is according to the ISO
8601 standard. This way, filtering and organization is easier.
 LOCAL: Determines of the event’s date was written locally (“Y”) (for example, the event has no timestamp) or not
(“N”).
 NAME: Signal name. Matches the field “NAME” of the coordinate.
 DESC: Point description (got from coreDb).
 VAL: Point value. The format will be according to the Tags configured using the window shown in Figure 2-3:
o If an event is triggered from a status point and has an associated ID in IDs List, this value will be shown the
following way: <label>, where “label” is the Tag set for the corresponding numeric value. Up to ten labels can
be configured; higher values are represented with its value directly. Example: ON.
o If the point has associated an ANALOG_LABEL label, then the value will be represented as follows:
<value> <label>, where “value” is the point value and “label” is configured in the TAG associated in Figure
2-3. Example: 2 Amperes (status point) 9.14500 miles.
 QF: Represents the quaility flags of the point generating the event. More information about this valuel in following
paragraph.
 SOURCE: Name of the Device wich is generating the event.

2.3.1 Quality Flags

The quality flag associated to a signal is depending on the local quality bits (associated to the coreDb point) and Device
quality bits (associated to the Device).
If several errors for a signal are detected, the hexadecimal value monitored for quality bits will result from the sum of all.
For example, if the two following errors occur: 0x00000001 (an overflow has occurred) and 0x00000002 (there has been a
carry on a counter or a roll-over), then the final value 0x00000003 would appear monitored.
Following tables show each possible value for local and device quality bits:

Values (Hexadecimal) Description

0x00000000 OK

0x00000001 There has been an overflow.

0x00000002 There has been a carry on a counter or a roll-over.

0x00000004 There has been a counter adjustment.

0x00000008 Excessive changes in a digital input.

0x00000010 Locked Point (blocked)

0x00000020 Point manually replaced (manual)

0x00000040 The point has not yet been written into the database (No refresh)

0x00000080 Invalid value (Error)

0x00000100 The value of the item has exceeded Highest Limit Alarm.

2-4 Configuring SOE

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

Values (Hexadecimal) Description

0x00000200 The value of the item has exceeded High Limit Alarm.

0x00000400 The value of the point has fallen down of Low Limit Alarm.

0x00000800 The value of the point has fallen down of Lowest Limit Alarm.

0x00001000 Invalid time.

Table 2-2 - Local quality bits

Values (Hexadecimal) Description

0x00000000 OK

0x00010000 There has been an overflow.

0x00020000 There has been a carry on a counter or a roll-over.

0x00040000 There has been a counter adjustment.

0x00080000 Excessive changes in a digital input.

0x00100000 Locked Point.

0x00200000 Point manually replaced.

0x00400000 The point has not yet been written into the database.

0x00800000 Invalid value.

0x10000000 Invalid time.

Table 2-3 - Quality bits from the Device

Configuring SOE 2-5

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

Chapter 3. SOE2 (only for HU250 CPU)

3.1 SOE2 Administration
3.1.1 Signal Identification - Coordinates
The point coordinates for the SOE2 device have the following format:

Coordinate for SOE2 device NAME:ID

Where:
 NAME: signal name which will be shown in the soe’s output. It allows filtering the changes produced per point.
 ID: Represents an identifier to a list of strings that are used for formatting the output data values.
Two types of strings can be used according to the signal type being represented:
 STATUS type list: list of strings that will be used to replace its numeric value in order to make it more descriptive.
For example, we can assign “OFF” to the value “0” and “ON” to the value “1”. This way, whenever the point
changes its value to 0 or 1, the event will show “OFF” or “ON”.
 ANALOG type list: represents the unit assigned to an analogue value. For example, we could add “Volts”, so if
the value registered is 5.2, then the output data will be “5.2 Volts”.

3.1.2 Relationship with coreDb

Possible Mappings
Once the coordinates’ format is defined, the user needs to determine the point types (according to the coreDb).
The table below includes the possible mappings of SOE2 points in coreDb:

Points

Coordinates (ID) STATUS ANALOG COMMAND SETPOINT

STATUS D D

ANALOG D D D D

Table 3-1. Coordinate mappings in coreDb

Empty cells indicate that mapping in the correspondent table is not possible. Cells containing a D indicate that these points
have to be mapped as destination.

3.2 Configuring SOE2 in Easergy Builder

At the left side in the configuration view of Easergy Builder, you can see the Devices tree for the configuration that you are
defining.
Use the button "Add" or the right-button of the mouse (on the tree) for creating a new Device.

Figure 3-1. New Device

Where:

Configuring SOE 3-1

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

 Type: Type of the new Device. For SOE2 you must select “Sequence of events”.
 Name: Name of the new Device (Only letter, numbers and ‘_’ character are allowed for the name). Max. 32
characters).
 Description (optional): Description of the new Device.
The new Device will be shown in the tree:

Figure 3-2. Four SOE2 Devices for a HU250 CPU

NOTICE
Up tp four “sequence of events” Devices can be configured for each Easergy T300 RTU..

You can double click on the Device (or use the buttom Modify) in order to edit or consult the configuration.

Figure 3-3. Configuration of SOE Device for Easergy T300

Where:

3-2 Configuring SOE

Baseline 11.05.05
 Rev. 1.0 (06-07-2016)

 Register Qualifier: Sets of a change in signal qualifiers triggers an event (checked) or not (unchecked).
 Register first event: Sets if the first event of signals is registered (checked) or not (unchecked). Unchecking this
field, the initial avalanche won’t be registered. Command and setPoint signals don’t use this field as it registers all
events. The first event will also be registered if value is written in coreDb using the EVENT mode, even if this field
is unchecked.
 Max. Events logged: Maximum number of events in the chronological file. The minimum value is 2065 bytes. IF
a value isn’t indicated, the default value is 2000 events. The value in parentheses corresponds to the maximum
size in memory occupied by the specified number of events.You must ensure that this size does not exceed the
non-volatile memory (NVRAM) device being used.
 Device: Name of the “sequence of events” Device being configured.
 Log file: Name of the log file that will register all events monitored by the bin being configured. More information
in following paragraph in this manual.
 Status:
o IDs List: List’s ID. It must match the “ID” field of the coordinate.
o Tags: Set of strings separated by “;” that will replace the signal value in the log files. The value ‘0’ will be
replaced by the first string, ‘1’ by the second and so on. If an event is registered with a value that has not an
associated tag, this value will be shown directly.
For the Status IDs, the maximum number of Tags is 10. The symbols <, >, “and & can’t be used in the field
identificator
 Analog:
o IDs List: List’s ID. It must match the “ID” field of the coordinate.
o Tags: Sets the string that goes with the point value.

You can use button in order to add the new ID with its TAGS to the IDs List.

3.3 Output File Structure

SOE2 writes output data to one or several text files. Each configured Device writes the events of its associated signals to
specific files. These files are stored on the path defined by the environment variable “LOG_DIR”, in the subfolder
“soeLogs”. Each Device creates a folder in this path in order to store its log files. These output files can be monitored by
other tools such as webApp.
Several files could be generated for each Device too. The file with the more recents events is named [Bin_name]0.txt.
When this file is full (depending on the “Max.events logged” parameter) this file is renamed to [Bin_name]1.txt (if this file
doesn’t exist) and a new empty file [Bin_name]0.txt is generated
The format of a log file is as follows:

logID=1||DATE=2016-01-30T11:39:29.298+01:00||LOCAL=Y||NAME=-||DESC=SOE START||VAL=-||QF=-||SOURCE=-||CRC=7485||
logID=2||DATE=2016-01-30T11:41:43.791+01:00||LOCAL=N||NAME=SOE_ST00||DESC=-||VAL=GoodBye||QF=0x00000020||SOURCE=-||CRC=8535||
logID=3||DATE=2016-01-30T11:43:03.075+01:00||LOCAL=N||NAME=SOE_ST00||DESC=-||VAL=Hello||QF=0x00000020||SOURCE=-||CRC=8348||
logID=4||DATE=2016-01-30T11:43:07.928+01:00||LOCAL=N||NAME=SOE_ST00||DESC=-||VAL=2||QF=0x00000020||SOURCE=-||CRC=7910||

Each event is stored in a single line where:

 logID: Log identifier or log number.
 DATE: Date, time (UTC) and UTC offset, of the registered event. This way, filtering and organization is easier.
 LOCAL: Determines of the event’s date was written locally (“Y”) (for example, the event has no timestamp) or not
(“N”).
 NAME: Signal name. Matches the field “NAME” of the coordinate.
 DESC: Point description (got from coreDb).
 VAL: Point The format will be according to the Tags configured using the window shown in Figure 2-3:
o If an event is triggered from a status point and has an associated ID in IDs List, this value will be shown the
following way: <label>, where “label” is the Tag set for the corresponding numeric value. Up to ten labels can
be configured; higher values are represented with its value directly. Example: ON.
o If the point has associated an ANALOG_LABEL label, then the value will be represented as follows:
<value> <label>, where “value” is the point value and “label” is configured in the TAG associated in Figure
2-3. Example: 2 Amperes (status point) 9.14500 miles.

Configuring SOE 3-3

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

 QF: Represents the quaility flags (view coreDb description document) of the point generating the event. This field
will not be present if the REG_QF configuration parameter is set to “N”. More information about the meaning of
this values in paragraph 2.3.1.
 SOURCE: represents the source bin name generating the event.
 CRC: CRC check per line. CRCs from the last written file are checked every time soe2 starts. If any CRC is
wrong the correspondent line is deleted.
Events with empty field “NAME” and “SOE START” as description are events written every time soe controller starts.

NOTICE
If a Device is removed from the configuration, the directory created to store logs for this Device will be remove at
startup. Also, if the file name changes and Device name doesn't, older files in the Device's folder will be removed.

3-4 Configuring SOE

Baseline 11.05.05
Rev. 1.0 (06-07-2016)

Glossary
coreDb Real time database of the Baseline Software Platform.

CPU Unidad Central de Procesamiento.

EN English language

HU 250 Easergy T300 CPU.

HU_A Saitel DR advanced HU (CPU).

HU_AF Saitel DR advanced HU (CPU) with acquisition.

HU_B Saitel DR basic HU (CPU).

HU_BF Saitel DR basic HU (CPU) with acquisition.

IED Intelligent Electronic Device

OS Operating System

PC Personal Computer

PLC Programable Logic Controler.

RAM Random Access Memory.

Rev Revision.

RTOS Real Time Operating System.

RTU Remote Terminal Unit

SCADA Supervisory Control and Data Acquisition

SM_CPU866 Saitel DP CPU (standard).

SM_CPU866e Saitel DP CPU (advanced).

SOE Sequence of Events

Configuring SOE A

Baseline 11.05.05
 Fax:
E-mail:
Phone:
Seville, Spain
C/ Charles Darwin s/n
Schneider Electric

+34 95 541 33 75
+34 95 492 09 92
www.schneider-electric.com

Parque Científico y Tecnológico de la Cartuja

[email protected]
Baseline Software Platform

© 2016 All rights reserved. The information contained in this document is confidential and is owned by Schneider Electric. It cannot

Rev. 1.0 – July 2016

be copied or distributed in any way, unless there is express written authorization by Schneider Electric. Although this information
was verified at the time of publication, may be subject to change without notice.