Foxboro Evo™

Process Automation
System
Product Specifications

PSS 31S-2SOE

Sequence of Events

The Sequence of Events (SOE) software package acquires, stores, displays, and reports state changes
(events) from specific digital input points in a control system.

OVERVIEW
The Sequence of Events (SOE) software package taking advantage of the optional GPS based time
provides the ability to accurately collect, display and synchronization capability, supports data acquisition
report both current and historical events, defined as at intervals of up to one ms across the entire system.
discrete state changes. The SOE software package Data that SOE software collects is sent to an
is designed to assist in the analysis of plant behavior AIM*Historian database for long-term storage to
after a fault. permanent media.
The SOE software package uses server/client SOE data is based on events, defined as the change
architecture for acquisition, storage, and display of in state of a digital input signal. When a digital input
data from digital points in your control system with a goes from false to true, an “event” occurs and the
resolution of one millisecond (ms). SOE software, SOE software displays a message showing the date
and time of the event. Similarly, when a digital input
PSS 31S-2SOE
Page 2

goes from true to false, an event occurs and is SOE CONFIGURATION AND OPERATOR
reported. A “sequence of events” is a complete time- CLIENTS
sorted set of data that documents the occurrences SOE software uses server/client architecture, and
and sequence of events or disturbances in a plant. provides two different types of interaction: operation
Data from the I/O channels of the following FBMs or configuration.
can be collected and analyzed with SOE software: Before collecting data, the process engineer uses the
 FBM207, Channel Isolated Voltage configuration client to define the behavior of the SOE
Monitor/Contact Sense Input Module software by setting general operating parameters
and selecting the real-time data points that will be
 FBM217, Group Isolated Discrete Input Module
monitored by SOE software. Each selected point is
 FBM219, Group Isolated Discrete Input Module identified by a unique tag, the FBM name, and the
FBM channel number associated with the point. Data
 FBM247, Current/Voltage Analog/Digital/Pulse
from these real-time points (RTPs) will be collected
I/O Configurable Module (4-20, 0-5 V dc, 0-10 V
from your running process and stored in an
dc, and SOE inputs for TDR).
AIM*Historian database.
FEATURES In addition, the configuration client allows you to
SOE provides the following features: customize each RTP’s description, and ON and OFF
state text. This facilitates identification and analysis of
 Highly accurate collection of digital signals at a
events and disturbances in the plant by making
resolution of up to 1 ms
reports and logs more meaningful and
 High-resolution data acquisition across multiple
understandable.
control processors with the optional GPS time
synchronization feature A process operator monitoring the plant uses the
 Prevention of data loss during high frequency operator client to display and print the configured
occurrences of events with the use of an SOE reports and logs. The operator client can be
intermediate, configurable buffer used with a mouse or a touchscreen.
 Seamless integration with AIM*Historian software
to provide long-term storage of SOE data SOFTWARE OPERATION
 Generation of reports and logs containing current The SOE server acquires data from FBM channels via
or historical digital information an FCP280, FCP270, or FCM100Et on the control
 Configurable report and log templates domain using a high speed data acquisition interface.
 Dynamically updated on-screen displays with The data is stored in a memory-resident circular
controls that allow you to easily navigate to and buffer and sent to an AIM*Historian database for
view or print specific data long-term storage. SOE sends current data (from the
 Access to reports and logs from any SOE buffer) or historical data to SOE clients, and the
operator client workstation clients show reports and logs with configurable and
 Easy-to-use GUI for quickly identifying and understandable messages.
importing SOE points for which you want to
record SOE data and events
 Capability of configuring meaningful and
identifiable entries to be used in reports and logs.
 PSS 31S-2SOE
Page 3

Data Collection Additionally, the configuration client allows you to edit

Data collection is performed by the same high speed the following general SOE operating parameters:
data acquisition interface to the control domain used  The time delay between event detection and the
by Transient Data Recorder and Analyzer (TDR/TDA) time at which the collected data is sorted by time
software (PSS 31S-2TDRA). The TDR/TDA product is stamp and stored in the circular buffer. This time
licensed separately from the SOE product; but for delay ensures that if there is a time delay between
digital points designated for both transient data and different data sources (FBMs), the data is stored
sequence of events reporting, the two packages may in the correct time sorted order in the circular
run in the same workstation and share the same high buffer.
speed data acquisition interface.
 The size of the SOE circular buffer.

Data Storage and Retrieval  The default debounce period, or the number of

The SOE package sends data to the AIM*Historian milliseconds a signal must be stable before its
product for permanent storage. Between the time change in state is processed. The debounce filter
that events are collected by SOE and archived by eliminates a signal’s relay chatter.
AIM*Historian, they are temporarily stored in an  The name of the AIM*Historian instance used to
intermediate buffer. SOE relies upon this buffering archive data.
mechanism to process an extensive amount of data
 The names of the printers used to print SOE
in a short time period without losing information. The
reports and logs.
circular buffer is configurable from 1,000 to
1,000,000 events.  The time preference (UTC or local time) in which
the timestamps are displayed.
You can use standard AIM*Historian functions to
query its archives for specific data.  The maximum number of rows in SOE data
tables that are displayed on the screen for the
Refer to AIM*Historian (PSS 21S-6AIMHST) for
reports and logs.
additional information on AIM*Historian software.
 The location of configurable report, log, and
THE SOE CONFIGURATION CLIENT configuration templates.
The configuration client provides the user interface Also, from the General Parameters window (Figure 1),
with which you can configure the real-time points you can access SOE server statistics (Figure 2), such
(RTPs) that are to be collected as SOE data from as buffer use and the number of events processed.
FBM I/O data channels. You can customize the
printed reports and logs in which these RTPs appear
by editing the supplied templates.
PSS 31S-2SOE
Page 4

Figure 1. Configuring SOE General Parameters

Figure 2. SOE Server Statistics

 PSS 31S-2SOE
Page 5

Selecting SOE Real-Time Points those points that are supported and enabled for
After setting up general SOE parameters, you can sequence of events collection.
quickly and easily select the digital tags in your The supported points are then displayed in a tree
control system for which you want to record SOE format so you can select them for inclusion in the set
data and events. of RTPs for which data will be collected, as shown in
SOE software queries the control system for available Figure 3. To do this, expand the compound in which
digital points that can be collected with SOE the points exist, then select the point you wish to
software, and retrieves only valid SOE RTPs, that is, include (block.parameter format).

Figure 3. Importing SOE Tags

Configuring Real-Time Points Using the SOE RTP Configuration window, shown in
After selecting a data point for which you want to Figure 4, you can:
collect data, the RTP name is set to a tag name  Modify the “Description” field to contain a
(C:B.P) assigned by SOE, no description of the point meaningful text string representing the RTP in
is provided, and the state text of the point defaults to reports and logs.
ON and OFF. You can customize this generic text
 Customize the “VALUE ON” and “VALUE OFF”
and insert an RTP description so that specific,
fields to contain the text that appears in the
meaningful messages pertaining to the RTPs and
“Value” column in SOE reports and logs when the
their state values are displayed in SOE reports and
logs.
PSS 31S-2SOE
Page 6

state of the associated RTP is On (True) or Off  Import from the set of SOE RTPs.
(False) respectively. For example, if the SOE tag
 Run the configuration report, which prints the
represents a valve’s position, you can set the
settings you establish in the SOE configuration
value “ON” to “Open” and the value “OFF” to
client on the printer specified in the General
“Closed”.
Parameters window.
 Adjust the debounce value to the time required
 Save or cancel configuration changes.
for a signal to be stable before its state change is
processed.  Exit the SOE configuration client.

 Enable or disable the collection of data for an

individual configured RTP.

Figure 4. Configuring SOE Real-Time Points

 PSS 31S-2SOE
Page 7

THE SOE OPERATOR CLIENT

The operator client is used to display and print SOE After a plant upset, for example, you can examine a
reports and logs. Two different modes are supported: generated report or log to determine what caused
the first mode displays current events with automatic the disturbance and how plant management can be
updates (current SOE log) on the screen. The second improved in response to the disturbance.
mode displays historical data. You can access current SOE events and have them
displayed and updated automatically on your
SOE Operator Client Main Window monitor. You can access historical SOE data stored
The operator client main window (Figure 5) is used to in the AIM*Historian instance, which can also be
perform all operator functions in the SOE software. viewed on a monitor or printed from any SOE client
From the operator client main window, you can: workstation.
 Display any of the available SOE reports or logs SOE software allows you to customize reports using
described in the following sections the provided report templates. The template files are
 Activate or deactivate automatic printing of the in rich text format, so you can use a word processor
current SOE log such as Microsoft® Word to tailor the reports
 Exit the SOE operator client. according to your preferences and to the
specifications of your plant.
SOE provides you with the capability to demand a
report or log at any time, or to configure the SOE
current log to display or print automatically to the
output device of your choice.
An SOE report documents the states of designated
digital points sorted by point ID at a specific point in
time (current or historical). An SOE log documents a
complete set of events sorted by time stamp over a
specified time span (current or historical). The
following reports can be displayed and printed in
landscape format:
 SOE report using the current time
Figure 5. SOE Operator Client  SOE report using a historical time
 SOE log using the current time
REPORTS AND LOGS  SOE log using a historical time.
An important feature of SOE software is the creation
of reports and logs, which organize and present Screen Displays of SOE Reports and Logs
information about SOE points and events so that you Identical data is reported in printed output and on
can easily analyze digital data. In addition, reports screen displays of SOE reports and logs. However,
and logs can be generated on demand using the screen displays contain controls that make it
archived data to allow plant personnel to analyze easy to navigate to and view or print specific data.
data when needed.
PSS 31S-2SOE
Page 8

Using the Update and Freeze buttons on the current Sequence of Events Reports
SOE log, you can enable or disable automatic An SOE report retrieves all RTPs configured as SOE
on-screen updates to current RTP values. These points and sorts them by Point ID (RTP name). For
buttons are only available when displaying an SOE each RTP, the report lists the Point ID, the time at
log using the current time; historical data cannot be which the digital RTP last changed its state (to the
dynamically updated. millisecond), a description of the RTP, and the state
Navigation buttons that appear on the right-hand to which the RTP changed at the listed time. An SOE
side of screen displays allow you to: report is generated on demand.
 Navigate to the top or bottom of the report/log Current SOE Report
 Go up or down one page Figure 6 shows an example of an SOE report
 Go up or down one item. displayed on a screen using the current time.
From a screen display, you can opt to print the
currently displayed page or the entire SOE report or
log to the configured printer.

Figure 6. Current SOE Report

 PSS 31S-2SOE
Page 9

Historical SOE Report Figure 8 shows an example of an SOE report

For a historical SOE report, a dialog box (Figure 7) displayed on a screen using a specified historical
allows you to select the point in time at which you time.
want to display the states of the configured SOE
RTPs.

Figure 7. Select Report Start Time

Figure 8. Historical SOE Report

PSS 31S-2SOE
Page 10

Sequence of Events Logs Current SOE Log

The SOE log contains an entry line for every event A current SOE log displayed on a screen shows data
that occurs, that is, one entry for every time an RTP that is automatically updated: a new line is added to
changes state. The events listed in the SOE log are the bottom of the displayed list every time an RTP
sorted by time. For each event entry, the SOE log changes state. The automatic updates to the log can
records the Point ID (RTP name), the time at which be disabled or enabled by clicking the Freeze or
the digital RTP changed its state, the RTP’s Update button.
description, and the state to which it changed. Figure 9 shows an example of a current SOE log
You can choose to view a current SOE log, or you displayed on a screen.
can specify a start point and an end point for the
historical SOE log.

Figure 9. Current SOE Log

Historical SOE Log

For a historical SOE log, a dialog box (see Figure 10)
allows you to select the start time and end time for
which you want to create a log of events. The
historical log displays the SOE RTPs that changed
state during the specified time period.
 PSS 31S-2SOE
Page 11

Figure 11 shows an example of an SOE log displayed on a screen using a specified historical time span.

Figure 10. Select Log Start and End Time

Figure 11. Historical SOE Log

PSS 31S-2SOE
Page 12

Printing Reports and Logs Depending on the printer, the log will print as follows:
Current reports and logs as well as historical reports  With a line printer configured, a line is printed
and logs work with page-oriented printers only. immediately every time a point value change
You can also print the most recent page of the occurs.
current SOE log, even if the page is not completely  With a page-oriented printer configured, every
full. Figure 12 shows an example of a printed SOE time a page of data is collected or the elapsed
log using the current time. time has expired, the page automatically prints in
landscape format.This page-oriented print
Auto Log Printing mechanism is controlled by a configurable elapse
timer.
The auto log printing function runs in the background
and is enabled and disabled from the SOE Operator A detailed log file is also created regarding the
Client. printing task: start and exit of the auto print log, use
of a line printer, errors, lines not printed due to errors.

SEQUENCE OF EVENTS
Current SOE Log
REPORT TIME: 12/20/2004 12:55:13 STATION ID: H91AW7-SOE

DATE TIME RTPNAME DESCRIPTION VALUE

12/20/200 12:54:59.392 6AP07E-06XSAP07E02 06-1 480V ST MCC TRIPPED TRIPPED

4 PM

12/20/200 12:54:59.392 06AP08E- 06-2 480V ST MCC TRIPPED NTRIPPE

4 PM 06XSAP08E04 D

12/20/200 12:54:59.892 5AMP04E- 5A GEN LCKOUT 86G25A TRPD LOCKOU

4 PM 5AXSMP04E02 T

12/20/200 12:54:59.892 5AMP04E- 5A GEN LCKOUT 86G35A TRPD NLOCKO

4 PM 5AXSMP04E03 UT

12/20/200 12:55:00.392 6AMP04E- 6A GEN LCKOUT 86G15B TRPD LOCKOU

4 PM 6AXSMP04E01 T

12/20/200 12:55:00.392 6AMP04E- 6A GEN LCKOUT 86G25B TRPD NLOCKO

4 PM 6AXSMP04E02 UT

12/20/200 12:55:00.892 6SMP04E- 6S GEN LCKOUT 86G26S TRPD NLOCKO

4 PM 6SXSMP04E02 UT

12/20/200 12:55:00.892 6SSY01E- 6S 230KV BUS LKOUT 86C21 NLOCKO

4 PM 6SXSSY01E03 TRPD UT
Figure 12. Printed SOE Log Using the Current Time
 PSS 31S-2SOE
Page 13

SYSTEM REQUIREMENTS
A Foxboro Evo™ or I/A Series® Windows based
workstation or Windows Server 2003 with I/A Series
V8.x software or Foxboro Evo Control Core Services
software v9.x or later installed and AIM*Historian
software (V3.2.4 or later) installed on the SOE server.
PSS 31S-2SOE
Page 14
PSS 31S-2SOE
Page 15
PSS 31S-2SOE
Page 16

Invensys Systems, Inc Copyright 2014–2015 Invensys Systems, Inc.

10900 Equity Drive All rights reserved.
Houston, TX 77041 Invensys is now part of Schneider Electric.
United States of America
http://www.invensys.com Schneider Electric, Invensys, Foxboro, and Foxboro Evo
are trademarks owned by Schneider Electric SE, its
subsidiaries and affiliates.
Global Customer Support All other trademarks are the property of their respective
Inside U.S.: 1-866-746-6477 owners.
Outside U.S.: 1-508-549-2424
Website: https://support.ips.invensys.com MB 031 0215