SOE Recorder Users Guide, V4.0

Triconex SOE Recorder, Version 4.
SOE Recorder
Users Guide
Version 4.0
Assembly No. 9700081-002
April 2004
Information in this document is subject to change without notice. Companies, names and data used in
examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or
transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express
written permission of Triconex.
2004 Invensys Systems, Inc. All Rights Reserved.
Triconex, Tricon, Trident, TriStation 1131, TriStation MSW, and CEMPLE are trademarks of Invensys plc,
its subsidiaries and affiliates. All other brands may be trademarks of their respective owners.
Document No. 9720081-003

Printed in the United States of America.
Contents
Preface v
Summary of Sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Product and Training Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Chapter 1 Triconex SOE Functionality 1

Overview of Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
TriStation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
SOE Recorder Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Chapter 2 TriStation and Controller Tasks 5

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Configuration Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Controller and Main Processor Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Communication Module Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
SOE Configuration in TriStation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
SOE Block Description and Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Defining SOE Block Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Assigning Event Variables to SOE Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Specifying a Trip Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Specifying the State Name and Color for Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Using Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
SOE Application Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
SOESTRT (SOE Start) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
SOESTOP (SOE Stop) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
SOECLR (SOE Clear). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
SOESTAT (SOE Statistics). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Chapter 3 SOE Recorder Tasks 21

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
SOE Recorder Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Installing SOE Recorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Uninstalling SOE Recorder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Retrieval Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Copying the SOE Definition File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Specifying Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
SOE Recorder Users Guide, v4.0

iv Contents
Specifying Snapshot Mode and Event File Location . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Specifying Controllers for Communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Changing the IP Address for Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Specifying Automatic Export of Event Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Event Retrieval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
File Naming Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Creating a New Event File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Specifying the Controllers To Retrieve Events From . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Beginning Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Saving a Snapshot During Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Adding or Removing Controllers to be Polled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Ending Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Viewing Information on the Message Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Viewing Status Bar Information During Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Event Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Viewing a Saved Event File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Viewing Event Data Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Finding Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Copying Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Filtering Event Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Sorting Event Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Saving a Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Exporting Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Viewing Status Bar Information During Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Using the Report Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Printing Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Errors During Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Lack of Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Download Change of TriStation Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Download All of TriStation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Unrecoverable Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Appendix A Commands and Properties 59
Glossary 89
Index 93

Preface
This guide describes the Sequence of Events (SOE) Recorder, which is a software application for
retrieving and analyzing sequence of events information from Triconex controllers. The
TriStation 1131 Developers Workbench software is required to identify the events information
to be collected.
In this guide, Triconex controllers refers to Tricon and Trident controllers.
Summary of Sections
Chapter 1, Triconex SOE FunctionalityExplains how SOE Recorder retrieves and
analyzes SOE data that is collected by a TriStation application running on a Triconex
controller.
Chapter 2, TriStation and Controller TasksExplains how to use TriStation to set up
time synchronization, set the IP addresses of controllers, configure SOE blocks, and
assign event variables to blocks. Describes SOE function blocks that start and stop event
collection.
Chapter 3, SOE Recorder TasksDescribes hardware and software requirements for
SOE Recorder; provides installation instructions; explains how to retrieve, save, and
analyze event data; explains how to export event data to dBASE IV and other types of
files; and describes reporting features.
Appendix A, Commands and PropertiesDescribes the commands and properties
available in SOE Recorder.
GlossaryProvides a glossary of terms used in this guide.

vi Preface
Related Documents
These guides contain information related to SOE Recorder:
ACM Users Guide
SMM Users Guide
TriStation 1131 Developers Guide
Tricon and Trident Communication Guides
Product and Training Information

To obtain information about Triconex products and in-house and on-site training, see the
Triconex Web site or contact your regional customer center.
Web Site
http://www.triconex.com
Technical Support
Customers in the U.S. and Canada can obtain technical support from the Customer Support
Center (CSC) at the numbers below. International customers should contact their regional
support center.
Requests for support are prioritized as follows:
Emergency requests are given the highest priority
Requests from participants in the System Watch Agreement (SWA) and customers with
purchase order or charge card authorization are given next priority
All other requests are handled on a time-available basis
If you require emergency or immediate response and are not an SWA participant, you may
incur a charge. Please have a purchase order or credit card available for billing.
Telephone
Toll-free number 866-746-6477, or
Toll number 508-549-2424 (outside U.S.)
Fax
Toll number 508-549-4999
E-mail
ips.csc@invensys.com

1
Triconex SOE Functionality
Overview of Functionality 2
TriStation Tasks 4
SOE Recorder Tasks 4

2 Chapter 1 Triconex SOE Functionality
Overview of Functionality
The Triconex Sequence of Events (SOE) Recorder software allows you to retrieve event data
from as many as 31 Triconex controllers on a network. This event data can be used to identify
the causes of shutdowns, define corrective actions and procedures for preventive maintenance,
and solve other process-control problems.
Understanding the sequence of events that leads to unsafe process conditions and possible
shutdowns may be essential to the safety application. For Triconex controllers, an event is the
state change of a Boolean variable from True to False or from False to True. A Triconex controller
can collect events and record the date, time, state, and variable name of each event in SOE blocks
that reside in the controllers memory. This figure shows how Triconex controllers, TriStation
1131, and SOE Recorder interact to provide sequence-of-events functionality.
Tristation 1131
Developers Workbench Sequence of
Events Data
File (*.SED)
SOE Blocks Snapshot
dBASE IV File
ASCII Text File
Event
Variables
SOE Recorder Online
SOE SOE
Function Definition
Blocks (.SOE) File
.SOE File
Analysis
.SOE File
Reports
Downloaded TriStation Projects
Enabled for SOE
Networked Triconex Controllers
CM CM
Tricon
N N
Node 02
M M M C C
P P P MM
A B C 1 2
MP MP
Trident Node 01 Trident Node nn
To enable event data to be detected by the controller, you must define the event variables and
SOE blocks in the TriStation application. In addition, the application must include SOE function
blocks that start event collection. After you download an SOE-enabled application to the
controller, TriStation creates an SOE definition file that contains the SOE block definitions.
To retrieve events with SOE Recorder, you must connect the SOE Recorder PC to a
communication port on a Triconex controller. (You can also retrieve events from a Triconex
controller with an SOE program on a non-Triconex external device.) You must use TriStation to
set the IP address of the controller and you must specify the address in SOE Recorder.

Overview of Functionality 3
SOE Recorder can simultaneously retrieve event data from as many as 31 Triconex controllers.
SOE Recorder queries all the controllers on the network to determine which TriStation
applications include SOE blocks. If an application includes one or more SOE blocks, SOE
Recorder opens the appropriate SOE definition file and begins retrieving events from the
associated controller.
SOE Recorder can save events in an event file until a trip occurs or the maximum allowable
number of events occurs. SOE Recorder can also save snapshots for periods that you specify, such
as the periods that reflect each shift of a plants operation. During event retrieval, you can
manually save an intermediate snapshot of event data at any time.
SOE Recorder allows you to find events and copy them to other Windows applications, filter
and sort events, and view the properties of individual events.
SOE Recorder also allows you to export event data, either manually or automatically, to
dBASEIV, ASCII, or other file formats. A report engine and standard report are also included.

4 Chapter 1 Triconex SOE Functionality
TriStation Tasks
The SOE tasks done in TriStation include:
Using Time Synchronization (page 15).
SOE Configuration in TriStation (page 8).
SOE Application Development (page 16).
For more information, see Chapter 2, TriStation and Controller Tasks.
SOE Recorder Tasks

SOE Recorder tasks must be completed after the TriStation application has been configured for
SOE and downloaded to the controller.
The tasks include:
Installing SOE Recorder (page 23)
Retrieval Setup (page 25).
Event Retrieval (page 33).
Event Analysis (page 44).
For more information, see Chapter 3, SOE Recorder Tasks.

2
TriStation and Controller Tasks
Overview 6
Configuration Specifications 7
SOE Configuration in TriStation 8
SOE Application Development 16

6 Chapter 2 TriStation and Controller Tasks
Overview
This section describes the SOE-specific tasks that must be done in TriStation 1131 to develop an
application that defines the event data to be collected by the controller. The TriStation
application must identify the event variables, the SOE blocks, and must include an SOE function
block that starts event collection. For information on standard development tasks such as
downloading an application, see the TriStation Developers Guide.
The TriStation 1131 software includes sample projects with SOE function blocks used in
programs, and with multiple SOE blocks with event variables assigned to them. With each
project, you can generate a sample SOE definition file which supplies point properties for the
event variables. For sample projects, see ExSoe.pt2 for Tricon controllers or TdSoe.pt2 for
Trident controllers.

Configuration Specifications 7
Configuration Specifications
This section includes information about hardware and software compatibility.
Topics include:
Controller and Main Processor Compatibility (page 7)
Communication Module Compatibility (page 7)
Controller and Main Processor Compatibility

SOE Recorder, v4.0 is compatible with these controller versions and Main Processors.
Triconex Controller Main Processor

Tricon version 9.5 Model 3006
Tricon version 9.6 and later Model 3008
Trident version 1.2 and later Model 3101
The Tricon model 3007 Main Processors do not have sufficient memory to
CAUTION be used with SOE Recorder.
Communication Module Compatibility

The type of communication module installed in a Triconex controller determines whether event
retrieval can be done by SOE Recorder or by a DCS application. This table describes the type of
communication modules that can be used with SOE Recorder or with a DCS utility.
Model Communication Module Name Use with: Controller

4409 Safety Manager Module (SMM) Honeywell TDC 3000 DCS Tricon
4329 Network Communication Module (NCM) SOE Recorder Tricon
4609 Advanced Communication Module (ACM) SOE Recorder or Tricon
Foxboro I/A Series system
3201 Trident Communication Module (CM) SOE Recorder Trident
For information on installing and configuring communication modules, see the Tricon
Communication Guide or Trident Communication Guide. For information on using an ACM or
SMM with a DCS utility for event retrieval, see the ACM Users Guide or the SMM Users Guide.

SOE Configuration in TriStation

This section explains how to configure SOE blocks and assign event variables to them so you
can retrieve events. For information on using SOE function blocks in programs, see SOE
Application Development (page 16).
SOE Recorder communicates via the Net port on the controller

CAUTION communication module, which must be configured for a network (open)
connection. For more information, see the TriStation 1131 Developers
Guide.
Topics include:
SOE Block Description and Type (page 8)
Defining SOE Block Properties (page 10)
Assigning Event Variables to SOE Blocks (page 11)
Specifying a Trip Variable (page 12)
Specifying the State Name and Color for Events (page 14)
Using Time Synchronization (page 15)
SOE Block Description and Type

An SOE block is a data structure that resides in the memory of the Main Processors. The block
header contains the block type, the buffer size, and a list of the event variables assigned to the
block. The buffer stores the event entries, which include the values of all the event variables that
changed during the current scan and a time stamp for the scan that applies to all of the changed
variables in the block. You determine when to start and stop collecting events from the SOE
blocks by using start and stop function blocks in the TriStation application.
There are 16 SOE blocks available. Blocks 1 through 14 can use any combination of External,
First Out, or History types. Blocks 15 and 16 are modified external blocks that are reserved for
use with the Safety Manager Module (SMM).
External Block Type

The External Block Type setting is typically used when an external device, such as a Foxboro or
Honeywell DCS or PC running SOE Recorder, is retrieving events from a controller on a
continual basis. When events are collected by the external device, event data is cleared from the
block. When the buffer is full, new event entries are discarded.
Process
1 The Main Processors write an event to the block and notify the external device.
2 The external device requests the data from the Main Processors and acknowledges the
receipt of the data.

3 After the Main Processors receive the acknowledgment, event data is cleared from the
block.
4 When the buffer is full, the Main Processors discard new event entries.
First Out Block Type

The First Out Block Type setting is typically used to retrieve the first and subsequent events that
led to a trip.
Process
1 The Main Processors write events to the block.
2 When the buffer is full, the Main Processors change the blocks status from collecting to
stopped. New events are discarded.
Historical Block Type

The Historical Block Type setting is typically used to monitor current events in SOE Recorder
application. An external device can collect events at any time, however, the collection does not
clear the block. If the TriStation application does not clear and restart recording, the oldest event
entries are overwritten when the buffer is full.
Process
2 When the buffer is full, the Main Processors overwrite the oldest event entries.
Modified External Block Type

The Modified External Block Type setting is used for event retrieval with the Safety Manager
Module (SMM). The SMM is the Triconex communication interface with the Honeywell
Universal Control Network (UCN), which is one of the principal networks of the Honeywell
TCD 3000 Distributed Control System.
Only blocks 15 and 16 can be specified as Modified External.
Process
1 The Main Processors write an event to the blocks and notify the SMM.
2 The SMM requests the data from the Main Processors and acknowledges the receipt of
the data.
3 The SMM forwards the data through the UCN to the TDC 3000 DCS.
block.
For more information, see the SMM Users Guide.

Related Topics
SOE Application Development (page 16).
Defining SOE Block Properties

This procedure explains how to define the block type and buffer size of an SOE block. This task
is required.
Defining SOE block properties is related to the general TriStation task of controller
configuration and can be completed at the same time. You can define SOE blocks to provide
continuous event information to external devices on a network, or you can define them for
limited operation when the controller is not on a network.
When a Foxboro I/A Series DCS retrieves events via an ACM, only one
CAUTION block can be configured, and it must be defined as an External Block
Type.
Blocks 15 and 16 can only be defined as Modified External.
Procedure
1 In TriStation 1131, open the SOE project, click the Application tree, double-click
Implementation, and expand the SOE Configuration icon.
2 Double-click the block number to be set.
3 Specify these settings on the SOE Block Definition tab.

Property Description
SOE Block Type These types can be selected:
External Block Type: Used when an external device, such as a DCS or
a PC running SOE Recorder, is continually retrieving events.
First Out Block Type: Used to retrieve events that started a trip.
Historical Block Type: Used to monitor current events.
Modified External Block Type: Used for event retrieval with the
SMM.
SOE Block Name Enter a title for the block.
SOE Buffer Size Enter the number of events to be stored in this block. The maximum
number is 20,000; the default is 0.
4 Click Apply.
5 Repeat for all blocks to be configured.
Related Topics
Assigning Event Variables to SOE Blocks

This procedure explains how to assign event variables (tagnames) to an SOE block. Only aliased
memory and input tagnames which are BOOL data types can be assigned as event variables.
This task is required.
When a Foxboro I/A Series DCS retrieves events via an ACM, the event variables are assigned
by the Foxboro I/A Series system. For more information, see the ACM Users Guide.
When the SMM is used to retrieve events, the event variables are assigned by the Honeywell
TDC 3000. For more information, see the Honeywell documentation and the SMM Users Guide.
Before Starting
Before you can assign event variables, you must define SOE block properties. For information,
see Defining SOE Block Properties (page 10).
Procedure
1 In TriStation 1131, open the SOE project, click the Application tree, and double-click
Implementation. Click the SOE Configuration branch. The tagnames and block
assignments, if any, are listed.
2 To assign a tagname to one or more SOE Blocks, double-click the row for the tagname.
An Item Properties screen is displayed.

3 To assign the tagname to specific blocks, check the box for the block number. If the
number is disabled, it means the block has not been defined.
Note If you add tagnames after opening the SOE Configuration screen, you must close
and re-open the SOE Configuration screen to have the new tagnames displayed.
4 Continue to assign tagnames to blocks as needed.
Related Topics
Specifying a Trip Variable

This procedure explains how to designate a trip variable, which enables SOE Recorder to take a
snapshot of events before and after a trip. This task is optional.
In an application used for safety shutdown, a trip variable is an aliased tagname whose state
transition causes SOE Recorder to automatically create a trip snapshot. An application can have
one trip variable, but it can apply to all blocks. If an application requires several variables
related to trip conditions, these variables must be evaluated in combination to determine the
final state of the trip variable.
To have a trip snapshot taken, SOE Recorder must be retrieving events

CAUTION before and after the trip occurs.
Before Starting
You must define at least one SOE block and assign an event variable to the block.

Procedure
1 In TriStation 1131, open the SOE project, click the Application tree, and double-click
Implementation. Double-click SOE Configuration.
2 Specify these settings on the SOE Trip Variable tab.
Trip Tagname Click a tagname from the list of event variable names. Only tagname that
are aliased BOOL data types are available.
Trip State Select the value on which to begin collecting events; can be True or False.
Time After Trip Set the number of minutes to collect events after a trip. The minimum
time is 0 minutes; the maximum time is 10 minutes. The default is 2
minutes.
Time Before Trip Set the number of minutes to collect events before a trip. The minimum
time is 2 minutes; the maximum time is 10 minutes. The default is 2
minutes.
Related Topics
Specifying Snapshot Mode and Event File Location (page 27)

Specifying the State Name and Color for Events

This procedure explains how to specify the name and color associated with a True or False state
which is displayed when events are retrieved by SOE Recorder. You can specify different state
names and colors for specific tagnames or specify the same state name and color for multiple
tagnames.
Procedure
1 In TriStation 1131, open the SOE project. Specify one or more tagnames by doing any of
these actions:
On the Tagname Declarations or Declarations tree, double-click a tagname.
Double-click a tagname on a logic sheet, and then click the Declarations button.
Select a range of tagnames by pressing the Shift key and clicking the top and
bottom, then double-click in the range.
Select multiple tagnames by pressing the Ctrl key and clicking the each tagname;
then double-click any tagname in the set.
2 Click the Display tab.
3 Specify these properties on the Display tab.
Property Action
True State Name Enter a name to display when the tagname value is True or use the
default setting which is TRUE.
True Color Select a color to display when the tagname value is True or use the
default setting which is red.
False State Name Enter a name to display when the tagname value is False or use the
default setting which is FALSE.
False Color Select a color to display when the tagname value is False or use the
default setting which is green.
4 To replace the default settings, click Get Defaults.

5 To save the settings, click Apply Changes.
Using Time Synchronization

Triconex controllers include a time synchronization feature which allows the time setting for
controllers to be synchronized to a master controller or an external device, such as a DCS or PC.
If you are collecting events for shutdown analysis, all the controllers being polled should be
using the time synchronization feature.
In a network, the controller clock can be synchronized with the master node (the controller with
the lowest node number) or with an external device that writes time values to the TriStation
application, or with both. In a combination approach, the master node accepts time adjustments
from an external device and in turn sets the time for other controllers on the network.
You can verify whether the polled controllers are synchronized by checking the SOE Recorder
message bar. Each day, SOE Recorder compares its clock with the clock of each controller from
which event data is being collected. If the PC clock and controller clock differ by five minutes or
more, this information is displayed in the Message Bar.
Avoiding Different Time Stamps for the Same Event

In a network of Triconex controllers, one point can be connected to more than one controller. If
that point is represented by event variables in more than one TriStation application, the SOE
time stamps might be slightly different for the various controllers when an event occurs. You
must determine whether this disparity is acceptable for the process by considering the following
information.
In a typical network, Triconex controllers synchronize their time with the master node (the
controller with the lowest node number) within plus or minus 25 milliseconds. A controller
recognizes events on a scan basis and time-stamps each event at the beginning of the scan.
Because the scans of the various controllers on the network are not synchronized, the same
event can be logged by two controllers with different time stamps. The worst-case difference is
the longer scan time plus 25 milliseconds.
For more information, see the TriStation 1131 Developers Guide.

SOE Application Development

This section describes function blocks that control and verify event collection for SOE blocks.
TriStation provides function blocks to start and stop event collection for specific SOE block,
check the status of an SOE block, and clear the values of an SOE block. The start function block
(SOESTRT) must be added to the program to identify the SOE blocks to be used for event
collection. The other SOE function blocks are optional.
SOESTRT (SOE Start) Starts event collection for a specified SOE block (Required)
SOESTOP (SOE Stop) Stops event collection for a specified SOE block (Optional)
SOECLR (SOE Clear) Clears a specified SOE block (Optional)
SOESTAT (SOE Statistics) Checks status of a specified SOE block (Optional)
Programming Notes
To properly execute the SOESTRT, SOESTOP and SOECLR function blocks, a program should
turn the CI input On for only one scan. If you leave CI on for more than one scan, SOE Recorder
generates another event for every scan. For more information, see the sample project on the
TriStation CD.
If you are programming with Structured Text language, you can use conditional statements to
execute SOESTRT, SOESTOP and SOECLR. For more information, see the Triconex Libraries
Reference.

SOESTRT (SOE Start)

The SOESTRT function block starts sequence of events (SOE) collection for an SOE block. The
Main Processors write an SOESTRT time stamp entry to the block and change the state of the
block from not started or stopped to collecting. The Main Processors use these initial values as
the basis for comparison during subsequent scans. If the SOESTRT operation is successful, the
output status is 1, which indicates the block is collecting data.
This function block must be executed for each SOE block from which you want to collect events.
Note The SOESTRT function block is executed once per scan, which means the resulting STAT
output is only valid for that scan.
Table 1 Input Parameters

Name Data Type Description
CI BOOL Enables SOESTRT.
BLOCK DINT The block number (116).
Table 2 Output Parameters

CO BOOL True if SOESTRT executes successfully.
STAT DINT Status:
0 = The block is not started or not configured with data type and size.
1 = The block is collecting data.
2 = The block is stopped or cleared.
3 = The block is full.

SOESTOP (SOE Stop)

The SOESTOP function block writes a time stamp to the sequence of events (SOE) block, and
changes the state of the block from collecting to stopped. Event collection stops until the next
SOESTRT operation.
If the SOESTOP operation is successful, the output status is 2, indicating that event collection is
stopped. If CI is false, no operation occurs (no output changes).
This function block is optional. It may be useful during development of an application.
Note The SOESTOP function block is executed for only one scan, which means the resulting
STAT output is only valid for that scan.

CI BOOL Enables SOESTOP.

CO BOOL True if SOESTOP executes successfully.
STAT DINT Status:

SOECLR (SOE Clear)

The SOECLR function block clears a sequence of event (SOE) block. SOECLR removes all entries
from the block and writes an SOECLR time stamp to the block. You must stop event collection
(using SOESTOP) before clearing the block.
If the SOECLR operation is successful, the output status is 2, indicating the block is cleared. If
the event collection was not stopped before the SOECLR operation was attempted, the status is
0, 1 or 3.
If CI is false, no operation occurs (no output changes).
This function block is optional.
Note The SOECLR function block is executed for only one scan, which means the resulting
STAT output is only valid for that scan.

CI BOOL Enables SOECLR.

CO BOOL True if SOECLR executes successfully.
STAT DINT Status:

SOESTAT (SOE Statistics)

The SOESTAT function block returns the status for a sequence of events (SOE) block, including
the number of eight-byte entries that are used, and the number of eight-byte entries that are free.
If CI is false, no operation occurs.
This function block is optional, however, it is highly recommended to provide information on
block status, including whether the block is full.

CI BOOL Enables SOESTAT.

CO BOOL True if SOESTAT executes successfully.
STAT DINT Status:
FREE DINT The number of unused eight-byte entries in the block.
USED DINT The number of used eight-byte entries in the block.

3
SOE Recorder Tasks
Overview 22
SOE Recorder Installation 23
Retrieval Setup 25
Event Retrieval 33
Event Analysis 44
Troubleshooting 56

22 Chapter 3 SOE Recorder Tasks
Overview
SOE Recorder can simultaneously retrieve event data from as many as 31 Triconex controllers
on a network. You can use this event data to identify the causes of shutdowns, define corrective
actions and procedures for preventive maintenance, and solve other process-control problems.
SOE Recorder accumulates events in an event file until a trip occurs or the maximum allowable
number of events occurs. SOE Recorder can also save snapshots for periods that you specify,
such as snapshots that reflect each shift of a plants operation. During event retrieval, you can
manually save an intermediate snapshot of event data at any time.
To analyze the event data, SOE Recorder includes tools for finding events and copying them to
other Windows applications, filtering and sorting saved event data, specifying the display of
point properties for event data, and viewing the properties of individual events. SOE Recorder
also allows you to export event data, either manually or automatically, to dBASEIV or ASCII
text files. A report engine and standard report are also included.

SOE Recorder Installation 23
SOE Recorder Installation

This section explains how to install and uninstall SOE Recorder on a PC running a Windows
2000 or XP operating system. For details on PC hardware and operating system requirements,
see the TriStation 1131 v4.0 Product Release Notice.
Topics include:
Installing SOE Recorder (page 23)
Uninstalling SOE Recorder (page 24)
Installing SOE Recorder

This procedure explains how to install SOE Recorder on a PC using a Windows 2000 or XP
operating system.
Before Starting
You must be logged on as an administrator or a user with administrative privileges. You can
install and run SOE Recorder on the same PC as TriStation 1131 or on a different PC.
If you have installed a previous version of SOE Recorder, you must

CAUTION uninstall it first.
Procedure
1 Exit any open applications.
2 Place the SOE Recorder CD in the CD ROM drive.
3 On the Start menu, click Settings.
4 Click the Control Panel icon.
5 Double-click the Add/Remove Programs icon.
6 On the Add/Remove Programs screen, click the Install/Uninstall tab.
7 Click Install.
8 Follow the instructions given in the Installation Wizard.
Triconex recommends installing SOE Recorder in the default destination directory,
which is c:\Program Files\Triconex\TcxSoe.
9 To complete the installation of SOE Recorder, click OK.
SOE Recorder is now installed on the computer. To start it, click Triconex Sequence of Events
from the Triconex shortcut of the Programs menu.
Related Topic
Uninstalling SOE Recorder (page 24).

Uninstalling SOE Recorder

This procedure explains how to uninstall SOE Recorder. If you have installed a previous version
of SOE Recorder, you must uninstall it before installing a new version.
Procedure
1 Log on as an administrator or as a user with administrator privileges.
2 On the Start menu, click Settings, and then click Control Panel.
3 Double-click Add/Remove Programs, and select Triconex Sequence of Events Recorder.
4 Click Change/Remove.
5 On the Confirm File Deletion screen, click Yes to remove the previous version of SOE
Recorder.
6 When the Uninstall Successfully Completed message appears, click OK.
7 You can now install a new version of the SOE Recorder software.
Related Topic
Installing SOE Recorder (page 23).

Retrieval Setup 25
Retrieval Setup
This section explains how to set up SOE Recorder so you can retrieve and view event
information. You can use the default settings for event retrieval or change them to meet your
needs.
Topics include:
Copying the SOE Definition File (page 25)
Specifying Display Options (page 26)
Specifying Controllers for Communication (page 29)
Changing the IP Address for Controllers (page 30)
Specifying Automatic Export of Event Data (page 31)
Copying the SOE Definition File

This procedure explains how to copy the SOE Definition file to the SoeConfig folder on the SOE
Recorder PC. The SOE Definition file contains SOE block definitions and point properties for the
event variables assigned to the SOE blocks. The file is generated and copied to the PC when the
TriStation application is downloaded to a controller.
Procedure
1 Ensure that an SOE-enabled application is downloaded to each Triconex controller that
is to collect events.
2 Go to the folder where the TriStation projects are stored and find the SOE Definition file.
The name of the file is displayed in the TriStation 1131 Message Bar when the application
is downloaded to the controller.
The naming convention for the file includes the first eight characters of the TriStation
project name, the major version number, minor version number, and time code. An
example is:
SOE_EX_9_0_33F4CE47.SOE
3 Copy the SOE Definition file to the SoeConfig folder where the SOE Recorder software
was installed. Repeat this process for each controller that is to collect events.
Do not rename the SOE definition file under any circumstances.

CAUTION Renaming it prevents SOE Recorder from retrieving event data.

Specifying Display Options

This procedure explains how to specify the type and order of information to display either
during event retrieval or after a saved events file is displayed. By default, all ten columns of
event information are displayed in the order indicated on the screen. You can change these
settings before or during event retrieval or when viewing a saved events file.
When you create an event file, the current column display settings are automatically applied to
the next file you create unless you change the settings. Adjustments you make to column widths
while an event file is open are saved when you close the file.
Procedure
1 On the SOE Recorder Tools menu, click Options.
2 On the Options screen, click the Display tab.
3 The Options screen includes these properties and commands.
Property/Command Description
Column Check the column name to include a column in the display.
Uncheck the column name to remove a column from the display.
Move Command Check the column name to be moved, and then click Up or Down to
move the column up or down in the list.

Retrieval Setup 27
Auto Scroll Check the Auto Scroll option to have event data scroll continuously
during live event retrieval. This option is only used during live event
retrieval.
The default is checked.
Default Click to return to the default column order, which is: Date, Time,
Alias, Tagname, Variable State, Node, Block, Group1, Group2, and
Description.
4 Click OK to save settings.
Specifying Snapshot Mode and Event File Location

This procedure explains how to specify the Periodic and Auto Snapshot modes and the location
of the Event File Directory. You can specify these features before event retrieval, but not during
event retrieval.
Periodic Snapshots
Periodic Snapshots allows you to specify whether a file of events is generated during a specific
time period. In addition to the daily, weekly, and monthly snapshots, you can specify a shift
snapshot which is based on time periods for up to three weekday shifts and three weekend
shifts.
Periodic snapshot filenames include the date and time of the snapshot and one of these file
extensions:
_D.SED for daily snapshot
_W.SED for weekly snapshot
_M.SED for monthly snapshot
_S.SED for shift snapshot
The file name identifies the user-defined file name, date and time of the snapshot, and an
extension that identifies the type of snapshot. This example identifies the parts of the file name.
Node7_ 20040410_10:20:15_ W.SED

User-defined name of event file Year, day, month, Weekly snapshot
hour, minute, and
second when
snapshot was taken
Auto Snapshots
Auto Snapshots automatically saves a snapshot when a trip occurs or when a specified number
of events occurs. You can have snapshots taken when either or both situations occur.

Event File Directory

The default Event File Directory is: C:\...\My Documents\Triconex\Triconex Sequence of
Events Recorder 4.0.
Procedure
1 On the SOE Recorder Tools menu, click Options, and then click the Mode tab.
2 For Periodic Snapshots, specify these properties on the Mode tab.
Periodic Snapshot Click the type of period for the snapshot.
Shift Definitions For Shift Snapshots, enter the hours for the shifts.
3 For Auto Snapshots, specify these properties on the Mode tab.
On Trip Events Check Trip Events to save a snapshot when a trip occurs.
On Max Events Check on Max Events to save a snapshot when a specified
number of events occurs.
Maximum Events Per File If you select On Max Events, enter the Maximum Number of
Events (up to 100,000) to retrieve.

Retrieval Setup 29
4 To specify the location of the Event File Directory, use the Browse button to locate the
directory.
5 Click OK to save.
Specifying Controllers for Communication

This procedure explains how to specify the Triconex controllers that are to be communicated
with to retrieve events. You can create the list of controllers by starting with a blank list and
adding each controller, or by displaying a default list of controller addresses and then
modifying and deleting controllers as needed.
You can specify controller settings before event retrieval, but not during event retrieval.
Before Starting
In SOE Recorder, close any open event files. The controllers you specify will apply to the next
event file you create.
Procedure
1 On the SOE Recorder Tools menu, click Options, and then click the Communications tab.
2 These commands are on the Communications tab.
Command Description
Add Click Add to add a controller address. If the Default button is clicked, Add
cannot be used.

Command Description
Modify Click an address and then click the Modify button to change address
information.
Delete Click an address and then click the Delete button to delete an address.
Defaults Click the Default button to display a list of default IP addresses. This list will
replace all current node information.
3 Click OK to save.
Related Topic
SOE Configuration in TriStation (page 8)
Changing the IP Address for Controllers (page 30)
Event Retrieval (page 33)
Changing the IP Address for Controllers

This procedure explains how to specify the IP addresses for Triconex controllers from which to
retrieve events. If the default IP Address was used for the TriStation application, you can use
the default address in the SOE Recorder listing. If you want SOE Recorder to retrieve events
from multiple controllers on a network, you must specify the IP addresses for all controllers on
the network.
You can specify this setting before event retrieval, but not during event retrieval.
Procedure
1 In SOE Recorder, close any open event files. The addresses you specify will be used for
the next file that is created.
2 On the Tools menu, click Options, and then click the Communications tab.
3 Click the node number for the desired controller, and then click Modify.

Retrieval Setup 31
4 Specify these properties on the IP Address screen.
Node Name Change the node name, if needed.
Node Number Change the node number, if needed.
IP Address Change the IP Address, if needed.
5 Click OK to save.
Specifying Automatic Export of Event Data

This procedure explains how to specify the automatic export of event data to a dBASE IV or
ASCII journal file. You can enable this option before or after you begin retrieving events. Event
data are exported to the specified file every 30 seconds.
To export events, SOE Recorder must have exclusive access to the journal file. If another
application accesses the file for several minutes, SOE Recorder waits until the file is available to
resume the export activity.
Procedure
1 On the SOE Recorder Tools menu, click the Options command, and then click the Auto
Export tab.
2 To enable the option, check Auto Export to a journal file.

3 Specify these properties on the Auto Export tab.
Auto Export to a Check to automatically export event data to a dBASE IV or ASCII
Journal File journal file.
Journal File Format Click the dBASE IV or ASCII Delimited Text setting.
Specify the Absolute Specify the absolute path for the journal file, including a file name.
Path for a Journal File Use Browse if needed.
If you plan to use the file with a dBASE IV application, the file name
should be no longer than eight characters.
The default path is the SoeData directory where SOE Recorder is
installed; the default file name is Journal.
4 Click OK.

Event Retrieval 33
Event Retrieval
This section describes how to retrieve events from one or more controllers. When you create a
new event file, SOE Recorder looks for controllers that are connected to the network. If the
controller is connected and the SOE Definition file matches the SOE definition in the SoeConfig
directory, you can retrieve events from it.
Only one SOE Recorder client can read event data from a controller. If
CAUTION more than one client tries to read data, neither client will get all of the
event data.
Topics include:
File Naming Conventions (page 34)
Creating a New Event File (page 35)
Specifying the Controllers To Retrieve Events From (page 36)
Beginning Event Retrieval (page 37)
Saving a Snapshot During Event Retrieval (page 39)
Adding or Removing Controllers to be Polled (page 40)
Ending Event Retrieval (page 41)
Viewing Information on the Message Bar (page 41)
Viewing Status Bar Information During Retrieval (page 42)

File Naming Conventions

Several types of files can be generated by SOE Recorder. The base event file, which is created
each time you create a new file, includes a user-defined name and the .SED file extension. For
example, Node7.SED.
Other files, such as the snapshot, trip, and over-limit files, are generated from the base event file.
These files include the name of the base file, the date and time the file was created, and an
identifier that indicates the type of file.
This table identifies the parts of file name.
File Part Description Example

Base name The name of the base file. Node7
Date The year, month, and day the file was created. 20040410
Time The hour, minute, and second the file was created. 102824
Identifier T indicates a trip file; the number identifies the node on which the trip T01.SED
occurred.
O indicates an over-limit file, which means the events file is over the O.SED
limit of the maximum events specified to be retrieved.
D indicates a daily snapshot. D.SED
W indicates a weekly snapshot. W.SED
M indicates a monthly snapshot. M.SED
S indicates a shift snapshot. S.SED
Related Topics

Event Retrieval 35
Creating a New Event File

This procedure explains how to create a new event file so that events can be retrieved from
controllers.
Before Starting
Make sure these tasks have been completed:
Specifying Automatic Export of Event Data (page 31)
Procedure
1 In SOE Recorder, click the New command from the File menu, or click .
2 On the Create New SED File screen, enter a name for the sequence of events data file in
the File name field, and then click Create. If you do not enter SED as the file extension,
it is automatically appended to the file name.
Related Topics
Retrieval Setup (page 25)

Specifying the Controllers To Retrieve Events From

This procedure explains how to specify the controllers that event data are to be retrieved from.
When you create a new event file, these actions are taken to determine which controllers are
available:
The IP addresses configured in SOE Recorder are polled to determine if they are valid
and if a physical connection can be made to a controller.
Each controller is polled to determine whether an SOE-enabled application has been
downloaded and is running.
The SOE configuration files in the SoeConfig folder on the PC are compared to the
application on the controllers to determine whether they match.
The results of the polling are displayed on the SOE Retrieve screen. If the controller is available
and the SOE configuration file matches, the Retrieve check box is enabled.
Procedure
1 On the SOE Recorder File menu, click New and enter a name for a new event file or select
an existing file to overwrite. Click OK to save. The SOE Retrieve screen displays the
controllers that were specified on the Communications tab.
2 These properties are displayed.
Retrieve SOE? Check this box to have events collected from the controller. The
check box is only available if the controller has a valid IP address,
is running an SOE-enabled application, and the SOE configuration
file matches the file on the PC.
Node Displays the node name specified on the Communications tab.

Event Retrieval 37
Status Indicates whether SOE Recorder is able to communicate with a
controller that is running an SOE application. These conditions are
possible:
Project name and version: identifies the name and version of
the downloaded TriStation application.
No response: indicates that SOE is unable to communicate
with the controller. Recheck the IP address.
No SOE blocks started yet: SOE Recorder is able to
communicate, but the application has not started collecting
events.
SOE Configuration File Indicates whether an SOE configuration file has been located. For
information, see Copying the SOE Definition File (page 25).
Match Indicates whether the SOE configuration file matches the file used
by the controller. If the files dont match, the controller cannot be
selected to retrieve events from.
3 To specify that a controller should be polled so that events can be retrieved, click the
check box next to the node name. Repeat for each controller from which events are to be
retrieved.
4 To refresh the display, click Refresh Node List on the Command menu or click .
Related Topic
Beginning Event Retrieval

This procedure explains how to begin retrieving events from controllers. After you begin event
retrieval, events continue to be retrieved until you select the End Event Retrieval command or
at the end of a snapshot period. If periodic or auto snapshot are specified, they are automatically
saved as separate files. If a trip variable is specified in the TriStation application, a trip file is
saved.
If the event variables (tagnames) have been specified in TriStation to display a different state
name or color, that state name and color are shown. Otherwise, the default settings are shown.
For more information, see Specifying the State Name and Color for Events (page 14).
Procedure
1 You must specify a new event file and the controllers to be polled. For steps, see
Specifying the Controllers To Retrieve Events From (page 36).
2 On the Command menu, click Begin Event Retrieval, or click .

SOE Recorder displays events in the event file as they are retrieved from the controller.
The order of the columns is set on the Display tab of the Options screen. If the Auto Scroll
option is checked, the list automatically scrolls as events occur.

3 These properties are displayed.
Date The date the event was collected by the controller.
Time The time the event was collected by the controller.
Alias The alias number of the tagname that represents the event.
Tagname The tagname of the event.
Variable State The state of the tagname. The default name and color is True (red) and
False (green). The state name and color can be changed. For more
information, see Specifying the State Name and Color for Events
(page 14).
Node The node number and node name of the controller collecting the event.
Block The SOE block number.
Group1 A user-defined category for the tagname.
Group2 A user-defined category for the tagname, which is subordinate to
Group1.
Description A description of the tagname.
Related Topics
Ending Event Retrieval (page 41)

Event Retrieval 39
Saving a Snapshot During Event Retrieval

This procedure explains how to manually save a snapshot during event retrieval. When the
Save Snapshot command is used during event retrieval, the snapshot file contains the current
events up to moment the file is saved. The Save Snapshot command can also be used to take a
snapshot of a previously saved events file.
Procedure
1 On the SOE Recorder File menu, click New and enter a name for a new event file. Click
OK to save.
2 On the SOE Retrieve screen, click the Retrieve SOE check box for each controller from
which events are to be retrieved.
3 On the Command menu, click Begin Event Retrieval, or click .
4 Specify a file name for the snapshot, and then click Save. The file will contain the events
from the beginning of the retrieval until the time the file is saved.

Adding or Removing Controllers to be Polled

This procedure explains how to add or remove nodes, which determines which controllers SOE
Recorder is retrieving events from. You can add or remove nodes to retrieve events from any
time during event retrieval. This procedure also explains how to re-poll after a lost connection
or a download change which modifies the application running on a controller.
When the Add/Remove Nodes screen is displayed, the list of polling nodes includes all the
nodes that were available based on the last poll. (If the connection was lost since the last poll,
the node is not displayed.) If events are being retrieved from a node, the box next to the node
name is checked. If the node is available but not being polled for events, the box is unchecked.
Re-Poll is used to verify:
If the physical connection to a node is lost
If the SOE configuration file changes because of a download change
If any new nodes are configured in SOE Recorder
If any of these conditions change, Re-Poll should be used to verify the currently available and
retrieving nodes.
Re-polling the list of nodes may take several minutes.

CAUTION
Procedure
1 While retrieving events, on the SOE Recorder Commands menu, click Add/Remove
Nodes. The List of Polling Nodes displays the retrieving and available nodes based on
the last poll. (If the connection to a retrieving node is lost, it is not displayed.)
If the check box is checked, events are being retrieved from the node.
If the check box is unchecked, the node is available to retrieve events from.

Event Retrieval 41
2 If a Download Change has modified the application running on a controller, copy the
new SOE configuration file to the SoeConfig folder on the PC, then click Re-Poll.
3 If a new node has been configured in SOE Recorder or a lost connection has been
restored, click Re-Poll.
Depending on the size of the system this action may take several minutes. (If you check
or uncheck any of the nodes, the Re-Poll button is disabled.)
4 To add a node, check the box next to the node name. After the OK button is clicked, event
retrieval from this controller will start.
5 To remove a node, uncheck the box next to the node name. After the OK button is
clicked, event retrieval from this controller will stop.
Related Topics
Event Retrieval (page 33)
Ending Event Retrieval

This procedure explains how to end event retrieval.
If a trip snapshot is specified in the TriStation application, do not end

CAUTION event retrieval until the number of minutes specified as Time After Trip
has elapsed.
Procedure
1 Click End Event Retrieval on the Command menu, or click .

2 If you do not close the SOE Retrieve screen, you can restart the retrieval of events by
clicking Begin Event Retrieval on the Command menu or clicking
Related Topics
Viewing Information on the Message Bar

During event retrieval, you can show processing information on the Message Bar, which is at
the bottom of the screen. Typically, the Message Bar displays information affecting event
retrieval that you could not learn through any other means.
These are examples of message content:
Jan-17-2004 13:00:07 : TRINODE13 (Node# 13) clock out of sync (01/17/0412:52:41).
Jan-17-2004 13:12:17 : Create Max-Events file 'test1_20040117_131211_O.SED'.
Jan-17-2004 14:56:12 : TRINODE13 (Node# 13) connection is lost. Node will be closed.

Note If the connections to all controllers on the network are lost, a message is flashed in the
middle of the screen. The message is also displayed on the Message Bar.
Viewing Status Bar Information During Retrieval

The Status Bar at the bottom of the SOE Recorder window displays information when events
are being retrieved.
The Status Bar displays this information from left to right:

Event Retrieval 43
Number of events collected.

Current operation:
SendSending a request for event data to Triconex nodes.
RecvReceiving event data from Triconex nodes.
ModeIdentifies whether a periodic snapshot is specified to be taken. For more
information, see Specifying Snapshot Mode and Event File Location (page 27).
Auto Scroll modeon or off. For more information, see Specifying Display Options
(page 26).
Time setting on the PC.

Event Analysis
This section describes the commands that can help you analyze event data.
Topics include:
Viewing a Saved Event File (page 45)
Viewing Event Data Properties (page 46)
Finding Events (page 47)
Copying Events (page 47)
Filtering Event Data (page 48)
Sorting Event Data (page 50)
Saving a Snapshot (page 51)
Exporting Events (page 51)
Viewing Status Bar Information During Analysis (page 52)
Using the Report Generator (page 53)
Printing Custom Reports (page 55)

Event Analysis 45
Viewing a Saved Event File

This procedure explains how to view a saved events by displaying the file on the SOE Analysis
screen.
Procedure
1 On the SOE Recorder File menu, click Open or click .
2 On the Open screen, double-click the file to be viewed, or click the file and click Open.
See Related Topics for ways to view and analyze events.
Related Topic
Viewing Event Data Properties (page 46)
Finding Events (page 47)

Copying Events (page 47)

Filtering Event Data (page 48)
Sorting Event Data (page 50)
Saving a Snapshot (page 51)
Viewing Event Data Properties

This procedure explains how to view the properties for a selected event.
Procedure
1 On the SOE Recorder File menu, click Open to open a saved event file.
2 Double-click the event to display.
The Event Data screen displays these properties.
Date & Time The date and time the event was collected by the controller.
Node The node number and node name of the controller collecting the event.
Block The SOE block number which is specified in TriStation.
Group1 A user-defined category for the tagname.
Group2 A user-defined category for the tagname, which is subordinate to
Group1.
Alias The alias number of the event.
Tagname The tagname of the event.
Variable State The name of the state of the tagname.
Description A description of the tagname.
3 Click OK to close the screen and return to the SOE Analysis screen.

Event Analysis 47
Finding Events
This procedure explains how to use the Find Event command, which allows you to search a
saved event file for a single event that occurred at or after a time you specify.
Procedure
1 On the SOE Recorder File menu, click Open to open an existing file.
2 On the Tools menu, click Find Event.
3 Enter the date or date and time. You do not need to enter the slashes or colonsSOE
Recorder enters them automatically.
4 Click Find.
Copying Events
This procedure explains how to use the Copy Events command, which allows you to copy
selected event data and paste it to another Windows application. You can only copy one screen
of data at a time.
Procedure
2 Select the event or events to be copied.
3 On the Tools menu, click Copy Event.
4 Paste the data into another Windows application.

Filtering Event Data

This procedure explains how to set up filters to limit the event data that are displayed. If the
setting for a property is blank, all values for that property are displayed. After customizing, you
can save the display settings by using the Save Snapshot command.
Wildcard Characters
Wildcard characters can help you filter events based on properties such as the name of the
variable state.
Use an asterisk (*) for any text string.
Use a question mark (?) for any single character.
Procedure
2 On the Tools menu, click Filter and Sort Events, and then click the Filters tab.
3 Specify these properties on the Filters tab.
Date & Time Enter the date and time in this format:
mm/dd/yyyyhh:mm:ss
You do not need to enter slashes or colons; SOE Recorder automatically
enters them.
Group1 and Enter the point properties that are assigned to event variables in TriStation.
Group2

Event Analysis 49
Node & Block Enter the node and block as integers separated by commas, dashes, or a
combination of both. Do not enter the alphanumeric names that may have
been assigned to controller nodes and SOE blocks in TriStation.
Alias Enter a single alias or a range of aliases (two aliases separated by a dash).
Use commas, dashes, or a combination of both.
Tagname Enter the value of a Tagname (event variable).
Variable State Enter the name associated with state, which can be specified in TriStation.
The default is True or False.
4 Click OK.

Sorting Event Data

This procedure explains how to specify sort criteria. You can specify the sort order of event data
as either of these:
In ascending or descending order according to the ASCII character set.
In a customized order based on the column headings.
Procedure
2 On the Tools menu, click Filter and Sort Events, and then click the Sort tab.
3 Specify these properties on the Sort tab.
Order Click Ascending to arrange events from the smallest to largest (1, 2, 3)
or from first to last (a, b, c). This is the default.
Click Descending to reverse the normal sort order from the largest to
the smallest (3, 2, 1) or from last to the first (c, b, a).
Sort By Click the second column on which events are to be sorted.
Then By Click third column on which events are to be sorted.
Clear All Command Click to clear current options.
4 Click OK.

Event Analysis 51
Saving a Snapshot
This procedure explains how to save a snapshot. The Save Snapshot command allows you to
save a copy of an event file or to save a filtered or sorted version of an event file.
Procedure
1 On the SOE Recorder File menu, click Open to open a saved event file.
2 If desired, select a subset of the event data by using the Filter and Sort command from
the Tools menu or by clicking the events to be saved.
3 On the Tools menu, click Save Snapshot, specify a file name, and then click Save.
Exporting Events
This procedure explains how to manually export events from a saved event file to a journal file
that has one of these formats.
Database or File Format File Name Extension

Any dBASE IV application dbf
Comma-delimited ASCII text records txt
A DBF file can be opened by dBASE IV applications, such as Microsoft Excel, or imported into
dBASE IV applications, such as Microsoft Access. A DBF file may be much larger than the saved
event file.
You can also export event data to various data formats through the Crystal Reports feature. For
more information, see Using the Report Generator (page 53).
Procedure
1 On the SOE Recorder File menu, click the Open command, and then click an event file
to open.
2 On the Tools menu, click the Export Events command.

3 On the Export Events screen, enter a file name for the journal file.
4 Click one of these file types from the list:

dBASE IV (*.dbf)
ASCII Delimited Text (*.txt)
If you do not specify an extension, SOE Recorder uses DBF as the default.
5 Click Export, and wait while SOE Recorder writes the event data.
Viewing Status Bar Information During Analysis

The Status Bar at the bottom of the SOE Recorder window displays information when a saved
event file is being analyzed.
The Status Bar displays this information from left to right:

Reminder to press F1 for Help documentation.
Current operation: StopNo communication with any Triconex controller.
FILTER ON/OFF Shows whether a filter option is on or off.
SORT ON/OFF Shows whether a sort option is on or off.
PC time.

Event Analysis 53
Using the Report Generator

This procedure explains how to use the report generator from Crystal Reports to print, search,
or export a report. This reporting tool allows you to print a standard Sequence of Events List
report or any custom reports created with dBASE-compatible report tools.
Procedures include:
Printing Procedure (page 53)
Export Procedure (page 54)
Search Procedure (page 54)
Printing Procedure
1 On the SOE Recorder File menu, click Open, and then click an event file.
2 On the File menu, click Print, or click . The event data is displayed as a standard
Sequence of Events List report.
3 If you have created custom reports, they can be selected at the bottom of the screen. The
selection list displays the report title, not the report file name, which means that report
titles should be unique.
4 To print, click on the Report Toolbar. A Print screen allows you to specify the pages
and numbers of copies to print.

Export Procedure
1 On the SOE Recorder File menu, click Open, and then click an event file.
2 On the File menu, click Print, or click . The report is displayed.
3 To export, click on the Report Toolbar. A screen allows you to specify the file format
and destination.
File formats include: Acrobat Format (PDF), Character-separated values, Comma-

separated values (CSV), Excel 5.0-8.0 (XLS), Excel 5.0-8.0 (XLS) (Extended), Paginated
text, Rich text (Exact) format, Tab-separated text, Tab-separated values, Text, and XML.
Destination includes: Disk file and Microsoft Mail.
Search Procedure
1 To search for text in the report, click on the Report Toolbar. A search screen allows
you to enter text to search for.

Event Analysis 55
Printing Custom Reports

This procedure explains how to print a custom report, which requires a DBF file exported from
SOE Recorder and one of these:
Crystal Reports Version 5.0 or later from Seagate.
Any other dBASE-compatible report generator.
For more information about report generators, see the users guide for the report-generating
package of your choice.
Note Triconex strongly recommends using Crystal Reports because it is integrated with SOE
Recorder.
Procedure
1 In SOE Recorder, export an event file to a dBASE file named ~SOERPT.DBF.
2 In the report-generating package, open ~SOERPT.DBF and create a custom report
format.
3 Save the custom report format in a file with a name of your choice and the extension .rpt.
4 Before starting SOE Recorder, place the report file in the SoeReports directory to make
the new report name appear automatically in the Print Reports screen.
5 If SOE Recorder is already running, exit the application before placing the report file in
SoeReports. SOE Recorder recognizes the new report file when you restart it.
6 In SOE Recorder, click the Print command to access the Print Reports screen.
7 Verify that the report file name appears in the Print Reports screen.
8 If desired, click the report name, and then click Print or Preview.
Related Topics
Exporting Events (page 51)

Troubleshooting
This section describes some unexpected events that may occur during event retrieval.
Topics include:
Errors During Export (page 56)
Lack of Response (page 56)
Download Change of TriStation Application (page 56)
Download All of TriStation (page 57)
Unrecoverable Errors (page 57)
Errors During Export

If errors occur during the automatic export of event data, SOE Recorder places a status file called
JOURNAL_STATUS.TXT in the same directory as the journal file.
This table lists the error codes in the status file.
Error Code Description

AUTOEXPT_0001 Not enough disk space. SOE Recorder cannot export any more events.
AUTOEXPT_0002 SOE cannot get exclusive access to the journal file.
AUTOEXPT_0003 The journal file is invalid. SOE must create a new one.
Lack of Response
Lack of response to SOE Recorders request for data is often recoverable. SOE Recorder
periodically checks each active connection to a node for time-outs. If more than 5 seconds elapse
after SOE Recorder sends a request to a controller on the network, the request is considered lost
and SOE Recorder re-sends the same request. In this case, SOE Recorder is operating normally
and does not notify you of the circumstances.
Download Change of TriStation Application

If a modified TriStation application is downloaded with a Download Change command, events
continue to be retrieved by SOE Recorder, but they may not be the same variables specified in
the previous SOE configuration file. To ensure the correct events are being retrieved, the new
SOE configuration file should be copied to the SoeConfig folder and the Re-Poll command used
to continue retrieving events based on the modified file. For instructions, see Adding or
Removing Controllers to be Polled (page 40).

Troubleshooting 57
Download All of TriStation

If a modified TriStation application is downloaded with a Download All command, event
retrieval is stopped while the application is halted. SOE Recorder continues to retrieve events
from all other controllers. After copying the SOE configuration file to the SoeConfig folder on
the PC, the Re-Poll command should be used to re-start event retrieval. For instructions, see
Adding or Removing Controllers to be Polled (page 40).
Unrecoverable Errors
In the case of an unrecoverable error, such as a disconnected cable, SOE Recorder closes the
connection. If there is no response, SOE Recorder stops sending requests to this controller and
displays a notification in the Message Bar.


A
Commands and Properties
About SOE Command

The About SOE command displays the current version number of SOE Recorder and registered
owner information.
Applies To
SOE Recorder
Location
Help menu
Add/Remove Nodes Command

The Add/Remove Nodes command allows you to add or remove Triconex controllers (nodes)
to be polled during event retrieval. This command is only available during event retrieval.
Applies To
Controllers
Location
Command menu
Alias
The Alias property identifies the alias number of the tagname. On the Filters tab, the Alias
property can be specified to the display of events based on the alias number.
Applies To
Events

60 Appendix A Commands and Properties
Location
Tools menu > Filter and Sort > Filters tab
Auto Export to a Journal File

The Auto Export to a Journal File property automatically exports event data to a dBASE IV or
ASCII journal file.
Applies To
Events
Location
Tools menu > Options command > Auto Report tab
Related Topics
Specify the Absolute Path for a Journal File (page 82)
Auto Scroll
The Auto Scroll property allows event data to scroll continuously as it is viewed during live
event retrieval. This property can be set before and during event retrieval.
Applies To
Event retrieval
Location
Tools menu > Options command > Display tab
Auto Snapshot
The Auto Snapshot properties specify a snapshot based on a trip event or a maximum number
of events.
Applies To
Events
Location
Tools menu > Options command > Mode tab

Related Topics
Maximum Events Per File (page 70)
On Max Events (page 73)
On Trip Events (page 73)
Begin Event Retrieval Command

The Begin Event Retrieval command starts the retrieval of event data from the selected
controllers for the current file.
Applies To
Events
Location
Begin Event Retrieval button or Command menu
Related Topics
End Event Retrieval Command (page 64)
Filter and Sort Events Command (page 66)
Block Type
See SOE Block Type (page 80).
Cascade Command
The Cascade command opens all windows and displays the title bar for each. To bring a
window to the top, select it from the list on the menu or click on the windows title bar.
Applies To
Display
Location
Window menu
Clear Command
The Clear command deletes the text in the message bar.
Applies To
Message display

Location
Right-click Message bar
Clear All Command

The Clear All command deletes the user-specified settings on the Filters and Sorts screens.
Applies To
Selecting events
Location
Tools menu > Filter and Sort Events > Filters and Sort tab
Close Command
The Close command closes an open event file.
Applies To
Events display
Location
File menu
Close All Command

The Close All command closes all open windows. You are prompted to save any elements that
have been changed since they were opened.
Applies To
SOE Recorder
Location
Window menu
Column
The Column property specifies the columns of event information to be displayed in an event
file. The property can be changed before, during, or after event retrieval.

Applies To
Event display
Location
Related Topics
Auto Scroll (page 60)
Copy Events Command

The Copy Events command allows you to copy selected event data and paste it into another
Windows application, such as a word processing document or spreadsheet.
Applies To
Events
Location
Tools menu
Related Topics
Find Event Command (page 67)
Date & Time

The Date & Time property limits the events displayed based on date and time settings.
Applies To
Event display
Location
Tools menu > Filter and Sort Events > Filters tab
Related Topics
Group1 and Group2 (page 68)
Node & Block (page 72)
Variable State (page 87)

End Event Retrieval Command

The End Event Retrieval command stops the retrieval of event data from the selected controllers
for the current file.
Applies To
Event retrieval
Location
End Event Retrieval button or Command menu
Related Topics
Begin Event Retrieval Command (page 61)
Event File Folder

The Event File Folder property specifies the folder where SOE Recorder stores event files.
Applies To
Events file location
Location
Related Topics
Options Command (page 74)
Exit Command
The Exit command closes the current event file and exits SOE Recorder.
Applies To
SOE Recorder software
Location
File menu

Export Events Command

The Export Events command allows you to export a saved event file to a dBASE IV or ASCII text
file.
Applies To
Events
Location
Tools menu
External Block Type

The External Block Type setting is typically used when an external device, such as a Foxboro or
Honeywell DCS or PC running SOE Recorder, is retrieving events from the controller on a
continual basis. When events are collected by the external device, event data is cleared from the
block. When the buffer is full, new event entries are discarded.
Blocks 1 through 14 can be set as External.
Process
1 The Main Processors write an event to the block and notify the external device.
2 The external device requests the data from the Main Processors and acknowledges the
receipt of the data.
block.
Applies To
SOE setup in TriStation 1131
Location
TriStation 1131 > Application tree > Implementation > SOE Configuration tree > Blocks
Related Topics
First Out Block Type (page 67)
Historical Block Type (page 69)
Modified External Block Type (page 70)

False Color
The False Color property determines the color used to display the false state of an event
variable. The possible colors include: black, red, green, blue, aqua, yellow, mauve, and white.
The default color is green.
Applies To
Event display
Location
TriStation 1131 > Tagname Declarations > Properties screen > Display Options tab
Related Topics
False State Name (page 66)
True Color (page 86)
True State Name (page 86)
False State Name

The False State Name property specifies a name for the display of an event variables that has a
false state. The default name is FALSE.
Applies To
Event display
Location
Related Topics
False Color (page 66)
Filter and Sort Events Command

The Filter and Sort Events command can be used to limit and sort the events that are displayed
in a saved event file.
Applies To
Event display

Location
Tools menu
Related Topics
Date & Time (page 63)
Tagname
Find Command
The Find command finds text in the message bar.
Applies To
Find message text
Location
Right-click the Message Bar
Find Event Command

The Find Event command allows you to find an event that occurred at or after a specific time.
You must enter the time in the format: mm/dd/yyyy
You can also use a more detailed format: mm/dd/yyyy.hh:mm:ss
Applies To
Event display
Location
Find Event button or Tools menu
First Out Block Type

The First Out Block Type setting is typically used to retrieve the first and subsequent events that
led to a trip.
Blocks 1 through 14 can be set as First Out.

Process
2 When the buffer is full, the Main Processors change the blocks status from collecting to
stopped. New events are discarded.
Applies To
Location
Related Topics
External Block Type (page 65)
Group1 and Group2

The Group1 and Group2 properties are user-defined categories that can be applied to tagnames.
These properties can be used to limit the display of events based on the settings.
Applies To
Tagname property
Location
Tools menu > Filter and Sort Events command > Filters tab
Related Topics
Tagname (page 82)
Help Topics Command

The Help Topics command opens the Help screen, which allows you to locate information by
displaying a listing of the contents or the index. You can also search for topics by using the Find
tab.
Applies To
SOE Recorder

Location
Help menu
Hide Message Bar Command

The Hide Message Bar command closes the Message Bar, which is an area at the bottom of the
screen which displays information during event retrieval.
Applies To
SOE Recorder
Location
Right-click Message Bar or Tools menu
Related Topics
Show Message Bar Command (page 78)
Historical Block Type

The Historical Block Type setting is typically used to monitor current events in SOE Recorder
application. An external device can collect events at any time, however, the collection does not
clear the block. If the TriStation application does not clear and restart recording, the oldest event
entries are overwritten when the buffer is full.
Blocks 1 through 14 can be set as External.
Process
2 When the buffer is full, the Main Processors overwrite the oldest event entries.
Applies To
Location
Related Topics

Journal File Format

The Journal File Format property specifies the format for the automatic export of event data to
a dBASEIV or ASCII delimited text file.
Applies To
Event data
Location
Tools menu > Options command > Auto Export tab
Related Topics
Maximum Events Per File

The Maximum Events Per File property identifies the maximum number of events that are
saved to a single file when an Auto Snapshot is generated. This property must be set before
events are retrieved.
Applies To
Events
Location
Related Topics
Auto Snapshot (page 60)
Periodic Snapshot (page 75)
Modified External Block Type

The Modified External Block Type setting is used for event retrieval with the Safety Manager
Module (SMM). The SMM is the Triconex communication interface with the Honeywell
Universal Control Network (UCN), which is one of the principal networks of the Honeywell
TCD 3000 Distributed Control System.
Only blocks 15 and 16 can be specified as Modified External.

Process
1 The Main Processors write an event to the blocks and notify the SMM.
2 The SMM requests the data from the Main Processors and acknowledges the receipt of
the data.
3 The SMM forwards the data through the UCN to the TDC 3000 DCS.
block.
For more information, see the SMM Users Guide.
Applies To
SOE setup in TriStation
Location
Related Topics
Move Command
The Move command allows you to change the order in which columns are displayed in an event
file by moving the column up or down in the order.
Applies To
Event display
Location
Related Topics
New Command
The New command allows you to create a new events file for retrieving events from the
controller. If you use the name of an existing file, the data in the file is overwritten.

Applies To
Events
Location
New File button or File menu
Node & Block

The Node & Block property allows saved events to be filter based on the node and block type.
Applies To
Event display
Location
Related Topics
Tagname (page 82)
Node Name
The Node Name property is a user-defined name for a controller.
Applies To
Controllers
Location
Tools menu > Options command > Communications tab > IP Address
Related Topics
Node Number (page 73)
IP Address (page 82)

Node Number
The Node Number property specifies the number of a controller.
Applies To
Controllers
Location
Tools menu > Options command > Communications tab > IP Address
Related Topics
Node Name (page 72)
IP Address (page 82)
On Max Events
The On Max Events property automatically saves a trip snapshot when a specified number of
events occurs. A trip snapshot is a file of events that occurred x minutes before a trip and y
minutes after a trip.
Applies To
Events
Location
Related Topics
On Trip Events
The On Trip Events property automatically saves a snapshot when a trip occurs. A trip snapshot
is a file of events that occurred x minutes before a trip and y minutes after a trip.
Applies To
Events

Location
Related Topics
Open Command
The Open command opens a previously saved event file for analysis.
Applies To
Saved events file
Location
Open button or File menu
Options Command
The Options command displays the Options screen, which is primarily used to set up event
retrieval. During event retrieval, only the Display and Auto Export tabs can be used.
The Options screen includes these tabs.
Tab Description
Display Changes a the column display for event files and turn Auto-Scroll on or off.
Mode Sets options for periodic snapshots and auto snapshots.
Communications Adds, modifies, or deletes IP addresses for Triconex nodes.
Auto Export Identifies whether to have SOE automatically export events to a journal file
every 30 seconds.
Applies To
Setup and event retrieval
Location
Tools menu > Options command

Order
The Order property determines the display of event data in ascending or descending order.
Only available with saved events.
Applies To
Event display
Location
Tools menu > Filter and Sort Events command > Sort tab
Related Topics
Sort By (page 81)
Then By (page 83)
Periodic Snapshot
The Periodic Snapshot property determines whether a file of events is taken during a specific
time period.
Option Description
None Does not take a periodic snapshot.
Shift Snapshot Takes a snapshot based on weekday and weekend shift periods that you define.
Daily Snapshot Starts at 12:00 midnight. Ends at 11:59 the next day.
Weekly Snapshot Starts at 12:00 midnight on Sunday. Ends at 11:59 the following Saturday.
Starts at 12:00 midnight the first day of the month. Ends at 11:59 the last day of
Monthly Snapshot
the month.
Applies To
Events
Location
Related Topics
Shift Definitions (page 78)

Print Command
The Print command prints the events being displayed from a saved events file and the text in
the message bar. Cannot be used to print during event retrieval.
Applies To
Printing saved events and messages
Location
Print button or right-click Message bar
Print Setup Command

The Print Setup command allows you to select a printer and modify its settings.
Applies To
Printing
Location
File menu
Refresh Nodes
The Refresh Nodes command polls the network and displays refreshed information about the
controllers identified on the Communications tab. This command is only available after a new
events file is created, but before you begin to retrieve events.
Applies To
Controllers
Location
Refresh Nodes button or Commands menu
Re-Poll
The Re-Poll command polls the network to identify the controllers (nodes) that are available to
retrieve events from. This command is only available during event retrieval.
Applies To
Communication

Location
Command menu > Add/Remove Nodes screen > Re-Poll button
Related Topics
Adding or Removing Controllers to be Polled (page 40)
Save Command
The Save command saves all events that are currently stored in a temporary buffer to the event
file.
Applies To
Events
Location
Save button or File menu
Save As Command
The Save As command saves the saved event file or message to another file name that you
specify. Cannot be used during event retrieval.
Applies To
Events file
Location
File menu or right-click Message Bar
Save Snapshot Command

The Save Snapshot command allows you to save a copy of all event data collected up until the
command is issued. The Save Snapshot command can also be used to save a snapshot selection
from a saved event file.
Applies To
Events
Location
Tools menu

Related Topics
Select Journal File

The Select Journal File property specifies the journal file format as dBASE IV or ASCII Delimited
Text.
Applies To
Events
Location
Tools menu > Options command > Auto Export tab
Shift Definitions
The Shift Definitions property specifies the time periods for shift snapshots. You can specify up
to three weekday shifts and three weekend shifts.
Applies To
SOE setup
Location
Related Topics
Show Message Bar Command

The Show Message Bar command shows the Message Bar, which is an area at the bottom of the
screen which displays information during event retrieval.
Applies To
SOE Recorder
Location
Window menu

Related Topics
Hide Message Bar Command (page 69)
SOE Block Number

The SOE Block Number identifies a data structure that resides in the memory of a controllers
Main Processors. The block header contains the block type, the buffer size, and a list of the event
variables assigned to the block. The buffer stores the event entries, each containing a time stamp
and one or more data entries.
Applies To
Location
TriStation 1131 > Application tree > Implementation > SOE Configuration
Related Topics
SOE Block Assignments (page 79)
SOE Block Name (page 79)
SOE Block Type (page 80)
SOE Buffer Size (page 80)
SOE Block Assignments

The SOE Block Assignments property links an event variable to an SOE block.
Applies To
Location
TriStation 1131 > Application tree > Implementation > SOE Configuration
Related Topics
SOE Block Number (page 79)
SOE Block Name

The SOE Block Name property identifies a name for an SOE block.

Applies To
Location
TriStation 1131 > Application tree > Implementation > Blocks
Related Topics
SOE Block Type

Block Type property identifies the way the events are stored. For details, see Related Topics.
Blocks 1 through 14 may be specified with any combination of History, First Out, and External
block types. Blocks 15 and 16 can only be specified with Modified External type and are reserved
for use with SMM.
Applies To
Location
Related Topics
SOE Buffer Size

The SOE Block Size property, expressed in multiples of 16 bytes, is the amount of memory that
the MPs reserve for recording event entries. An event entry consists of an 8-byte time stamp and
one or more 8-byte data entries. Each data entry contains the alias and state for the tagname.
This figure shows how the MPs store data in an SOE block.

Scan Number Block

Number of Events Contents
1 1 time stamp
_ data entry
2 2 time stamp
_ data entry
_ data entry
3 1 time stamp
_ data entry
The maximum block size is 20,000 events (320,000 bytes). A maximum size of 60,000 events
(1 megabyte) is allowed across all blocks.
Applies To
Location
TriStation 1131 > Application tree > Implementation > SOE Configuration > Blocks
Related Topics
Sort By
The Sort By property determines the display order of columns of event data.
Applies To
Event display
Location
Related Topics
Order (page 75)
Then By (page 83)

Specify the Absolute Path for a Journal File

The Specify the Absolute Path for a Journal File property determines the file name and location
of a journal file. To ensure that any dBASE IV application can open this file, you should limit the
file name to eight characters.
Applies To
Event file
Location
Tools menu > Options command > Auto Report tab
Related Topics
Auto Export to a Journal File (page 60)
Tagname
The Tagname property limits the display of events based on the tagname setting.
Applies To
Events
Location
Tools menu > Filter and Sort > Filters tab
Related Topics
IP Address
The IP Address property specifies the IP address of a Triconex controller from which you want
to retrieve events.
Applies To
Event setup
Location
Tools menu > Options command > Communications tab

Related Topics
Node Name (page 72)
Node Number (page 73)
Then By
The Then By property determines the second and third sort order for displaying columns of
event data. The first sort order is based on the Sort By property.
Applies To
Events sorting
Location
Related Topics
Sort By (page 81)
Then By (page 83)
Tile Horizontally Command

The Tile Horizontally command displays all the opened windows stacked horizontally as
shown by this figure.
Applies To
Event display

Location
Window menu
Tile Vertically Command

The Tile Vertically command displays all the opened windows stacked vertically as shown by
this figure.
Applies To
Event display
Location
Window menu
Time After Trip

The Time After Trip property specifies the number of minutes after the trip to continue
collecting events for the trip snapshot.
The minimum is 2 minutes; the maximum is 10 minutes. The default is 2 minutes.
Applies To
Location
TriStation 1131 > Application > Implementation > double-click SOE Configuration
Related Topics
Time Before Trip (page 85)
Trip State (page 85)
Trip Tagname (page 85)

Time Before Trip

The Time Before Trip property specifies the number of minutes before the trip to begin
collecting events for the trip snapshot.
The minimum is 2 minutes; the maximum is 10 minutes. The default is 2 minutes.
Applies To
Location
Related Topics
Time After Trip (page 84)
Trip State
The Trip State property specifies the value True or False) on which to begin collecting events.
Applies To
Location
Related Topics
Trip Tagname
The Trip Tagname property specifies the tagname (variable) that designates whether a trip has
occurred.
Applies To

Location
TriStation 1131 > Application > Implementation > SOE Configuration
Related Topics
True Color
The True Color property determines the color used to display the true state of an event variable.
The possible colors include: black, red, green, blue, aqua, yellow, mauve, and white. The default
color is red.
Applies To
Event display
Location
Related Topics
True State Name

The True State Name property specifies a name for the display of an event variables that has a
true state. The default is TRUE.
Applies To
Event display
Location
Related Topics

Variable State
The Variable State property limits the display of events based on the variable state setting. The
default settings are TRUE and FALSE.
Applies To
Event display
Location
Related Topics


Glossary
application
In TriStation, an application is the compiled code (built from program elements and
configuration information) that is downloaded to and runs in a Triconex controller.
application type
In TriStation, the application type specifies whether a program, function, or data type can be
used in a safety or control application.
auto export
An SOE Recorder option that automatically exports events to a journal file every 30 seconds.
auto scroll mode

An SOE Recorder option that allows continuous scrolling of event data during live event
retrieval.
auto snapshot
A snapshot of events that SOE Recorder saves automatically either when a trip event occurs or
when the maximum of events per file is reached.
block
A data structure that resides in Main Processor memory.
daily snapshot
A type of periodic snapshot that starts at 12:00 midnight and ends at 11:59 the next day.
event detection
An action taken by the Triconex controller of storing event data in a buffer for later retrieval by
the SOE Recorder PC.
event file
A file that stores events that SOE Recorder retrieves from one or more controllers.
event logger
A utility that logs, displays, and prints critical events in real time, based on state changes of
discrete variables in the user-written application. Proper use of an event logger warns about
dangerous conditions and helps identify the sequence of events that led to a trip.
event retrieval
Events are retrieved by SOE Recorder by reading the event data detected by one or more
controllers and storing it in a file.

90 Glossary
event variable
A BOOL variable defined in a TriStation application whose state changes are detected by a Main
Processor and retrieved by SOE Recorder.
exporting events
An SOE Recorder feature that exports events to a journal file either manually for a previously
saved event file, or automatically while event retrieval is taking place.
external block
A type of SOE block that is typically used by an external host, such as a DCS.
first out block

A type of SOE block used to analyze events that led to a process upset. The Main Processors
change the blocks status from collecting to stopped and discard new event entries.
history block
A type of SOE block that is typically used for monitoring current events. The Main Processors
overwrite the oldest event entries in the block.
IP address
The unique address of a computer attached to an Ethernet network. Every client and server in
an Ethernet network requires an IP address which is either permanently assigned or
dynamically assigned at startup.
journal file
A file having the dBASE IV (.dbf) or ASCII text (.txt) format which contains events exported by
SOE Recorder.
MAC address
Stands for media access control address, which is the unique physical address of a network
device that is burned into the Network Interface Card (NIC) of the device when it is
manufactured.
manual export
A feature that allows manual export of events from a previously saved event file to a journal file.
manually saved snapshot

An intermediate snapshot of event data saved by the user during event retrieval.
modified external blocks

Blocks 15 and 16 which are used only with the Safety Manager Module (SMM).
module
An active field-replaceable unit consisting of an electronic circuit assembly housed in a metal
spine. Also called board or card.
monthly snapshot
A type of periodic snapshot that starts at 12:00 midnight the first day of the month, and ends at
11:59 the first day of the next month.

Glossary 91
node
In computer communication, a node is a network junction or connection point. For example, a
Triconex controller in an Ethernet network is a node. A terminal connected to a PC or
mainframe is also a node.
periodic snapshot
A type of snapshot that SOE automatically saves at the end of a daily, weekly, or monthly time
period.
point
A variable in a TriStation application that represents an input, output, or memory location. See
also tagname.
RARP
Stands for Reverse Address Resolution Protocol, which is an IP protocol used by a diskless
workstation to obtain its IP address.
sequence of events data file

A file that stores events that SOE Recorder retrieves from one or more controllers.
Sequence of Events List

A standard report that SOE Recorder can print for any event file.
shift snapshot
A snapshot of events that occur during a time shift of a plants operation, based on user-
specified time periods. Three weekday shifts and three weekend shifts can be specified.
snapshot
A file of event data saved by SOE Recorder according to options set by the user. There are
several types of snapshots: auto snapshots, periodic snapshots, shift snapshots, manually saved
snapshots, and trip event snapshots.
SOE definition file

A file with the extension .SOE, created by TriStation when an SOE-enabled application is
downloaded to a controller. The SOE definition file contains SOE block definitions and point
properties for the block event variables.
SOE function blocks

Function blocks used in a TriStation application to control and verify event collection for SOE
blocks. The function blocks include: start (SOESTRT), stop (SOESTOP), clear (SOECLR), and
status (SOESTAT).
SOECLR function
An SOE function block that clears the buffer of the designated SOE block, removes all entries
from the block, and writes an SOECLR time stamp into the buffer.
SOESTAT function
An SOE function block that returns the status of the designated block, the number of eight-byte
entries that are used, and the number of eight-byte entries that are unused.

92 Glossary
SOESTOP function
An SOE function block that stops event collection for the designated block, writes an SOESTOP
time stamp into the buffer, and changes the state of the block from collecting to stopped.
SOESTRT function
An SOE function block that starts event collection for the designated SOE block.
tagname
A name that identifies a global variable that is used to access input, output, and memory points
in a controller.
time synchronization
A Triconex protocol used to establish and maintain a synchronized, network-wide time basis.
Time can be synchronized with the master node in a network of Tricon or Trident controllers,
with a Distributed Control System (DCS), or with an OPC client/server application.
trip
A safety-related shutdown of a controlled process, or a portion of a controlled process.
trip snapshot
A snapshot saved automatically by SOE Recorder when the trip variable in a TriStation
application changes state. A trip snapshot contains events that occurred x minutes before the
trip and y minutes after the trip.
trip variable
An aliased tagname of type BOOL whose state transition causes SOE Recorder to automatically
create a trip snapshot.
weekly snapshot
A type of periodic snapshot that starts at 12:00 midnight on Sunday and ends at 11:59 the
following Sunday.

Index
Symbols Copy Events command, 47, 63

~SOERPT.DBF file, 55 creating an event file, procedure, 35
customer support, vi
A
ACM, using with DCS utility, 7 D
Add/Remove Nodes command, 40, 59 Daily Snapshot, standard time period, 75
Advanced Communication Module. See ACM. Date & Time property, 63
Alias property, 59 dBASE IV file format, 51
application type, definition, 89 dBASE-compatible report generator, 55
ASCII text format for journal file, 51 DCS utility for SOE, communication modules, 7
Auto Export to a Journal File property, 60 disconnected cable, 57
Auto Scroll property, 60 display options, of event variables, 26
Auto Snapshot properties, 60 Download All, trouble-shooting, 57
automatic export of events Download Change, trouble-shooting, 56
errors during export, 56
procedure, 31 E
End Event Retrieval command, 64
B event analysis, procedures, 44
Begin Event Retrieval, procedure, 37 Event Data screen, 46
Begin Event Retrieval command, 61 event export, automatic, 31
block header of SOE block, 8 event file, creating, 35
blocks. See SOE blocks. Event File Directory, specifying location, 27
buffer for event storage, 8 Event File Folder property, 64
buffer-full condition of block, 67 event retrieval
communication errors, 56
C procedure, 37
Cascade command, 61 setup overview, 25
Clear All command, 62 event variables, assigning to SOE blocks, 11
Clear command, 61 events
copying, 47
clear function block, 19
filtering, 48
Close All command, 62 finding, 47
Close command, 62 sorting, 50
Column property, 62 Exit command, 64
communication modules, compatibility, 7 Export Events command, 51, 65
configuring SOE blocks, 8 exporting events
controllers automatic, 31
polled, 36 manual, 51
specifying IP address, 29, 30

94 Index
External Block Type, 65 Modified External Block Type, 70

process, 8 process, 9
monitor display, with tagnames, 14
F Monthly Snapshot, standard time period, 75
False Color property, 66 Move command, 71
False State Name property, 66
files, naming conventions, 34 N
Filter and Sort Events command, 66 naming conventions, description, 34
Find command, 67 NCM, using with SOE Recorder, 7
Find Event command, 67 Network Communication Module. See NCM.
procedure, 47 New command, 71
finding events, 47 Node & Block property, 72
First Out Block Type setting, 67 Node Name property, 72
process, 9
Node Number property, 73
function blocks for event collection, 1620
nodes (controllers), adding and removing, 40
G O
group1 and group2, 68
On Max Events, setting, 27
On Max Events property, 73
H
On Trip Event, setting, 27
Help Topics Command, 68
On Trip Events property, 73
Hide Message Bar command, 69
Open command, 74
Historical Block Type, 69
process, 9 Options command, 74
Order property, 75
I
IP Address property, 82 P
IP addresses Periodic Snapshot property, 75
specifying for controllers, 30 point properties
specifying in SOE Recorder, 29 in SOE definition file, 25
sorting, 50
J Print command, 76
Journal File Format property, 70 Print Setup command, 76
journal files of saved events, 51 printing, reports, 53
M R
Main Processors Refresh Nodes command, 76
compatibility, 7 registered owner information, 59
memory reserved for events, 80 Re-Poll, command description, 76
writing events to buffer, 8
re-polling, uses, 40
writing SOE time-stamps, 17
report generator, features, 53
master node in Triconex network, 15
reports, printing, 53
Maximum Events per File, setting, 27
Maximum Events Per File property, 70
S
maximum SOE buffer size, 80
Safety Manager Module. See SMM.
Message Bar, description, 41
sample TriStation project, 6

Index 95
Save As command, 77 Sort By property, 81

Save command, 77 Specify the Absolute Path for a Journal File property, 82
Save Snapshot command, 77 start function block, 17
creating snapshot from saved event file, 51 Status Bar, description, 42, 52
procedure, 39
status function block, 20
Select Journal File property, 78
stop function block, 18
Sequence of Events List report, 53
sequence-of-events functionality, overview, 2 T
Shift Definitions property, 78 tagname properties, filtered and sorted in display, 66
Shift Snapshot, standard time period, 75 Tagname property, 82
Show Message Bar command, 78 tagnames, monitor color, 14
size of SOE buffer, 80 tagnames in Tristation, 11
SMM, using with DCS utility, 7 technical support, vi
snapshots, auto and periodic, 27 text file, exported events, 31
SOE Then By property, 83
assigning event variables, 11
Tile Horizontally command, 83
trip variable, 12
SOE Block Assignments property, 79 Tile Vertically command, 84
SOE Block Name property, 79 Time After Trip property, 84
SOE Block Number, description, 79 Time Before Trip property, 85
SOE Block Type property, 80 time stamp

different for same event, 15
SOE blocks in SOE block, 80
block header, 8 written to buffer by SOESTOP function block, 18
defining block properties, 10
time synchronization, time stamps, 15
maximum buffer size, 80
overview, 8 time-outs on active nodes, 56
types, 8 training, vi
SOE Buffer Size property, 80 Triconex contact information, vi
SOE definition file, copying to SoeConfig folder, 25 trip event, 12
SOE function blocks trip snapshot, 12
adding to TriStation project, 16 Trip State property, 85
detailed descriptions, 1620
Trip Tagname property, 85
SOECLR, 19
SOESTAT, 20 trip variable, assigning, 12
SOESTOP, 18 TriStation application, list of SOE-related tasks, 4
SOESTRT, 17 TriStation project
SOE functionality, diagrams, 2 examples of SOE features, 6
SOE Recorder version number, 25
installing, 23 True Color property, 86
overview, 2 True State Name property, 86
SOE Recorder PC, comparing to controllers clock, 15
SOE time stamps, 15 U
SOECLR function block, 19 unrecoverable errors, 57
SoeData directory, 31
SOESTAT function block, 20 V
SOESTOP function block, 18 Variable State property, 87
SOESTRT function block, 17

96 Index
version number
of SOE Recorder, 59
of TriStation project, 25
viewing polled controllers, procedure, 36
W
Weekly Snapshot, standard time period, 75

SOE Recorder Users Guide, V4.0 - Trident Controller

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SOE Recorder Users Guide, V4.0 - Trident Controller

Uploaded by

Copyright:

Available Formats

Triconex SOE Recorder, Version 4.

2004 Invensys Systems, Inc. All Rights Reserved.

Document No. 9720081-003

Chapter 1 Triconex SOE Functionality 1

Chapter 2 TriStation and Controller Tasks 5

Chapter 3 SOE Recorder Tasks 21

Specifying Snapshot Mode and Event File Location . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Appendix A Commands and Properties 59

SOE Recorder Users Guide, v4.0

SOE Recorder Users Guide, v4.0

Product and Training Information

SOE Recorder Users Guide, v4.0

SOE Recorder Users Guide, v4.0

Networked Triconex Controllers

Trident Node 01 Trident Node nn

SOE Recorder Users Guide, v4.0

SOE Recorder Users Guide, v4.0

SOE Recorder Tasks

SOE Recorder Users Guide, v4.0

SOE Recorder Users Guide, v4.0

SOE Recorder Users Guide, v4.0

Controller and Main Processor Compatibility

Triconex Controller Main Processor

Communication Module Compatibility

Model Communication Module Name Use with: Controller

SOE Recorder Users Guide, v4.0

SOE Configuration in TriStation

SOE Recorder communicates via the Net port on the controller

SOE Block Description and Type

External Block Type

SOE Recorder Users Guide, v4.0

First Out Block Type

Historical Block Type

Modified External Block Type

SOE Recorder Users Guide, v4.0

Defining SOE Block Properties

3 Specify these settings on the SOE Block Definition tab.

SOE Recorder Users Guide, v4.0

Assigning Event Variables to SOE Blocks

SOE Recorder Users Guide, v4.0

Specifying a Trip Variable

To have a trip snapshot taken, SOE Recorder must be retrieving events

SOE Recorder Users Guide, v4.0

2 Specify these settings on the SOE Trip Variable tab.

SOE Recorder Users Guide, v4.0

Specifying the State Name and Color for Events

3 Specify these properties on the Display tab.

4 To replace the default settings, click Get Defaults.

SOE Recorder Users Guide, v4.0

5 To save the settings, click Apply Changes.

Using Time Synchronization

Avoiding Different Time Stamps for the Same Event

SOE Recorder Users Guide, v4.0

SOE Application Development

SOE Recorder Users Guide, v4.0

SOESTRT (SOE Start)

Table 1 Input Parameters

Table 2 Output Parameters

SOE Recorder Users Guide, v4.0

SOESTOP (SOE Stop)

Table 3 Input Parameters

Table 4 Output Parameters