Está en la página 1de 132

SOE Recorder

User’s Guide

Triconex SOE Recorder


Version 4.3.x

Assembly Number 9700081-008


December 2013
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 Invensys Systems, Inc.

© 2007–2013 Invensys Systems, Inc. All rights reserved.

Invensys, Invensys logo, Foxboro, I/A Series, Triconex, Tricon, Trident, and TriStation are trademarks of
Invensys plc, its subsidiaries and affiliates. All other brands may be trademarks of their respective owners.

Document Number 9720081-008, Rev 1


Printed in the United States of America.
Contents

Preface iii
New Features in Triconex SOE Recorder 4.3.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Summary of Sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Product and Training Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv
We Welcome Your Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Chapter 1 Getting Started 1


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Controller Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Communication Module Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Installing Triconex SOE Recorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Installing SOE Recorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Uninstalling SOE Recorder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Starting Triconex SOE Recorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Logging In to SOE Recorder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Troubleshooting Login Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Customizing the Security Banner Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Viewing User Access Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Where to Go Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 2 Configuring SOE 19


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Configuration Steps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Configuring Your Application to Enable SOE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
About SOE Block Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
About SOE Block Collection Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Configuring Your Application to Retrieve the Same Event Data
Using Multiple SOE Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Defining SOE Block Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Assigning Tagnames to SOE Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Specifying a Trip Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Specifying the State Name and Color for Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Using Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Using the SOE Function Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Configuring SOE Recorder to Retrieve Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Configuring the Controllers to Retrieve Events From . . . . . . . . . . . . . . . . . . . . . . . . . 42
Selecting the Blocks to Retrieve Events From in Custom Mode (Optional) . . . . . . . 50
Copying the SOE Definition File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Configuring Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Triconex SOE Recorder User’s Guide, 4.3.x


ii Contents

Enabling Snapshot Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56


Changing the Events File Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Configuring Automatic Export of Event Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 3 Retrieving and Analyzing Events 63


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Retrieving Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
File Naming Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
About SOE Collection Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Creating a New Events File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Starting Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Filtering Events During Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Sorting Events During Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Manually Saving a Snapshot During Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . 76
Re-Polling the Controller List During Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . 77
Pausing Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Ending Event Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Viewing Message Bar and Status Bar Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Troubleshooting Event Retrieval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Analyzing Event Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Viewing Saved Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Finding Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Filtering Event Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Sorting Event Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Saving a Filtered or Sorted Events File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Exporting Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Viewing Status Bar Information During Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Working with Event Data Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Appendix A Commands and Properties 99

Index 117

Triconex SOE Recorder User’s Guide, 4.3.x


Preface

Triconex® Sequence of Events (SOE) Recorder is a software application for retrieving and
analyzing sequence of events information from Triconex controllers.
The TriStation™ 1131 Developer’s Workbench software is required to identify the events
information to be collected.

New Features in Triconex SOE Recorder 4.3.x


SOE Recorder 4.3.x is a maintenance release, incorporating several minor fixes and
enhancements.

Summary of Sections
• Chapter 1: Getting Started— Describes hardware and software requirements for SOE
Recorder, and provides installation instructions. Also explains how SOE Recorder
retrieves SOE data generated by a TriStation 1131 application running on a Triconex
controller.
• Chapter 2: Configuring SOE— Explains how to use the TriStation 1131 software to
configure an application to enable SOE. Describes SOE function blocks that start and
stop event collection. Explains how to configure SOE Recorder to retrieve events.
• Chapter 3: Retrieving and Analyzing Events— 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 Properties—Describes the commands and properties
available in SOE Recorder.
Note In this guide, Triconex controllers refers to all Tricon, Trident, and Tri-GP controllers.

Related Documents
• TriStation 1131 Developer’s Guide
• TriStation 1131 Libraries Reference
• Tricon, Trident, and Tri-GP Communication Guides
• ACM User’s Guide
• SMM User’s Guide

Triconex SOE Recorder User’s Guide, 4.3.x


iv Preface

Product and Training Information


To obtain information about Invensys products and in-house and on-site training, see the
Invensys Web site or contact your regional customer center.

Website
http://www.iom.invensys.com

Technical Support
Customers in the U.S. and Canada can obtain technical support from the Invensys Global
Customer Support (GCS) center 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 customers with a support agreement 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 do not have a support agreement, 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

Website
http://support.ips.invensys.com/ (registration required)

Triconex SOE Recorder User’s Guide, 4.3.x


Preface v

We Welcome Your Comments


To help us improve future versions of Triconex documentation, we want to know about any
corrections, clarifications, or further information you would find useful. When you contact us,
please include the following information:
• The title and version of the guide you are referring to
• A brief description of the content you are referring to (for example, step-by-step
instructions that are incorrect, information that requires clarification or more details,
missing information that you would find helpful)
• Your suggestions for correcting or improving the documentation
• The version of the Triconex hardware or software you are using
• Your name, company name, job title, phone number, and e-mail address
Send e-mail to us at:
triconextechpubs@invensys.com
Please keep in mind that this e-mail address is only for documentation feedback. If you have a
technical problem or question, please contact the Invensys Global Customer Support (GCS)
center. See Technical Support on page iv for contact information.
Or, you can write us at:
Attn: Technical Publications — Triconex
Invensys
26561 Rancho Parkway South
Lake Forest, CA 92630
USA
Thank you for your feedback.

Triconex SOE Recorder User’s Guide, 4.3.x


vi Preface

Triconex SOE Recorder User’s Guide, 4.3.x


1
Getting Started

Overview 2
Controller Compatibility 4
Installing Triconex SOE Recorder 6
Starting Triconex SOE Recorder 9
Where to Go Next 17

Triconex SOE Recorder User’s Guide, 4.3.x


2 Chapter 1 Getting Started

Overview
The Triconex Sequence of Events (SOE) Recorder software allows you to retrieve event data
from as many as 63 Triconex controllers on a network (up to 16 controllers simultaneously). 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 (transition) 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 controller’s memory. This
figure shows how Triconex controllers, a TriStation 1131 application, and SOE Recorder interact
to provide sequence-of-events functionality.

TriStation 1131
Developer’s Workbench SOE Data File
(.SED)
SOE Blocks Snapshot
dBASE IV File
ASCII Text File
Event
Variables
SOE Recorder Online Analysis
SOE SOE
Function Definition File
Blocks (.SOE)

.SOE File

.SOE File

Reports
Downloaded TriS tation 1131 P rojects
Enabled for SOE

Networked Triconex Controllers

L
N
1
NO
C
NC
L
N
2
NO
RC C
NC

POWER A MP B C COM L 2 R L 3 R L 4 R L 5 R L 6 R L 7 R

1
REMOTE RUN

PROGRAM PASS PASS PASS


PASS PASS PASS
PASS PASS PASS
STOP FAULT
FAULT FAULT
FAULT FAULT FAULT
FAULT FAULT FAULT
Ñ LOCAL Ñ ACTIVE ACTIVE ACTIVE
ACTIVE ACTIVE ACTIVE
ACTIVE ACTIVE ACTIVE
LOAD/ LOAD/
MAINT1 MAINT1 FUSE FUSE
MAINT1
1 1
MAINT2 MAINT2 MAINT2
1TX
115/230 VAC 2 2
1 1
1RX
2 2
3 3
NET 1
3 3
PASS 4 4
FAULT 5 5
4 4

ALARM 5 5
6 6
TEMP TX
6 6
RX 7 7
BATT LOW 2TX
7 7
8 8
2RX

9 9 8 8

10 10

11 11

12 12

13 13
3TX
NET 2 14 14 3RX

POWER MODULE 15 15
MODEL 8310
16 16

TX 17 17

RX 18 18

19 19
115/230 VAC 4TX
20 20 4RX

21 21
PASS
22 22
FAULT
23 23
ALARM
COM RX COM RX COM RX
TEMP 24 24
COM TX COM TX COM TX COMM 9 9
BATT LOW 25 25
I/O RX I/O RX I/O RX TX 10 10
26 26 PRT
I/O TX I/O TX I/O TX RX
11 11
27 27
12 12
28 28
13 13
29 29
14 14
30 30
15 15
31 31
16 16
32 32
POWER MODULE EMP EMP EMP NCM
DIGITAL DIGITAL DIGITAL DIGITAL
EICM
MODEL 8310 3006 3006 3006 4329 INPUT INPUT OUTPUT
3603B
OUTPUT
3603B
4119
3501E 3501E

Tricon Node 02

Trident Node 01 Tri-GP Node 03

To enable event data to be detected by the controller, you must define the event variables and
SOE blocks in the TriStation 1131 application. In addition, the application must include SOE
function blocks that start event collection. After you download an SOE-enabled application to
the controller, the TriStation 1131 software creates an SOE definition file that contains the SOE
block definitions.

Triconex SOE Recorder User’s Guide, 4.3.x


Overview 3

To retrieve events with SOE Recorder, you must connect the SOE Recorder PC to an open
network communication port on a Triconex controller. You must use the TriStation 1131
software to set the IP address of the controller and you must specify the address in SOE
Recorder.
To use TSAA Multicast option in SOE, the control program that is created and downloaded to
the Triconex controller should be enabled to Multicast, and given a Multicast IP in the TSAA
Configuration in TCM (or the corresponding Communication Module) setup windows.
SOE Recorder can simultaneously retrieve event data from as many as 16 Triconex controllers.
SOE Recorder queries all the controllers on the network to determine which TriStation 1131
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.
You can control the specific SOE blocks that SOE Recorder should retrieve events from on a per-
controller basis. SOE block collection can be configured as Automatic or Manual. Setting the
block collection to Manual specifies that events from these blocks cannot be automatically
collected in either Primary or Redundant mode. Setting the block collection to Automatic allows
the system to define the SOE blocks for retrieval. Other SOE blocks in the same application can
be configured for retrieval by another sequence of events utility (such as the Foxboro® I/A
Series® workstation).
SOE Recorder can save events in an events 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 plant’s 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-based 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
dBASE™ IV, ASCII, or other file formats. A report engine and standard report are also included.

Triconex SOE Recorder User’s Guide, 4.3.x


4 Chapter 1 Getting Started

Controller Compatibility
SOE Recorder is compatible with these controller versions, Main Processors, and
communication modules.

Triconex Controller Main Processor Communication Modules


Tricon version 9.5.x/9.51.x/9.52.x Model 3006 NCM 4329
ACM 4609
Tricon version 9.6.x — 9.10.x Model 3008 NCM 4329/4329G
ACM 4609
Tricon version 10.0.x Model 3008 TCM 4351/4352
NCM 4329/4329G
ACM 4609
Tricon version 10.1.x — 10.2.x Model 3008 TCM 4351A/4352A
NCM 4329/4329G
ACM 4609
Tricon version 10.3.x and later Model 3008 TCM 4351A/4352A1
TCM 4351B/4352B
TCM 4353/4354
NCM 4329/4329G
ACM 4609
Trident version 1.2 and later Model 3101 CM 3201
CIM 32112
Tri-GP version 2.1.x and later Model 3101S2 CM 3201S2
CIM 3211S22

1. Requires TriStation 1131 4.4 or later; these modules cannot be configured in a Tricon 10.3.x system
using earlier versions of the TriStation 1131 software.
2. This module can only be configured in a Trident or Tri-GP 3.x system using TriStation 1131 4.10.0 or
later.

The Tricon Model 3007 Main Processors do not have sufficient memory to
CAUTION be used with SOE Recorder.

Additionally, SOE Recorder 4.3.x is compatible with the SOE definition file generated by
TriStation 1131 3.1.347 and later; see Copying the SOE Definition File on page 53 for more
information.
If the SOE definition file is generated by TriStation 1131 4.6 or earlier, all of the blocks are treated
by SOE Recorder 4.3.x as Primary and Automatic.

Triconex SOE Recorder User’s Guide, 4.3.x


Controller Compatibility 5

Communication Module Compatibility


The type of communication module installed in a Triconex controller determines whether event
retrieval can be performed 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 Tricon
DCS
4329 Network Communication Module (NCM) SOE Recorder Tricon
4329G
4609 Advanced Communication Module (ACM) SOE Recorder Tricon
Foxboro I/A Series System
(8.8 and earlier)
4351/A/B Tricon Communication Module (TCM) SOE Recorder Tricon
4352/A/B
4353, 4354
3201 Trident Communication Module (CM) SOE Recorder Trident
3201S2 Tri-GP Communication Module (CM) SOE Recorder Tri-GP
3211 Trident Communications Integration SOE Recorder Trident
Module (CIM)
3211S2 Tri-GP Communications Integration SOE Recorder Tri-GP
Module

For information on installing and configuring communication modules, see the Communication
Guide for Tricon, Trident, or Tri-GP systems. For information on using an ACM or SMM with a
DCS utility for event retrieval, see the ACM User’s Guide or the SMM User’s Guide.

Triconex SOE Recorder User’s Guide, 4.3.x


6 Chapter 1 Getting Started

Installing Triconex SOE Recorder


This section explains how to install and uninstall SOE Recorder. SOE Recorder is intended to be
installed on a DCS operator workstation, but can be installed on any PC located on the same
network as the Triconex controller(s) you will be retrieving events from.
To install SOE Recorder, you must be logged into Windows as a user with administrator
privileges. If you do not have administrator privileges, contact your network administrator for
assistance.
Note Throughout this manual, the PC on which you install and use SOE Recorder is referred
to as the SOE Recorder PC.
Topics include:
• System Requirements on page 6
• Installing SOE Recorder on page 7
• Uninstalling SOE Recorder on page 8

System Requirements
The following are the minimum system requirements for SOE Recorder:
• PC running the .NET Framework 3.5 and one of the following Windows® operating
systems:
— Windows XP Professional (32-bit)
— Windows 7 Professional/Enterprise (32-bit or 64-bit)
— Windows Server® 2003 (32-bit)
— Windows Server 2008 R2 (32-bit or 64-bit)
Note If the .NET Framework is not already installed, setup will install it for you before
installing SOE Recorder.
• 433 MHz processor with 256 MB RAM
• 500 MB free hard drive space for installation of the application
• 8 GB free hard drive space for event collection and snapshot file generation
• CD-ROM drive
• Network adapter card
• SVGA monitor running at 1024 x 768 resolution with 64,000 colors

Triconex SOE Recorder User’s Guide, 4.3.x


Installing Triconex SOE Recorder 7

Installing SOE Recorder


This procedure explains how to install the SOE Recorder software. You must have Windows
administrator privileges to install SOE Recorder. You do not need to install SOE Recorder on the
same PC as the TriStation 1131 software.
If an earlier version of SOE Recorder is installed on the PC, it will be upgraded to the current
version.
If the .NET Framework is not already installed, setup will install it for you before installing SOE
Recorder. Depending on your PC's configuration, .NET Framework installation can take several
minutes, and may require you to restart your PC in order to complete the installation process.
Note During installation, you will be asked if you want to change the NERC Security Banner
message text. This is optional; the message text can also be modified at any time after
installation. If you aren’t sure if you want to change the text, leave the default text as-is
during installation. See Customizing the Security Banner Text on page 11 for more
information.

Procedure
1 Log on to Windows as an administrator or as a user with administrator privileges.
2 Close all open applications.
3 Insert the SOE Recorder CD in the CD-ROM drive.
If the installation starts automatically, go to step 8. Otherwise, go to the next step.
4 From the Start menu, click Settings, and then click Control Panel.
5 Double-click Add or Remove Programs, and then click Add New Programs.
6 Click CD or Floppy, and then browse to locate the setup.exe file on the CD.
7 Double-click setup.exe to start the installation.
8 Follow the InstallShield Wizard instructions.
Invensys recommends installing the SOE Recorder software in the default destination
folder, which is: C:\Program Files\Triconex\TcxSoe.
Note For Windows 7 64-bit or Windows 2008 Server R2 64-bit, the default folder is:
C:\Program files(x86)\Triconex\TcxSoe.

Triconex SOE Recorder User’s Guide, 4.3.x


8 Chapter 1 Getting Started

Uninstalling SOE Recorder


This procedure explains how to uninstall SOE Recorder.

Procedure
1 Log on to Windows as an administrator or as a user with administrator privileges.
2 From the Start menu, click Settings, and then click Control Panel.
3 Double-click Add or Remove Programs, and select Triconex Sequence of Events
Recorder.
4 Click Change/Remove. Follow the on-screen instructions to confirm the deletion of the
selected application and all its components.
Note If you saved configuration files or event log files in the default directory,
(C:\Documents and Settings\All Users\Application
Data\Triconex\TcxSoe in Windows XP Professional and Windows Server
2003, and C:\ProgramData\Triconex\TcxSoe in Windows Server 2008 and
Windows 7), the uninstall program does not remove them.
5 Click Yes or Yes to All if the Remove Shared File dialog box asks about removing unused
DLLs.
6 Click Finish to complete the uninstallation process.

Triconex SOE Recorder User’s Guide, 4.3.x


Starting Triconex SOE Recorder 9

Starting Triconex SOE Recorder


You must log in to Triconex SOE Recorder using your Windows user name and password. The
number of times you can attempt to enter your user name and password is determined by your
Windows domain setting.
For example, if your Windows domain setting is limited to three login attempts, after three
unsuccessful attempts to log in to the Triconex SOE Recorder, your user account will be locked
out. If this occurs, ask your network administrator to reset your Windows account.
Topics in this section include:
• Logging In to SOE Recorder on page 9
• Troubleshooting Login Problems on page 10
• Customizing the Security Banner Text on page 11
• Viewing User Access Logs on page 13

Logging In to SOE Recorder


You must use your Windows user name and password to log in to Triconex SOE Recorder. Your
user information will be authenticated against Windows Active Directory.
If you are having problems logging in using your Windows user information, see
Troubleshooting Login Problems on page 10.

Procedure
1 On the Start menu, select Programs > Triconex > Triconex SOE Recorder.
The Windows login dialog box appears.
2 Enter your Windows user name (including domain, if necessary) and password, and
click OK.

Triconex SOE Recorder User’s Guide, 4.3.x


10 Chapter 1 Getting Started

Troubleshooting Login Problems


The following are common problems you may encounter when trying to log in to SOE Recorder.

Problem Solution
The following error message This message appears when you click OK in the Login dialog
appears: box without entering your Windows user name and/or
“The parameter is incorrect.” password.
When you click OK in the error message box, the Login dialog
box will appear again. Be sure not to leave the user name
and/or password field blank.
The following error message This message appears when you enter an incorrect password
appears: in the login dialog box.
“Logon failure: unknown user In this case, SOE Recorder is unable to authenticate your user
name or bad password.” information with Windows.
When you click OK in the error message box, the login dialog
box will appear again. Verify that you are trying to log in with
the correct Windows user name and password.
User names and passwords are case-sensitive. Verify that the
CAPS LOCK key is not on when you enter your user
information.
The following error message This message appears if you are trying to log in using a
appears: Windows “Guest” account.
“Logon failure: the user has not Windows “Guest” accounts are used to provide access to a
been granted the requested computer when you do not have a Windows user account on
logon type at this computer.” that computer. In order for you to be able to log in to SOE
Recorder with a “Guest” account, ask your network or system
administrator to do the following:
• Remove the “Guest” user from the Windows Local
Security Policy “Deny access to this computer from the
network” list.
• Enable the “Accounts: Guest account status” option in the
Windows Local Security Policy security options list.

Triconex SOE Recorder User’s Guide, 4.3.x


Starting Triconex SOE Recorder 11

Customizing the Security Banner Text


Each time you start Triconex SOE Recorder,
a security banner appears, advising you of
the appropriate use of Triconex SOE
Recorder.
If you are an administrator managing
Triconex SOE Recorder installations in
your organization, you may want to
customize the security banner text to reflect
your corporate policy, meet site-specific
needs, or be in compliance with North
American Electric Reliability Corporation
(NERC) cyber security standards.
Note For more information about the
NERC’s cyber security standards, a
set of sound security practices that, if properly implemented, can assist in securing
critical infrastructure from cyber security threats, see www.nerc.com.
The security banner text must be customized in each Triconex SOE Recorder installation
individually. However, once you modify the security banner text once, you can simply copy and
paste the text from one PC to another. An easy way to do this would be to create a temporary
text file with the security banner text in it, and place that file on the network, or on a portable
flash drive. You can then copy and paste the text from the file.
Also, the same security banner text can be used for other Triconex products that use the security
banner functionality. For example, if your organization’s security banner text is the same for all
Triconex products, you can use the same text for the TriStation 1131 software as you do for
Triconex SOE Recorder.
The security banner text can be changed during Triconex SOE Recorder installation, or at any
time after installation using the procedure provided in this section.
You must be logged in to Triconex SOE Recorder as a Windows user with administrator
privileges to change the security banner text.

Procedure
1 Make sure that all network node connections are closed.
2 On the Edit menu, click Modify Banner Message.
Note If you don’t see the Modify Banner Message menu item, you are not logged in to
Triconex SOE Recorder with administrator privileges.
The Modify Banner Message dialog box appears.

Triconex SOE Recorder User’s Guide, 4.3.x


12 Chapter 1 Getting Started

3 Edit the security banner text as needed, and then click OK.
Note You cannot have a blank security banner message; if you delete the existing text,
but do not enter new text, the default security banner message (“This system is
for use by authorized Safety System personnel only.”) will be displayed.
The next time you start Triconex SOE Recorder, the customized text will appear in the
security banner.
Note If you receive an “Unable to save changes to the banner message” error message when
you attempt to save the security banner text, you may not have read/write access to the
location where the message text is stored. Contact Invensys Global Customer Support
for assistance. For contact information, see Technical Support on page iv.

Triconex SOE Recorder User’s Guide, 4.3.x


Starting Triconex SOE Recorder 13

Viewing User Access Logs


The Triconex SOE Recorder keeps a log of all user login attempts, whether they are successful
or not. These access logs are required for compliance with NERC cyber security standards.
The SOE Recorder uses the Windows System Events Log to store the following information
about user login and logoff attempts:
• Successful login using Windows user name and password
• Login failure due to an incorrect Windows user name and/or password
• Login attempt cancelled by the user
• Login failure due to the user forgetting to enter their Windows user name and/or
password (this is referred to as an “incorrect parameter” error)
• Successful logoff (when the user closes the SOE Recorder)
You can view this log to determine if an unauthorized user is attempting to log in to SOE
Recorder. You can also use this log as a troubleshooting tool when helping a user who is having
login problems.
Note If you are logged into Windows using a “Guest” account, you will be unable to view the
Windows System Events Log. For more information, see Microsoft® Knowledge Base
Article 842209 (http://support.microsoft.com/kb/842209).
Topics in this section include:
• Viewing the User Access Log In Windows Event Viewer on page 13
• Saving the User Access Log to a File on page 14
• Changing Event Logging Options on page 15
• Clearing the User Access Log on page 16

Viewing the User Access Log In Windows Event Viewer


This procedure describes how to view the Triconex SOE Recorder user access information in the
Windows System Events Log using the Windows Event Viewer. You must be logged on to
Windows as an administrator to perform this procedure.

Procedure
1 On the Start menu, click Control Panel, and then double-click Administrative Tools.
2 Double-click the Event Viewer icon. The Windows Event Viewer opens.
3 In the console tree, click Application. Event information appears in the details pane.

Triconex SOE Recorder User’s Guide, 4.3.x


14 Chapter 1 Getting Started

4 In the details pane, click the Source column header to sort the events by application.
5 Look for Triconex SOE Recorder as the source type.
6 To view detailed information about a specific event, double-click the event.

Saving the User Access Log to a File


This procedure describes how to save the user access event information to a file. You must be
logged on to Windows as an administrator to perform this procedure.
When you save a log file, the entire log is saved, regardless of filtering options. You cannot save
a log file with just the events related to the Triconex SOE Recorder. Also, the sort order is not
retained when logs are saved.

Procedure
1 In the Windows Event Viewer, display the event log with the user access information
that you want to save to a file.
2 On the Action menu, click Save Log File As.
3 In File name, enter a name for the archived log file.

Triconex SOE Recorder User’s Guide, 4.3.x


Starting Triconex SOE Recorder 15

4 In Save as type, select a file format, and then click Save.


• If you archive a log in log-file format, you can reopen it in Event Viewer. Logs
saved as event log files (.evt) retain the binary data for each event recorded.
• If you archive a log in text (.txt) or comma-delimited (.csv) format, you can reopen
the log in other programs, such as word processing or spreadsheet programs. Logs
saved in text or comma-delimited format do not retain the binary data.

Changing Event Logging Options


Using the Windows Event Viewer, you can set the maximum size of the log and specify whether
events are overwritten or stored for a certain period of time.
The default logging policy is that if a log is full, the oldest events are deleted to make room for
new events. Invensys recommends that you change this setting to ensure that user login event
information is not lost.
This procedure describes how to change event logging options using the Windows Event
Viewer. You must be logged on to Windows as an administrator to perform this procedure.

Procedure
1 On the Start menu, click Control Panel, and then double-click Administrative Tools.
2 Double-click the Event Viewer icon. The Windows Event Viewer opens.
3 In the console tree, right-click Application. The Application Properties dialog box
appears.

4 Do one or both of the following:


• To increase the maximum size of the event log file, enter the desired value (in KB) in
the Maximum log size field
• Select Do not overwrite events (clear log file manually).
5 Click OK to save your changes.

Triconex SOE Recorder User’s Guide, 4.3.x


16 Chapter 1 Getting Started

Clearing the User Access Log


When the Windows System Events Log reaches its maximum size, you will see the following
error message in SOE Recorder:
The event log file is full. You must manually clear all events from the event log file before
new entries can be added.
This procedure describes how to clear the event log file so that you can continue collecting user
login event information. You must be logged on to Windows as an administrator to perform this
procedure.
Note Clearing the log file will clear ALL application event information, not just events related
to the Triconex SOE Recorder. We highly recommend saving the file prior to clearing it.

Procedure
1 On the Start menu, click Control Panel, and then double-click Administrative Tools.
2 Double-click the Event Viewer icon. The Windows Event Viewer opens.
3 In the console tree, right-click Application, and then select Clear all events.
4 When prompted to save the log before clearing it, click Yes.
5 Select the location where you want to save the file to, and click Save.
The file is saved to your selected location, and the current log file is cleared.

Triconex SOE Recorder User’s Guide, 4.3.x


Where to Go Next 17

Where to Go Next
To configure your Triconex controllers to collect and retrieve sequence of events information,
you must complete a series of tasks in both the TriStation 1131 software and the SOE Recorder
software.

Procedure
1 Configure your TriStation 1131 application to enable SOE.
Using the TriStation 1131 software, you must configure your application to use SOE, and
then download it to the controller. You must complete this step before you can configure
the SOE Recorder software to retrieve events.
After you have configured your application to enable SOE, you can use the Triconex
Emulator, which is installed with the TriStation 1131 software, to test the SOE blocks
configured in your application. For more information, see the Triconex Emulator User’s
Guide.
2 Configure SOE Recorder.
After your application has been configured for SOE and downloaded to the controller,
you can set up SOE Recorder to retrieve and save event information.
For detailed instructions, see Chapter 2, Configuring SOE.

Triconex SOE Recorder User’s Guide, 4.3.x


18 Chapter 1 Getting Started

Triconex SOE Recorder User’s Guide, 4.3.x


2
Configuring SOE

Overview 20
Configuration Steps 21
Configuring Your Application to Enable SOE 22
Configuring SOE Recorder to Retrieve Events 42

Triconex SOE Recorder User’s Guide, 4.3.x


20 Chapter 2 Configuring SOE

Overview
This section describes how to enable SOE in your application, as well as how to configure the
SOE Recorder software to retrieve events.
You must use the TriStation 1131 software to develop an application that defines the event data
to be collected by the controller. The application must identify the event variables and the SOE
blocks, and must include an SOE function block that starts event collection.
Note For information on standard development tasks such as downloading an application,
see the TriStation 1131 Developer’s Guide.
Once you have downloaded the application to the controller or the Emulator, you need to
configure SOE Recorder to retrieve and save events. SOE Recorder accumulates events in an
events file until a trip occurs, or until 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 plant’s operation.
This figure shows the main steps for configuring your application and SOE Recorder for event
retrieval:

START C onfigure SOE blocks


C onfigure the
controllers to retrieve
events from

Assign tagnames to C onfigure the SOE


SOE blocks blocks to retrieve
events from
(optional)

Specify a trip
variable
(optional) C onfigure event
display options
C opy SOE (optional)
definition file to
SOEC onfig
directory

C ustomize tagname Enable


state name / color snapshot mode
(optional) (optional)

C onfigure automatic
export of event data
Test SOE configuration (optional)
in application using
the Emulator
(optional)

Download application Start


to controller event retrieval END

TriStation 1131 Tasks SOE Recorder Tasks

Figure 1 Steps for Configuring Your Application and SOE Recorder for Event Retrieval

Triconex SOE Recorder User’s Guide, 4.3.x


Configuration Steps 21

Configuration Steps
This list includes steps that can be or should be done during SOE configuration.

Steps Where Performed See

 Add and configure SOE TriStation 1131 Defining SOE Block Properties on
blocks in your application. page 28

 Assign tagnames to the SOE TriStation 1131 Assigning Tagnames to SOE Blocks on
blocks. page 31

 Specify a trip variable. TriStation 1131 Specifying a Trip Variable on page 33


(optional)

 Customize the state name(s) TriStation 1131 Specifying the State Name and Color for
and color(s) for tagnames Events on page 35
assigned to SOE blocks.
(optional)

 Test SOE configuration in Triconex Emulator The Triconex Emulator User’s Guide.
application using the
Emulator. (optional)

 Download the application to TriStation 1131 The TriStation 1131 Developer’s Guide.
your controller(s).

 Copy the SOE definition file Windows Explorer Copying the SOE Definition File on
generated by TriStation 1131 page 53
to the SOEConfig directory.

 Configure the controllers you SOE Recorder Configuring the Controllers to Retrieve
want to retrieve events from. Events From on page 42

 Specify the SOE blocks you SOE Recorder Selecting the Blocks to Retrieve Events
want to retrieve events from From in Custom Mode (Optional) on
for each controller. (optional) page 50

 Configure display options. SOE Recorder Configuring Display Options on page 54


(optional)

 Enable snapshot mode. SOE Recorder Enabling Snapshot Mode on page 56


(optional)

 Configure the automatic SOE Recorder Configuring Automatic Export of Event


export of event data to a Data on page 60
database or text file. (optional)

Triconex SOE Recorder User’s Guide, 4.3.x


22 Chapter 2 Configuring SOE

Configuring Your Application to Enable SOE


This section explains how to configure SOE blocks and assign tagnames (event variables) to
them so you can retrieve events. It also provides information on using SOE function blocks in
programs.
Note SOE Recorder communicates via the communication module NET port, which must be
configured for a network (open) connection. For more information, see the TriStation
1131 Developer’s Guide.
Topics include:
• About SOE Block Types on page 23
• About SOE Block Collection Modes on page 26
• Configuring Your Application to Retrieve the Same Event Data Using Multiple SOE
Clients on page 27
• Defining SOE Block Properties on page 28
• Assigning Tagnames to SOE Blocks on page 31
• Specifying a Trip Variable on page 33
• Specifying the State Name and Color for Events on page 35
• Using Time Synchronization on page 36
• Using the SOE Function Blocks on page 37

Before You Begin


Before you start configuring your application to use SOE, you may want to view the sample
projects provided with the TriStation 1131 software to familiarize yourself with how SOE blocks
can be used in applications.
• For Tricon controllers, see ExSoe.pt2.
• For Trident controllers, see TdSoe.pt2.
• For Tri-GP controllers, see TgpSoe.pt2.
The sample projects include SOE function blocks used in programs, and multiple SOE blocks
with tagnames (event variables) assigned to them. With each project, you can generate a sample
SOE definition file which supplies point properties for the tagnames.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 23

About SOE Block Types


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 tagnames assigned to the block.
The buffer stores the event entries, which include the values of all the tagnames that changed
during the current scan, and a time stamp for the scan that applies to all of the changed
tagnames in the block. The following figure shows how the MPs store data in an SOE block:

You determine when to start and stop collecting events with the SOE blocks by using start and
stop function blocks in your TriStation 1131 application.
Note If you are using Primary and Redundant blocks, design your application so that
Redundant blocks start and stop in the same scan as their related Primary blocks.
There are 16 SOE blocks available. Blocks 1 through 14 can use any combination of External,
First Out, OPC, or History types. Blocks 15 and 16 are modified external blocks that are reserved
for use with the Safety Manager Module (SMM) in a Tricon project. SOE Recorder cannot collect
events from block 15 and 16 in any of the modes.

External Block Type


The External Block Type setting is typically used when an external device, such as a Foxboro or
Honeywell DCS, or a 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.

Triconex SOE Recorder User’s Guide, 4.3.x


24 Chapter 2 Configuring SOE

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 block’s status from collecting to
stopped. New events are discarded.

History Block Type


The History Block Type setting is typically used to monitor current events in an SOE Recorder
application. An external device can collect events at any time; however, the collection does not
clear the block. If the application does not clear and restart recording, the oldest event entries
are overwritten when the buffer is full.

Process
1 The Main Processors write events to the block.
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
TDC 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.
4 After the Main Processors receive the acknowledgment, event data is cleared from the
block.
5 When the buffer is full, the Main Processors discard new event entries.
For more information, see the SMM User’s Guide.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 25

OPC Block Type


The OPC Block Type setting is typically used to retrieve process alarms events from OPC UA
clients. It is supported for use only with the CIM. If the block size is not large enough, process
alarm events may be lost.

Process
1 The Main Processors write events to the block.
2 When the buffer is full, the Main Processors change the block’s status from collecting to
stopped. New process alarm events are discarded.

Triconex SOE Recorder User’s Guide, 4.3.x


26 Chapter 2 Configuring SOE

About SOE Block Collection Modes


When you are defining SOE blocks in your TriStation 1131 application, you can select one of two
SOE Block Collection Modes:
• Primary SOE Block Collection Mode
• Redundant SOE Block Collection Mode

Primary SOE Block Collection Mode


The events from blocks with the SOE Block Collection Mode identified as Primary will be
collected by an instance of SOE Recorder running in Primary mode or an instance of SOE
Recorder running in Custom mode when the blocks are selected for collection. For more on
collection modes, see About SOE Collection Modes on page 67.

Redundant SOE Block Collection Mode


The events from blocks with the SOE Block Collection Mode identified as Redundant will be
collected by an instance of SOE Recorder running in Redundant mode or an instance of SOE
Recorder running in Custom mode when the blocks are selected for collection. For more on
collection modes, see About SOE Collection Modes on page 67.
When you select Redundant as the SOE Block Collection Mode, you must select a Primary block
that you want the Redundant block to be a copy of.
If you select Redundant as the SOE Block Collection Mode, please note the following:
• The tagnames assigned to the selected Primary block will automatically be assigned to
the Redundant block; you cannot manually assign tagnames to a Redundant block.
• Each Redundant block is a copy of the associated Primary block and all changes to the
Primary block are propagated to the Redundant block, including tagnames, block type,
buffer size, and collection type.
• Redundant blocks are read only.
• Each Primary block can have only one Redundant block.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 27

The following table identifies the causes of error messages you may encounter while defining
Redundant SOE Blocks in your TriStation 1131 application.

Error Message Cause


This Primary block is currently referenced by a You select “Redundant of” for a Primary block
Redundant block (block n). You cannot change that already has a Redundant block referring to
this block's collection mode from Primary to it.
Redundant unless you remove the reference to
this block from block n.
This Primary block is currently referenced by a You select “UNASSIGNED” as the SOE Block
Redundant block (block n). You cannot configure Type for a Primary block that has a Redundant
this block's type as UNASSIGNED. block referring to it.
You have configured this block's collection type You select “Redundant of” for a block and then
as Redundant, but have not selected the Primary click Apply without selecting a Primary block to
block to associate it with. Select a block from the associate it with.
list, or change this block's collection type to
Primary.

Configuring Your Application to Retrieve the Same Event Data Using


Multiple SOE Clients
Only one sequence of events utility can access each block in an application running on a
controller. You cannot assign the same block for event retrieval by multiple SOE clients. If
multiple clients are configured to access the same block, neither client will receive all the event
data.

There is no way for SOE Recorder to know if a block has already been
CAUTION configured for event retrieval in another SOE utility. It is up to you to
make sure that you do not configure multiple SOE clients to access the
same block. Multiple SOE clients accessing the same block can result in
loss of event data.

If you need to retrieve the same event data into another instance of SOE Recorder, you can do
so by specifying Primary blocks and Redundant blocks in your TriStation 1131 project, and then
collecting events from those blocks by running an instance of SOE Recorder in Primary mode
and running another instance of SOE Recorder in Redundant mode. For more on collection
modes, see About SOE Collection Modes on page 67.
Event data from Primary blocks is captured by an instance of SOE Recorder running in Primary
Mode, or an instance of SOE Recorder running in Custom mode when the blocks are selected
for collection.
Selecting the Redundant collection mode for a block creates a copy of a selected Primary block.
Event data from Redundant blocks is captured by an instance of SOE Recorder running in
Redundant Mode, or an instance of SOE Recorder running in Custom mode when the blocks are
selected for collection.
For information about selecting blocks for collection in Custom mode, see Selecting the Blocks
to Retrieve Events From in Custom Mode (Optional) on page 50.

Triconex SOE Recorder User’s Guide, 4.3.x


28 Chapter 2 Configuring SOE

Defining SOE Block Properties


This procedure explains how to define the properties of an SOE block, which is required if you
are using sequence of events in an application.
Defining SOE block properties is related to the general 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 your controller is not on a network.
The following table lists the types of SOE blocks that can be defined for each type of sequence
of events recorder:

If You’re Using This Sequence


Use These Types of SOE Blocks:
of Events Recorder:
Triconex SOE Recorder • First Out
• History
• External
• OPC
Foxboro I/A Series DCS • External
Honeywell TDC 3000 DCS • Modified External

When the 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.

Each external block can be accessed by only one sequence of events utility. For example, if the
Foxboro I/A Series workstation is retrieving events from an External SOE block, SOE Recorder
cannot also retrieve events from that same block. See Selecting the Blocks to Retrieve Events
From in Custom Mode (Optional) on page 50 for instructions on specifying the blocks SOE
Recorder can retrieve events from.

A Note About Using OPC to Collect SOE Events


If you are using one of the following communication modules, an OPC server is embedded, and
can be used to obtain SOE events:
• If you have a model 4353 or 4354 TCM, you can use a third-party OPC client to obtain
Tricon SOE events through a subscription to the TCM’s embedded OPC Alarms &
Events server.
• If you have a model 3211 or 3211S2 CIM, you can use a third-party OPC client to obtain
Trident or Tri-GP SOE events through a subscription to the CIM’s embedded OPC UA
server.
When an OPC client is subscribed, all change of state events (transitions) for tagnames assigned
to the block you have defined for this purpose will be sent to the OPC client as simple events.
However, if an OPC client is not connected, the events collected by the SOE block will be
continually cleared by the communication module’s embedded OPC server.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 29

If you choose to use the communication module’s embedded OPC server to obtain events from
a controller, you cannot also use SOE Recorder to retrieve events from the same SOE block.
When using the TCM’s OPC server, an SOE block used for OPC must be configured with a block
type of EXTERNAL. For more information about configuring the TCM’s OPC server, see the
TriStation 1131 Developer’s Guide.
When using the CIM’s OPC UA server:
• The SOE block used to retrieve events from the OPC UA client (defined as the SOE
Block Number in the CIM configuration) must be configured with a block type of
EXTERNAL.
• The SOE block used to retrieve process alarm events (defined as the Alarms SOE Block
Number in the CIM configuration) must be configured with a block type of OPC.
For more information about configuring the CIM’s OPC server, see TriStation 1131 Developer’s
Guide.

Procedure
1 In TriStation 1131, open the project for the application in which you want to enable SOE.
2 Click the Application tree, and double-click Implementation.
3 Expand the SOE Configuration tree, and double-click a block number.

4 Specify these settings on the SOE Block Definition tab.

Triconex SOE Recorder User’s Guide, 4.3.x


30 Chapter 2 Configuring SOE

Property Action
SOE Block Type Select one of the following block types:
• 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.
• History Block Type: Used to monitor current events.
• Modified External Block Type: Used for event retrieval with the
SMM.
• OPC: Used for process alarms event retrieval from an OPC UA client.
For use with the CIM only.
Blocks 1 through 14 can use any combination of History, First Out, OPC,
and External block types. Blocks 15 and 16 can use only the Modified
External block type.
The default is unassigned.
SOE Block Name Enter a title for the block. If you do not enter a block name, a default
name will be assigned automatically.
The default is “soe_block_n,” where n is the block number.
SOE Buffer Size The buffer stores the event entries, each containing a 8-byte time stamp
and one or more 8-byte data entries.
Enter the number of events to be stored in this block. The maximum
number is 20,000 events (320,000 bytes); the default is 0.
The maximum buffer size across all blocks is 60,000 events (1 MB).
Note: You cannot change the SOE Buffer Size while the project is in the
Download Changes state. If the project is currently in the
Download Changes state, when you click Apply you will be
prompted to change the project state to Download All. If you do
not change the project state to Download All, the buffer size will
not be changed.
SOE Block Select the event collection behavior type for the block.
Collection Type • Select Automatic if you want the block’s events to be automatically
collected by an instance of SOE Recorder running in Primary,
Redundant, or Custom mode.
• Select Manual if you want the block’s events to be collected by an
external DCS or an instance of SOE Recorder running in Custom
mode.
The default is Automatic.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 31

Property Action
SOE Block Select the collection mode for the block.
Collection Mode • Select Primary if you want the block’s events to be collected by an
instance of SOE Recorder running in Primary mode or an instance of
SOE Recorder running in Custom mode when the blocks are selected
for collection.
• Select Redundant if you want the block to be a copy of an existing
Primary block, and then select the Primary block you want this block
to be a copy of.
The tagnames assigned to the selected Primary block will
automatically be assigned to the Redundant block; you cannot
manually assign tagnames to a Redundant block.
The default is Primary.
For more on SOE Block Collection Modes, see About SOE Block
Collection Modes on page 26.

5 Click Apply to save your changes.


6 Repeat steps 3 through 5 for all the blocks to be configured.

Assigning Tagnames to SOE Blocks


This procedure explains how to assign tagnames (event variables) to an SOE block, which is
required if you are using sequence of events in an application.
Tagnames must be aliased memory and/or input tagnames of type BOOL:
• Discrete physical input points
• Discrete memory read-only aliased variables, or
• Discrete memory read/write aliased variables
Discrete output points cannot be assigned to an SOE block.
Tagname states can be displayed with names and colors that you define. You can designate one
tagname in a TriStation 1131 application as the trip variable that notifies the operator when a
trip occurs.
Tagnames can be assigned only to blocks configured as Primary blocks. A block configured as
Redundant is automatically assigned the same tagnames as its associated Primary block.
Note For Tricon, if you define a block for use with the Advanced Communication Module
(ACM), the Foxboro I/A Series assigns the tagnames. The only additional configuration
you can do is to specify a type of External and a buffer size.

Before You Begin


Before you can assign tagnames, you must define SOE block properties (see Defining SOE Block
Properties on page 28).

Triconex SOE Recorder User’s Guide, 4.3.x


32 Chapter 2 Configuring SOE

Procedure
1 In TriStation 1131, open the project for the application in which you want to enable SOE.
2 Open the Application tree, and double-click Implementation.
3 Click the SOE Configuration branch. The tagnames and block assignments, if any, are
listed in a pane to the right of the tree.
4 To assign a tagname to one or more SOE Blocks, double-click the row for the tagname.
The Item Properties dialog box appears.

5 To assign the tagname to specific blocks, select the block number check box.
If the number is disabled, it means the block has not been defined, or the block has been
defined as a Redundant block. You cannot manually assign tagnames to Redundant
blocks.
Note If you add tagnames after opening the SOE Configuration screen, you must close
and re-open the SOE Configuration screen for the new tagnames to appear.
6 Continue to assign tagnames to blocks as needed.
7 After assigning all the tagnames, save the project so the tagnames are available when
specifying a trip variable.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 33

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 procedure 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
only 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.
Exiting SOE Recorder while a trip snapshot file is being created may cause
a loss of events. In this case, wait until the “file creation is complete”
message appears in the Message Bar before exiting the application.

Before You Begin


You must define at least one SOE block and assign a tagname to the block (see Defining SOE
Block Properties on page 28 and Assigning Tagnames to SOE Blocks on page 31).

Procedure
1 In TriStation 1131, open the project for the application in which you want to enable SOE.
2 Open the Application tree, and double-click Implementation.
3 Double-click SOE Configuration. The Item Properties dialog box appears.

4 Specify these settings on the SOE Trip Variable tab:

Triconex SOE Recorder User’s Guide, 4.3.x


34 Chapter 2 Configuring SOE

Property Action
Trip Tagname The tagname that designates whether a trip has occurred.
Select the tagname from the list of tagnames, and then select a Trip State
of True or False.
Only tagnames that are aliased BOOL data types are available.
Trip State Select the value on which to begin collecting events: True or False.
Time After Trip Select the number of minutes to collect events after a trip. The minimum
time is 2 minutes; the maximum time is 10 minutes. The default is 2
minutes.
Time Before Trip Select 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.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 35

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.
The name and color are 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 project for the application in which you want to enable SOE.
2 Open a tagname by doing either of these:
• 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.
3 Click the Display tab.

4 Specify these properties on the Display tab.

Property Action
True State Name Enter a name to display when the tagname value is True. The
default setting is TRUE.
True Color Select a color to display when the tagname value is True. The
default setting is red.
False State Name Enter a name to display when the tagname value is False. The
default setting is FALSE.
False Color Select a color to display when the tagname value is False. The
default setting is green.

5 To save your changes, click Apply.


To cancel your changes and restore the original settings, click Restore before clicking
Apply. To use the default settings, click Get Defaults at any time.

Triconex SOE Recorder User’s Guide, 4.3.x


36 Chapter 2 Configuring SOE

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, PC,
or GPS. If you are collecting events for shutdown analysis, all the controllers being polled
should be using time synchronization.
In a network, the controller clock can be synchronized with the master node (the controller with
the lowest node number) on a Triconex Peer-to-Peer network, or with an external device that
writes time values to the 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, a warning message is displayed in the Message Bar. To resolve this issue, the PC clock
should be adjusted to be within ±5 minutes of the controller clock.

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 tagnames in more than one 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 ± 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 Developer’s Guide.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 37

Using the SOE Function Blocks


This section describes the function blocks that control and verify event collection for SOE blocks.
The TriStation 1131 software provides function blocks to start and stop event collection for a
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 application 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 1131 Installation CD.
Design your application so that Primary and Redundant SOE blocks are started, stopped, and
cleared in the same scan.
If you are programming with Structured Text language, you can use conditional statements to
execute SOESTRT, SOESTOP, and SOECLR. For more information, see the TriStation 1131
Libraries Reference.

Triconex SOE Recorder User’s Guide, 4.3.x


38 Chapter 2 Configuring SOE

SOESTRT (SOE Start)


The SOESTRT function block starts sequence of events 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.
For each SOE block that you want to collect events from, you must execute the SOESTRT
function block before you connect SOE Recorder to the controller.
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 (1–16).

Table 2 Output Parameters


Name Data Type Description
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.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 39

SOESTOP (SOE Stop)


The SOESTOP function block writes a time stamp to the SOE block, and changes the state of the
block from collecting to stopped. Event collection stops until the next SOESTRT (SOE Start)
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 application development.
Note The SOESTOP function block is executed for only one scan, which means the resulting
STAT output is only valid for that scan.

Table 3 Input Parameters


Name Data Type Description
CI BOOL Enables SOESTOP.
BLOCK DINT The block number (1–16).

Table 4 Output Parameters


Name Data Type Description
CO BOOL True if SOESTOP 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.

Triconex SOE Recorder User’s Guide, 4.3.x


40 Chapter 2 Configuring SOE

SOECLR (SOE Clear)


The SOECLR function block clears an 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
(SOE Stop) 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.

Table 5 Input Parameters


Name Data Type Description
CI BOOL Enables SOECLR.
BLOCK DINT The block number (1–16).

Table 6 Output Parameters


Name Data Type Description
CO BOOL True if SOECLR 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.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring Your Application to Enable SOE 41

SOESTAT (SOE Statistics)


The SOESTAT function block returns the status for an SOE block, including the number of
8-byte entries that are used, and the number of 8-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.

Table 7 Input Parameters


Name Data Type Description
CI BOOL Enables SOESTAT.
BLOCK DINT The block number (1–16).

Table 8 Output Parameters


Name Data Type Description
CO BOOL True if SOESTAT 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.
FREE DINT The number of unused 8-byte entries in the block.
USED DINT The number of used 8-byte entries in the block.

Triconex SOE Recorder User’s Guide, 4.3.x


42 Chapter 2 Configuring SOE

Configuring SOE Recorder to Retrieve Events


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:
• Configuring the Controllers to Retrieve Events From on page 42
• Selecting the Blocks to Retrieve Events From in Custom Mode (Optional) on page 50
• Copying the SOE Definition File on page 53
• Configuring Display Options on page 54
• Enabling Snapshot Mode on page 56
• Changing the Events File Directory on page 59
• Configuring Automatic Export of Event Data on page 60

Configuring the Controllers to Retrieve Events From


This section explains how to configure the Triconex controllers that SOE Recorder will be
communicating with to retrieve events.
You can configure up to 63 controllers; but a maximum of 31 can be Tricon controllers. For
example, you can configure 25 Tricon controllers and 35 Trident controllers at the same time.
But you cannot configure 31 Tricon controllers and 33 Trident controllers, as this exceeds the 63
controller limit.
Tricon controllers must be assigned to nodes 1 through 31. Trident or Tri-GP controllers can be
assigned to nodes 1 through 63. You cannot duplicate node numbers.
You can create the list of controllers by starting with a blank list and adding each controller
individually, or by displaying the default list of controller addresses and then modifying and
deleting controllers as needed.
You can configure the controller list before event retrieval, but not during event retrieval.
Topics include:
• Using the Default Controller Configurations on page 43
• Using the Backup SOE Configuration File on page 43
• Adding a Controller on page 44
• Changing a Controller’s Configuration on page 46
• Deleting a Controller on page 47
• Using Multicasting on page 48
• Creating a Configuration for Custom Collection Mode on page 49

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 43

Using the Default Controller Configurations


To populate the controller list with the default configuration of 63 nodes, click Defaults.
You may find this function useful when you are first configuring the controllers that SOE
Recorder will be retrieving events from. The default Triconex controller configuration
information (IP addresses, host names, etc.) may be used as templates for your own controller
configurations.

When you click Defaults, all existing controller configurations will be


CAUTION deleted and replaced with the default configurations.

Using the Backup SOE Configuration File


If you upgraded to SOE Recorder 4.3.x from an earlier version, during the upgrade process, the
SOE Recorder installer checked for the existence of an SOE configuration file (SOE.cfg). This file
contains information about the controllers configured for event retrieval. If an
SOE configuration file was found, you were prompted to keep or discard the file.
If you chose to discard the existing file, a backup version of the file (SOE_bkp.cfg) was created
in the following directory: C:\Documents and Settings\All Users\Application
Data\Triconex\TcxSoe in Windows XP Professional and Windows Server 2003, or
C:\ProgramData\Triconex\TcxSoe in Windows Server 2008 and Windows 7.

Note If you upgraded to SOE Recorder 4.3.x from SOE Recorder 4.1.113 and chose to discard
the existing file, two backup files were created (SOE_bkp.cfg and
SOEBLKCFG_bkp.cfg). However, SOEBLKCFG_bkp.cfg cannot be used with SOE
Recorder 4.2.0 and later.
Before you can use the backup SOE configuration file, you must change the file name and copy
it to the correct directory.

Procedure
1 If SOE Recorder is open, close it before continuing.
2 In Windows Explorer, browse to the current SOE.cfg file in the following location:
C:\Documents and Settings\All Users\Application
Data\Triconex\TcxSoe\SoeConfig in Windows XP Professional and Windows Server
2003, or C:\ProgramData\Triconex\TcxSoe\SoeConfig in Windows Server 2008 and
Windows 7.
3 Rename the SOE.cfg file.
You can rename it to anything you like; we recommend SOE_orig.cfg.
4 Browse to the SOE_bkp.cfg file in the following location:
C:\Documents and Settings\All Users\Application Data\Triconex\TcxSoe in
Windows XP Professional and Windows Server 2003, or
C:\ProgramData\Triconex\TcxSoe in Windows Server 2008 and Windows 7.
5 Copy and paste the SOE_bkp.cfg file to the following location:

Triconex SOE Recorder User’s Guide, 4.3.x


44 Chapter 2 Configuring SOE

C:\Documents and Settings\All Users\Application


Data\Triconex\TcxSoe\SoeConfig in Windows XP Professional and Windows Server
2003, or C:\ProgramData\Triconex\TcxSoe\SoeConfig in Windows Server 2008 and
Windows 7.
6 Rename the SOE_bkp.cfg file to SOE.cfg.
7 Start SOE Recorder.
8 On the Tools menu, click Options, and then click the Communications tab.
9 Verify that the list includes the desired controller configuration.

Adding a Controller
This procedure describes how to add a new controller to the list of controllers that SOE Recorder
will be retrieving events from.

Procedure
1 If any events files are currently open, close them. , The controllers you configure during
this procedure will apply to the next events file you create.
2 On the Tools menu, click Options, and then click the Communications tab.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 45

3 Click Add. The IP Address dialog box appears:

Note If 63 nodes have already been configured, the Add button will be unavailable.
You must delete an existing node before you can add a new one.
4 In the IP Address dialog box, specify the following properties.

Property Description
Node Name Identifies the user-defined name for the controller. Each controller must
have a unique node name.
The default names are TRINODE01 (for node 1) through TRINODE63
(for node 63).
Node Number Identifies the controller’s node number. Each controller must have a
unique node number.
• For Tricon controllers, the node number must match the physical
switch settings (on the NCM or ACM) and the node address
specified in the TriStation 1131 project. (The TCM does not have a
physical node switch; its node is configured in TriStation 1131 only.)
The default values are from 1 to 31.
• For Trident or Tri-GP controllers, the node number must match the
address plug on the MP Baseplate and the node address specified in
the TriStation 1131 project. The default values are from 1 to 63.
IP Address Identifies the unique 32-bit network address of the primary
communication module in the Triconex controller.
If the default IP address was used in the TriStation 1131 application, you
can use the default address.
The highest and lowest IP addresses in a subnet (addresses where the
last number is 0 or 255, such as 192.168.1.255) are reserved for broadcast
messaging and cannot be used as a valid IP address.
See IP Address on page 105 for more information about valid IP
addresses.

Triconex SOE Recorder User’s Guide, 4.3.x


46 Chapter 2 Configuring SOE

Property Description
TSAA Port Specifies the port to be used for TSAA communication with the
controller.
The TSAA Port Number entered here should match the TSAA Port
Number you specified for the communications module in your
TriStation 1131 project. The default is 1500.
Multicast Select the check box to enable SOE Recorder to receive multicast
Enabled messages from the controller. The controller you are adding must be
configured, in your TriStation 1131 project, to use IP multicasting.
See Using Multicasting on page 48 for more information about
multicasting.
Multicast IP If you enabled Multicast, enter the Multicast IP address of the controller
Address to match the multicast IP address you specified for the controller in your
TriStation 1131 project.
The default is 0.0.0.0 (IP multicasting is disabled).

5 Click OK to save the controller configuration information.


Note Once you have configured a controller, you can select the specific blocks that SOE
Recorder can retrieve events from on that controller. This feature is optional and is
available only when you are collecting events in Custom mode; by default, all blocks are
selected for event retrieval. See Selecting the Blocks to Retrieve Events From in Custom
Mode (Optional) on page 50 for more information.

Changing a Controller’s Configuration


This procedure describes how to change the node name, node number, or IP address of a
controller configured for event retrieval.
If the default IP address was used in the TriStation 1131 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.

Procedure
1 If any events files are currently open, close them.
The controller information you change during this procedure will apply to the next
events file you create.
2 On the Tools menu, click Options, and then click the Communications tab.
3 In the list, select the node name of the controller you want to modify.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 47

4 Click Modify. The IP Address dialog box appears.

5 Edit the controller’s configuration information as required.


Note You cannot change the node name, node number, or IP address to a value that
has already been configured for another controller in the list.
6 Click OK to save the controller configuration information.

Deleting a Controller
This procedure describes how to remove a controller from the controller list.
If you delete a controller from the list, the associated controller will no longer be able to be
accessed by SOE Recorder, and events will not be retrieved.

Procedure
1 If any events files are currently open, close them.
The controllers removed during this procedure will apply to the next events file you
create.
2 On the Tools menu, click Options, and then click the Communications tab.
3 Select the node name of the controller you want to delete.
Note Before clicking Delete, be sure you want to remove this controller from the list,
as you are NOT asked to confirm your selection. The controller will be
immediately deleted from the list.
4 Click Delete.

Triconex SOE Recorder User’s Guide, 4.3.x


48 Chapter 2 Configuring SOE

Using Multicasting
Multicasting allows multiple clients to exchange data with the Triconex controller without
overloading your network. When multicasting is not used, all clients send messages to all
controllers at the same time, causing heavy network traffic.
IP multicasting allows the TCM, CM, or CIM to send one message to the multicast IP address,
instead of sending point-to-point or broadcast messages, reducing network traffic levels. All
clients (such as the Triconex SOE Recorder) that are listening to the multicast IP address will
receive the message at the same time.
TSAA IP multicasting is available only on the following Tricon, Trident, and Tri-GP systems:
• Trident 2.0 and later systems.
• Tri-GP 2.1 and later systems.
• Tricon 10.3 or later systems that have a TCM model 4351B, 4352B, 4353, or 4354
installed.
Note Model 4353 and 4354 TCMs must use NET 1. Multicasting is not available on NET 2
because it is reserved for OPC communication.
Additionally, your network hardware (such as routers) must also support multicasting. See
your Network Administrator or IT department for more information.
To use multicasting, you must configure the controller to support multicasting, in your
TriStation 1131 project and in SOE Recorder. Note that multicast configuration is available only
in TriStation 1131 4.2.0 or later.
For instructions on configuring your TriStation 1131 project, see the TriStation 1131 Developer’s
Guide. For instructions on configuring SOE Recorder, see Adding a Controller on page 44.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 49

Creating a Configuration for Custom Collection Mode


This procedure describes how to create a configuration file to use for collecting events in
Custom Collection Mode.
When SOE Recorder is in Primary Collection Mode and you edit the properties in the Options
dialog box, the primary configuration file (Soe.cfg) is automatically updated. When SOE
Recorder is in Redundant Collection Mode, the first time that you edit the properties in the
Options dialog box, the primary configuration file is automatically duplicated and renamed to
Soe_Redundant.cfg, and then your configuration changes are saved in the
Soe_Redundant.cfg file. However, you must manually create a configuration file for use in
Custom Collection Mode.

Procedure
1 On the File menu, click New Custom.
2 In the Open dialog box, type a name for the custom configuration file in the File name
box, and then click Open.
Note You cannot name the file with one of these reserved names: Soe.cfg,
Soe_Redundant.cfg, or SoeBlkCfg.cfg.
3 Click Yes, to create the file.
A message appears confirming that a new custom configuration file was created with a
default configuration.
4 Click OK.
A message appears prompting you to specify a node (controller) for polling.
5 Click OK.
For instructions on adding a controller (specifying a node), see Adding a Controller on page 44.
For instructions on selecting blocks to collect events from, see Selecting the Blocks to Retrieve
Events From in Custom Mode (Optional) on page 50.

Triconex SOE Recorder User’s Guide, 4.3.x


50 Chapter 2 Configuring SOE

Selecting the Blocks to Retrieve Events From in Custom Mode (Optional)


Once you have configured the Triconex controllers that SOE Recorder will be communicating
with to retrieve events, you can select the individual SOE blocks that SOE Recorder will collect
events from. Block selection must be completed prior to starting event retrieval in Custom
mode. If you will not be collecting events in Custom mode, you do not need to complete the
procedure in this section.
Note Block selection is available only when you are collecting events in Custom mode and is
an optional feature; by default, all SOE blocks are selected for event collection on all
configured controllers. If Redundant or Primary mode is selected, blocks are chosen
based on the defaults for those modes.
You can define specific SOE blocks for retrieval by SOE Recorder, while other SOE blocks in the
same application can be configured for retrieval in another sequence of events utility (such as
the Foxboro I/A Series workstation).
Only one sequence of events utility can access each block. You cannot assign the same block
for event retrieval by multiple SOE clients. If multiple clients are configured to access the same
block, neither client will receive all the event data.

There is no way for SOE Recorder to know if a block has already been
CAUTION configured for event retrieval in another SOE utility. It is up to you to
make sure that you do not configure multiple SOE clients to access the
same block. Multiple SOE clients accessing the same block can result in
loss of event data.

For each configured controller, all SOE blocks (regardless of block type) are available for
selection, even if they are not currently configured in the application running on the controller.
This allows you to configure a block for retrieval in advance of configuring the block in the
application. See Updating the List of Blocks to Collect Events From In Custom Mode on page 82
for more information.
To view the configuration status and/or block type for each block, use the TriStation 1131
software. See the TriStation 1131 Developer’s Guide for more information.
If none of the selected blocks are configured in the application running on the controller, the
following error message will appear in the Message Bar when SOE Recorder begins event
collection: “Unsuccessful send attempts made. Check the network connection.”.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 51

Selecting Blocks for Event Retrieval


This procedure explains how to select the specific blocks SOE Recorder will retrieve events from
for each configured controller when SOE Recorder is running in Custom mode.

Procedure
1 If any events files are currently open, close them.
The blocks you specify during this procedure will apply to the next events file you
create.
2 On the File menu, click New Custom.
3 Select or create a Custom .SED file., For more information, see Creating a New Events
File on page 69
4 On the Tools menu, click Options, and then click the Block Selection tab.

5 In the Configured Nodes list, select the controller you want to specify blocks for.
Only controllers that have already been configured on the Communications tab appear
in this list. See Configuring the Controllers to Retrieve Events From on page 42.
Note If you added a node to the list of configured controllers on the Communications
tab, but you don’t see it in the Configured Nodes list, click OK to close the dialog
box and then repeat step 2. The newly added node should then appear in the list.

Triconex SOE Recorder User’s Guide, 4.3.x


52 Chapter 2 Configuring SOE

6 In the Available Blocks list, select or clear the check box for each SOE block, as needed:
• If you want SOE Recorder to collect events from the block when connected to the
selected controller, select the check box for the block.
• If you do not want SOE Recorder to collect events from the block, clear the check
box for the block.
• To restore the default values (all blocks selected) for the selected controller, click
Defaults.
All blocks use the default name soe_blkX, where X is the block number (1 - 14).
7 When you have finished selecting blocks for the currently selected controller, click Save.
Click OK when the “saved configuration” confirmation message box appears.
Note You must click Save after you have completed your block selection for each
controller. If you select another controller in the Configured Nodes list prior to
clicking Save, your block selections will not be saved.
8 Repeat steps 5–7 for each configured controller.
9 When block selection for all configured controllers is complete, click OK.

Updating the Block Selection After Application Changes


After initial block selection is complete, if you change the block definitions in the TriStation 1131
application (add, change, or remove blocks), you must:
• Using the TriStation 1131 software, download the changed application to the controller
to generate a new SOE definition file.
• Update your block selection to reflect the new or changed blocks. See Selecting Blocks
for Event Retrieval on page 51.
If you add a block to the application and download the change to the controller, SOE Recorder
will not retrieve data from that block while in Custom mode until you have selected the block
for retrieval.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 53

Copying the SOE Definition File


The SOE definition file contains SOE block definitions and point properties for the tagnames
assigned to the SOE blocks. This file is generated on the TriStation PC when you download your
application to the controller. You must copy the file to the SOE Recorder’s SoeConfig directory
before SOE Recorder can begin retrieving events.
This procedure explains how to copy the SOE definition file to the SoeConfig folder on the SOE
Recorder PC.

Procedure
1 Ensure that an SOE-enabled application is downloaded to each Triconex controller that
will be collecting events.
2 On the TriStation PC, go to the folder where your TriStation 1131 projects are stored, and
locate the SOE definition file.
The file name includes the first eight characters of the TriStation 1131 project name, the
major version number, the minor version number, and a time code. For example:
SOE_EX_9_0_33F4CE47.SOE
The name of the file is displayed in the TriStation 1131 Message Bar when the application
is downloaded to the controller.
3 Copy the SOE definition file to the SoeConfig folder on the SOE Recorder PC.
The default location is: C:\Documents and Settings\All Users\Application
Data\Triconex\TcxSoe\SoeConfig in Windows XP Professional and Windows Server
2003, and C:\ProgramData\Triconex\TcxSoe\SoeConfig in Windows Server 2008
and Windows 7.
4 Repeat steps 2 and 3 for each controller that will be collecting events.

Do not rename the SOE definition file under any circumstances.


CAUTION Renaming it will prevent SOE Recorder from retrieving event data.

Triconex SOE Recorder User’s Guide, 4.3.x


54 Chapter 2 Configuring SOE

Configuring Display Options


This procedure explains how to configure the type and order of information to display—either
during event retrieval or when viewing a saved events file—in SOE Recorder.
By default, all 10 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 events 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 events file is open are saved when you close the file.

Procedure
1 On the Tools menu, click Options.

2 Specify these settings on the Display tab.

Property Description
Columns Select the column name check box to include a column in the display.
Clear the check box to remove a column from the display.
Move Up/Down Click on the column name to be moved (so that the column name is
Command highlighted), and then click Up or Down to move the column up or
down in the list.
Moving a column up in the list will move it left in the events file view;
moving it down in the list will move it right in the events file view.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 55

Property Description
Auto Scroll Select the Auto Scroll check box if you want event data to scroll
continuously during live event retrieval.
Auto Scroll does not apply while viewing a saved events file.
The default is selected.
Default Click to return to the default column order, which is:
• Date
• Time
• Alias
• Tagname
• Variable State
• Node
• Block
• Group1
• Group2
• Description

3 Click OK to save your changes.

Triconex SOE Recorder User’s Guide, 4.3.x


56 Chapter 2 Configuring SOE

Enabling Snapshot Mode


This procedure explains how to enable the Periodic and Auto Snapshot modes. A snapshot is a
file of events that are generated during a specific time period, or as a result of a designated
event.
You can enable snapshot mode before event retrieval, but not during event retrieval. If snapshot
mode is enabled, make sure that you have at least 4 GB of free space on the drive where you
installed SOE Recorder, to ensure you have enough space for the snapshot files that will be
generated.
Note You can also manually save a snapshot of events. See Manually Saving a Snapshot
During Event Retrieval on page 76.

Periodic Snapshots
A periodic snapshot is a file of all the events that are generated during a specific time period.
Daily, weekly, and monthly snapshots can be generated, as well as a shift snapshot. A shift
snapshot is based on specific time periods you designate for up to four weekday shifts and four
weekend shifts.
Periodic snapshot file names include the file name you select, the date and time of the snapshot,
and one of these file formats:
• _D.sed for daily snapshot
• _W.sed for weekly snapshot
• _M.sed for monthly snapshot
• _S.sed for shift snapshot
For example, in the file name Node7_20080215_10:20:15_W.sed:
• Node7_: The file name you selected.
• 20080215_10:20:15_: Year, day, month, hour, minute, and second when the snapshot
was taken. In this example, the snapshot was taken at 10:20:15 a.m. on February 15,
2008.
• _W.sed: The file format indicating that this is a weekly snapshot.

Creation of the periodic snapshot file is not complete until 5 minutes after
CAUTION the end of the specified time period.

Closing SOE Recorder immediately after the end of the specified time
period (before periodic snapshot file creation is complete) will corrupt the
periodic snapshot file and prevent it from being created.
Also, while the periodic snapshot file is being created, intermediate .dat
files are created in the same directory as the snapshot file. Do not open,
edit, or delete these files—doing so will corrupt the periodic snapshot
file and result in either an incomplete file, or no file at all.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 57

Auto Snapshots
An auto snapshot is a file of events that is saved automatically when a trip occurs or when a
specified number of events occurs. You can have snapshots taken when either or both situations
occur.

Procedure
1 On the Tools menu, click Options, and then click the Mode tab.

2 Do one or both of the following:


• To enable Periodic Snapshots, specify these properties:

Property Description
Periodic Snapshot Select the type of periodic snapshot you want to enable. Only one
type can be selected at any one time.
For example, if you enable weekly snapshots, you cannot also
enable monthly snapshots at the same time.
The default is None.

Triconex SOE Recorder User’s Guide, 4.3.x


58 Chapter 2 Configuring SOE

Property Description
Shift Definitions If you select Shift Snapshot, enter the shift times in hours, using 24-
hour notation, where 00:00 is midnight. If the shift end time is
earlier than the shift start time, it is assumed the shift ends the next
day.
Shift times cannot overlap. For example, if Shift 1 is configured to
be from 02:00 to 08:00, Shift 2 cannot be configured to be from 05:00
to 13:00, as this would cause a 3-hour overlap from 05:00 to 08:00.
Only the last shift of the day can start on one calendar day and end
on the next calendar day.
The Shift periods include the “From” time up to, but not including,
the “To” time. In other words, a shift beginning at 08:00 and ending
at 16:00 will contain events collected from 08:00:00 through
approximately 15:59:59.

• To enable Auto Snapshot, specify these properties:

Property Description
On Trip Events Select to save a snapshot when a trip occurs.
The number of minutes of event information saved before
and after a trip event is defined in TriStation 1131. See
Specifying a Trip Variable on page 33.
The default is selected.
On Max Events Select to save a snapshot when the maximum number of
events per file is reached.
The default is selected.
Maximum Events Per File Select the maximum number of events to be saved in a
single events file.
This is also the threshold value for when the auto snapshot
will be saved if you selected the On Max Events property.
From 1,000 to 100,000 in 1,000 event increments. The default
is 100,000.
To ensure that all events will be collected, consider the
number of controllers you will be collecting events from, as
well as the rate at which events are generated.
Several controllers, plus a high rate of event generation,
requires a higher maximum number of events value.

3 Click OK to save your changes.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 59

Changing the Events File Directory


This procedure explains how to change the location of the events file directory. This is the
directory where all events files, including snapshot files, are saved.
You can change the location before event retrieval, but not during event retrieval.
The default events file directory is found in the following locations:
• Windows XP Professional and Windows Server 2003: C:\Documents and
Settings\<yourusername>\My Documents\Triconex\Triconex Sequence of
Events Recorder 4.3.x
• Windows 7 and Windows Server 2008: C:\Users\<yourusername>\Documents
\Triconex\Triconex Sequence of Events Recorder 4.3.x .

Note The drive where the events file directory is located should have at least 4 GB of free
space, to ensure there is enough space for the events files that will be generated.

Procedure
1 On the Tools menu, click Options, and then click the Mode tab.
2 Under Events File Folder, enter the full path for where events files should be saved, or
click Browse to locate the desired directory.
3 Click OK to save your changes.

Triconex SOE Recorder User’s Guide, 4.3.x


60 Chapter 2 Configuring SOE

Configuring Automatic Export of Event Data


This procedure explains how to configure 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 is exported to the specified file every 20–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.
The maximum size of the journal file is 2 GB. Once this limit is reached, SOE Recorder will keep
collecting events, but the journal file will no longer be updated and a message will appear in the
Message Bar.
If this occurs, rename the existing journal file, or move it to another directory. SOE Recorder will
then automatically create a new journal file and restart the automatic export of event data.
Note Events that were collected during the time when automatic data export was stopped will
not be exported once the export activity resumes. To save these events, check the
Message Bar for the time period when automatic data export was stopped, and then save
a snapshot file from the events file (.sed) for that time period. See Manually Saving a
Snapshot During Event Retrieval on page 76.

Procedure
1 On the Tools menu, click Options, and then click the Auto Export tab.
2 Select the Auto Export to a journal file check box.

Triconex SOE Recorder User’s Guide, 4.3.x


Configuring SOE Recorder to Retrieve Events 61

3 Specify the following properties:

Property Description
Journal File Select dBASE IV or ASCII Delimited Text, depending on the type of
Format journal file you want to export events to.
Specify the Enter or browse for the journal file path, including the file name.
Absolute Path for The default path is:
a Journal File C:\Documents and Settings\<yourusername>\My
Documents\Triconex\Triconex Sequence of Events
Recorder 4.3.x in Windows XP Professional and Windows Server
2003, and
C:\Users\<yourusername>\Documents\Triconex\Triconex
Sequence of Events Recorder 4.3.x in Windows Server 2008
and Windows 7.
The default name for a Primary mode journal file is Journal.dbf or
Journal.txt, depending on the file format you selected.
The default name for a Redundant mode journal file is
Journal_Redundant.dbf or Journal_redundant.txt, depending on the
file format you selected.
The default name for a Custom mode journal file is
Journal_Custom.dbf or Journal_Custom.txt, depending on the file
format you selected.
If you plan to use the file with a dBASE IV application, the file name
should be no longer than eight characters.

4 Click OK.

Triconex SOE Recorder User’s Guide, 4.3.x


62 Chapter 2 Configuring SOE

Triconex SOE Recorder User’s Guide, 4.3.x


3
Retrieving and Analyzing Events

Overview 64
Retrieving Events 65
Analyzing Event Data 83

Triconex SOE Recorder User’s Guide, 4.3.x


64 Chapter 3 Retrieving and Analyzing Events

Overview
SOE Recorder can simultaneously retrieve event data from as many as 16 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.
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.
• 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.

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 65

Retrieving Events
This section describes how to retrieve events from one or more controllers.
When you create a new events 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 each block in an
CAUTION application running on a controller. If more than one client tries to read
data from the same block, neither client will get all of the event data.
Multiple SOE Recorder clients can read event data from a single controller
only as long as they are collecting events from different blocks.

Topics include:
• File Naming Conventions on page 66
• About SOE Collection Modes on page 67
• Creating a New Events File on page 69
• Starting Event Retrieval on page 72
• Filtering Events During Event Retrieval on page 73
• Sorting Events During Event Retrieval on page 74
• Manually Saving a Snapshot During Event Retrieval on page 76
• Re-Polling the Controller List During Event Retrieval on page 77
• Pausing Event Retrieval on page 78
• Viewing Message Bar and Status Bar Information on page 79
• Troubleshooting Event Retrieval on page 80

Triconex SOE Recorder User’s Guide, 4.3.x


66 Chapter 3 Retrieving and Analyzing Events

File Naming Conventions


Several types of files can be generated by SOE Recorder. The base events 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 events
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 describes the file naming conventions used by SOE Recorder.

File Part Description Example


Base name The name of the base file. Must be 35 characters or less. Node7
Date The year, month, and day the file was created. 20080410
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 T07.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

Trip File Example

Overlimit File Example


Base Name

Tricon08_ _ _ .SED
Minute

Seconds

Overlimit Indicator
Month
Year

Day

Hour

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 67

About SOE Collection Modes


SOE Recorder can run in three different modes:
• Primary Collection Mode
• Redundant Collection Mode
• Custom Collection Mode

Primary Collection Mode


In Primary Collection Mode, SOE Recorder collects events from all SOE blocks that have the
Block Collection Type defined as Automatic, and the Block Collection Mode defined as Primary.
For more information, see Primary SOE Block Collection Mode on page 26.
If you start and log in to SOE Recorder when there are no other instances of SOE Recorder
running in Primary mode on the PC, SOE Recorder starts in Primary mode.
There can be only one instance of SOE Recorder running in Primary mode on the same PC.
Note If you want to be able to select which blocks to collect events from, you can switch to
Custom mode by selecting New Custom from the File menu.

Redundant Collection Mode


In Redundant Collection Mode, SOE Recorder collects events from all SOE blocks that have the
Block Collection Type defined as Automatic, and the Block Collection Mode defined as
Redundant. For more information, see Redundant SOE Block Collection Mode on page 26.
If you start and log in to SOE Recorder when there is already an instance of SOE Recorder
running in Primary mode, the following message appears:
“Another instance of SOE Recorder is already opened in Primary mode. SOE Recorder will
open in Redundant mode.”
After you click OK, SOE Recorder starts in Redundant mode.
There can be only one instance of SOE Recorder running in Redundant mode on the same PC.
Note If you want to be able to select which blocks to collect events from, you can switch to
Custom mode by selecting New Custom from the File menu.

Custom Collection Mode


In Custom Collection Mode, you can select which blocks you want to collect events from,
regardless of the Block Collection Type and Block Collection Mode settings of the blocks. For
more information, see About SOE Block Types on page 23 and About SOE Block Collection
Modes on page 26.
You can use SOE Recorder in Custom Mode by selecting New Custom from the File menu. You
will be prompted to select a custom configuration file. For more information, see Creating a
Configuration for Custom Collection Mode on page 49.

Triconex SOE Recorder User’s Guide, 4.3.x


68 Chapter 3 Retrieving and Analyzing Events

After you select or create a custom configuration file, you can select the blocks that you want to
collect events from in the Block Selection tab of the Options dialog box. For more information,
see Selecting the Blocks to Retrieve Events From in Custom Mode (Optional) on page 50.
If you start and log in to SOE Recorder when there is already an instances of SOE Recorder
running in Primary mode and an instance of SOE Recorder running in Redundant mode, the
following message appears:
“Two instances of SOE Recorder are already opened in Primary and Redundant modes. SOE
Recorder will open in Custom mode.”
There can be up to three instances of SOE Recorder running in Custom mode on the same PC.

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 69

Creating a New Events File


This procedure explains how to create a new sequence of events data file so that events can be
retrieved from the configured controllers.
When you create a new events file, SOE Recorder performs the following actions to determine
which controllers are available:
• The IP addresses configured in the SOE Recorder controller list (see Configuring the
Controllers to Retrieve Events From on page 42) are polled to determine if they are
valid and if a physical connection can be made to the controller(s).
• Each controller is polled to determine whether an SOE-enabled application has been
downloaded and is currently running.
• The SOE definition files in the SoeConfig folder on the SOE Recorder PC are compared
to the application running on the controller(s) to determine whether they match.

Before You Begin


Make sure you have completed the following tasks:
• Copying the SOE Definition File on page 53
• Configuring the Controllers to Retrieve Events From on page 42
• Selecting the Blocks to Retrieve Events From in Custom Mode (Optional) on page 50
(optional)
• Enabling Snapshot Mode on page 56 (optional)
• Configuring Automatic Export of Event Data on page 60 (optional)
Note The location of the directory where the events file will be saved is obtained from the last-
used configuration. If you log in to SOE Recorder as a user without administrator
privileges, ensure that the Event File Folder is set to a location that you can access (Tools
> Options > Mode tab). For more, see Changing the Events File Directory on page 59.
Similarly, if you have configured automatic export of event data, ensure that the path for
the journal file is set to a location that you can access (Tools > Options > Auto Export
tab). For more, see Configuring Automatic Export of Event Data on page 60.

Procedure
1 In SOE Recorder, on the File menu, click New Primary, New Redundant, or New
Custom.
One of the following happens:
• For New Primary or New Redundant, the Create New SED File dialog box appears.
• For New Custom, you are prompted to select a custom configuration file. If you
have previously created a custom configuration file, select it. If not, create one. For
more information, see Creating a Configuration for Custom Collection Mode on
page 49.
2 In the File name field, enter a name for the events data file, and then click Create.

Triconex SOE Recorder User’s Guide, 4.3.x


70 Chapter 3 Retrieving and Analyzing Events

Note The file name must be 35 characters or less. If you do not enter .sed as the file
extension, it is automatically appended to the file name.
SOE Recorder polls the controllers in the controller list to determine if any of the
controllers are available for event retrieval. The results of the polling appear in the SOE
Retrieve window.

If the controller is available and the SOE definition file matches, the Retrieve check box
is selected.
The following properties are displayed in the SOE Retrieve window:

Property Description
Retrieve SOE? If selected, events will be collected from the controller.
Available (Y) only if the controller has a valid IP address, is running an
SOE-enabled application, and the SOE definition file matches the file
on the PC.
If any of the above conditions are not met (N), or if the controller status
is No SOE blocks started yet (see below), events cannot be collected from
the controller.
Node Displays the node name specified in the SOE Recorder controller list.
See Configuring the Controllers to Retrieve Events From on page 42.
Status Indicates whether SOE Recorder is able to communicate with a
controller that is running an SOE application. The following conditions
are possible:
• Project name and version: Identifies the name and version of the
downloaded TriStation 1131 application.
• No response: Indicates that SOE Recorder is unable to
communicate with the controller. See Connection to the Controller
Is Lost on page 80 for troubleshooting tips.
• No SOE blocks started yet: SOE Recorder is able to communicate,
but the application has not started generating events. Typically,
this is because the SOESTRT block has not been started. Manually
toggle the CI input to the TRUE state and then back to the FALSE
state to initiate SOE.

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 71

Property Description
SOE Configuration Indicates whether an SOE definition file has been located. If no file is
File found, ------------------ is displayed instead of a file name. For more
information, see Copying the SOE Definition File on page 53.
Match Indicates whether the SOE definition file matches the file used by the
controller (Y or N). If the files don’t match (N), you cannot retrieve
events from the controller.

3 To specify that a controller should be polled so that events can be retrieved, select the
Retrieve SOE? check box next to the node name.
4 Repeat step 3 for each controller you want to retrieve events from.
5 To refresh the display, on the Command menu, click Refresh Node List.

Triconex SOE Recorder User’s Guide, 4.3.x


72 Chapter 3 Retrieving and Analyzing Events

Starting Event Retrieval


This procedure explains how to start retrieving events from the selected controllers.
After you start event retrieval, events continue to be retrieved until you select the End Event
Retrieval command, or until the end of a snapshot period.
If periodic or auto snapshots are specified, they are automatically saved as separate files. If a trip
variable is specified in the TriStation 1131 application, a trip file is saved.
If the tagnames (event variables) have been specified in the TriStation 1131 application 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 on page 35.

Procedure
1 Create a new events file and then select the controllers to retrieve events from. See
Creating a New Events File on page 69.
2 With the SOE Retrieve window open, on the Command menu, click Begin Event
Retrieval.
SOE Recorder displays events in the events file as they are retrieved from the controller. If the
Auto Scroll option is selected (in Tools > Options), the list automatically scrolls as events occur.

The following properties are displayed in the events file.

Property Description
HRDI Icon Indicates that the event was collected from a High Resolution Digital Input (HRDI)
module.
Note that HRDI modules are available for use with Trident or Tri-GP controllers
only.
MP Icon Indicates that the event was collected from a Main Processor (MP).

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 73

Property Description
Date The date the event was collected from the controller.
Time The time the event was collected from the controller.
Alias The alias number of the tagname associated with the event.
Tagname The tagname associated with 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; see Specifying the State Name and Color
for Events on page 35.
Node The node number and name of the controller the event was collected from.
Block The SOE block number specified in the TriStation 1131 project.
Group1 A user-defined category for the tagname (if defined in the TriStation 1131 project).
Group2 A user-defined category for the tagname, which is subordinate to Group1 (if defined
in the TriStation 1131 project).
Description The tagname’s description.

Note You can change the order of the columns in the events file window. See Configuring
Display Options on page 54.

Maximum Number of Events Per File


By default, a maximum of 100,000 events can be saved to a single events file.
When the maximum number of events is reached, SOE Recorder will delete the oldest events to
make room for the new events. To avoid loss of event information, prior to starting event
retrieval, you should configure SOE Recorder to automatically create a snapshot (over-limit) file
when the maximum number of events is reached.
See Enabling Snapshot Mode on page 56 for instructions; see Overlimit File Example on page 66
for file naming conventions.

Filtering Events During Event Retrieval


This procedure explains how to filter the events that are displayed in the SOE Retrieve window.
You can filter event data while collecting events, in two ways:
• To show only events collected by High Resolution Digital Input (HRDI) modules. Note
that HRDI modules are available for use only with Trident or Tri-GP controllers.
• To show only events collected by Main Processors (MP).
By default, events are not filtered.

Procedure
• With the SOE Retrieve window open, on the Tools menu, do one of the following:

Triconex SOE Recorder User’s Guide, 4.3.x


74 Chapter 3 Retrieving and Analyzing Events

— To show only events collected by HRDI modules, click Filter HRDI Event.
— To show only events collected by MPs, click Filter MP Events.
The SOE Retrieve window is updated once every five seconds to display the events that
you specified. If you do not have Auto Scroll selected, you must scroll to the bottom of
the SOE Retrieve window to see the most recent events.
Note To view all events (unfiltered) again, click Remove Filter on the Tools menu.

Sorting Events During Event Retrieval


This procedure explains how to sort the events that are displayed in the SOE Retrieve window.
You can sort event data, before or while collecting events, in two ways:
• In ascending or descending order according to the ASCII character set.
• In a customized order based on the column headings.
By default, event data is sorted by date and time, in Ascending order (the most recent events at
the bottom of the list).

Procedure
1 With the SOE Retrieve window open, on the Tools menu, click Sort Events in Collection
Mode.

2 Specify the following properties on the Sort tab:

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 75

Property/Command Description
Order Select how you want event data to be arranged:
• Click Ascending to arrange events from the smallest to largest (1,
2, 3) or from first to last (a, b, c).
• Click Descending to reverse the normal sort order from the largest
to the smallest (3, 2, 1) or from last to first (c, b, a).
The default setting is Ascending.
Sort By Select the first column by which events are to be sorted.
This field is optional; if left blank, events will be sorted by the default:
date and time.
Then By Select the second and third columns by which events are to be sorted.
These fields are optional.

3 Click OK.
The SOE Retrieve window is updated once every five seconds to display events in the
sort order you specified. If you do not have Auto Scroll selected, you must scroll to the
bottom of the SOE Retrieve window to see the most recent events.
Note To view events in the default sort order again, click Clear All on the Sort tab, and
then click OK.

Triconex SOE Recorder User’s Guide, 4.3.x


76 Chapter 3 Retrieving and Analyzing Events

Manually 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 from the beginning of the event retrieval session, until the time the file is saved.
You can also use this command to take a snapshot of a previously saved events file.

Procedure
1 Start an event retrieval session. See Starting Event Retrieval on page 72.
2 On the Tools menu, click Save Snapshot. The Save Snapshot dialog box appears:

3 In the File name field, enter a name for the snapshot file, and then click Save.
If you do not enter .sed as the file extension, it is automatically appended to the file
name.

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 77

Re-Polling the Controller List During Event Retrieval


This procedure explains how—during event retrieval—to change the controllers that SOE
Recorder is currently retrieving events from by re-polling the controller list. Re-polling allows
you to add or remove controllers during event retrieval.
You should also re-poll the controller list after you have performed a TriStation 1131 Download
Changes command on an application running on a controller.
Re-polling is used to determine:
• If the SOE definition file changed because of a Download Changes command.
• If any new controllers have been configured in the SOE Recorder controller list.
If either of these conditions change, you should re-poll the controller list to verify the list of
currently available controllers, and the controllers that events are currently being retrieved
from.
Note Re-polling the controller list may take several minutes.

Procedure
1 During event retrieval, on the Commands menu, click Add/Remove Nodes. The
Add/Remove Nodes dialog box appears:

The List of Polling Nodes includes all the controllers that were available as of the last
poll. If the connection to a retrieving controller has been lost, it will not appear in the list.
• If the check box for a controller is selected, events are being retrieved from the
controller.
• If the check box for a controller is cleared, the controller is available, but events are
not being retrieved.
2 Do either of the following:

Triconex SOE Recorder User’s Guide, 4.3.x


78 Chapter 3 Retrieving and Analyzing Events

• If a Download Changes command has modified the application running on a


controller, copy the new SOE definition file to the SoeConfig folder on the SOE
Recorder PC, and then click Re-Poll.
• If a new controller has been configured in the SOE Recorder controller list, or a lost
connection has been restored, click Re-Poll to add the controller to the list of polling
nodes.
Depending on the size of the system, this action may take several minutes.
3 Once the List of Polling Nodes has been updated, do one or both of the following:
• To start retrieving events from a controller in the list, select the check box next to the
node name.
• To stop retrieving events from a controller in the list, clear the check box next to the
node name.
Note If you select or clear the check boxes for any of the controllers, the Re-Poll button
will be disabled. You must save your changes by clicking OK, and then access the
Add/Remove Nodes dialog box again to re-enable the Re-Poll button.
4 Click OK to save your changes.
Event retrieval from the controller(s) you changed in step 3 will start or stop
immediately.

Pausing Event Retrieval

To pause event retrieval:


1 On the Command menu, click End Event Retrieval.
2 Do NOT close the SOE Retrieve window.
3 When you are ready to resume event retrieval, on the Command menu, click Begin
Event Retrieval.
Event retrieval begins again from where it left off.

Ending Event Retrieval


To stop event retrieval, on the Command menu, click End Event Retrieval.

If a trip snapshot is specified in the TriStation 1131 application, and a trip


CAUTION has occurred, do not end event retrieval until the number of minutes
specified as Time After Trip has elapsed.

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 79

Viewing Message Bar and Status Bar Information


During event retrieval, you can view processing information in the Message Bar and Status Bar,
which are at the bottom of the screen.

Viewing the Message Bar


Typically, the Message Bar displays information affecting event retrieval that you could not
learn through any other means. To view the Message Bar, on the Window menu, click Show
Message Bar.

The following are examples of message content:


• Jan-17-2008 13:00:07 : TRINODE13 (Node# 13) clock out of sync
(01/17/0812:52:41)
• Jan-17-2008 13:12:17 : Create Max-Events file
'test1_20080117_131211_O.SED'
• Jan-17-2008 14:56:12 : TRINODE13 (Node# 13) 4 unsuccessful send
attempts made, check the network connection (or) traffic. Event
retrieval resumes automatically.

Viewing the Status Bar


The Status Bar displays the following types of information (from left to right) while events are
being retrieved:

• The number of events that have been collected, or the status of the current operation.
• The current operation:
— Send: Sending a request for event data to Triconex nodes.
— Recv: Receiving event data from Triconex nodes.
• Mode: Identifies whether a periodic snapshot is specified to be taken. For more
information, see Enabling Snapshot Mode on page 56.
• Auto Scroll: ON or OFF. For more information, see Configuring Display Options on
page 54.
• The current block collection mode: Primary, Redundant, or Custom.
For more information, see Configuring Your Application to Retrieve the Same Event
Data Using Multiple SOE Clients on page 27.
• The current time setting on the SOE Recorder PC.

Triconex SOE Recorder User’s Guide, 4.3.x


80 Chapter 3 Retrieving and Analyzing Events

Troubleshooting Event Retrieval


This section describes how to troubleshoot problems that may occur during event retrieval.
Topics include:
• Connection to the Controller Is Lost on page 80
• Errors During Automatic Data Export on page 81
• Changes to the Application on the Controller on page 81
• Unrecoverable Errors on page 82

Connection to the Controller Is Lost


SOE Recorder periodically checks each active connection to a node for time-outs. If more than 5
seconds elapse without a response 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.
SOE Recorder will continue trying to restore the connection indefinitely, until the connection is
successfully restored, or until you cancel the connection attempts. During this time, messages
appear in the Message Bar informing you of the disconnection and connection status of the
node.
Connection error messages include the following information:
• The date and time the connection/disconnection occurred.
• The node number of the affected controller.
• The reason for the connection / disconnection.
• Any action you may need to take to resolve the connection issue, if applicable.
When troubleshooting a connection problem, try the following:
• Verify that the network cable is still connected to both the controller and the SOE
Recorder PC.
• Verify that the IP address for the controller is correct.
• Use the ping command to verify that the SOE Recorder PC can see the controller on the
network.

Triconex SOE Recorder User’s Guide, 4.3.x


Retrieving Events 81

Errors During Automatic Data Export


If errors occur during the automatic export of event data, SOE Recorder places a status file called
SOE_STATUS.txt in the same directory as the journal file. Error codes provided in this file
describe the problem that was encountered during data export.
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 Recorder cannot get exclusive access to the journal file.
AUTOEXPT_0003 The journal file is invalid. SOE Recorder must create a new one.

Changes to the Application on the Controller


SOE Recorder will react differently to changes made to a TriStation 1131 application on a
controller, depending on how the changes were made—via the Download Changes command
or the Download All command.
Note See the TriStation 1131 Developer’s Guide for more information about using the Download
Changes and Download All commands.

When a Download Changes Command Is Performed


When a modified TriStation 1131 application is downloaded to a controller via the Download
Changes command, events continue to be retrieved by SOE Recorder, but they may not be based
on the same tagnames specified in the previous SOE definition file.
To ensure the correct events are being retrieved, the new SOE definition 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 Re-Polling the Controller List During Event Retrieval on
page 77.

When a Download All Command Is Performed


When a modified TriStation 1131 application is downloaded to a controller via the Download
All command, event retrieval is stopped while the controller is halted. SOE Recorder continues
to retrieve events from all other controllers.
After copying the updated SOE definition file to the SoeConfig folder on the PC, the Re-Poll
command should be used to restart event retrieval. For instructions, see Re-Polling the
Controller List During Event Retrieval on page 77.
Changes to the SOE definition file as a result of the modified application may also affect the
events being retrieved from other controllers, in addition to the events collected from the
controller the modified application was downloaded to.

Triconex SOE Recorder User’s Guide, 4.3.x


82 Chapter 3 Retrieving and Analyzing Events

Updating the List of Blocks to Collect Events From In Custom Mode


After a modified TriStation 1131 application has been downloaded to the controller, any new or
updated SOE blocks may need to be specified as blocks that SOE Recorder can retrieve events
from in Custom mode. See Selecting the Blocks to Retrieve Events From in Custom Mode
(Optional) on page 50.
• If a block is added to the application, but not specified in SOE Recorder as a block to
collect events from, events will not be retrieved from that block.
• If a block is added to the application, but it was already specified in SOE Recorder as a
block to collect events from, events will be retrieved from that block only after you have
updated the SOE definition file and re-polled the controller list.
• If a block is removed from the application, you should also remove it from the list of
selected blocks to prevent error messages from appearing in the Message Bar.

Unrecoverable Errors
In the case of an unrecoverable error, such as a disconnected cable, SOE Recorder will not close
the connection. If there is no response, SOE Recorder continues sending requests to the
controller and displays a notification in the Message Bar.

Triconex SOE Recorder User’s Guide, 4.3.x


Analyzing Event Data 83

Analyzing Event Data


This section provides information about the SOE Recorder commands that can help you analyze
your event data both during and after event retrieval.
Topics include:
• Viewing Saved Events on page 83
• Finding Events on page 86
• Filtering Event Data on page 87
• Sorting Event Data on page 89
• Saving a Filtered or Sorted Events File on page 91
• Exporting Events on page 92
• Viewing Status Bar Information During Analysis on page 93
• Working with Event Data Reports on page 93

Viewing Saved Events


This procedure explains how to view previously saved events.

Procedure
1 On the File menu, click Open. The Open dialog box appears.

Triconex SOE Recorder User’s Guide, 4.3.x


84 Chapter 3 Retrieving and Analyzing Events

2 Select the file with the events you want to view, and then click Open. The events file
opens in the SOE Analysis window.

When you first open a saved events file, all events are shown, sorted by date and time.
3 If desired, do one or both of the following:
• To reduce the number of events being displayed, based on criteria you specify, see
Filtering Event Data on page 87.
• To sort the list differently, see Sorting Event Data on page 89.

Viewing Event Data Properties


This procedure explains how to view the properties for a selected event.

Procedure
1 In the SOE Analysis window, double-click on the event whose properties you want to
view. The Event Data dialog box appears:

Triconex SOE Recorder User’s Guide, 4.3.x


Analyzing Event Data 85

2 View the following properties in the Event Data dialog box.

Property Description
Date & Time The date and time the event was collected from the controller.
Node The node number and name of the controller the event was collected
from.
Block The SOE block number specified in the TriStation 1131 project.
Group1 A user-defined category for the tagname (if defined in the TriStation 1131
project).
Group2 A user-defined category for the tagname, which is subordinate to Group1
(if defined in the TriStation 1131 project).
Event Type Indicates whether an event was collected from a High Resolution Digital
Input (HRDI) module or from a Main Processor (MP).
Note that HRDI modules are available for use with Trident or Tri-GP
controllers only.
Alias The alias number of the tagname associated with the event.
Tagname The tagname associated with the event.
Variable State The state of the tagname (event variable).
The state name and color can be changed; see Specifying the State Name
and Color for Events on page 35.
Description The tagname’s description.

3 Click OK to close the dialog box and return to the SOE Analysis window.

Copying Event Data


This procedure explains how to copy selected event data and paste it to another Windows-based
application (such as Microsoft Word® or Excel®). You can only copy one screen of data at a time.

Procedure
1 Open an existing event data file. See Viewing Saved Events on page 83.
2 Select the event or events you want to copy.
3 On the Tools menu, click Copy Event.
4 Paste the data into the desired location.

Triconex SOE Recorder User’s Guide, 4.3.x


86 Chapter 3 Retrieving and Analyzing Events

Finding Events
This procedure explains how to search a saved events file for an event that occurred at or after
a specified time.

Procedure
1 Open an existing events file. See Viewing Saved Events on page 83.
2 While viewing the SOE Analysis window, on the Tools menu, click Find Event.

3 Do one of the following:


• Enter the date the event you are looking for occurred on.
• Enter the date and time of the event you are looking for.
You do not need to enter the slashes or colons—SOE Recorder enters them
automatically.
4 Click Find.
The first event matching the specified date and time is highlighted in the SOE Analysis
window.
If an exact match is not found, the event closest to the specified time is highlighted.

Triconex SOE Recorder User’s Guide, 4.3.x


Analyzing Event Data 87

Filtering Event Data


This procedure explains how to set up filters to limit the number of events that are displayed in
the SOE Analysis window.
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.
Note Because events files are read-only, any filters you apply to the file are not permanent; if
you close and re-open the file, the filter will no longer be applied. However, you can save
the filtered version of the events file by saving a snapshot of the file—see Saving a
Filtered or Sorted Events File on page 91.

Procedure
1 Open an existing events file. See Viewing Saved Events on page 83.
2 While viewing the SOE Analysis window, on the Tools menu, click Filter and Sort
Events.

3 Specify the following properties on the Filters tab:


Note The more properties you specify, the more refined your filter will be. If you don’t
get the desired results when you apply your filter, remove properties to make
your filter less restrictive.

Property Description
Date & Time Enter the start and end date and time in the following format, using 24-hour
notation: mm/dd/yyyy—hh:mm:ss
You do not need to enter slashes or colons; SOE Recorder automatically
enters them for you.

Triconex SOE Recorder User’s Guide, 4.3.x


88 Chapter 3 Retrieving and Analyzing Events

Property Description
Group1 and Enter the name(s) of a group assigned to tagnames, as defined in your
Group2 TriStation 1131 project.
Node & Block Enter node numbers and/or block numbers, as described below.
• Enter a single node or block number, such as 14.
• Enter a range of node or block numbers, to view events for all nodes or
blocks included in the range, such as 10-12.
• Enter individual node or block addresses, separated by commas, to view
events for more than one node or block, such as 23,04,17.
• Enter a combination of individual node or block addresses and ranges,
such as 13,01-06,23,17-19.
Do not enter the alphanumeric names (such as TRINODE03) that may have
been assigned to controller nodes and SOE blocks in TriStation 1131.
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 a variable state, which is specified in your
TriStation 1131 project. The default is True or False.

Note If the value for a property is left blank, all values for that property will be
displayed in the filtered list.
4 Click OK.
The SOE Analysis window is updated to include only those events that match the
properties you specified. The total number of filtered events is displayed in the title bar
of the window.

Removing a Filter
Once a filter has been applied to an events file, you need to remove the filter to view all events
in the file again.
Note To save a filtered version of the events file, see Saving a Filtered or Sorted Events File on
page 91.

Procedure
1 While viewing a filtered events file, on the Tools menu, click Filter and Sort Events.
2 On the Filters tab, click Clear All.
3 Click OK.
The previously applied filter is removed, and all events in the file are displayed in the
SOE Analysis window.

Triconex SOE Recorder User’s Guide, 4.3.x


Analyzing Event Data 89

Sorting Event Data


This procedure explains how to sort the events that are displayed in the SOE Analysis window.
You can sort event data in two ways:
• In ascending or descending order according to the ASCII character set.
• In a customized order based on the column headings.
By default, event data is sorted by date and time, in ascending order (the most recent events at
the bottom of the list).
Note Because events files are read-only, the sort order you apply to the file is not permanent;
if you close and re-open the file, the default sort order will apply. However, you can save
the sorted version of the events file by saving a snapshot of the file—see Saving a Filtered
or Sorted Events File on page 91.

Procedure
1 Open an existing events file. See Viewing Saved Events on page 83.
2 While viewing the SOE Analysis window, on the Tools menu, click Filter and Sort
Events.
3 Click the Sort tab.

4 Specify the following properties:

Triconex SOE Recorder User’s Guide, 4.3.x


90 Chapter 3 Retrieving and Analyzing Events

Property/Command Description
Order Select how you want event data to be arranged:
• Click Ascending to arrange events from the smallest to largest (1,
2, 3) or from first to last (a, b, c).
• Click Descending to reverse the normal sort order from the largest
to the smallest (3, 2, 1) or from last to first (c, b, a).
The default setting is Ascending.
Sort By Select the first column by which events are to be sorted.
This field is optional; if left blank, events will be sorted by the default:
date and time.
Then By Select the second and third columns by which events are to be sorted.
These fields are optional.

5 Click OK.
The SOE Analysis window is updated to display events in the sort order you specified.
Note To view events in the default sort order again, click Clear All on the Sort tab, and
then click OK.

Triconex SOE Recorder User’s Guide, 4.3.x


Analyzing Event Data 91

Saving a Filtered or Sorted Events File


This procedure explains how to save a snapshot of a filtered or sorted events file.

Procedure
1 Open an existing events file. See Viewing Saved Events on page 83.
2 While viewing the SOE Analysis window, select a subset of the event data by doing
either of the following:
• Applying a filter or sort order to the file. See Filtering Event Data on page 87 and
Sorting Event Data on page 89.
• Selecting the events to be saved. Press CRTL to select multiple non-contiguous
events at once; press SHIFT to select multiple contiguous events.
3 On the Tools menu, click Save Snapshot. The Save Snapshot dialog box appears:

4 In the File name field, enter a name for the snapshot file, and then click Save.
If you do not enter .sed as the file extension, it is automatically appended to the file
name.

Triconex SOE Recorder User’s Guide, 4.3.x


92 Chapter 3 Retrieving and Analyzing Events

Exporting Events
This procedure explains how to manually export events from a saved events file to a database
or text file. Events can be exported to one of the following file formats:

File Format File Name Extension


Any dBASE IV application .dbf
Comma-delimited ASCII text records .txt

A database file (.dbf) can be opened by dBASE IV applications, such as Microsoft Excel, or
imported into dBASE IV applications, such as Microsoft Access. A database file may be much
larger than the saved events data file.
Note You can also export event data to other data formats using SAP® Crystal Reports®
software. For more information, see Working with Event Data Reports on page 93.
The exported file will contain ALL event information, even if you chose to not display selected
columns of event information in Configuring Display Options on page 54.
To export events during event retrieval, you must first create a snapshot of events (see Manually
Saving a Snapshot During Event Retrieval on page 76), and then export events from the saved
snapshot file.

Procedure
1 Open an existing events file. See Viewing Saved Events on page 83.
2 While viewing the SOE Analysis window, on the Tools menu, click Export Events. The
Export Events dialog box appears.
3 In the File name field, enter a name for the exported file.
4 In the Save as type field, select 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 to the new file.

Triconex SOE Recorder User’s Guide, 4.3.x


Analyzing Event Data 93

Viewing Status Bar Information During Analysis


The Status Bar displays the following types of information (from left to right) while a saved
events file is being viewed:

• Reminder to press F1 for Help documentation.


• The current operation:
— Stop: No communication with any Triconex controller.
• FILTER ON/OFF
— When ON, a filter is currently applied to the events file.
— When OFF, all events in the file are being displayed.
• SORT ON/OFF
— When ON, a custom sort order is currently applied to the events file.
— When OFF, the events file is sorted by date and time, in ascending order.
• The current time setting on the SOE Recorder PC.

Working with Event Data Reports


This section describes how to generate an event data report. This report can be printed and
searched. You can also export the report to a variety of formats, which can be saved to disk or
sent to an e-mail address.
The event data report is displayed through the Crystal Reports viewer, which is installed with
the SOE Recorder software. Custom reports must be created using Crystal Reports (which can
be purchased separately) or another dBASE IV-compatible reports generator.
Topics include:
• Generating a Report on page 94
• Exporting Report Data on page 95
• Working with Custom Reports on page 96

Triconex SOE Recorder User’s Guide, 4.3.x


94 Chapter 3 Retrieving and Analyzing Events

Generating a Report
This procedure explains how to generate an event data report.

Procedure
1 Open an existing events file. See Viewing Saved Events on page 83.
2 While viewing the SOE Analysis window, on the File menu, click Print.
The standard SOE List report appears in the report viewer window.

Note If you have created custom reports, they can be selected at the bottom of the
report viewer window. The selection list displays the report file name. For more
information, see Working with Custom Reports on page 96.
3 Perform any of the following tasks in the report viewer.

Command Action
Print Click to print the report being viewed.
Command Only one instance of SOE Recorder can print at a time. If
multiple instances are open and another instance is printing,
the Print command will be unavailable.
Export Report Click to export the report data to a file. For further instructions,
Command see Exporting Report Data on page 95.
Refresh Click to refresh the display, which re-loads event data to the
Command report.
Size of view Type or select a percentage to change the size of the report
view.
Search Text Click to search for text in the report.
Command

Triconex SOE Recorder User’s Guide, 4.3.x


Analyzing Event Data 95

Exporting Report Data


This procedure explains how to export report data. You can export a report to a variety of file
formats, and can save the exported data to a disk or send it to someone via email.

Procedure
1 Open an existing events file. See Viewing Saved Events on page 83.
2 While viewing the SOE Analysis window, on the File menu, click Print. The report
appears in the report viewer window.

3 On the report viewer toolbar, click the Export Report button .

4 Specify these properties in the Export dialog box.

Property Action
Format Select the file format. The default is PDF.
Destination Select the destination as either Disk file or Microsoft Mail. The
default is Disk.

5 Click OK to continue.
Depending on the format, additional information—such as the characters to use to
separate and delimit a file—may be requested.

Triconex SOE Recorder User’s Guide, 4.3.x


96 Chapter 3 Retrieving and Analyzing Events

Exported File Format


The format of an exported file is as follows:

Maximum Length
Column Name Format
(Number of Characters)
DATE Text 10
TIME Text 12
EVENT_TYPE Text 15
ALIAS Text 7
TAGNAME Text 12
STATE Text 12
NODE Text 12
BLOCK Text 70
GROUP1 Text 12
GROUP2 Text 12
DESCRIPTION Text 64

Working with Custom Reports


This procedure explains how to add and generate a custom report, which requires a database
(.dbf) file exported from SOE Recorder and one of the following:
• SAP Crystal Reports version 8.5 or later (see the SAP Crystal Reports website for
availability information)
Invensys strongly recommends using Crystal Reports because it is integrated with SOE
Recorder.
• Any other dBASE-compatible report generator
Note For more information about report generators, see the documentation for the report-
generating package of your choice.

Procedure
1 In SOE Recorder, export an events file to a dBASE file named ~SOERPT.dbf. See
Exporting Events on page 92.
2 Close SOE Recorder.
3 In the report-generating package, open ~SOERPT.dbf and create a custom report format.
4 Save the custom report format with a name of your choice and the extension .rpt.
5 Before starting SOE Recorder, place the report file in the SoeReports directory.
Placing the file in this directory makes it available for selection in the report list at the
bottom of the SOE Recorder report viewer window.

Triconex SOE Recorder User’s Guide, 4.3.x


Analyzing Event Data 97

6 Open SOE Recorder.


7 Open an existing events file. See Viewing Saved Events on page 83.
8 While viewing the SOE Analysis window, on the File menu, click Print.
The standard SOE List report appears in the report viewer window.
9 Verify that your custom report file name appears in the drop-down list at the bottom of
the report viewer window.

Note If you did not close SOE Recorder prior to moving your custom report file to the
SoeReports directory, you must close and re-open SOE Recorder in order for the
custom report to appear in the report list.
10 If desired, select the custom report, and then click Print or Preview.

Triconex SOE Recorder User’s Guide, 4.3.x


98 Chapter 3 Retrieving and Analyzing Events

Triconex SOE Recorder User’s Guide, 4.3.x


A
Commands and Properties

This appendix provides descriptions of SOE Recorder commands and properties.

Note Descriptions of the commands and properties used while configuring your TriStation
1131 application to enable SOE event retrieval can be found in Appendix A of the
TriStation 1131 Developer’s Guide.

Add Command
The Add command adds a new controller to the list of controllers that SOE Recorder will be
retrieving events from. You can add up to 63 controllers to the controller list, but a maximum of
31 can be Tricon controllers.
This command is available before or after event retrieval, but not during event retrieval.

Location
Tools menu > Options command > Options dialog box > Communications tab

Add/Remove Nodes Command


The Add/Remove Nodes command changes the controllers that SOE Recorder is retrieving
events from by re-polling the controller list during event retrieval. See Re-Poll Command on
page 112 for more information.
This command is available only during event retrieval.

Location
Command menu

Triconex SOE Recorder User’s Guide, 4.3.x


100 Appendix A Commands and Properties

Alias
The Alias property identifies the alias number of a tagname. Used as a filter to limit the number
of events that are displayed in the SOE Analysis window. Enter a single alias or a range of
aliases (two aliases separated by a dash). Use commas, dashes, or a combination of both.

Location
Tools menu > Filter and Sort Events command> Filter and Sort dialog box > 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. When enabled, event data is exported to the specified file every 20–30
seconds. You can enable this option before, during, or after event retrieval.

Location
Tools menu > Options command > Options dialog box > Auto Export tab

Auto Scroll
The Auto Scroll property defines the behavior of the event list during event retrieval. When
selected, the event list automatically scrolls vertically to keep the most recent events visible.
When cleared, the event list view does not change. You must manually use the vertical scroll bar
to view the most recent events.
Auto scroll does not apply while viewing a saved events file. You can enable this option before
or during event retrieval.
The default is selected (auto scroll enabled).

Location
Tools menu > Options command > Options dialog box > Display tab

Auto Snapshot
The Auto Snapshot properties specify the conditions under which an auto snapshot file should
be created: when a trip occurs, when a specified number of events occurs, or both.
This command is available before or after event retrieval, but not during event retrieval. It does
not apply while viewing a saved events file.
See On Trip Events on page 110 and On Max Events on page 110 for more information.

Location
Tools menu > Options command > Mode tab

Triconex SOE Recorder User’s Guide, 4.3.x


101

Begin Event Retrieval Command


The Begin Event Retrieval command starts the retrieval of event data from the selected
controllers.

Locations
Begin Event Retrieval button, or Command menu

Clear Command
The Clear command deletes all text in the Message Bar.

Location
Window menu > Show Message Bar command > Right-click in Message Bar

Clear All Command


The Clear All command deletes all user-specified settings in the Filter and Sort Events dialog
box. Each tab has its own Clear All command.

Locations
• Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Filters tab
• Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Sort tab

Close Command
The Close command closes the events file currently being viewed.
If the events file is actively collecting events, selecting the Close command will stop the retrieval
of event data from the selected controllers, save the previously collected events, and then close
the SOE Retrieval window.

Location
File menu

Triconex SOE Recorder User’s Guide, 4.3.x


102 Appendix A Commands and Properties

Columns
The Columns property specifies the type of event information to be displayed in an events file—
either during event retrieval or when viewing a saved events file. By default, all 10 columns of
event information are displayed in the order indicated on the screen.
You can change this property’s settings before or during event retrieval, or when viewing a
saved events file.

Location
Tools menu > Options command > Display tab

Copy Events Command


The Copy Events command copies selected event data from an events file and places it on the
clipboard.
This command is available only while viewing a saved events file.

Location
Tools menu

Date & Time


The Date & Time property limits the events displayed based on a specified date and time, in the
month/day/year/hour/minute/second format, using 24-hour notation.
For example: 12/31/2037 11:59:59 PM.
This property is available only while viewing a saved events file.

Locations
• Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Filters tab
• Tools menu > Find Event command > Find Event dialog box

Delete Command
The Delete command removes a controller from the list of controllers that SOE Recorder will be
retrieving events from.
This command is available before or after event retrieval, but not during event retrieval.

Location
Tools menu > Options command > Options dialog box > Communications tab

Triconex SOE Recorder User’s Guide, 4.3.x


103

End Event Retrieval Command


The End Event Retrieval command stops the retrieval of event data from the selected
controllers.
This command is available only when you are actively collecting events.

Locations
End Event Retrieval button, or Command menu

Events File Folder


The Events File Folder property specifies the directory where all events files, including snapshot
files, are saved.
The default events file directory is found in the following locations:
• Windows XP Professional and Windows Server 2003: C:\Documents and
Settings\<yourusername>\My Documents\Triconex\Triconex Sequence of
Events Recorder 4.3.x
• Windows Server 2008 and Windows 7: C:\Users\<yourusername>\Documents
\Triconex\Triconex Sequence of Events Recorder 4.3.x.

This property is available before or after event retrieval, but not during event retrieval. It is not
available while viewing a saved events file.

Location
Tools menu > Options command Options dialog box > Mode tab

Event Type
The Event Type property indicates whether an event was collected from an HRDI module or
from the MP. HRDI modules are available for Trident or Tri-GP controllers only.
Used as a filter to limit the number of events that are displayed in the SOE Retrieve window and
the SOE Analysis window.

Locations
HRDI and MP buttons

Triconex SOE Recorder User’s Guide, 4.3.x


104 Appendix A Commands and Properties

Exit Command
The Exit command closes the current events file and exits SOE Recorder.
If the events file is actively collecting events, selecting the Exit command will stop the retrieval
of event data from the selected controllers, save the previously collected events, and then close
the SOE Retrieval window before exiting the application.

Location
File menu

Export Events Command


The Export Events command exports an events file (.sed) to an ASCII text (.txt) file, or a dBase
IV-compatible (.dbf) file that can be opened in applications such as Microsoft Excel or Access.
Only the events that are currently being shown will be exported. To export all viewable events
in a file, be sure to remove all filtering options before exporting the file.
This command is available only when an events file is open for viewing. You cannot export an
events file that is actively collecting events.

Location
Tools menu

Filter and Sort Events Command


The Filter and Sort Events command allows you to limit and sort the events being displayed in
a saved events file.
This command is available only when an events file is open for viewing. You cannot filter or sort
an events file that is actively collecting events.

Location
Tools menu

Find Command
The Find command locates specified text in the Message Bar.

Location
Window menu > Show Message Bar command > Right-click in Message Bar

Triconex SOE Recorder User’s Guide, 4.3.x


105

Find Event Command


The Find Event command allows you to locate an event that occurred at or after a specified time.
See Date & Time on page 102 for more information.
This command is available only while viewing a saved events file.

Locations
Find Event button, or Tools menu

Group1 and Group2


The Group1 and Group2 properties limit the events displayed based on the names of tagname
groups assigned to event variables, as defined in your TriStation 1131 project. Group2 is
subordinate to Group1.
These properties are available only while viewing a saved events file.

Location
Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Filters tab

Hide Message Bar Command


The Hide Message Bar command closes the Message Bar at the bottom of the screen.
The Message Bar displays information affecting event retrieval.

Locations
Window menu, or right-click in the Message Bar

IP Address
The IP Address property specifies the unique 32-bit address of the primary communication
module in a Triconex controller on an Ethernet network.
A network uses IP addresses to route messages to their destinations. An IP address is formatted
as four numbers separated by periods, where each number can be zero to 255. An example is
1.160.10.240.
Every client and server in a network requires an IP address, which is either permanently or
dynamically assigned at startup. The defaults are as follows:
• Tricon ACM/NCM: 192.168.1.x
• Tricon TCM, Trident 2.x CM, Tri-GP CM, and Trident/Tri-GP 3.x CIM: 192.168.0.x for
NET 1; 192.168.1.x for NET 2
where x is the node number.

Triconex SOE Recorder User’s Guide, 4.3.x


106 Appendix A Commands and Properties

The following IP addresses are reserved and cannot be used as a valid IP address for a Triconex
communication module:
• The highest and lowest IP addresses in a subnet (addresses where the last number is 0
or 255, such as 192.168.1.255)—these addresses are reserved for broadcast messaging
• 0.x.x.x—default route address
• 127.x.x.x—loopback address
• 224.0.0.0 through 254.0.0.0—Class D or Class E addresses
This property is available before or after event retrieval, but not during event retrieval. It is not
available while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Communications tab > IP Address
dialog box

Journal File Format


The Journal File Format property specifies the format of the events file to be created from an
automatic export of event data. Options are dBASE IV (.dbf) or ASCII Delimited Text (.txt).
You can enable this option before, during, or after event retrieval.
See Auto Export to a Journal File on page 100 for more information.

Location
Tools menu > Options command > Options dialog box > Auto Export tab

Maximum Events Per File


The Maximum Events Per File property defines the maximum number of events that can be
saved to a single file. If desired, an auto snapshot can be generated when this value is reached.
From 1,000 to 100,000 in 1,000 event increments. The default is 100,000.
Note To ensure that all events will be collected, consider the number of controllers you will be
collecting events from, as well as the rate at which events are generated, when selecting
the value for this property. , Several controllers, plus a high rate of event generation,
requires a higher maximum number of events value.
This property must be set before event retrieval begins, but is not available while viewing a
saved events file.

Location
Tools menu > Options command > Options dialog box > Mode tab

Triconex SOE Recorder User’s Guide, 4.3.x


107

Modify Command
The Modify command changes the node name, node number, or IP address of a controller in the
list of controllers that SOE Recorder will be retrieving events from.
This command is available before or after event retrieval, but not during event retrieval.

Location
Tools menu > Options command > Options dialog box > Communications tab

Move Up/Down Command


The Move command changes the order in which columns are displayed in an events file by
moving the column up or down in the order. The first column in the list is displayed to the far
left, and the last column is displayed to the far right.

Location
Tools menu > Options command > Options dialog box > Display tab

Multicast Enabled
The Multicast Enabled property specifies the use of IP Multicasting on the controller. When
selected, SOE Recorder can receive multicast messages from the controller. The controller must
be configured, in the TriStation 1131 project, to use IP multicasting.
This property is available before or after event retrieval, but not during event retrieval. It is not
available while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Communications tab > IP Address
dialog box

Multicast IP Address
The Multicast IP Address property identifies the IP address specified for multicasting on your
controller. The IP address entered here should match the multicast IP address you specified for
the controller in your TriStation 1131 project. The default is 0.0.0.0 (IP multicasting is disabled).
This property is available before or after event retrieval, but not during event retrieval. It is not
available while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Communications tab > IP Address
dialog box

Triconex SOE Recorder User’s Guide, 4.3.x


108 Appendix A Commands and Properties

Network IP Address
The Network IP Address property defines the list of controllers that SOE Recorder will be
retrieving events from.
This property is available before or after event retrieval, but not during event retrieval.

Location
Tools menu > Options command > Options dialog box > Communications tab

New Custom Command


The New Custom command starts event collection in Custom mode, prompts you to select
blocks for collection, and creates a new sequence of events data file (.sed) so that events can be
retrieved from the configured controllers. If you use the name of an existing file, the data in the
existing file will be overwritten.
This command is available before or after event retrieval, but not during event retrieval.

Locations
New Custom button, or File menu > New Custom

New Primary Command


The New Primary command starts event collection in Primary mode and creates a new
sequence of events data file (.sed) so that events can be retrieved from the configured
controllers. If you use the name of an existing file, the data in the existing file will be overwritten.
This command is available before or after event retrieval, but not during event retrieval.

Locations
New Primary button, or File menu > New Primary

New Redundant Command


The New Redundant command starts event collection in Redundant mode and creates a new
sequence of events data file (.sed) so that events can be retrieved from the configured
controllers. If you use the name of an existing file, the data in the existing file will be overwritten.
This command is available before or after event retrieval, but not during event retrieval.

Locations
New Redundant button, or File menu > New Redundant

Triconex SOE Recorder User’s Guide, 4.3.x


109

Node & Block


The Node & Block property limits the events displayed based on the node and block type. Enter
node numbers and/or block numbers, as described below.
• Enter a single node or block number, such as 14.
• Enter a range of node or block numbers, to view events for all nodes or blocks included
in the range, such as 10-12.
• Enter individual node or block addresses, separated by commas, to view events for
more than one node or block, such as 23,04,17.
• Enter a combination of individual node or block addresses and ranges, such as 13,01-
06,23,17-19.

Do not enter the alphanumeric names (such as TRINODE03) that may have been assigned to
controller nodes and SOE blocks in the TriStation 1131 project.
This property is available only while viewing a saved events file.

Location
Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Filters tab

Node Name
The Node Name property identifies the user-defined name for the controller. Each controller
must have a unique node name.
The default names are TRINODE01 (for node 1) through TRINODE63 (for node 63).
This property is available before or after event retrieval, but not during event retrieval. It is not
available while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Communications tab > IP Address
dialog box

Node Number
The Node Number property identifies the controller’s node number. Each controller must have
a unique node number.
• For Tricon controllers, the node number must match the physical switch settings (on
the NCM or ACM) and the node address specified in the TriStation 1131 project. (The
TCM does not have a physical node switch; its node is configured in the TriStation 1131
project only.) The default values are from 1 to 31.
• For Trident and Tri-GP controllers, the node number must match the address plug on
the MP Baseplate and the node address specified in the TriStation 1131 project. The
default values are from 1 to 63.

Triconex SOE Recorder User’s Guide, 4.3.x


110 Appendix A Commands and Properties

This property is available before or after event retrieval, but not during event retrieval. It is not
available while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Communications tab > IP Address
dialog box

On Max Events
The On Max Events property saves an auto snapshot (over-limit file) when the maximum
number of events per file is reached. An auto snapshot is a file of events that is saved
automatically when the specified number of events occurs.
The over-limit file is identified with an O at the end; see File Naming Conventions on page 66
for more information.
This property is not available while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Mode tab

On Trip Events
The On Trip Events property saves an auto snapshot (trip file) 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.
The trip file is identified with a T at the end; see File Naming Conventions on page 66 for more
information.
This property is not available while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Mode tab

Open Command
The Open command opens a previously saved events file for analysis.

Locations
Open button, or File menu

Triconex SOE Recorder User’s Guide, 4.3.x


111

Order
The Order property changes the display order of event data in a saved events file.
• Click Ascending to arrange events from the smallest to largest (1, 2, 3) or from first to
last (a, b, c).
• Click Descending to reverse the normal sort order from the largest to the smallest (3, 2,
1) or from last to first (c, b, a).
The default is Ascending.
This property is available only while viewing a saved events file.

Location
Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Sort tab

Periodic Snapshot
The Periodic Snapshot property specifies when a periodic snapshot file should be created. A
periodic snapshot is a file of all the events that are generated during a specific time period.
Select the type of periodic snapshot you want to enable:

Option Description
None Does not take a periodic snapshot. This is the default selection.
Shift Snapshot Takes a snapshot based on weekday and weekend shift periods that you define.
See Shift Definitions on page 114.
Daily Snapshot Starts at midnight. Ends at 11:59 P.M. the next day.
Weekly Snapshot Starts at midnight on Sunday. Ends at 11:59 P.M. the following Saturday.
Monthly Snapshot Starts at midnight the first day of the month. Ends at 11:59 P.M. the last day of
the month.

Only one type can be selected at any one time. For example, if you enable weekly snapshots, you
cannot also enable monthly snapshots at the same time.
This command is available before or after event retrieval, but not during event retrieval. It does
not apply while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Mode tab

Triconex SOE Recorder User’s Guide, 4.3.x


112 Appendix A Commands and Properties

Print Command
The Print command generates an events data report. This report can then be printed or
searched.
Only the events that are currently being shown will be included in the generated report. To print
all viewable events in a file, be sure to remove all filtering options before generating a events
data report.
This command is available only when an events file is open for viewing. You cannot generate a
report from an events file that is actively collecting events.

Locations
Print button, File menu, or right-click Message bar

Refresh Node List Command


The Refresh Node List command polls the network and displays updated information for each
configured controller (node) in a newly-created events file.
• The IP addresses configured in the SOE Recorder controller list are polled to determine
if they are valid and if a physical connection can be made to the controller(s).
• Each controller is polled to determine whether an SOE-enabled application has been
downloaded and is currently running.
This command is available only after a new events file has been created, but before event
retrieval has begun.

Locations
Refresh Nodes button, or Commands menu

Re-Poll Command
The Re-Poll command polls the network—during event retrieval—to verify the list of currently
available controllers. Re-polling allows you to add or remove controllers during event retrieval.
Re-polling is used to determine:
• If the SOE definition file changed because of a Download Changes command.
• If any new controllers have been configured in the SOE Recorder controller list.
You should also re-poll the controller list after you have performed a Download Changes
command on an application running on a controller. This command is available only during
event retrieval.
Note Re-polling the controller list may take several minutes.

Location
Command menu > Add/Remove Nodes dialog box

Triconex SOE Recorder User’s Guide, 4.3.x


113

Save Command
The Save command saves all events that are currently stored in a temporary buffer to the open
events file.
This command is available only during event retrieval.

Locations
Save button, or File menu

Save As Command
The Save As command saves the currently selected events file, or Message Bar text, to another
file.
This command is available before or after event retrieval, or while viewing a saved events file,
but not during event retrieval.

Locations
File menu, or right-click Message Bar

Save Snapshot Command


The Save Snapshot command allows you to manually save a snapshot during event retrieval.
The snapshot file contains the events from the beginning of the event retrieval session, until the
time the file is saved. You can also use this command to take a snapshot of a previously saved
events file.

Location
Tools menu

Select Journal File Format


See Journal File Format on page 106.

Triconex SOE Recorder User’s Guide, 4.3.x


114 Appendix A Commands and Properties

Shift Definitions
The Shift Definitions property specifies the time periods for periodic shift snapshots. You can
specify up to four weekday shifts and four weekend shifts.
Enter the shift times in hours, using 24-hour notation, where 00:00 is midnight. If the shift end
time is less than the shift start time, it is assumed the shift ends the next day. For example, if Shift
4 starts at 23:00 (11 pm) and ends at 07:00 (7 am).
Shift times can start and end on different days but they cannot overlap. For example, if Shift 1
is configured to be from 02:00 to 08:00, Shift 2 cannot be configured to be from 05:00 to 13:00, as
this would cause a 3-hour overlap from 05:00 to 08:00.
The Shift periods include the “From” time up to, but not including, the “To” time. In other
words, a shift beginning at 08:00 and ending at 16:00 will contain events collected from 08:00:00
through approximately 15:59:59.
The duration of all four shifts cannot exceed 24 hours.
This command does not apply while viewing a saved events file.
See also Periodic Snapshot on page 111.

Location
Tools menu > Options command > Options dialog box > Mode tab

Show Message Bar Command


The Show Message Bar command shows the Message Bar at the bottom of the screen. The
Message Bar displays information affecting event retrieval.

Location
Window menu

Sort By
The Sort By property determines the first column by which events are to be sorted in a saved
events file. This property is optional. If left blank, events will be sorted by the default: date and
time.
This property is available only while viewing a saved events file.

Location
Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Sort tab

Triconex SOE Recorder User’s Guide, 4.3.x


115

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.
The default path is found in the following locations:
• Windows XP Professional and Windows Server 2003: C:\Documents and
Settings\<yourusername>\My Documents\Triconex\Triconex Sequence of
Events Recorder 4.3.x\journal.dbf
• Windows 7 and Windows Server 2008: C:\Users\<yourusername>\Documents
\Triconex\Triconex Sequence of Events Recorder 4.3.x

If you plan to use the file with a dBASE IV application, the file name should be no longer than
eight characters.

Location
Tools menu > Options command > Options dialog box > Auto Export tab

Tagname
The Tagname property identifies the name of a tagname. Used as a filter to limit the number of
events that are displayed in the SOE Analysis window.

Location
Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Filters tab

Then By
The Then By properties determines the second and third columns by which events are to be
sorted in a saved events file. These properties are optional. If left blank, events will be sorted by
the default: date and time. This property is available only while viewing a saved events file.
See also Sort By on page 114.

Location
Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Sort tab

Triconex SOE Recorder User’s Guide, 4.3.x


116 Appendix A Commands and Properties

TSAA Port
The TSAA Port property specifies the port to be used for TSAA communication with the
controller.
The TSAA Port Number entered here should match the TSAA Port Number you specified for
the communications module in your TriStation 1131 project. The default is 1500.
This property is available before or after event retrieval, but not during event retrieval. It is not
available while viewing a saved events file.

Location
Tools menu > Options command > Options dialog box > Communications tab > IP Address
dialog box

Variable State
The Variable State property identifies the state name of a tagname (event variable).Used as a
filter to limit the number of events that are displayed in the SOE Analysis window.
The default settings are TRUE and FALSE.

Location
Tools menu > Filter and Sort Events command> Filter and Sort dialog box > Filters tab

Triconex SOE Recorder User’s Guide, 4.3.x


Index

A C
ACM, compatibility 5 changing
Add command 99 controller configuration 46
Add/Remove Nodes command 77, 99 events file directory 59
adding controller 44 CI input, function blocks 37
Advanced Communication Module. See ACM. CIM
alias 73, 88 compatibility 28
Alias property 100 OPC UA, using with SOE 28
analyzing events Clear All command 101
copying event data 85 Clear command 101
event data properties 84 clear function block 40
exporting events 92 clock, PC 36
filter, removing 88 Close command 101
filtering events 87 CM, compatibility 5
finding events 86 collection modes
overview 64, 83 custom 67
reports, generating 93 primary 67
saving filtered or sorted events 91 redundant 67
sorting events 89 color monitoring 35
ascending sort 74, 89 color, tagnames 35
ASCII text format 61, 92 column order, events file 55
Auto Export to a Journal File property 100 Column property 102
Auto Scroll property 100 communication modules, compatibility 5
auto snapshots compatibility
overview 57 CIM embedded OPC UA server 28
properties 100 communication modules 5
automatic data export controller 4
configuring 60 Main Processors 4
troubleshooting 81 TCM embedded OPC server 28
configuration file, for Custom mode 49
B configuration file, SOE 42, 43
backup SOE configuration file 43 configuration steps 21
Begin Event Retrieval command 101 configuring SOE blocks 22
block header, SOE block 23 controllers
block number, filtering by 88 adding 44
block selection changing 46, 77
configuring 51 default configuration 43
description 50 deleting 47
Foxboro Evo System 28 error messages, connection 80
updating 52, 82 IP address 42, 45
blocks. See SOE blocks. lost connection 80
buffer, event storage 23, 30 maximum allowed 42
node name 45
node number 45

Triconex SOE Recorder User’s Guide, 4.3.x


118 Index

controllers (continued) event analysis (continued)


re-polling 77 filtering events 87
retrieving events from 72 finding events 86
SOE configuration file 43 generating reports 93
status of 70 overview 64
troubleshooting 80 procedures 83
controllers, compatibility with 4 saving filtered or sorted events 91
Copy Events command 85, 102 sorting events 89
copying viewing saved events 83
event data 85 event data
SOE definition file 53 copying 85
creating events file 69 exporting
Crystal Reports 92, 93, 96 automatically 60
problems with 81
custom collection mode 67
filter, removing 88
Custom mode, configuration file 49
filtering 73, 87
custom reports 96
properties 84
customer support iv reports 94
sorting 74, 89
D event retrieval
daily snapshots, overview 56 adding controllers during 77
Date & Time property 102 changing configured controllers 46
dBASE IV file format 61, 92 communication errors 80
dBASE report generators 96 configuration overview 42
.dbf files, format 96 configuring controllers 44
ending 78
default
pausing 78
column order, events file 55
removing controllers 47, 77
controller configuration 43
saving snapshot during 76
events file directory 59
selecting blocks for 50
journal file directory 61
snapshot mode, enabling 56
Delete command 102
sorting events 74
deleting controller configuration 47
starting 72
descending sort 74, 89 stopping 78
directory troubleshooting 70, 80
events file 59 Event Type property 103
journal file 61
event variables
disconnected cable 82 assigning to SOE blocks 31
display options, events file 54 data types of 31
Download All command 81 display options 54
Download Changes command 77, 81 monitor color 35
state names 35
E events
End Event Retrieval command 103 copying 85
ending event retrieval 78 filtering 87
filtering during retrieval 73
error codes, journal file 81
finding 86
error messages, connection 80
sorting 89
event, defined 2
sorting during retrieval 74
event analysis time stamps for 36
copying event data 85 events file
event data properties 84 auto scroll property 55
exporting events 92 base file name 66
filter, removing 88 column order 55

Triconex SOE Recorder User’s Guide, 4.3.x


Index 119

events file (continued) Group2 property 105


creating new 69
directory, changing 59 H
display options 54
Hide Message Bar command 105
exporting 92
Historical Block Type 24
file name for 69
filter, removing 88 Honeywell TDC 3000 DCS 28
filtered, saving 91
filtering 73, 87 I
generating report from 93 installing SOE Recorder 6, 7
maximum number of events 58, 73 IP address
naming conventions for 66 controller, configuring 42, 45
opening saved 83 default addresses 105
printing 94 reserved addresses 105
saving filtered or sorted 91 IP Address property 105
searching in 86 IP multicasting 48
sort order 75, 90
sorted, saving 91
sorting 74, 89
J
journal file
Events File Folder property 103
automatic event data export 60
Exit command 104
default directory for 61
Export Events command 92, 104
errors 81
exporting for saved events 92
events 92 format 61
reports 95 troubleshooting 81
troubleshooting 81 Journal File Format property 106
External Block Type 23
external devices, block type for 23
L
location
F events file directory 59
false color 35 journal file directory 61
false state name 35 logging in 9
file format, exported reports 96 logs
file names clearing user log 16
events file 69 saving user log to file 14
journal file 61 user login 13
periodic snapshots 56 lost connection, controller 80
SOE Recorder files 66
Filter and Sort Events command 104
M
filtering events 73, 87
Main Processors
Find command 104
compatibility with 4
Find Event command 86, 105 writing events to buffer 23
finding events 86 manually saved snapshot, creating 76
First Out Block Type 24 maximum
format, .dbf files 96 buffer size 30
Foxboro Evo System 28 number of events 58, 73
Foxboro I/A Series DCS 5, 28 Maximum Events Per File property 106
function blocks for event collection 37–41 Message Bar 79
Modified External Block Type 24
G Modify command 107
generating reports 93 monthly snapshots, overview 56
Group1 property 105 Move command 107

Triconex SOE Recorder User’s Guide, 4.3.x


120 Index

Multicast Enabled property 107 refreshing report view 94


Multicast IP Address property 107 removing events filter 88
multicasting, overview 48 Re-Poll command 112
multiple SOE clients 27 re-polling controllers 77
reports
N custom 96
naming conventions, SOE Recorder files 66 export file format 96
exporting 95
NCM compatibility 5
generating 94
Network Communication Module. See NCM.
overview 93
Network IP Address property 108
printing 94
New Custom command 108 refreshing 94
New Primary command 108 searching 94
New Redundant command 108 standard report 94
node requirements, system 6
adding and removing 77 retrieving events
name 45 filtering events 73
number 45, 88 sorting events 74
Node & Block property 109
Node Name property 109 S
Node Number property 109
Safety Manager Module. See SMM.
sample TriStation 1131 projects 22
O Save As command 113
On Max Events property 110 Save command 113
On Trip Events property 110 Save Snapshot command 76, 91, 113
OPC saved events, viewing 83
SOE block for 28 saving snapshot file manually 76
SOE block type for 28
searching
OPC Block Type 25 for events 86
OPC UA, SOE block type for 25 in reports 94
Open command 110 security banner, customizing text 11
Order property 111 Select Journal File Format property 113
overlimit file 66, 73 shift definitions 58
Shift Definitions property 114
P shift snapshots, overview 56
pausing event retrieval 78 Show Message Bar command 114
Periodic Snapshot properties 111 SMM
periodic snapshots, overview 56 compatibility 5
point properties, in SOE definition file 53 SOE block type for 24
primary collection mode 67 snapshot mode 56
Primary SOE block collection mode 26 snapshots
Print command 112 file naming conventions for 66
printing manually saving 76
events file 94 overview 56
reports 94 SOE, OPC, using with 28
properties, SOE block 28 SOE Analysis window 84
SOE block collection mode
R primary 26
redundant 26
redundant collection mode 67
SOE Block Collection Mode property 26, 31
Redundant SOE block collection mode 26
SOE block collection modes 26, 27
Refresh Node List command 112

Triconex SOE Recorder User’s Guide, 4.3.x


Index 121

SOE blocks SOE Retrieve window 70


block collection modes 26 SOE_STATUS.txt file 81
block header 23 SOE.cfg file 43
contents of 23 SOECLR function block, properties 40
event variables, assigning to 31 SoeReports directory 96
External 23 ~SOERPT.dbf file 96
First Out 24
SOESTAT function block, properties 41
Historical 24
SOESTOP function block, properties 39
Modified External 24
OPC 25 SOESTRT function block, properties 38
properties, defining 27, 28 Sort By property 114
selecting for retrieval 50 sort order, events file 75, 90
status 41 sorting events 74, 89, 91
tagnames, assigning to 31 Specify the Absolute Path for a Journal File
types 23 property 115
updating selected 82 start function block 38
SOE buffer size 30 starting, SOE Recorder 9
SOE configuration 20 starting event retrieval 72
SOE configuration file 42, 43 state name, tagnames 35
SOE definition file Status Bar 79, 93
changed 77 status function block 41
comparison of 69 stop function block 39
compatibility 4 stopping event retrieval 78
copying to SoeConfig folder 53
system requirements 6
matching 71
SOE for OPC 28
SOE function blocks
T
adding to TriStation 1131 application 37 Tagname property 115
CI input 37 tagnames
descriptions 37–41 assigning to SOE blocks 31
SOECLR 40 display options 54
SOESTAT 41 monitor color 35
SOESTOP 39 state names 35
SOESTRT 38 TCM, compatibility 5
SOE functionality diagram 2 technical support iv
SOE List report 94 text file format 61
SOE Recorder Then By property 115
adding controller 44 time after trip 34
changing controller 46 time before trip 34
compatibility 4 time stamps
configuration 20, 21 event 36
configuring controllers for 42 SOECLR 40
connection problems 80 SOESTOP 39
controller status 70 SOESTRT 38
deleting controller 47 time synchronization
display options 54 description of 36
installing 6, 7 setting PC clock for 36
logging in 9 time stamps 36
multiple clients 27, 28 Tricon Communication Module. See TCM.
overview 2 Tricon TCM
starting 9 compatibility 28
system requirements 6 OPC 28
uninstalling 8
Triconex contact information iv
SOE Recorder collection modes 67

Triconex SOE Recorder User’s Guide, 4.3.x


122 Index

Trident Communication Module. See CM. wildcard characters, filtering 87


Tri-GP Communication Module. See CM. Windows Event Viewer, changing options 15
trip snapshots Windows, supported versions 6
configuring 57
sample file name 66
trip state 34
trip tagname 34
trip variable
assigning 33
properties 33
TriStation 1131
conditional statements 37
Download All command 81
Download Changes command 81
function blocks, SOE 37
IP address, default 46
project version number 53
sample projects 22
SOE definition file generation 53
troubleshooting
automatic data export 81
cannot retrieve events 70
connection problems 80
disconnected cable 82
event retrieval 80
login problems 10
unrecoverable errors 82
true color 35
true state name 35
TSAA Port property 116
TSAA protocol, multicasting with 48

U
uninstalling SOE Recorder 8
unrecoverable errors 82
user access
clearing log of 16
saving log of 14
viewing log of 13

V
variable state 73
Variable State property 116
viewing
event data properties 84
Message Bar 79
saved events 83
Status Bar 79, 93

W
web site, Triconex iv
weekly snapshots, overview 56

Triconex SOE Recorder User’s Guide, 4.3.x


Invensys
10900 Equity Drive
Houston, TX 77041
United States of America
http://iom.invensys.com

Global Customer Support


Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424 or contact your
local Invensys representative.
Website: http://support.ips.invensys.com

También podría gustarte