UM5500

Download as pdf or txt
Download as pdf or txt
You are on page 1of 194

U

PID

A/D

RAM
F
GLOBAL
SUPPLIERS
OF
TURBINE
ID
AND
COMPRESSOR
CONTROL
SYSTEMS

UM5500 TrainTools Product Overview and Setupmanual

TrainTools
Product Overview
and Setup

Publication UM5500 (5.0.0)


Product Version: 6.1
System Release: 6.1
May 2007

Documentation Feedback Form

4725 121st Street

Des Moines, Iowa 50323, U.S.A.

Phone: (515) 270-0857

Fax: (515) 270-1331

Web: www.cccglobal.com
© 2002-2007, Compressor Controls Corporation. All rights reserved.
This manual is for the use of Compressor Controls Corporation and is
not to be reproduced without written permission.
Air Miser, Guardian, Recycle Trip, Reliant, Safety On, SureLink, TTC,
Total Train Control, TrainTools, TrainView, TrainWare, Vanguard,
Vantage, WOIS, and the TTC and impeller logos are registered trade-
marks; and COMMAND, TrainPanel, and the Series 3++ and Series 5
logos are trademarks of Compressor Controls Corporation. Other
company and product names used in this manual are trademarks or
registered trademarks of their respective holders.
The control methods and products discussed in this manual may be
covered by one or more of the following patents, which have been
granted to Compressor Controls Corporation by the United States
Patent and Trademark Office:
4,949,276 5,347,467 5,508,943 5,609,465
5,622,042 5,699,267 5,743,715 5,752,378
5,879,133 5,908,462 5,951,240 5,967,742
6,116,258 6,217,288 6,317,655 6,332,336
6,494,672 6,503,048
Many of these methods have also been patented in other countries,
and additional patent applications are pending.
The purpose of this manual is only to describe the configuration and
use of the described products. It is not sufficiently detailed to enable
outside parties to duplicate or simulate their operation.
The completeness and accuracy of this document is not guaranteed,
and nothing herein should be construed as a warranty or guarantee,
expressed or implied, regarding the use or applicability of the
described products. CCC reserves the right to alter the designs
or specifications of its products at any time and without notice.
TrainTools Product Overview and Setup 3

Document Scope
This manual provides an overview of and set up instructions for our TrainTools soft-
ware products:
Chapter 1 introduces our TrainTools software packages.
Chapter 2 discusses the TrainTools data communication and recording pro-
grams and underlying client-server protocols.
Chapter 3 describes the TrainView Operator Interface Program and Archival
Database Utilities.
Chapter 4 discusses the communication of process data and TrainView pic-
tures via TrainTools web services.
Chapter 5 describes the Platform Engineering Utilities, which are used to con-
figure and tune CCC controllers.
Chapter 6 describes the Project Engineering Utilities and TrainTools project
engineering process.
Chapter 7 discusses the Series 5 Controller emulation program.
Appendix A lists and defines the basic terms used to describe TrainTools pro-
grams and their underlying concepts.
Appendix B tells how to set up and maintain a TrainTools workstation.
Appendix C tells how to create custom and automated methods for starting
TrainTools programs.
Appendix D discusses various Windows and TrainTools security features and
tells how to use the Administrator program.
Appendix E discusses various issues that arise when TrainTools client and
server functions are distributed among a group of PCs.
Additional TrainTools product information can be found in the following documents:
DS5501 TrainTools Workstation Software Computer System Requirements
MS79 Software License Agreement
TN31 Upgrading to TrainTools Version 3.0

May 2007 UM5500 (5.0.0)


4 Contents

TrainTools Documentation Road Map Are Here


You

TrainTools Product Overview and Setup [UM5500]


provides an overview of and set-up instructions for our
TrainTools software products.

Communication Programs Operator Interface Programs

Modbus/OPC Gateways [UM5502] Archival Data Viewers [UM5521]


tells how to use the TrainTools Modbus to OPC and tells how to use the Archive Reporter, Exporter, and
OPC to Modbus communication gateway programs. Viewer programs to review recorded data.

Series 3 OPC Server [UM5503] TrainView Program [UM5522]


tells how to use the TrainTools OPC data access server tells how to use a typical TrainView workstation to
for Series 3 / 3 Plus / 3++ Controllers. operate a CCC turbomachinery control system.

Series 4 OPC Server [UM5504] Emulator Program [UM5523]


tells how to use the TrainTools OPC data access server tells how to use simulation programs to demonstrate
for Series 4 Controllers. and test the operation of TrainTools HMI programs.

Series 5 OPC Server [UM5505]


tells how to use the TrainTools OPC data access and
alarm and event server for Series 5 Controllers.

Web Server and Workstation [UM5509]


tells how to use TrainViewWeb and the TrainTools Web
Communication programs.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 5

TrainTools Documentation Road Map


TrainTools Product Overview and Setup [UM5500]
provides an overview of and set-up instructions for our
TrainTools software products.

Field Engineering Programs Project Engineering Programs

Series 5 Engineering Utilities [UM5512] Project Builder Program [UM5531]


tells how to use the field engineering utilities for Series describes the Project Builder program and tells how to
5 Vanguard and Reliant Controllers. create and manage control system projects.

Series 3 Engineering Utilities [UM5513] PC Communication Engineering [UM5532]


tells how to use the field engineering utilities for Series tells how to define the project elements that govern the
3 / 3 Plus / 3++ Controllers. communication and recording of process data.

Series 4 Engineering Utilities [UM5514] Archival Data Report Engineering [UM5533]


tells how to use the field engineering utilities for Series tells how to specify and design tabulated reports of
4 Controllers. archived OPC data.

Series 5 Control System Engineering [UM5535]


discusses aspects of the project engineering process
that are specific to Series 5 Control Systems.

May 2007 UM5500 (5.0.0)


6 Contents

Documentation Conventions
The document title appears in the header of each odd-numbered
page, while the chapter or appendix title appears in the header of
even-numbered pages. Odd-page footers list the document number
and revision level [UM5500 (5.0.0)], while even-page footers provide
the publication date (May 2007).
Acronyms are defined in the sections of this manual that discuss the
corresponding subjects, by placing them in parentheses following
the spelled-out terms they represent. As an example, a three-letter
acronym (TLA) is a way to represent a three-word subject by com-
bining and capitalizing the initial letters of those three words. Most
are also listed under Symbols and Acronyms on page 14.
Cross-references to other documents specify a section and chapter,
while cross-references between chapters of this document specify a
page number. References that do not specify a location are internal
to the chapter in which they appear. In computerized versions of this
manual, all such references are hot-linked to their target locations
and appear in green. Entries in the tables of contents, illustration
and table lists, and index are also hot-linked but are not green.
Attention may be drawn to information of special importance by
using this text styling or one of the following structures:

Note: Notes contain important information that needs to be emphasized.

Cautions contain instructions that, if not followed, could lead to irre-


Caution: versible damage to equipment or loss of data.

Warnings contain instructions that, if not followed, could lead


Warning! to personal injury.

The appearance of this electrical hazard warning symbol on CCC


equipment or the word Warning appearing in this manual indicates
dangerously-high voltages are present inside its enclosure. To
reduce the risk of fire or electrical shock, do not open the enclo-
sure or attempt to access areas where you are not instructed to do
so. Refer all servicing to qualified service personnel.

The appearance of this user caution symbol on CCC equipment or


the word Caution appearing in this manual indicates damage to the
equipment or injury to the operator could occur if operational proce-
dures are not followed. To reduce such risks, follow all procedures
or steps as instructed.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 7

Table of Contents
Document Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
TrainTools Documentation Road Map . . . . . . . . . . . . . . . . . . . . . . . . . 4
Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Table of Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
List of Figures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Symbols and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapter 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
TrainTools Software Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Data Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Platform Communication Servers. . . . . . . . . . . . . . . . . . . . . . . . . . 20
Archive Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Operator Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
TrainView Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Archival Data Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
TrainTools Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Platform Engineering Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Project Engineering Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Series 5 Emulator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Chapter 2 Data Communication Programs . . . . . . . . . . . . . . . . . . . . . . . . . 25
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Communication Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Component Object Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
OLE for Process Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
OPC Online Data Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Alarm and Event Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
AE Message Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Archival Database Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Platform Communication Package. . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Series 5 OPC Server Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
S5 OPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
S5 AES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Series 4 OPC Server Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Series 3 OPC Server Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Modbus Master OPC Server Program . . . . . . . . . . . . . . . . . . . . . . 39
Generic Controller AE Server Program . . . . . . . . . . . . . . . . . . . . . 40
Script Engine Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
SE OPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
SE AES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Modbus Slave OPC Client Program. . . . . . . . . . . . . . . . . . . . . . . . 43

May 2007 UM5500 (5.0.0)


8 Contents

TV1 OPC Server Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44


SCI Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Archive Server Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
Archival Data Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Tagged Data Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Critical Event Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
ArcCom Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
Database Space Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . .48
Chapter 3 Operator Interface Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
ActiveX Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Events Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Alarms Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Trends Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
IOView Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Map Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Gas Turbine Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Compressor Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
TrainView Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
TrainView Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Dynamic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
TV Pictures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
TrainView Template Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Archival Data Utilities Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Archive Reporter Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
Reporter Agent Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
Archive Viewer Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Archive Exporter Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Chapter 4 Web Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
WebServices Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
WebGateway Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
TrainViewWeb Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Chapter 5 Field Engineering Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Configurator Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Series 5 Configurator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Series 4 Configurator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Series 3 Plus Configurator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
Series 5 Duplex Supervisor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Fast Recorder Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Alarm Monitor Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 9

Chapter 6 Project Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Project Engineering Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Project Unzip Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
TrainTools HMI Engineering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Series 5 Controller Engineering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Application Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Chapter 7 Controller Emulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Series 5 Emulator Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Emulator OS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Emulator Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
IO Simulation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Appendix A TrainTools Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Appendix B Installation and Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
CCC Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
TTC Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
TrainTools Setup Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Default Installation of Licensed Packages . . . . . . . . . . . . . . . . 100
Custom Installation of Selected Software. . . . . . . . . . . . . . . . . 106
Modification of Installed Software. . . . . . . . . . . . . . . . . . . . . . . 107
Repair of Installed Components . . . . . . . . . . . . . . . . . . . . . . . . 109
Removal of All TrainTools Software . . . . . . . . . . . . . . . . . . . . . 109
TTC Patch Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Windows 2000 Service Pack 4. . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Internet Explorer 6 Service Pack 1. . . . . . . . . . . . . . . . . . . . . . . . 113
Internet Information Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Power Management Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Adobe Reader Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Site Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Project Folders and Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
TrainTools Information Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
TrainTools Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
License Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Revision Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Software Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Hard Drive Defragmentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

May 2007 UM5500 (5.0.0)


10 Contents

Appendix C Starting TrainTools Programs . . . . . . . . . . . . . . . . . . . . . . . . . .125


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Run Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Shortcut Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
Path Environment Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
Documents and Settings Subdirectories . . . . . . . . . . . . . . . . . . . . . .129
Desktop Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Favorites Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Start Menu Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Startup Program Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
TrainTools Program Group . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
Start Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
Classic Start Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
XP Start Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132
All Programs Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133
Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134
Custom Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135
Default Projects Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
Command Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
Archival Communication Program . . . . . . . . . . . . . . . . . . . . . . . . .137
TrainView Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
Archive Reporter Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138
Reporter Agent Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139
Modbus Slave Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139
Series 5 Operator Panel Program . . . . . . . . . . . . . . . . . . . . . . . . .140
Appendix D Security Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
Windows Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
Domains and Workgroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
Network Identity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
Local Account Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144
File System Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
Converting From FAT to NTFS . . . . . . . . . . . . . . . . . . . . . . . . .147
NTFS File Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
TrainTools Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
Administrator Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
Creating the Accounts Database . . . . . . . . . . . . . . . . . . . . . . . .150
Modifying the Accounts Database . . . . . . . . . . . . . . . . . . . . . . .151
Controller Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
Series 5 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
Series 4 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
Series 3 Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 11

Appendix E Networked TrainTools HMIs . . . . . . . . . . . . . . . . . . . . . . . . . . . 155


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Distributed Communication Options. . . . . . . . . . . . . . . . . . . . . . . . . 156
Network Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Connection Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Name Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Controller Communication Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Project Database Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Share Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Mapping Drives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
DCOM Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Network Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
DCOM Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Default Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Customizing Individual Servers . . . . . . . . . . . . . . . . . . . . . . . . 170
XP Service Pack 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Firewall Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Windows XP Firewall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Time Synchronization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

May 2007 UM5500 (5.0.0)


12 Contents

List of Figures
Figure 1-1 TrainTools Components and Communication Paths . . . . . . . . . . . . . .18
Figure 1-2 Distributed TrainTools HMI Example. . . . . . . . . . . . . . . . . . . . . . . . . .19
Figure 1-3 TrainTools Data Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Figure 1-4 TrainTools Operator Interface Programs. . . . . . . . . . . . . . . . . . . . . . .21
Figure 1-5 TrainTools Web Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Figure 1-6 TrainViewWeb Loading and Operation . . . . . . . . . . . . . . . . . . . . . . . .22
Figure 1-7 TrainTools Field Engineering Utilities . . . . . . . . . . . . . . . . . . . . . . . . .23
Figure 1-8 TrainTools Project Engineering Utilities. . . . . . . . . . . . . . . . . . . . . . . .24
Figure 1-9 Series 5 Control System Training and Testing . . . . . . . . . . . . . . . . . .24
Figure 2-1 TrainTools Platform Communication and Archive Servers . . . . . . . . .25
Figure 2-2 Master-Slave versus Client-Server Communication . . . . . . . . . . . . . .26
Figure 2-3 OPC Online Data Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Figure 2-4 TrainTools Alarm and Event Communication . . . . . . . . . . . . . . . . . . .31
Figure 2-5 TrainTools Archival Data Communication . . . . . . . . . . . . . . . . . . . . . .33
Figure 2-6 OPC/DA and AE Server Programs . . . . . . . . . . . . . . . . . . . . . . . . . . .34
Figure 2-7 Series 5 Controller OPC/DA Communication . . . . . . . . . . . . . . . . . . .35
Figure 2-8 Series 5 Controller Alarm and Event Communication . . . . . . . . . . . . .36
Figure 2-9 Series 4 Controller OPC/DA Communication . . . . . . . . . . . . . . . . . . .37
Figure 2-10 Series 3/3 Plus / 3++ Controller OPC/DA Communication . . . . . . . . .38
Figure 2-11 OPC/DA Client Access to Modbus Slave Data . . . . . . . . . . . . . . . . . .39
Figure 2-12 Generic Controller AE Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Figure 2-13 Script Engine Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Figure 2-14 Modbus Master Access to OPC Server Data . . . . . . . . . . . . . . . . . . .43
Figure 2-15 Bridging OPC and WOIS/DIAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Figure 2-16 TrainTools Archival Data Programs. . . . . . . . . . . . . . . . . . . . . . . . . . .45
Figure 3-1 Data Sources for TrainTools ActiveX Controls . . . . . . . . . . . . . . . . . .49
Figure 3-2 Data Sources for TrainTools ActiveX Controls . . . . . . . . . . . . . . . . . .50
Figure 3-3 Events ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Figure 3-4 Alarms ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Figure 3-5 Trends ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Figure 3-6 IOView ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Figure 3-7 Map Control Displaying a Gas Turbine Limit . . . . . . . . . . . . . . . . . . . .54
Figure 3-8 Map Control Displaying Compressor Surge Limit . . . . . . . . . . . . . . . .55
Figure 3-9 Example of TrainView Run-Time Window . . . . . . . . . . . . . . . . . . . . . .56
Figure 3-10 Examples of TrainView Dynamic Objects . . . . . . . . . . . . . . . . . . . . . .57
Figure 3-11 Typical Control System Process and Instrumentation Drawing. . . . . .58
Figure 3-12 Typical Controller Faceplate Components . . . . . . . . . . . . . . . . . . . . .59
Figure 3-13 Archival Data Utility Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Figure 3-14 Data Flow for Trends and Events Controls . . . . . . . . . . . . . . . . . . . . .62

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 13

Figure 4-1 TrainTools Web Process Data Communication . . . . . . . . . . . . . . . . . 63


Figure 4-2 WebServices Program Components . . . . . . . . . . . . . . . . . . . . . . . . . 64
Figure 4-3 WebGateway Program Components . . . . . . . . . . . . . . . . . . . . . . . . . 65
Figure 4-4 TrainViewWeb Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Figure 5-1 Field Engineering Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Figure 5-2 Main Window of Series 5 Configurator Utility. . . . . . . . . . . . . . . . . . . 68
Figure 5-3 Main Window of Series 4 Configurator Utility. . . . . . . . . . . . . . . . . . . 69
Figure 5-4 Main Window of Series 3 Configurator Utility. . . . . . . . . . . . . . . . . . . 70
Figure 5-5 Main Window of Series 5 Duplex Supervisor Utility . . . . . . . . . . . . . . 71
Figure 5-6 Main Window of Fast Recorder Utility . . . . . . . . . . . . . . . . . . . . . . . . 72
Figure 5-7 Main Window of Alarm Monitor Utility . . . . . . . . . . . . . . . . . . . . . . . . 73
Figure 6-1 TrainTools Project Data Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Figure 6-2 TrainTools Project Engineering Programs . . . . . . . . . . . . . . . . . . . . . 76
Figure 6-3 Project Database Field I/O Connections . . . . . . . . . . . . . . . . . . . . . . 80
Figure 7-1 Typical Operator Training Simulator Components . . . . . . . . . . . . . . . 81
Figure 7-2 Series 5 Control System Emulation . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Figure 7-3 Functional Diagram of Emulated Controller Instance. . . . . . . . . . . . . 83
Figure B-1 CCC Installer Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Figure B-2 Partial Listing of Distribution CD Contents . . . . . . . . . . . . . . . . . . . . . 97
Figure B-3 Project Folders and Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Figure B-4 General Pane of TrainTools Information Window . . . . . . . . . . . . . . 119
Figure B-5 License Pane of TrainTools Information Window. . . . . . . . . . . . . . . 120
Figure B-6 Modules Pane of TrainTools Information Window . . . . . . . . . . . . . . 121
Figure B-7 Windows Disk Defragmenter Utility . . . . . . . . . . . . . . . . . . . . . . . . . 122
Figure C-1 Windows XP Start Menu Options. . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Figure C-2 Manipulating the Desktop Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . 134
Figure D-1 Setting a File or Folder’s Access Rights . . . . . . . . . . . . . . . . . . . . . 148
Figure D-2 Administrator Accounts Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Figure E-1 Distributed TrainTools Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Figure E-2 Workstation Communication Options. . . . . . . . . . . . . . . . . . . . . . . . 156
Figure E-3 Isolating Vanguard Controllers from Other Networks. . . . . . . . . . . . 163
Figure E-4 TrainTools Workstation Time Synchronization. . . . . . . . . . . . . . . . . 175

List of Tables
Table R-1 Manual and Product Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

May 2007 UM5500 (5.0.0)


14 Contents

Symbols and Acronyms


The basic terms and phrases underlying most of these acronyms are defined in
Appendix A.
ADaM Archival Data Manager
AE Alarm and Event
AES Alarm and Event Server
AFM Application Function Module (Series 4 Controllers)
ASCII American Standard Code for Information Interchange
ASP Application Software Package (Series 4 Controllers)
CCC Compressor Controls Corporation
CE Critical Event
CF4 ConFigurator 4 (file type)
COM Component Object Model
CPU Central Processing Unit
CSV Comma-Separated Values (file type)
DCOM Distributed Component Object Model
DCS Distributed Control System
DHCP Dynamic Host Configuration Protocol
DIAC Dynamic InterApplication Communication
DLL Dynamic Link Library
DNS Domain Name System
EA Extended Attributes file
FTA Field Termination Assembly
FTP File Transfer Protocol
GC AES Generic Controller AE Server
GUI Graphical User Interface
HMI Human-Machine Interface
HTML HyperText Markup Language file format
HTTP HyperText Transport Protocol
IEC International Electro-technical Commission
IO Input-Output
I/O Input and/or Output (circuits or signals)
IP Internet Protocol

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 15

IT Information Technology department


MPU Main Processing Unit
NAT Network Address Translation
NIC Network Interface Card
NTFS NT File System
NOS Notification Object Service (Series 5 Controllers)
NTP Network Time Protocol
OIS Operator Interface Station Protocol (Series 4 Controllers)
OLE Object Linking and Embedding
OPC OLE for Process Control
OPC/DA OPC Online Data Access
OTS Operator Training Simulator
PDF Portable Document Format
PDI Project Data Interface
P&ID Piping and Instrumentation Drawing
POU Program Organization Unit
RDF Report Data Format
RTF Rich Text Format
RTU Remote Terminal Unit
SCADA Supervisory Control and Data Acquisition
SCI Serial Communication Interface (Series 4 Controllers)
SE Script Engine
TCP Transmission Control Protocol
TIF Tagged Image Format
TV TrainView
TV1 WOIS TrainView 1 software package
TV2 TrainTools TrainView Package or TrainView Program
UDP User Datagram Protocol
URL uniform resource locator
WOIS Workstation Operator Interface Software
W2K Windows 2000
XLS ExceL Spreadsheet file format
XML eXtended Markup Language file format

May 2007 UM5500 (5.0.0)


16 Contents

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 17

UM5500 TrainTools Product Overview and Setupmanual

Chapter 1 Overview
This chapter introduces our TrainTools software packages.

Introduction Our TrainTools software products collectively provide an integrated


set of process control system human-machine interface (HMI) and
project engineering programs that run under the Windows XP or
2000 Professional operating system.
Although they can all be run on a single workstation, the TrainTools
programs are divided into seven separate packages that can be run
on groups of computers in various combinations. For most uses, the
question this poses is not which packages to acquire, but which to
install on each PC.
This manual provides an overview of each software package and its
component programs, tells how to distribute their functions among a
group of PCs, and describes various common functions:
• For an overview of the TrainTools software packages, read the
rest of this chapter.
• If you want to know how TrainTools programs communicate and
record controller information, read Chapter 2.
• If you want to know more about the TrainView operator interface
program and Archival Data Utilities, read Chapter 3.
• If you want to know more about the field engineering programs
for CCC controllers, read Chapter 4.
• If you want to know more about the web communication and
operator interface programs, read Chapter 5.
• If you want to know how the TrainTools and Series 5 Controller
software are adapted to specific applications, read Chapter 6.
• If you want to learn about the operation and use of the Series 5
Controller emulation program, read Chapter 7.
• If you need to know what a TrainTools-related word or phrase
refers to, consult Appendix A.
• If you want to know how to install and maintain TrainTools soft-
ware, read Appendix B.
• If you want to know how to configure the start up of a TrainTools
human-machine interface, read Appendix C.
• If you need to create or modify the accounts that govern each
user’s access to various program features, read Appendix D.
• If you need to configure a group of networked TrainTools PCs,
read Appendix E.

May 2007 UM5500 (5.0.0)


18 Chapter 1: Overview

TrainTools Workstation
Platform TrainView Archival Data
Utilities GUI Utilities

CCC and
Platform Archive Project
Third-Party
Servers Server Utilities
Controllers

Project Database

Figure 1-1 TrainTools Components and Communication Paths

TrainTools The TrainTools HMI incorporates a modular, client-server approach


that allows multiple programs running on one or more computers to
Software communicate with the same controllers while minimizing the load on
Packages their central processing units (CPUs) and communication channels.
To facilitate the setup of distributed HMI systems and accommodate
customers that do not require all available functions, the TrainTools
programs have been separated into eight software packages:
• Some of the programs in the Platform Communication Servers
Package provide OPC online data access (OPC/DA) to the HMI
variables of CCC Controllers and third-party Modbus slaves.
Other programs in that package forward alarm and event (AE)
messages posted by or synthesized for those controllers.
• The programs in the Archive Server Package record specified
data from the platform communication servers and share it with
Archival Data Manager (ADaM) client programs.
• The TrainView Program provides a graphical user interface
(GUI) for current and archived AE and OPC/DA data.
• The Archival Data Utilities provide ways to extract archived AE
and OPC data to files and formal reports.
• Each Platform Engineering Utilities Package provides programs
for configuring and tuning a specific series of CCC controllers
via the corresponding OPC Server program.
• The Project Engineering Utilities create and modify the project
database that governs the operation of most TrainTools HMI
programs. They are also used to develop the application soft-
ware for Series 5 Controllers.
• Programs in the TrainTools Web Package allow TrainTools and
OPC/DA clients and servers to communicate using standard
World Wide Web (rather than problematic DCOM) protocols.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 19

4 Server PCs 5 Operator PCs


Communication TrainViewWeb
Servers browser plug-in

DCOM and/or Web Services Networks


Archive
Server 1 Engineer’s PC
Controllers TrainViewWeb Project
service Utilities

Engineering TrainView
Utilities Program

Script Engine
2 Manager PCs Program

TrainView Archive
Program Reporter

Archive Reporter Project


Exporter & Viewer Database

Figure 1-2 Distributed TrainTools HMI Example

• The Series 5 Emulator programs allow a single PC to execute


the application software of up to sixteen Series 5 Controllers for
testing and training purposes.
Each software package also includes various dynamic link library
(DLL), help, documentation, and supporting program files, including
the Project Unzip Utility (see page 77), TrainTools Information Utility
(see page 119), and Administrator Program (see page 150).
As an example, the system illustrated in Figure 1-2 includes 12 PCs
running three different combinations of the available packages:
• Server PCs require the Platform Communication, Archive
Server, Engineering Utility, and TrainTools Web packages.
• Manager PCs require the TrainView and Archival Data Utility
packages.
• The Engineer’s PC, which is used to develop and host the
project database, requires the Project Utilities, TrainView,
Platform Communication, and Archival Data Utility packages.
• Operator PCs require only the Internet Explorer program.
Each PC’s license key (see page 120) specifies which packages will
be installed and can be run on each PC. In addition, a USB key is
required to run the Series 5 Emulator program.

May 2007 UM5500 (5.0.0)


20 Chapter 1: Overview

TrainTools Workstations
Archive Server
Programs
TrainTools
Clients
TrainTools
CCC and AE Servers
Modbus Slave
Third-Party
Controllers Program
TrainTools
OPC Servers

Third-Party Third-Party Third-Party


OPC Servers OPC Clients Modbus Master

Figure 1-3 TrainTools Data Communication

Data Programs in the Platform Communication Servers and Archive


Server Packages gather, transform, and record controller data, then
Communication share it with client programs using the industry-standard OPC/DA
(see Chapter 2) and our proprietary event and archival data protocols. To avoid
DCOM communication problems, clients of any server can commu-
nicate with it via the web communication programs in the TrainTools
Web (see page 22) Package.

Platform Programs in the Platform Communication Package (see page 34)


Communication gather and share run-time data from CCC and other controllers:
Servers • TrainTools OPC Servers use various protocols to read and set
Series 5, Series 4, Series 3/3 Plus / 3++, and third-party Modbus
slave HMI variables, then share that access with TrainTools and
connected third-party OPC/DA version 2 clients.
• TrainTools AE Servers share and provide ways to enable and
disable alarm and event messages and acknowledge alarms
created from Series 5 Controller AE notices or Series 4, Series
3 / 3 Plus / 3++, Modbus slave, and third-party OPC server data.
• The TrainTools Modbus Slave program allows multiple third-
party Modbus master devices to access OPC server data items
as Modbus registers, coils, and discrete bits.
Any system employing a TrainTools HMI must include at least one
PC running appropriate Platform Communication Server programs.

Archive Server Programs in the Archive Server Package (see page 45) record data
from AE and OPC/DA servers running on the same PC and share it
with TrainView Program and Archival Data Utilities client programs
running on the same or networked workstations.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 21

TrainView Program
OPC/DA Dynamic Objects
Servers Map and IO Controls

Alarm Controls
TrainTools
AE Servers Trend and Event Controls

Archive Exporter Program Data Files


Archive
Servers
Archive Viewer Program
Third-Party
Trend and Event Controls Programs

Archive Reporter Program Report Files

Figure 1-4 TrainTools Operator Interface Programs

Operator Programs in the TrainView and Archival Data Utilities Packages are
used to monitor, alter, and review the operation of the controllers
Interface connected to OPC/DA, AE, and Archive Servers. TrainView (or TV
(see Chapter 3) Web) must be run on every operator workstation, while the Archival
Utilities are generally installed on all PCs from which you want to
export or review recorded information.

TrainView The TrainView Program (see page 56) displays user-selectable


Program pictures that consist of Dynamic Objects and ActiveX Controls
superimposed on static background drawings:
• Each dynamic object and most ActiveX controls are connected
to specific OPC/DA or AE servers and automatically display the
most recent data available from them.
• Trend and Event controls obtain OPC data and AE messages
from specified Archive Servers, and can be scrolled to display
any information currently available from those sources.

Archival Data Programs in the Archival Data Utilities Package (see page 60)
Utilities extract, save, display, and print controller data recorded by the
Archive Server programs during specified intervals or critical events:
• The Archive Reporter creates, displays, and prints tabulated
OPC data reports, and can save them to files for viewing on
other workstations or using third-party programs.
• The Archive Exporter program saves AE messages and OPC
data to files that can be replayed by the Archive Viewer or
opened using various third-party programs.

May 2007 UM5500 (5.0.0)


22 Chapter 1: Overview

OPC Data Alarm and Archival Data


Access Clients Event Clients Clients
COM/
DCOM
WebGateway WWW Web Communication
Programs Protocols Services
COM

OPC Data Alarm and Archival Data


Controllers Access Servers Event Servers Servers

Figure 1-5 TrainTools Web Communication

TrainTools Web The TrainTools Web Package includes the WebServices program
and its associated software modules, which implement two types of
(see Chapter 4) web services:
• The web communication services allow OPC, AE, and ADaM
client and server programs on separate PCs to communicate
using web protocols and TrainTools security instead of the prob-
lematic distributed component object model (DCOM). Clients
connect to these services via a local WebGateway program.
• The TrainViewWeb service allows TrainView workstations to be
set up, run, and automatically updated without directly installing
any TrainTools software on them or requiring direct access to
the project database. The operator interface files and needed
software are instead downloaded from server PCs via Internet
Explorer web pages.
TrainTools networks can be set up to use various combinations of
COM/DCOM and Web communication, as discussed under Distrib-
uted Communication Options on page 156).

Internet TT ActiveX WebGateway


Explorer Controls Program

TrainViewWeb TVWeb Communication


Service Plug-In Services

TrainViewWeb OPC/DA, AE &


Projects Controllers Archive Servers

Figure 1-6 TrainViewWeb Loading and Operation

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 23

TrainTools Workstation
Series5 Series 5 Series 5
Controllers OPC Program Engineering Utilities

Series3/3Plus/3++ Series 3 Plus Series 3 Plus


Controllers OPC Program Engineering Utilities
GC_AES or
SE Program
Series4 Series 4 Series 4
Controllers OPC Program Engineering Utilities

Figure 1-7 TrainTools Field Engineering Utilities

Platform Programs in the Platform Engineering Utilities Package are used to


configure, tune, and upgrade the control programs or application
Engineering software of specified CCC controllers:
Utilities • The Configurator program for each controller series displays
(see Chapter 5) and allows you to change its configuration parameters. Each
also provides access to other HMI variables or can download
revised software to the controller.
• The Fast Recorder program is an electronic chart recorder that
records and plots the behavior of selected data items from any
OPC/DA server running on the same computer.
• The Alarm Monitor program displays and allows the user to
acknowledge messages from any AE server.
• The Series 5 Duplex Supervisor program compares and can
synchronize the operating system, application software, and
configuration of duplex Vanguard and Reliant Controllers.
This package must be installed by any customer with Series 4 or
Series 5 Controllers, so the corresponding Configurator program will
be available for troubleshooting (perhaps via telephone consultation
with CCC engineers). It is also highly recommended for Series 3/
3 Plus / 3++ Controllers, although they could alternately be reconfig-
ured using their built-in engineering keyboards.

May 2007 UM5500 (5.0.0)


24 Chapter 1: Overview

Project Builder

Application Application TrainView Script Archive


Editor Generator Program Engine Reporter

Project Database

Figure 1-8 TrainTools Project Engineering Utilities

Project Programs in the Project Engineering Utilities Package are used to


create and modify the Project Database that configures the opera-
Engineering tion of most TrainTools run-time programs, and specify, code, and
Utilities compile the application software for Series 5 Vanguard and Reliant
Controllers. This package is needed only to create or modify:
(see Chapter 6)
• Series 5 Controller logic control programs, Modbus data sets,
and/or alarm and event message attributes;
• TrainView operator interfaces (for which the TrainView Package
is also required);
• archival data recording and reporting processes (for which the
Archive Reporter utility is also required); or
• Script Engine OPC and AES servers (for which that platform
communication program is also required).

Series 5 TrainView
Emulator Program Series 5 Program
Third-Party OPC Program Series 5
Process Simulator Configurator

Figure 1-9 Series 5 Control System Training and Testing

Series 5 When paired with third-party process simulators, the programs in


the Series 5 Emulator package allow a single PC to simulate the
Emulator operation of up to sixteen Series 5 Controllers. This provides a cost-
(see Chapter 7) effective method of training operators and testing control systems as
they are being engineered.
The application software for each emulator instance is identical to
that of the emulated Reliant or Vanguard Controller, except that it
must be recompiled to run on the PC. It is uploaded to the emulated
controller (which stores it in a file on the PC’s hard drive) and config-
ured using the Series 5 Configurator engineering utility, just like it
would be for a real controller.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 25

UM5500 TrainTools Product Overview and Setupmanual

Chapter 2 Data Communication Programs


This chapter discusses the TrainTools data communication and
recording programs and underlying client-server protocols.

Archive Server TrainTools


Programs Clients

TrainTools Modbus Slave Third-Party


CCC and AE Servers Program Modbus Master
Third-Party
Controllers TrainTools Third-Party
OPC Servers OPC Clients

Figure 2-1 TrainTools Platform Communication and Archive Servers

Introduction TrainTools programs employ various communication protocols (see


page 26) and COM components (see page 28) to allow multiple pro-
grams to interact with a common set of process controllers:
• OPC Online Data Access (see page 30) and Alarm and Event
Messaging (see page 31) are provided by the programs in the
Platform Communication Package (see page 34).
• Archival Database Access (see page 33) is provided by the pro-
grams in the Archive Server Package (see page 45).
Although all of the TrainTools programs can be run on a single or
each of several PCs, it is usually better to run the server programs
on a few Server PCs that relay controller data to multiple operator
workstations and supervisory computers. This minimizes the com-
munication load on each controller and keeps display and reporting
programs from interfering with the timely execution of time-critical
data acquisition and archiving tasks. Because most controllers have
a limited communication capacity, this can be the only way to sup-
port the desired number of workstations (see page 163).
When the components of a TrainTools HMI are distributed among
a group of PCs, they can communicate using either the Windows
distributed component object model (DCOM) service or TrainTools
web services programs (see Chapter 4).

May 2007 UM5500 (5.0.0)


26 Chapter 2: Data Communication Programs

Master-Slave Connection Keys


Request
Master Slave Master Slave
Data or Response
One master, multiple slaves, no communication between slaves

Client-Server
Subscription or Change
Server Client Server Client
Data Updates
Multiple servers and clients, no communication between clients or between servers
Figure 2-2 Master-Slave versus Client-Server Communication

Communication Communication protocols specify how computers exchange data.


Operator workstations and host computers or controllers can inter-
Protocols act with controllers using two basic protocol types (see Figure 2-2):
• master-slave, such as the Modbus protocol
• client-server, such as the OPC data access interface
In a master-slave system, communication is initiated by a master
that can either broadcast information to all slaves or request data or
action from a specific one. In the latter case, the slave has a speci-
fied amount of time to respond, and the master can initiate no other
communication until that response is received or times out.
In a client-server system, each device or program might execute
multiple client and server processes. Specific implementations can
differ, but in general:
• Server processes maintain one or more sets of data, each at the
request of a specific client. When so directed, they periodically
transmit updated variable values to those clients.
• Client processes can usually request a listing of a server’s avail-
able data and then define subsets of that data that they can
read, change, or be sent automatically updated values for.
A program can be a client of multiple servers implementing one or
more protocols, perhaps obtaining data from all of them or transfer-
ring information from one to another, or act a client for one protocol
and a server for another.
Of course, a single program can also implement both master-slave
and client-server communications, perhaps functioning as a Modbus
master and an OPC server in order to provide Modbus slave data to
OPC client programs.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 27

Process controllers have traditionally implemented master-slave


serial communication protocols that operator workstations and
supervisory (host) computers can use to read or change the values
of certain controller variables. These relatively simple protocols
have a number of drawbacks, including:
• Most require dedicated serial connections between each host
program and the controllers it is to monitor. The number of hosts
that can monitor a device is thus limited by the number of com-
munication ports it provides, and the computational load on it
increases if multiple hosts access the same variables.
• Most are proprietary, so each host program must be provided
with custom drivers for each controller. Although a few (such as
the Modicon Modbus protocol) have become defacto industry
standards, it is common for a host to need several potentially-
incompatible drivers from numerous different vendors.
• The available data usually consists of single-valued variables
that are accessed via numerical addresses. Their addresses,
data types, and scaling attributes must be carefully programmed
into each host program.
Most of these drawbacks can be mitigated by using a client-server
system employing standard protocols:
• Multiple, networked clients can then monitor each controller via
a single server requiring just one connection to that controller.
The server generally minimizes its computational load on the
controller by accessing each variable only once no matter how
many clients request its value.
• Server programs are available for most control devices, which
means even the server PC rarely needs custom drivers.
• Custom configuration is required only for the server, after which
clients can access the values and properties of its variables by
name using standard DLL subroutines.

May 2007 UM5500 (5.0.0)


28 Chapter 2: Data Communication Programs

Component The Windows Component Object Model (COM) technology allows


Object Model programs on the same computer to share information. This is done
by incorporating Dynamic Link Libraries (DLLs) that implement
COM Interfaces client programs can use to connect to server programs
and then access, modify, display, print, and otherwise manipulate
their data objects.
Object Linking and Embedding (OLE) refers to the use of COM
components to include dynamically-updated data from one program
within a document or display maintained by another. For example,
Microsoft Word and Excel use the same DLL to display, edit, and
print pie charts based on data from spreadsheet files.
Any program can employ both standard and proprietary interfaces:
• Some standard interfaces are provided by the Windows operat-
ing system, others are defined by organizations that provide the
DLLs and documentation needed to implement them. In particu-
lar, the OLE for Process Control (OPC) specifications and DLLs
that TrainTools programs use to communicate current process
variable values (see page 30) are defined and provided by the
OPC Foundation.
• Proprietary interfaces, such as those TrainTools programs use
to communicate alarms and events (see page 31) and archival
database information (see page 33), are defined by individual
companies for use only in conjunction with their own products.
Because a single program can incorporate multiple components,
each can function as a client and/or server for several protocols. As
an example, the S5_OPC.exe program provides both the AE and
OPC/DA servers for Series 5 Controllers.
As discussed in Chapter 4, programs running on different computers
can communicate using the distributed component object model
(DCOM) technology that is also built into Windows operating sys-
tems. Alternately, networked workstations can employ TrainTools
Web Communication to avoid the practical problems associated
with DCOM.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 29

Compatibility COM clients and servers (and their interface specifications) are sup-
posed to be implemented and maintained in ways that assure the
compatibility of products from different vendors:
• A server component is not required to provide all of the features
defined by a given interface specification. Instead, clients must
query each server to determine and then use only the interfaces
that it does provide.
• Similarly, a server might not be required to fully implement all
methods of a supported interface—some methods allow the
server to simply return a “not implemented” error code. Clients
must react appropriately when this occurs.
• The potential capabilities of any server can be expanded only by
defining new interfaces, rather than modifying the existing ones
(although a new interface can include all of the features of and
effectively replace an older one).
If a revised specification defines a new interface, the clients and
servers implementing that specification must both be upgraded
(not necessarily at the same time) before that interface can be
used. Because clients are not supposed to require desired inter-
faces but can detect and use them if present, use of the new
interface will automatically commence as soon as you have
installed clients that want to use it and servers that provide it.
Thus, any client should be compatible with any server implementing
the same version of its interface specification, and all clients and
servers could (and ideally would) be interoperable. However, their
ability to share specific types of data would depend on their imple-
mentation and joint use of corresponding interfaces.

The OPC client and server components incorporated into various


TrainTools programs have been extensively tested to assure they
Note: can communicate with each other. They should be compatible with
most third-party OPC software, but compatibility with any particular
program can not be assured unless specifically tested.

May 2007 UM5500 (5.0.0)


30 Chapter 2: Data Communication Programs

OPC Server Program Client Program


Controller
OPC Server Object Client Object
HMI Variables
Data Groups
Data Items
Controller
HMI Variables Configuration
Data Tags

Figure 2-3 OPC Online Data Access

OLE for Process Object Linking and Embedding for Process Control (OPC) refers to
Control a collection of standard COM interfaces for various types of control
system data. The specifications and DLLs for these interfaces are
developed, maintained, and available from an organization of pro-
cess control companies known as the OPC Foundation.
TrainTools programs employ interfaces defined by versions 1 and 2
of the OPC Online Data Access (OPC/DA) specifications, as well as
the required Common OPC Server Behaviors (but their compatibility
with third-party products is not guaranteed). They specifically do not
implement the OPC interfaces for event and historical data.

OPC Online Data Under the OPC Online Data Access protocol:
Access • Each OPC/DA server maintains a list of data tags (also known
as dataIDs) called a configuration. Each tag represents one of
the HMI variables available from the connected controllers.
• Any client can read that configuration, ask the server to create
one or more data groups, and then add data items representing
specified tag variables to those groups. The server program will
then link those items to the specified controller variables.
• Each data item has a value, a timestamp that indicates when its
value was read, a quality indicating whether that value is valid,
various attributes, and other, optional properties.
Clients cannot access items individually, only via their parent
groups. They can ask the server to transmit all items in a group at
any time (when starting up, for example), or to provide data updates
at specified intervals. In the latter case, a server would transmit only
items whose values or qualities changed during the preceding inter-
val. This minimizes the communication and computational overhead
and makes it easy to determine which data has changed.
Clients can also set data item values, in which case the server will
change the associated HMI variable only if allowed by the controller.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 31

S5 Controller AE Server Program Client Program


NOS AE Filter
Event Client Objects
AE Functions Functions
Messages Enable
Server
Disable
OPC Servers Object Acknowledge
Alarm
AE Conditions Functions

Figure 2-4 TrainTools Alarm and Event Communication

Alarm and Event TrainTools programs use a proprietary set of COM interfaces to
Messaging communicate controller alarm and event messages:
• Each program having an AE Server component is configured to
generate alarm and event messages for specified controllers
(see S5 AES, GC AES, and SE AES).
• Each message has a specified set of fields that communicate
what happened and when (see AE Message Fields on page 32).
• When a client connects to such a server, it can provide an AE
Filter specifying various conditions the fields of any message
sent to it must satisfy. Each client’s user manual tells whether
and how its filter can be edited.
• When a client first connects to an AE Server, it is immediately
sent messages indicating the states of all uncorrected alarm
conditions that meet its criteria. It will subsequently be sent any
new or modified alarm or event messages meeting its criteria.
• Any client can ask its server to enable or disable any active
alarm or event, or acknowledge any active alarm. Messages
indicating those changes are then sent to all clients of that
server unless blocked by their specified filters.

May 2007 UM5500 (5.0.0)


32 Chapter 2: Data Communication Programs

AE Message Fields Each alarm or event message has the following fields, which convey
information about the condition that triggered it:
State: Events have four possible states:
0 : clear (condition does not exist)
1 : active (condition does exist)
4 : re-enabled
5 : disabled
Alarms have six possible states:
0 : clear (corrected and acknowledged, or not detected)
1 : active (neither corrected nor acknowledged)
2 : acknowledged (but not corrected)
3 : unacknowledged (but corrected)
4 : re-enabled
5 : disabled
Timestamp: The time at which the status most recently changed (set
by PC except for messages from Series 5 Controllers).
Text: A text string, which can be defined in two different languages,
briefly describing the associated alarm condition or event:
• For an alarm condition, this message is always the same.
• For an event, one message is displayed when the associated
condition is detected and a different message can (but need
not) be displayed when that condition is cleared. For example,
a multistep sequence could post an overall begin message,
a series of begin messages as individual steps are initiated,
and a final, overall end message.
Source: Bilingual text string identifying the element of the control
system that caused or posted the alarm or event. For example,
the source of an I/O alarm might identify the associated field
device, while that of an antisurge control alarm might identify the
associated compressor.
Destination: Bilingual text string identifying an element of the control
system affected by the alarm or event condition. For example,
the destination of an I/O alarm might be used to identify its asso-
ciated field wiring terminals.
Priority: An assigned integer that indicates the seriousness of the
alarm or event. AE clients can display messages using different
colors corresponding to this property, and subscribe only to
messages with specified priorities.
Group: An assigned integer that can be used to associate groups of
alarms or events, primarily for filtering purposes.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 33

ADaM Program Client Program


ADaM Server ADaM Client
Archival Object Object
Database AE Filter

AE Message Msg Channel


Files Objects AE data

Critical Event CE Channel


Files Objects critical events

Tagged Data Tag Channel


Files Objects OPC data

Tag Objects

Figure 2-5 TrainTools Archival Data Communication

Archival TrainTools programs use a proprietary set of COM interfaces to


Database Access record, manage, and read archived OPC data and AE messages:
• The Archival Data Manager (see page 46), which maintains the
archival database files, is the only program that incorporates an
ADaM server component.
• Client programs can instruct an ADaM server to:
• open or create an archival database and specify how long
data recorded to its files should be retained;
• create, modify, or delete channels in which tagged (OPC)
data, AE messages, and critical events can be recorded;
• add or delete OPC data items to the list of tag objects each
tagged data channel records; and
• add or retrieve recorded data records from any channel.
As with AE servers, ADaM clients can provide AE Filters specifying
conditions the fields of any messages they retrieve must satisfy.
Each client’s filter can be edited as described in its user manual.

May 2007 UM5500 (5.0.0)


34 Chapter 2: Data Communication Programs

Server PCs
Series 5 Series 5
Controllers OPC Program Script Engine
Series 4 Series 4 Program AE
Controllers OPC Program Messages
Generic Controller
Series 3 (any) Series 3 AE Server Program
Controllers OPC Program
TrainTools
OPC Data Items Client Programs
Modbus Modbus
Slave Devices OPC Program Modbus Slave
Program

Third-Party Third-Party Third-Party


OPC Servers OPC Clients Modbus Master

Figure 2-6 OPC/DA and AE Server Programs

Platform This package’s programs provide OPC Online Data Access (see
page 30) and/or Alarm and Event Messaging (see page 31) servers:
Communication
• The Series 5 OPC Server Program (see page 35) accesses and
Package shares the HMI variables and alarm and event notices of Series
5 Controllers with its OPC/DA and AE clients.
• The Series 4 OPC Server Program (see page 37) accesses and
shares the database parameters of Series 4 Controllers with its
OPC/DA and SCI clients.
• The Series 3 OPC Server Program (see page 38) accesses and
shares all Modbus and some parameters and calculated vari-
ables of Series 3/3Plus/3++ Controllers with its OPC/DA clients.
• The Modbus Master OPC Server Program (see page 39)
accesses and shares user-specified Modbus variables of any
Modbus slave with its OPC/DA clients.
• The Generic Controller AE Server Program (see page 40) posts
alarm and event messages triggered by boolean variables from
specified OPC/DA servers with its AE clients.
• The Script Engine Program (see page 41) shares OPC data
items calculated from and AE messages triggered by data from
any OPC/DA server with its OPC/DA and AE clients.
• The Modbus Slave OPC Client Program (see page 43) enables
Modbus masters to access OPC/DA server data.
• The TV1 OPC Server Program (see page 44) allows OPC/DA
clients to access Workstation Operator Interface Software
(WOIS) data sources.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 35

Series 5 Series 5 OPC Program Client Program


Controller
S5 OPC Server Object OPC/DA
Clock Client Object
Data Groups
Application Software Data Items
HMI Variables
Configuration
Extended Attributes Data Tags
Transit File

Figure 2-7 Series 5 Controller OPC/DA Communication

Series 5 OPC The Series 5 OPC Server program communicates directly with one
Server Program or more Series 5 Controllers and shares that access with clients of
its S5 OPC and S5 AES server component objects. It also provides
a communication pathway for downloading application software to
those controllers, and can synchronize their internal clocks with that
of its host PC.
This program communicates with each Series 5 Controller via two or
more of its limited Series 5 Protocol communication channels (each
Vanguard MPU has 16, each Reliant MPU has 6):
• All clients of its S5 AES server share a single channel.
• Most clients of its S5 OPC server share a single channel (and its
associated access level), but additional dedicated channels are
opened for each ArcCom or Fast Recorder client program.

S5 OPC The OPC server component of the Series 5 OPC Server program
provides OPC Online Data Access (see page 30) to HMI variables
defined by each Series 5 Controller’s application software:
• The optional IOPCBrowseServerAddressSpace interface is
implemented, so clients can obtain a list of data tags available
from all connected controllers. Each controller’s variable list is
defined by its extended attributes (EA) file, which is downloaded
from that device when the host program first connects to it.
• The server can be configured to connect to specified controllers
on startup. Otherwise, it will connect to a controller and down-
load its EA file the first time any client tries to access its data.
• The server will only read controller variables that clients have
created data items for. If possible, it will read each such variable
at an interval equal to the fastest update rate of any data group
that includes a data item for it. Any time it reads any variable, it
also reads the controller’s clock The timestamp of each data
item is the controller time at which its variable was last read.

May 2007 UM5500 (5.0.0)


36 Chapter 2: Data Communication Programs

Series 5 Controller Series 5 OPC Client Program


TrainWare AE Definitions
Program
AES Client
function block Transit File AE Filter
Signal Messages Enable
HMI Variables S5 AES
Disable
Alarm_S disable, ackn
Server Object Acknowledge
or
Event_S active, State
timestamp S5 OPC
block Server Object
priority, handle Client Program
Clock NOS Buffer OPC/DA Client
AE Notice AE Block Variables

Figure 2-8 Series 5 Controller Alarm and Event Communication

• A parameter or command can be set only via a channel with an


access level at least equal to that specified by the variable’s
access level attribute, as discussed in Chapter 2 of the Series 5
Controller Operation and Configuration manual [UM5402].
• Duplex controller variables are read from the active MPU by
default, but clients can specifically monitor variables from either
the primary or backup MPU.

S5 AES Each Series 5 Controller’s application software uses embedded


alarm and event function blocks to post alarm and event notices to
its notification object service (NOS) buffer. Each includes a subset
of the AE message fields (see page 32), including a timestamp that
indicates the controller time at which the associated condition last
changed. Each also includes a handle that identifies an entry in the
controller’s AE Definitions transit file that provides the remaining AE
message field values for that alarm or event.
The Series 5 OPC program retrieves all AE notices posted by each
connected controller and converts them to AE messages using the
referenced definitions file entry. Its S5 AES server component then
forwards those messages to all of its clients. Beginning with version
6.1, the text fields in the AE definitions file can be modified without
restarting the controller.
The AE notice fields of each controller alarm or event block are also
communicated by HMI variables that any OPC/DA client can read.
Either type of client can acknowledge an alarm or enable or disable
an alarm or event through its server. The Series 5 OPC program
then sets or clears the Ackn or Disable variable of the corresponding
controller alarm or event block.

Series 5 Controller alarms and events are timestamped by the


Note: source controller, and all changes are communicated to all AE and
OPC clients monitoring them via any connected S5 AES server.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 37

Series 4 Series 4 OPC Program Client Program


Controller
S4 OPC Server Object OPC/DA
Parameter Database Client Object
Data Groups
Parameters
Data Items

Configuration
Data Tags
CF4 Files

Figure 2-9 Series 4 Controller OPC/DA Communication

Series 4 OPC The Series 4 OPC Server program communicates with Series 4
Server Program Application Function Modules (AFMs) and shares that access with
its OPC/DA and SCI (see page 44) clients. It can be connected to
each AFM via any Series 4 OIS protocol serial port, as discussed in
Appendix A of the Series 4 OPC Server user manual [UM5504].
The OPC server component of this program provides OPC Online
Data Access (see page 30) to the database parameters defined by
each AFM’s application software bundle:
• The optional IOPCBrowseServerAddressSpace interface is
implemented, so clients can obtain a list of data tags available
from all connected AFMs. Each AFM’s parameter list is read
from the CF4 files for its operating system and applications,
which must be present in a specified folder of the host PC.
• The server can be manually started and connected to all avail-
able AFMs, in which case its configuration will include tags for
all parameters of those controllers. Otherwise, it will initially con-
nect to and add tags for all previously-scanned AFMs, and then
add any others that clients try to access data from.
• The server will only read parameters that clients have created
data items for. If possible, it will read each such variable at an
interval equal to the fastest update rate of any data group that
includes a data item for it. The timestamp of each data item is
the PC time at which its parameter was last read.
• Any parameter can be set only if the server’s access level at
least equals the parameter’s access level property.
• Duplex and triplex controller parameters are read from the
active AFMs by default, but clients can specifically monitor
those of any running MPU.
Series 4 Controller AE messages are generated by Script Engine
Program scripts and/or the Generic Controller AE Server Program.

May 2007 UM5500 (5.0.0)


38 Chapter 2: Data Communication Programs

Series 3 Series 3 OPC Program Client Program


Controller
S3p OPC Server Object OPC/DA
Parameter Set Client Object
Data Groups
Modbus Data Data Items

Configuration

Figure 2-10 Series 3/3 Plus / 3++ Controller OPC/DA Communication

Series 3 OPC The Series 3 OPC Server program communicates directly with one
Server Program or more Series 3 / 3 Plus / 3++ Controllers and shares that access
with its OPC/DA clients. It also provides a communication interface
for the Series 3 Plus Configurator program. It can be connected to
any Modbus serial port, as discussed in Appendix A of the Series 3
OPC Server user manual [UM5503].
The OPC server component of this program provides OPC Online
Data Access (see page 30) to a hard-coded set of OPC data for
each Series 3 / 3 Plus / 3++ control program:
• The optional IOPCBrowseServerAddressSpace interface is
implemented, so clients can obtain a list of data tags available
from all connected controllers. Data tags are defined for each
Modbus register, coil, and discrete bit, plus a few parameters
and variables calculated from registers and parameters.
• The server can be configured to connect to specified controllers
on startup. Otherwise, it will connect to each controller and add
tags for it the first time any client tries to access its data.
• Each Modbus variable is read only if clients have created data
items for it or a variable calculated from it. If possible, each is
read at an interval equal to the fastest update rate of any group
that includes a data item for it. The timestamp of each data item
is the PC time at which its Modbus data point was last read.
Each controller’s configuration parameter set is read when con-
necting and any time its parameter checksum register changes.
• Only Modbus coils and holding registers can be set.
• When redundant controllers are installed, data can only be read
from the active controller unless the two devices are assigned
different Computer ID numbers. If they are, data should be read
from both and the active controller identified by checking their
Tracking variables.
AE messages for these controllers are usually generated by the
Generic Controller AE Server Program.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 39

Modbus Slaves Modbus OPC Program Client Program


Discretes, Coils Modbus OPC Server Object OPC/DA
& Registers Client Object
Data Groups
Data Items

Configuration
Data Tags
Configuration File

Figure 2-11 OPC/DA Client Access to Modbus Slave Data

Modbus Master The Modbus OPC Server program operates as a master that com-
OPC Server municates directly with one or more Modbus slaves and shares its
Program access to their data with clients of its OPC Online Data Access (see
page 30) server component:
• This program can communicate with each slave via either a
dedicated serial (RTU or ASCII) or network TCP/IP connection.
• The available data tags are defined and mapped to the coils,
discrete bits, and registers of those devices by a configuration
file that is read when the program starts up.
• The optional IOPCBrowseServerAddressSpace interface is
implemented, so clients can obtain a list of those data tags.
• Each Modbus variable is read only if clients have created data
items for it or a variable calculated from it. If possible, each is
read at an interval equal to the fastest update rate of any group
that includes a data item for it. The timestamp of each data item
is the PC time at which its Modbus data point was last read.
• Only Modbus coils and holding registers can be set.
AE messages for Modbus slaves are usually generated by the
Generic Controller AE Server Program.

May 2007 UM5500 (5.0.0)


40 Chapter 2: Data Communication Programs

GC_AES Program Client Program


OPC Servers AES Client
Alarm Functions
Filter
Data Group
OPC/DA GC AES Messages Enable
Boolean Disable
Data Items Client Object Server Object
Acknowledge

Event Functions
Project Database

Figure 2-12 Generic Controller AE Messaging

Generic The Generic Controller AE Server program can provide Alarm and
Controller AE Event Messaging (see page 31) for any device whose OPC/DA
Server Program server provides boolean data tags indicating whether alarm and
event conditions exist. It does so by implementing function blocks
GC AES that essentially duplicate the functionality of those within a Series 5
Controller’s application software:
• If its trigger variable becomes true, each such block generate an
AE message whose State is 1/active and timestamp equals that
of the trigger variable. The values of all other fields are defined
by properties of the corresponding Controller Alarm Variable
element in the project database.
• This program’s GC AES server component then forwards that
message to all of its clients, subject to conditions specified by
their respective AE filters.
Unlike the Series 5 OPC Server program, this program does not
provide an OPC/DA interface to the internal operation of its alarm
and event function blocks. Thus, their operation can be enabled or
disabled only via the alarm and event messaging interface (which
can only disable active alarms and events).
If more than one GC AES server is set up for any given controller,
their alarm and event blocks will operate independently. Disabling,
re-enabling, or acknowledging a message from one of them will not
affect clients of the others.
The Project Engineering Package includes template projects that
configure this server to post appropriate alarms and events for
Series 3 / 3 Plus / 3++ Controllers.

GC AES messages have the same timestamp as the OPC/DA data


items that trigger them, which are generally the times at which their
Note: values were read from their controllers.
The acknowledgement, enabling, or disabling of any alarm or event
is communicated only to other clients of the same GC AES server.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 41

OPC Servers Script Engine Program


Project Database
Data Group SE OPC
OPC/DA Server Object
Data Items Client Object
Data Groups
Client Programs
Data Items OPC/DA
VB Scripts Client Object

Configuration
Script I/O
Variables Data Tags
AES
Client Object
Filter
Messages Enable
AE Function SE AES
Blocks Server Object Disable
Acknowledge

Figure 2-13 Script Engine Communication

Script Engine The Script Engine program periodically:


Program • runs custom Visual Basic scripts that use data from other
OPC/DA servers to calculate additional variables, and
• executes alarm and event functions that generate messages
triggered by boolean data from other servers or its own scripts.
This program includes the following client/server components:
• an OPC Online Data Access (see page 30) client through which
its scripts and AE function blocks can access data items from
any available OPC/DA server,
• an OPC server that provides online data access to script HMI
variables, and
• an Alarm and Event Messaging (see page 31) server that posts
AE Messages triggered by boolean script variables.
When OPC and AE clients subscribe to data from a Script Engine,
they identify the SE Script branches of the project database that
identify the associated script and/or data sources. The Script Engine
program is started automatically (if not already running), and then
connects to the data sources and runs the scripts so specified.

SE OPC The OPC server component of the Script Engine program provides
online data access to script output variables specified by the project
engineer and all OPC data items obtained from other servers:
• The optional IOPCBrowseServerAddressSpace interface is
implemented, so clients can obtain a list of available data tags.
• The timestamp of each script output data item is the host PC
time at which its value last changed.

May 2007 UM5500 (5.0.0)


42 Chapter 2: Data Communication Programs

SE AES The Script Engine program also uses internal function blocks to
generate alarms and events triggered by boolean OPC data items
that obtained from other programs or calculated by this one:
• If its trigger variable becomes true, each such block generate an
AE message whose State is 1/active and timestamp equals that
of the trigger variable. The values of all other fields are defined
by properties of the corresponding Controller Alarm Variable
element in the project database.
• This program’s SE AES server component then forwards that
message to all of its clients, subject to conditions specified by
their respective AE filters.
This program’s ability to calculate trigger variables can be used to
create alarms and events for non-boolean conditions. For example,
an alarm might be indicated if an analog OPC variable exceeds a
specified threshold. The Series 4 project template included in the
Project Engineering Package includes a Script Engine program that
retrieves alarms and events from the alarm and history buffers of
such controllers and then posts appropriate AE messages.
Because this program does not provide an OPC/DA interface to the
internal operation of these blocks, they can be enabled or disabled
only via the messaging interface (which can only disable active
alarms and events). In addition, their trigger variables can all be
monitored via the SE OPC server.
If more than one instance of this program is set up to generate the
same alarms and events, disabling, re-enabling, or acknowledging a
message from one of them will not affect clients of the others.

SE AES messages have the same timestamp as the OPC/DA data


items that trigger them, which are generally the times at which their
Note: values were calculated or read from their controllers.
The acknowledgement, enabling, or disabling of any alarm or event
is communicated only to other clients of the same SE AES server.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 43

Server PC
Modbus Slave Program OPC Servers

Modbus Discretes OPC/DA Data Groups


Coils Client
Master Registers Object Data Items

Configuration
Data Tags
Configuration File

Figure 2-14 Modbus Master Access to OPC Server Data

Modbus Slave The Modbus Slave program provides a communication channel


OPC Client through which a Modbus master can access data from one or more
Program OPC Online Data Access (see page 30) servers. This can enable
Modbus masters to access data that is available in a controller’s
OPC configuration but not in its Modbus data set. It can also be
used to circumvent various limitations of the OPC protocol.
This program acts as a single Modbus node with up to 9,999 data
points of each type (coils, discrete bits, input registers, and holding
registers). A Modbus master can communicate with it via either a
serial or network connection:
• When the Modbus RTU or ASCII protocol is used, each PC can
run multiple instances of this program. Each can be assigned
any ID (0 to 255) and communicates with a single master over
any available serial port (COM1 through COM255). The OPC
data can thus be accessed by multiple Modbus masters, each of
which can use multiple ports for increased bandwidth.
• When the Modbus TCP protocol is used, only one instance of
this program can be run on each PC. Multiple masters can
access its data via any ethernet card installed in that PC.
Communication settings and register, coil, and discrete data points
are defined by a comma-separated-variable (CSV) file that is read
when the program starts up. This file can be created by either:
• using this program’s configuration interface, which allows you to
select each data point’s OPC server and browse its address
space to select the desired data tag; or
• using a spreadsheet or text editor, in which case the data tag for
each data point must be manually determined and typed in.
If multiple instances of this program are run on a single PC, they
must load different configuration files.

May 2007 UM5500 (5.0.0)


44 Chapter 2: Data Communication Programs

TrainTools Programs WOIS Programs


TrainView (TV2) PrISM Program

WOIS TrainView
Package (TV1)
Operator Interface
OPC/DA Clients
S4Map Program
Compressor Maps
TV1 OPC Server
TV1_OPC Server ForCE Program
Data Calculation

OD32 OpcDiac16
OPC/DA Client
OD16
OPC/DA

DIAC
Series3 OPC Server
Series 3
Controller MS3 Driver
S3p_OPC Server

Series 3 Configurator
Series4 OPC Server
Series 4
Controller PCommEn Driver
S4_OPC Server
SCI
SCI Interface
SCI Series 4 Configurator

Figure 2-15 Bridging OPC and WOIS/DIAC

TV1 OPC Server The TrainTools product line was developed along with our Series 5
Program Vanguard and Reliant Controllers. Previous to their introduction, we
offered Workstation Operator Interface Software (WOIS) packages
that predated and thus could not use COM. Instead, they shared
HMI data using a Dynamic InterApplication Communication (DIAC)
protocol and configured Series 4 Controllers using a DIAC superset
known as the Serial Communication Interface (SCI).
As illustrated in Figure 2-15, the TV1 OPC Server and OpcDiac16
programs from the TrainTools Platform Communication package
allow OPC/DA clients to access DIAC data sources.
Conversely, current versions of the WOIS TrainView software pack-
age include two programs named OD16 and OD32 that allow DIAC
clients to access OPC/DA servers.

SCI Interface Beginning with Release 6.1, the Series 4 OPC Server program also
provides a SCI Interface process that allows the Series 4 Configura-
tor utility and other SCI clients to communicate with controller AFMs
via the OPC server’s serial port connections.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 45

OPC/DA OPC/DA
Platform Servers Client
Communication
Servers AE AE ArcCom
Servers Client
Program
ADaM
Client
Archival
ADaM
Data Server
Manager ADaM TrainView
Clients Program

Archival Database Files ADaM Archival


within default projects folder Client Data Utilities

Figure 2-16 TrainTools Archival Data Programs

Archive Server Online process data and alarm and event messages are recorded
by the following programs in the Archive Server package:
Package
• The Archival Data Manager records, manages, and shares data
at the direction of its Archival Database Access (see page 33)
client programs.
• The ArcCom Program gathers data from various OPC/DA and
AE servers and directs the Archival Data Manager to record it,
as defined within a specified project database.
The recorded information can then be retrieved by ADaM clients
incorporated into the programs of the TrainView Package (see page
56) and Archival Data Utilities Package (see page 60):
• The TrainView program uses Events pictures to list recorded
alarm and event messages and Trends pictures to display the
variation of recorded process variables over time.
• The Archive Exporter program (which can be invoked from the
TrainView program) extracts data recorded during specified
time periods and saves it to files that can be reviewed using
Archive Viewer Events and Trends pictures. Exporting data also
preserves it beyond the configured time at which the Archival
Data Manager purges it from its database.
• The Archive Reporter creates, displays, and prints tabulated
and summarized archival data reports, and can save them to
files for viewing on other workstations or using other programs.
The Reporter Agent automatically invokes the Archive Reporter
to execute reporting actions at regular intervals or in response
to specified critical events.

May 2007 UM5500 (5.0.0)


46 Chapter 2: Data Communication Programs

Archival Data The Archival Data Manager (ADaM) program maintains one or more
Manager Archive Databases, in which data is recorded at the direction of the
ArcCom Program (see page 47) and then retrieved by other Archival
Database Access (see page 33) clients.
Three types of data can be recorded:
• All AE messages are recorded in a single Message Channel.
The length of time such messages will be retained in the archive
database is user configurable (typically four weeks).
• OPC data items are recorded in Tagged Data Channels with
various maximum resolutions and retained times.
• Messages and tagged data recorded during specified Critical
Events are copied to individual Critical Event Files.

Tagged Data OPC data items (which convey data represented by the correspond-
Channels ing server data tags) are recorded in Tagged Data Channels:
• Variables that have boolean and integer values that cannot be
averaged (for example, controller operating state and digital I/O
variables) should be assigned to the Discrete Channel. Because
such items rarely change, they are recorded at a high resolution
and retained for a relatively long time (typically one millisecond
resolution for a month).
• All real-numbered data items (analog I/O variables, for example)
are recorded in the Low-Density 1 Channel, which has a modest
resolution and retention time (by default, one second resolution
for a week).
• Rapidly-changing items can be recorded to a High-Density
Channel that has a higher resolution but shorter retention time
(typically one millisecond resolution for a day). The low-density
records for such variables are obtained by averaging the high-
density entries recorded during the corresponding intervals.
• In addition, a longer-term archive is created by averaging all
low-density variables to a second low-density channel with a
lower resolution but even longer retention time (typically one
minute resolution for a month).
The Resolution of each such channel sets the minimum interval at
which entries are added to its database file. During each such inter-
val, a record is added for each data item that changes. Each record
identifies the item, its new value, and the time at which it changed:
• If an item changes more than once during a given interval, only
the first change is recorded. For example, when recording an
item whose OPC data group is updated at 50 millisecond inter-
vals to a channel with a 100 millisecond resolution, in which
case two changes could be received during any given interval.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 47

• On the other hand, no data is recorded for intervals in which no


change is received. For example, if an item whose data group is
updated at 50 millisecond intervals is recorded to a channel with
a 10 millisecond resolution, changes will be recorded in at most
one out of every five intervals.

The frequency at which entries are added for each variable will not
Note: exceed the rate at which its tag group is updated by its OPC Server.

Critical Event Files Each project can define one or more Critical Events, each of which
will cause a critical event file to be recorded if any of its specified
triggering variables becomes non-zero. Typically, these are boolean
variables that are set when some undesirable condition is detected,
such as the active variable in an alarm group.
When it detects any such change, the Archival Data Manager will
automatically copy all AE messages and high-resolution tagged
data recorded during a length of time set by the project engineer.
That period always begins a specified number of seconds before
and usually ends a specified number of seconds after the triggering
event. However, if additional triggering events are detected during
that interval, it is extended to include all data recorded up to the
specified time after the last such event.
The maximum number of such files that will be stored in the archival
database is also set by the project engineer (typically ten). Once
that number of events have been recorded, each subsequent event
will replace the oldest previously-recorded file.

ArcCom Program When the Archive Communication (ArcCom) program is started, it


reads a specified branch of the project database and then;
• launches its host PC’s Archival Data Manager and instructs it to
open (or create) and manage an archival database as defined in
that project branch;
• subscribes to all messages posted by specified AE servers and
records them to the message channel of its ADaM database;
• connects to any specified OPC/DA servers, tells them to create
and subscribes to its assigned data groups, reads and tells
ADaM to record the values of their data items to appropriate
tagged data channels, and then continuously records all data
item updates it receives from those servers.

May 2007 UM5500 (5.0.0)


48 Chapter 2: Data Communication Programs

Database Space In addition to the hard drive space for the TrainTools programs and
Requirements project files, workstations that archive process data also require an
additional 11 bytes for each recorded data point and 60 bytes for
each recorded alarm or event. In most cases, the space required for
recorded OPC data far exceeds that for alarms and events.
The Archive Data Manager can be configured to archive data at
three different intervals, or densities, with a different duration and
granularity for each. For example, it might record:
• 100 data points every 0.1 second for 24 hours, storing that data
in six four-hour files. For each data point, each of those files
would require:
11 bytes 600 samples 240 minutes 1 MB 1.51 MB
----------------------- × ---------------------------------- × --------------------------------- × --------------------------------------- = ----------------------
sample minute file 1048576 bytes file
• Thus, six such files recording 100 points would require a total of:
100 × 6 × 1.51 MB = 906 MB
• 100 data points every second for ten days, storing that data in
ten 24-hour files. For each data point, each file would require:
11 bytes 3600 samples 24 hours 1 MB 0.906 MB
----------------------- × ------------------------------------- × ----------------------- × --------------------------------------- = --------------------------
sample hour file 1048576 bytes file
Ten such files recording 100 data points would require a total of:
100 × 10 × 0.906 MB = 906 MB
• 100 data points every ten seconds for 360 days, storing that
data in twelve 30-day files. For each data point, each file would
require:
11 bytes 360 samples 720 hours 1 MB 2.72 MB
----------------------- × ---------------------------------- × --------------------------- × --------------------------------------- = ----------------------
sample hour file 1048576 bytes file
Twelve files recording 100 data points would require a total of:
1 GB
100 × 12 × 2.72 MB × ------------------------ = 3.19 GB
1024 MB
Thus, a system recording 100 points at these three rates and dura-
tions would require approximately 5 gigabytes of hard drive space.
Space requirements for alarms and events are typically much
smaller. For example, a control system that posts an average of 100
messages per hour and stores them for a year would need:
60 byte 100 posts 8760 hours 1 MB 50.1 MB
------------------- × -------------------------- × ------------------------------ × --------------------------------------- = ----------------------
post hour year 1048576 bytes year

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 49

UM5500 TrainTools Product Overview and Setupmanual

Chapter 3 Operator Interface Programs


This chapter describes the TrainView Operator Interface Program
and Archival Database Utilities.

OPC/DA Servers AE Servers ADaM Servers

TrainView Program Archival Data Utilities

Figure 3-1 Data Sources for TrainTools ActiveX Controls

Introduction The operation of any controller that has an OPC/DA server can be
monitored, directed, and reviewed using the following programs,
which use ActiveX Controls (see page 50) to communicate with and
display data from specific OPC/DA, AE, and ADaM servers:
• The TrainView Program (see page 56) displays user-selectable
pictures that consist of ActiveX Controls and Dynamic Objects
superimposed on static background drawings:
• Most dynamic objects and ActiveX controls are connected to
specific OPC/DA and AE servers and automatically display
the most recent data available from them.
• Trend and Event controls obtain OPC data and AE messages
from specified ADaM Servers, and can be scrolled to display
any information currently archived in their databases.
This program, its ActiveX controls, and its template libraries are
provided by the TrainView Package (see page 56). As an alter-
native to installing that package on each workstation, you can
set up a TrainViewWeb Service (see page 66) whose pictures
can be viewed in Internet Explorer windows.
• The programs in the Archival Data Utilities Package (see page
60) can be used to review data from ADaM servers:
• The Archive Viewer Program uses Trend and Event controls
to display OPC and AE data extracted from ADaM databases
using the Archive Exporter Program (see page 62).
• The Archive Reporter Program (see page 61) displays, prints,
and saves tabulated reports of recorded OPC data.
Both the Archive Exporter and Reporter programs can save
data to files that can be reviewed on computers that do not have
access to the ADaM database, using either TrainTools (Archive
Viewer and Archival Reporter) or third-party programs.

May 2007 UM5500 (5.0.0)


50 Chapter 3: Operator Interface Programs

OPC/DA Server AE Server ADaM Server

Map IOView Alarms Events Trends


ActiveX ActiveX ActiveX ActiveX ActiveX
Control Control Control Control Control

Figure 3-2 Data Sources for TrainTools ActiveX Controls

ActiveX An ActiveX control is a COM/DCOM object that can be integrated


into Windows programs to provide a consistent user interface for a
Controls specific type of data. Most are implemented by dynamic link libraries
(DLLs) provided by the Windows operating system, licensed from
third-party developers, or custom-developed for specific programs.
The TrainView, Archival Data Utilities, and some other TrainTools
packages include DLL files that define any licensed third-party and
TrainTools ActiveX Controls that they might use.
TrainTools operator interface programs use the following ActiveX
controls to display information from OPC/DA, AE, or ADaM servers:
• An Alarms Control maintains a scrollable list of currently active
alarms posted by an assigned AE server. New (or all active)
alarms can be acknowledged, active alarms can be disabled,
and any disabled alarm can be re-enabled.
• An Events Control maintains a scrollable list of all alarm and
event messages recorded by an assigned ADaM server during
the time period encompassed by that server’s database.
• A Trends Control plots the time-varying behavior of a group of
OPC/DA data items recorded by an assigned ADaM server. It
usually displays the most recent information, but can be scrolled
to display any data from that server’s database.
• Map Controls use OPC server data to plot either:
• a dynamic compressor’s operation relative to its surge limit, or
• the value and limiting control threshold of some gas turbine
operating condition whose limit is defined as a function of
some other condition.
• An IOView Control provides a tabular operator interface for the
field I/O signals and signal processing blocks of a Series 5 Con-
troller, which are monitored via an S5_OPC server.
The text elements and dialog boxes of all but the Map control can be
toggled between English and Russian by the user.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 51

Figure 3-3 Events ActiveX Control

Events Control Each Events control presents a scrollable, chronological list of all
alarm and event messages recorded by a connected ADaM server
that meet specified filtering criteria:
• New messages are added to the top (or bottom) of the list with-
out removing earlier messages concerning the same condition.
• You can scroll to the messages posted nearest a specified time
or critical event.
• You can locate messages whose fields meet specified criteria.
• All messages recorded during a specified time interval can be
printed or saved to an Archive Viewer data file (see page 62).

Figure 3-4 Alarms ActiveX Control

Alarms Control Each Alarms control displays a scrollable list of all of its AE server’s
current alarms that meet specified filtering criteria:
• Each newly-detected alarm is added to the top (or bottom) of
the list, updated without changing its position whenever its state
changes, and removed if its state changes to cleared.
• Each such control can be configured to display only the earliest
of the alarms posted to it, ignoring all others until that alarm has
been acknowledged and corrected. This can help to identify the
actual cause of cascading alarms.
• One or more of the displayed alarms can be selected and then
acknowledged, disabled, or re-enabled. It is also possible to
acknowledge all active alarms simultaneously.
• The displayed list of active alarms can be printed or saved to a
text file by invoking other shortcut menu commands.
Alternately, this control can be configured to display a chronological
list of alarm and event messages like that of an Events control.

May 2007 UM5500 (5.0.0)


52 Chapter 3: Operator Interface Programs

Figure 3-5 Trends ActiveX Control

Trends Control Each Trends control plots the time-varying behavior of a group of
recorded OPC variables. That group is specified by selecting a Pen
Group from the drop-down menu at the top of the control’s Legend.
The remainder of that Legend lists the variables in the selected pen
group, indicates their current values, and shows the pen colors used
to plot their variations.
You can set the length of time for which data is normally displayed
and then zoom in or out to display data for a shorter or longer time.
The most recent data is usually shown, but you can scroll back to
view earlier data or invoke dialogs to specify a time period or critical
event for which data will then be displayed.
Each variable has a configured range, within which its values are
plotted relative to a configured portion of the graph’s height. Clicking
a legend entry selects the corresponding pen and displays a grid of
vertical and horizontal lines whose spacing is a property of that pen
or its parent group:
• Each horizontal grid line is labeled (on the left) with the corre-
sponding value of the selected variable.
• Each vertical grid line is labeled (at the top) with the correspond-
ing data sampling time.
Selecting a pen also positions brackets in the vertical scroll bar that
indicate its variable’s range.
You can also print the displayed trend graph, or export all data
recorded during a specified time period to an Archive Viewer data
file (see page 62).

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 53

Signal
Variable
Mode

I/O
Debug
Mode

Figure 3-6 IOView ActiveX Control

IOView Control Each IOView control lists and can print the current value and status
of each of a Series 5 Controller’s field I/O variables or circuits:
• Its Signals by Card mode lists the values, units, and instruments
for all assigned signals of a user-selectable field termination
assembly (FTA), while the All Signals mode lists that information
for all of the controller’s I/O signals. Either can be set to display
signals of all or any one type of input or output.
• Its I/O Debug modes lists the raw values of all assigned I/Os of
a selected local or remote I/O card.
This control can also operate a Series 5 Controller’s built-in field I/O
simulation features, which can be used for off-line training and test-
ing purposes.

May 2007 UM5500 (5.0.0)


54 Chapter 3: Operator Interface Programs

Label Accel/Decel % Upper Limit

83.33

Variable
Limited
66.67

50.

Current 33.33
Value Lower Limit

16.67 CDP barg


5.0 10. 15. 20.

Current Value Characterizer Label


Argument
Figure 3-7 Map Control Displaying a Gas Turbine Limit

Map Controls Each Map control uses OPC server data to plot a dynamic, two-
dimensional graph indicating either:
• the value of some gas turbine operating condition relative to
upper and/or lower limits that can be defined as functions of
another process variable, or
• a dynamic compressor’s operation relative to its surge limit
(which is essentially minimum flow as a function of head).
In either case, a shortcut menu provides commands for zooming in
and out or enabling an operating point trace.

Gas Turbine Maps The operation of a gas turbine is subject to several variable limits
that are commonly defined as functions of other conditions. A Map
control can be configured to display the current value of one such
variable relative to its maximum and minimum allowable values.
As shown in Figure 3-7, each such map includes:
• a user-specified number of horizontal and vertical grid lines;
• a label in the upper-left corner identifying the limited variable,
and a number at the left end of each horizontal grid line specify-
ing the corresponding value of that variable;
• one or two curves representing the maximum and/or minimum
value of the limited variable;
• a label in the lower-right corner identifying the argument variable
from which those limits are calculated, and a number at the
lower end of each vertical grid line specifying the corresponding
value of that variable; and
• an operating point cross-hair indicating the current values of
both variables.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 55

Label
Surge Limit Line

Surge Control Line

Performance Curve
Current
Value
Variable
Head

Flow Variable Current Value Label

Figure 3-8 Map Control Displaying Compressor Surge Limit

Compressor Maps If the flow through an axial or centrifugal compressor falls below a
minimum limit that is a function of the developed head, it will drop
precipitously and might even reverse. Antisurge controllers protect
against this potentially damaging phenomenon by opening a valve
to increase the total flow when operating near that limit.
A Map control can be configured to indicate how closely such a
compressor is operating to its surge limit. As shown in Figure 3-9,
each such map includes:
• a user-specified number of horizontal and vertical grid lines;
• a label in the upper-left corner identifying the head variable, and
a number at the left end of each horizontal grid line specifying
the corresponding value of that variable;
• a label in the lower-right corner identifying the flow variable, and
a number at the lower end of each vertical grid line specifying
the corresponding value of that variable;
• an operating point cross-hair indicating the current values of
both variables;
• the controller’s surge control line (it will increase the flow if the
operating point moves to the left of this line);
• the compressor’s surge limit line (the machine will surge if the
operating point moves to the left of this line);
• several curves representing combinations of head and flow that
can occur at various speeds or guide vane positions; and
• optional compressor efficiency and power limit curves.

May 2007 UM5500 (5.0.0)


56 Chapter 3: Operator Interface Programs

Figure 3-9 Example of TrainView Run-Time Window

TrainView The TrainTools TrainView software package includes the TrainView


Program, all ActiveX Controls and other supporting files it might
Package need, and the TrainView Template Libraries (see page 59). The
operation of a TrainView interface developed from those templates
is described by the TrainView Program operator manual [UM5522].

TrainView The TrainView operator interface program displays a collection of


Program interactive TV Pictures. Each consists of a background drawing with
superimposed ActiveX Controls or Dynamic Objects. Each picture,
object, and control can be assigned a Visual Basic script to define or
modify its interaction with the operator and its data sources.
Each picture, object, or script can be an instance of a corresponding
object from our standard or a custom TrainView template library, or
uniquely developed for a specific application (perhaps by modifying
a similar library object).
Access to critical features is controlled by the TrainTools security
system (see Appendix D). Although certain program features are
available only to users logged on at some minimum access level (for
example, only users with engineer or higher access can shut down
the TrainView program), most such restrictions are scripted and can
be customized.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 57

Numeric 429.53

1 2
Sequence GT-123 Switcher OFF ON 3 4

Linear Slider

Rotative Knob

Figure 3-10 Examples of TrainView Dynamic Objects

Dynamic Objects Dynamic Objects consist of a static background with an overlying


image derived from the object’s value, which is in turn set by an
associated script in response to an OPC data item update or an
operator action. These can be taken from our standard TrainView
libraries or custom designed for specific projects:
• Numeric Objects, which are most commonly used for process
variable readouts, display real numeric values.
• Sequence Objects, which are used to mimic single or groups of
LEDs and equipment symbols that change color to indicate their
status, display one of several defined overlays based on their
boolean states or integer values.
• Switcher Objects, which are used to mimic switches, keypads,
and grouped or individual buttons, are sequence objects whose
values can be changed by clicking within defined areas.
• Linear Objects are used to mimic process variable bar graphs.
The appearance of each is interpolated from two overlay objects
whose positions correspond to a process variable’s minimum
and maximum values.
• Slider Objects are used to mimic linear potentiometers. Each is
essentially a linear object that can be used to change the value
of a process variable by dragging a sliding “thumb” control or
clicking on its desired position.
• Rotative Objects are used to mimic angular meter movements.
The appearance of each is interpolated from two overlays (two
needle positions, for example) whose angular orientations cor-
respond to a variable’s minimum and maximum values.
• Knob Objects are used to mimic rotating potentiometers. Each
is essentially a rotative object that can be used to change the
value of a process variable by dragging a rotating knob or click-
ing on its desired position.

May 2007 UM5500 (5.0.0)


58 Chapter 3: Operator Interface Programs

Figure 3-11 Typical Control System Process and Instrumentation Drawing

Dynamic objects can be grouped into composite objects that display


and can change several OPC data items, such as the simulated
controller faceplate shown in Figure 3-12.

TV Pictures Each TrainView picture consists of an optional background and


some combination of ActiveX Controls and Dynamic Objects that
typically represent any or a combination of the following:
• a piping and instrumentation drawing (P&ID) for monitoring the
operation of a turbomachinery train,
• a map of a compressor or gas turbine’s performance relative to
its design limitations,
• trend graphs that plot process variables as functions of time,
• scrollable lists of control system alarms and events,
• simulated controller faceplates for operating control loops,
• tabular lists of controller field inputs and outputs, and
• navigation bars for activating and hiding the other pictures.
Those pictures are continuously updated to reflect current process
conditions, as reported by associated controller communication
programs. Conversely, operator interactions with picture elements
(clicking on buttons, for example) can trigger controller actions by
changing the appropriate OPC/DA variables.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 59

Title Bar
Loop Selection Button
Variable
Readouts

Status Readout

LEDs and Buttons

Figure 3-12 Typical Controller Faceplate Components

TrainView Each picture, object, or script included in a TrainView interface can


Template be an instance or modification of a corresponding object from a
Libraries TrainView library, which is a collection of such objects previously
created and saved as a library project. This can greatly reduce the
amount of time needed to engineer an operator interface.
An interface element added from a template library can be resized
and connected to an appropriate data source, but retains most of
the other properties of its template (including its scripted behavior)
unless its template link is reset. If a library is revised, all objects
linked to it can be easily updated to incorporate any improvements
and corrections.
The TrainView software package includes our Standard Templates
library, from which our engineers create most of the TrainView
projects commissioned by our customers. It includes picture and
dynamic object templates (many with predefined scripts) that depict:
• operator panel buttons, indicator lights, gauges and numeric
readouts;
• simulated faceplates that can be used to operate various CCC
compressor and turbine controllers;
• various rotating machines, process vessels, pipes, and final
control elements for inclusion in P&ID drawings;
• standard Alarm, Event, and Trend control pictures; and
• our standard interface navigation bars.

May 2007 UM5500 (5.0.0)


60 Chapter 3: Operator Interface Programs

Archive
Reporter Report Files
Third-Party
Archival Data Programs
Manager CSV Files
Archive Archive
Exporter Viewer
Archival
Database ADaM Files

Figure 3-13 Archival Data Utility Programs

Archival Data The Archival Data Utilities package includes the following programs,
which can be used to extract, save, display, and print data recorded
Utilities by the Archival Data Manager (see page 46) during specified time
Package periods or critical events:
• The Archive Reporter Program can be automatically invoked
by the Reporter Agent Program to generate, display, and print
tabulated and summarized OPC data reports. Those reports
can also be saved to files that can be viewed on any PC using
the Archive Reporter or various third-party programs.
If the TrainView and Archival Data Utilities packages are
installed on the same PC:
• TrainView scripts can invoke the Archive Reporter to generate
reports at an operator’s request, and
• the ActiveX control the Reporter program uses to display and
print reports can be incorporated into TrainView pictures to
allow reports to be viewed from within the TrainView interface.
• The Archive Viewer Program uses the same Trends and Events
ActiveX controls as the TrainView program to display OPC data
and AE messages extracted from the archival database using
the Archive Exporter Program.
In addition, the Archive Reporter and Exporter programs can both
save archival data to files that can be analyzed using third-party
spreadsheet and database programs.
The Archival Data Viewers user manual [UM5521] describes and
tells how to use the programs in this package.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 61

Archive Reporter The purpose of the TrainTools archival data reporting system is to
Program provide tabulated and summarized reports of process conditions, at
regular intervals and/or in response to critical process changes:
Reporter Agent
• The content and appearance of each report and the times or
Program
conditions under which it will be automatically generated are
specified using TrainTools project engineering programs (see
TrainTools HMI Engineering on page 78).
• Each report is generated by an Archive Reporter program
instance that is invoked by the Reporter Agent program (or a
TrainView script) to print, display, and/or save that report to
Windows or UNIX file system locations.
For example, a report could be saved to a file server HTML or
PDF file for viewing via a company intranet. In addition, notices
of its generation (and an optional copy of any generated file)
can be emailed to specified recipients.
• The program used to open a report file depends on its format:
• RDF (Report Data Format) files can be viewed, printed, and
saved to other formats using the Archive Reporter program
(or a TrainView picture incorporating the report viewing
ActiveX control).
• XLS files can be opened and analyzed using Microsoft Excel
or a compatible spreadsheet program.
• PDF files can be viewed and printed using the Adobe Acrobat
Reader or most other programs capable of opening Portable
Document Format files.
• HTML files can be viewed using a web browser or other pro-
gram capable of opening HyperText Markup Language files.
• RTF files can be opened by most word processors and other
programs capable of importing Rich Text Format files.
• TXT files can be opened by any text editor or other program
capable of opening unformatted text files.
• TIF files can be opened using almost any paint program, or
imported into documents by any program capable of display-
ing Tagged Image Format bitmap files.

May 2007 UM5500 (5.0.0)


62 Chapter 3: Operator Interface Programs

Archival Data TrainView


Manager
Trends Events
Control Control

Archive CSV & XML Third-Party


Exporter Data Files Programs

ADaM Native Archive


Data Files
Viewer
Trends Events
Control Control

Figure 3-14 Data Flow for Trends and Events Controls

Archive Viewer The Events and Trends ActiveX controls (see page 51 and page 52)
Program that TrainView pictures use to display current AE messages and
OPC data trends can also be scrolled back to visually review the
Archive Exporter operation of a process at earlier times, particularly during critical
Program process events. Alternately, the Archive Exporter program can be
used to save such data to files that can be moved to and replayed
on other PCs using the Archive Viewer program, which incorporates
the same Events and Trends controls (see Figure 3-14).
The Exporter program, which must be run on the same computer as
the Archival Data Manager (see page 46), can save either:
• a file that includes all of the data recorded during a specified
time period or critical event, which can only be reviewed using
the Archive Viewer program; or
• comma separated variable files that include only specified OPC
data items and filtered AE messages, which can be reviewed
using the Archive Viewer or third-party spreadsheet and data-
base programs.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 63

UM5500 TrainTools Product Overview and Setupmanual

Chapter 4 Web Communication


This chapter discusses the communication of process data and
TrainView pictures via TrainTools web services, as an alternative to
DCOM (see Distributed Communication Options on page 156).

OPC Data Alarm and Archival Data


Access Clients Event Clients Clients
COM

WebGateway HTTP WebServices


Programs Programs
COM

OPC Data Alarm and Archival Data


Controllers Access Servers Event Servers Managers

Figure 4-1 TrainTools Web Process Data Communication

Introduction The TrainTools Web software package provides a group of software


modules that implement two types of web services:
• The TrainTools web communication services allow OPC, AE,
and/or ADaM clients and servers on separate PCs to communi-
cate using HTTP instead of DCOM (as discussed on page 156).
• The TrainViewWeb Service allows operator interface pictures to
be viewed on any PC as Internet Explorer web pages, without
directly installing any TrainTools software on them, requiring
project database access, or employing DCOM communication.
These services are provided by the WebServices Program, which
must be installed and run on each web communication or TVWeb
server PC. Similarly, the WebGateway Program is installed on client
workstations (or downloaded to them as part of the TVWeb plug-in).
OPC, AE, and ADaM clients running on client PCs connect to the
corresponding COM servers in their local WebGateway programs,
which forward equivalent HTTP requests to WebServices programs.
The WebServices programs reconstitute the COM requests and
pass them to the intended OPC, AE, and ADaM servers (which start
automatically). The server responses are returned to the WebGate-
way programs, which reconstitute and pass them to the COM clients
that originally requested them.
If communication between the PCs is disrupted, the connection
between the WebServices and WebGateway programs will be auto-
matically restored as soon as possible.

May 2007 UM5500 (5.0.0)


64 Chapter 4: Web Communication

Server Programs WebServices Program


OPC/DA COM OPC/DA HTTP
DAService

to Web Services Clients


Server Objects Client Object

Alarm/Event COM Alarm/Event HTTP


Server Objects Client Object AEService

ADaM COM ADaM HTTP


Server Object Client Object ArcService

HTTP
TVWeb Software, TVWebService
Pages and Projects

Figure 4-2 WebServices Program Components

WebServices The TrainTools WebServices Program provides all four of the Train-
Program Tools web services:
• The three web communication services allow remote clients to
access the corresponding COM servers of its host PC:
• Web DAService clients access controller HMI variables via
the host’s OPC/DA servers. Those servers automatically
report any subscribed variable changes to the DAService,
which it forwards to its web clients on request.
• Web AEService clients obtain AE messages from the host’s
TrainTools AE servers. Those servers automatically report
subscribed messages to the AEService, which it forwards to
its web clients on request.
• Web ArcService clients retrieve recorded OPC data and AE
messages from the host’s TrainTools ADaM server.
• The TrainViewWeb Service (see page 66) allows remote clients
to download TVWeb pages, project files, and client software.
This program must be started (manually or as part of the host PC’s
startup sequence) before web clients can obtain data from it. Once
started, however, it will automatically start and connect to any OPC,
AE, and/or ADaM servers those clients request data from.
If communication with a client is disrupted, the corresponding COM
connections are automatically closed and the associated service
subscriptions are deleted. If communication with that client is then
restored and it tries to access those connections and subscriptions,
it will be told to first reestablish them.
For security, web clients cannot set variables or acknowledge
alarms unless they provide the name and password of a TrainTools
account with operator or higher privileges (see Appendix D).

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 65

to TTWebComm Hosts
WebGateway Program Client Programs
DAService Client WebG_OPC Server OPC/DA Clients

AEService Client WebG_AES Server AE Clients

ArcService Client WebG_ARC Server ADaM Clients

Figure 4-3 WebGateway Program Components

WebGateway The TrainTools WebGateway Program incorporates three DCOM


Program servers, each of which serves as a proxy for and communicates with
remote servers of the same type via the corresponding TrainTools
web communication service:
• WebG_OPC Server clients can read and set controller variables
via the Web DAServices and OPC/DA servers of other PCs,
• WebG_AES Server clients are passed and can acknowledge,
enable, or disable messages via the Web AEServices and AE
servers of other PCs, and
• WebG_ARC Server clients can retrieve recorded data via the
Web ArcServices and ADaM servers of other PCs.
Although this program is usually used only in conjunction with Train-
Tools client programs, third-party OPC/DA clients can obtain data
through it. TrainTools WebServices programs running on other PCs
are its only possible source of information.
If this program is not running, the host PC’s operating system will
automatically launch it if any client connects to one of its servers. It
will then subscribe to and periodically retrieve the web service data
requested from any remote PC as soon as its WebServices program
is started.
If communication with a web host is disrupted, this program will still
try to retrieve its subscribed data but will obviously have no variable
changes or new messages to report until the problem is resolved. At
that time, the host will either resume sending new data or report that
the referenced subscription does not exist. If need be, this program
will re-establish the subscription so it can resume retrieving data.

May 2007 UM5500 (5.0.0)


66 Chapter 4: Web Communication

TVWeb Server Client PC


TVWeb TrainViewWeb Internet Explorer, TVWeb Plug-In
Projects Service TrainView Pictures
Alarms Trends Events
Server PCs Control Control Control
ADaM, AE & Map IOView
Controllers OPC Servers Control Control

TTWebComm
Services WebGateway Program

Figure 4-4 TrainViewWeb Operation

TrainViewWeb The TrainViewWeb Service allows TrainView (TV) workstations to


Service be set up, run, and automatically updated without directly installing
any TrainTools software on them, requiring direct project database
access, or employing DCOM communication:
Step 1: Each control system’s operator interface is defined using the
Project Builder and TrainView programs (see Chapter 6), and
then exported to the project’s TVWeb folder.
Step 2: That folder is copied to one or more TVWeb server PCs, on
which the WebServices Program (see page 64) must be run (a
TVWeb project can be served from the PC it was created on).
Step 3: The Internet Explorer program of each operator workstation
is used to view the TVWeb pages of such a server. Each such
page displays an ActiveX control that is used to select and dis-
play one of its server’s TVWeb projects.
Step 4: Selecting a project downloads it from the server (unless its
current version is already present on the client) and displays
its TV pictures, whose dynamic objects and ActiveX controls
obtain OPC, AE, and archival data via a local WebGateway and
remote TrainTools web communication server (which can but
need not be the TVWeb server).
If the current versions of the TV ActiveX controls and WebGateway
program are not already present, they are collectively downloaded
and installed as components of the TrainViewWeb plug-in.
The number of workstations that can connect to any TVWeb server
at any one time is limited by its license (see page 120).

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 67

UM5500 TrainTools Product Overview and Setupmanual

Chapter 5 Field Engineering Utilities


This chapter describes the Platform Engineering Utilities, which are
used to configure and tune CCC controllers.

Series 4 Series 4 Series 4


Controllers OPC Program Configurator

Series 3 (all) Series 3 Series 3


Controllers OPC Program Configurator

Series 5 Series 5 Series 5


Controllers OPC Program Configurator

Series 5 Duplex Fast


Supervisor Recorder
Script Engine Alarm
or GC AES Monitor

Figure 5-1 Field Engineering Utilities

Introduction Engineering Utilities are programs that test, configure, tune, and
upgrade the application software of various CCC controllers:
• Each of the Configurator Utilities (see page 68) displays and
allows you to change the configuration parameters and some or
all of the other HMI variables of a specific CCC controller series.
Most can also load revised controller software.
• The Series 5 Duplex Supervisor (see page 71) compares and
can synchronize the operating system, application software,
and configuration of duplex Vanguard and Reliant Controllers.
• The Fast Recorder Utility (see page 72) plots the time-variant
behavior of selected OPC data items as a controller tuning aid.
• The Alarm Monitor Utility (see page 73) displays and allows the
user to acknowledge alarm and event messages from any
TrainTools AE Server.
When installing this package, the TrainTools Setup Utility (see page
99) can be instructed to include all or only those programs that are
applicable to the CCC Controllers you have. The TrainTools Series
5 Engineering Utilities manual [UM5512], Series 3 Engineering Utili-
ties user manual [UM5513], and Series 4 Engineering Utilities user
manual [UM5514] tell how to use the applicable programs to config-
ure and maintain the corresponding controllers.
None of these programs requires access to a project database.

May 2007 UM5500 (5.0.0)


68 Chapter 5: Field Engineering Utilities

Figure 5-2 Main Window of Series 5 Configurator Utility

Configurator Each Configurator utility displays and can change the configuration
parameters and possibly other HMI variables of the corresponding
Utilities type of CCC controller. In addition, a Series 3 Plus / 3++ or Series 5
Controller’s software can be updated using its Configurator utility.

Series 5 The Series 5 Configurator displays all controller HMI variables and
Configurator allows users to change commands and configuration parameters. It
can also load new or revised application software into such control-
lers and synchronize their internal clocks with its host PC. Beginning
with version 6.1, this program can also save extensive diagnostic/
troubleshooting information to a zip file, and download revised AE
definitions files and Modbus data sets to a running controller.
This program connects to any requested controller via its Series 5
OPC Server, then browses that server’s data tags to identify and list
the controller’s HMI variables. Expanding any group (including those
for AE blocks) displays its child groups and the values of its configu-
ration, command, and status variables. Changing a parameter or
command’s value will immediately affect the controller’s operation.
You can also record all of a controller’s HMI variables or only its
configuration parameters to snapshot files that can be compared or
downloaded to any controller running the same application software.
This program can also display simulated controller faceplates that
can be used to operate control applications or an IOView Control
(see page 53) to monitor or diagnose field inputs and outputs.

The Series 5 Configurator will always communicate via an instance


Note: of the Series 5 OPC Server program running on the same PC.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 69

Figure 5-3 Main Window of Series 4 Configurator Utility

Series 4 The Series 4 Configurator program displays groups of HMI variables


Configurator and allows you to change the values of command variables and
configuration parameters. It can also display the status and internal
alarms and events of a controller’s Application Function Modules
(AFMs), and operate them using simulated face plates.
This program queries each AFM is to identify the operating system
and control applications it is running, then uses template files to:
• identify, read, and display groups of configuration and operating
parameters, whose individual values can be changed to alter
the AFM’s operation, or
• upload AFM parameter sets to image files that can be moved to
other PCs, edited, compared, and downloaded to other AFMs.
Beginning with release 6.1, the Series 4 OPC Server does support
this program’s Serial Communication Interface (SCI) protocol, thus
allowing them to share a single controller serial port connection.
Previously, separate connections were needed to use SCI and OPC
clients simultaneously.

Changing a parameter read from a controller will alter its operation,


Note: changing an image of its parameter set will not.

May 2007 UM5500 (5.0.0)


70 Chapter 5: Field Engineering Utilities

Figure 5-4 Main Window of Series 3 Configurator Utility

Series 3 Plus The Series 3 Configurator utility displays and allows you to change
Configurator the values of all Series 3, 3 Plus, and 3++ Controller configuration
and tuning parameters, and to download new controller software:
• Each controller’s application software is stored in two memory
blocks that can be overwritten by control program files down-
loaded via the Series 3 OPC Server Program (see page 38).
The Configurator utility can determine which program any given
controller is running by reading specific Modbus coils.
• The parameter set for each such program is stored in another
memory block that can be read and overwritten using Modbus
functions that are also invoked via that OPC Server. The offsets,
default values, and possible ranges of all parameters for each
control program are recorded in a corresponding template file.
Sets of parameter values can be uploaded from controllers,
read from project files created by this program, or created from
the supplied templates. Any such set can then be displayed,
printed, compared, edited, added to a project, or downloaded to
any controller running the corresponding control program.

The Series 3 Configurator utility must be run on the same PC as the


Series 3 OPC Server program.
Note: Editing a parameter set has no affect on the controller (if any) from
which it was uploaded from unless you subsequently download it
back to that controller.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 71

Figure 5-5 Main Window of Series 5 Duplex Supervisor Utility

Series 5 Duplex The operation of a duplex Series 5 Controller assumes that the
operating system, application software, and configuration data for
Supervisor the main and backup modules are identical. Compliance with this
requirement can be checked and restored (when necessary) using
the TrainTools Duplex Supervisor utility.
• Comparison operations can be manually initiated following
maintenance or other operations that might create differences
between the active and backup controllers. If any differences
are found, both controllers post an alarm and the supervisor
program records them in its log file.
• Those discrepancies can be eliminated by initiating a learning
operation, which copies the active MPU’s application software
and configuration to its peer. At the conclusion of that process,
both controllers post an event indicating its success or failure.
This utility can be set to initiate such comparisons at regular inter-
vals, but all learning operations must be started manually.
Detailed operating instructions for the supervisor program can be
found in the TrainTools Duplex Supervisor Utility Program Technical
Note [TN32].

May 2007 UM5500 (5.0.0)


72 Chapter 5: Field Engineering Utilities

Figure 5-6 Main Window of Fast Recorder Utility

Fast Recorder The Fast Recorder utility allows you to record and display trend
graphs of specified OPC data items in real-time. It is used primarily
Utility when tuning controllers or troubleshooting process problems.
This program can be operated in either of two modes:
• The On-Line Mode creates OPC data groups comprised of user-
selected data items from any available OPC/DA server (see
page 30), and requests that those servers report changes at a
user-specified update rate. The resulting data are displayed as
trend graphs and can also be recorded.
• The Replay Mode displays trend graphs of recorded data, and
can export it to third-party reporting and analysis programs via
comma separated values files.
In either mode, any one of ten trends pages can be displayed, each
plotting the time variation of up to ten variables using user-specified
pen colors. The active page can be toggled between displaying the
variables assigned to the current page in individual compartments or
as a single set of overlapping curves.
The ability to connect to OPC servers running on other computers
was purposely omitted from this program in order to assure it could
reliably obtain information at the intended high sampling rates.

The Fast Recorder utility can only connect to OPC servers running
Note: on the same computer.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 73

Figure 5-7 Main Window of Alarm Monitor Utility

Alarm Monitor The main window of the Alarm Monitor program consists primarily of
two instances of the TrainTools Alarms Control (see page 51) that
Utility display messages posted for a specific controller by its TrainTools
AE Server:
• The upper control lists only the most recent message for each
unacknowledged or uncorrected alarm conditions.
• The lower control is a chronological list of all alarm and event
messages posted by the connected server.
Both controls can use the same user-defined AE filter to specify any
conditions that messages sent to them must satisfy (see Alarm and
Event Messaging on page 31).
Any or all active alarms can be acknowledged, the events list can be
cleared, and either list can be printed or saved to a file.

May 2007 UM5500 (5.0.0)


74 Chapter 5: Field Engineering Utilities

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 75

UM5500 TrainTools Product Overview and Setupmanual

Chapter 6 Project Engineering


This chapter describes the Project Engineering Utilities and Train-
Tools project engineering process.

Project Database Accounts Database

Project Data Interface

Project Run-Time Administrator


Engineering Interface Program

Figure 6-1 TrainTools Project Data Access

Introduction TrainTools Workstations are adapted to specific applications by


developing a hierarchical Project Database that:
• lists the data tags available from each OPC/DA server, which
TrainTools client programs use to access the corresponding
controller variables;
• defines the operation of and OPC data groups for the Script
Engine and Generic Controller AE Server programs;
• configures the data archiving and reporting processes; and
• defines the elements of and OPC data groups for each Train-
View operator interface.
Series 5 Control System projects also specify their instrumentation,
controller hardware, and control applications. That information is
then used to generate each controller’s application software and
various engineering reports (see page 79).
As shown in Figure 6-1, each project database is created using
TrainTools Project Engineering Programs, stored on any network-
accessible PC, and accessed by run-time HMI programs via the
Project Data Interface (PDI). To prevent unauthorized modifications,
that PDI restricts each program user’s ability to access or change
the project database to a level specified for him or her in the Train-
Tools Accounts Database of the PC the project files are stored on.
Appendix D tells how to use the Administrator program to create an
accounts database.

The OPC/DA Server and Engineering Utility programs for CCC


Note: Controllers do not use information from the project database and
thus do not require project engineering.

May 2007 UM5500 (5.0.0)


76 Chapter 6: Project Engineering

Project Builder

Application Application TrainView Script Archive


Editor Generator Program Engine Reporter

Project Database

Figure 6-2 TrainTools Project Engineering Programs

Project Each TrainTools HMI or Series 5 Control System is designed using


Engineering an integrated set of TrainTools project engineering programs (see
Programs Figure 6-2):
• The Project Builder is used to create the project database and
add or modify most of its elements, and to invoke the design
modes of other TrainTools programs. Its use is described in the
TrainTools Project Builder Program user manual [UM5531].
Beginning with version 5.0, user-defined commands can be
added to the user interface of this program.
• The design modes of the TrainView, Script Engine, and Archive
Reporter programs are used to develop the run-time human-
machine interface.
• For each Series 5 Controller, the Application Generator creates
an IEC-61131 program incorporating its described tasks, from
which it compiles the controller’s application software and transit
files. When custom function blocks are required, the Application
Editor is used to create and modify them prior to compilation.
Finally, the Series5 Configurator engineering utility is used to
download and configure each controller’s software.
Beginning with version 5.0, each Series 5 Controller’s Modbus
dataset can be defined using the Project Builder program.
Beginning with version 6.1, the Project Builder program can
modify the Modbus dataset and/or alarm and event message
attributes of a running Series 5 Controller. Alternately, it can
save special project revisions that include the associated transit
files, which can then be installed by the Series 5 Configurator.
Series 5 Controller software engineering is described in the
Series 5 Control System Engineering manual [UM5535].
The Project Builder, Application Generator, and Application Editor
comprise the Project Engineering software package, which should
be purchased by all customers who want to create or modify:
• TrainView operator interfaces;

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 77

• data archiving and reporting processes;


• Series 5 Controller logic control programs, Modbus data sets,
and/or alarm and event message attributes;
• Script Engine scripts; or
• Script Engine and Generic Controller alarms and events.
The TrainView, Script Engine, and Archive Reporter programs are
included in the TrainView, Platform Communication, and Archival
Data Utilities packages, respectively, which any one wanting to run
those programs would have to purchase. In order to engineer their
operation, the Project Engineering package would also be needed.

Project Unzip Control system projects are archived and distributed as compressed
Utility revision folders that can be created and opened using the Project
Builder program. Beginning with version 6.1, all TrainTools installa-
tions include a new Project Unzip utility that can also extract the files
from such revision folders. This means you no longer have to install
the Project Engineering package in order to unzip such folders.

May 2007 UM5500 (5.0.0)


78 Chapter 6: Project Engineering

TrainTools HMI The operation of some TrainTools run-time programs are configured
by project database branches that must be specified when those
Engineering programs are started or their data is accessed:
• When the ArcCom Program (see page 47) is started, a project
branch specifying the archival database it should create or open
and the data it should gather and record must be identified.
• When the TrainView Program (see page 56) is started, a project
branch defining its operator interface elements and their data
sources must be identified.
• When the run mode of the Archive Reporter Program (see page
61) is invoked, a project branch defining the report it should
generate must be identified.
If the Reporter Agent Program (see page 61) is started, the
project branch defining the times or conditions under which it
should invoke the Archive Reporter must be identified.
However, the Archive Exporter, Archive Viewer, and view mode
of the Archive Reporter program require no access to either the
project or the archival database.
• The data tags that OPC clients of the Script Engine Program
(see page 41) must provide to add data items to their data
groups specify the project database branches that identify the
script files and OPC data it uses to calculate those variables.
• When an AE client connects to a Script Engine or the Generic
Controller AE Server Program (see page 40), a project branch
specifying its alarms and events and their OPC trigger variables
must be identified.
All other Platform Communication programs operate independently
of the project database, as discussed in Chapter 2. Project data-
base elements describing the controller data available from them
are added only to provide the information TrainTools clients need to
access that data.
The Engineering Utility programs also operate independently of the
project database, as discussed in Chapter 5. However, the Alarm
Monitor utility can be used with Series 3 or 4 Controllers only if a
Script Engine or GC AES program has been engineered to generate
alarm and event messages for them.
The project elements that configure the data archiving process and
tell TrainTools programs how to subscribe to OPC data tags and AE
messages are discussed in the PC Communication Engineering
manual [UM5532]. Those that govern the archival data reporting
process are discussed in the Archival Data Report Engineering
manual [UM5533].

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 79

Series 5 Defining the connections between field instruments, control program


variables, and HMI elements is perhaps the most error-prone aspect
Controller of control system engineering. For example, if you connect a pres-
Engineering sure transmitter to a controller analog input, you typically have to:
• add that connection and the transmitter specifications to various
reports and drawings,
• determine where and how that signal is represented within the
controller’s memory,
• map a control program variable to that memory location,
• define a control program variable to represent the “real-world”
value of the corresponding process condition,
• calculate and enter scaling coefficients for that process variable
from the transmitter specifications, and
• configure an operator workstation variable to track (and option-
ally rescale) that process variable.
For Series 5 Control Systems, the TrainTools project engineering
programs simplify this process by automating the scaling, memory
mapping, communication connections, and report generation, so the
project engineer can focus on adapting control program and HMI
components to the controlled process. The database for such a
project will include branches specifying its process instrumentation,
controller hardware, and control applications. That information is
then used to generate each controller’s application software and
various engineering reports, as well as to define the data tags and
AE messages available from its Series 5 OPC Server program.
TrainTools version 6.1 is required to engineer Vanguard Controllers
that employ the MPU-1002 card.
Project elements that are specific to such projects are discussed in
the Series 5 Control System Engineering manual [UM5535].

May 2007 UM5500 (5.0.0)


80 Chapter 6: Project Engineering

I/O Card S5 Signal Control


FTA Input Application
Transmitter Input : CM Input
Input InOut Input
Key:
Connection
Data Flow
I/O Card
FTA S5 Signal
Transducer Output : CM Out InOut Output

Figure 6-3 Project Database Field I/O Connections

Application Although the application software for Series 5 Controllers is created


Software using IEC-61131 compliant tools, familiarity with that standard’s pro-
gramming languages is needed only to develop custom process or
logic control programs. The application software for controllers that
only require features provided by our standard TrainWare machine
control programs can be created using the following procedure:
• The Project Builder program is used to add database elements
specifying the I/O processing and standard control applications
to be executed by each controller:
• Each controller’s hardware is specified by adding S5 Rack
(Vanguard) and S5 Reliant branches.
• Process instrumentation and control elements are specified
by adding Instrument elements and connecting them to I/O
conditioning module elements of the controller branches.
• I/O scaling, testing, and selection tasks are specified by add-
ing S5 Signal elements and connecting them to conditioning
module elements.
• Control applications are specified by adding S5 Functions and
connecting their inputs and outputs to S5 Signals.
• The Application Generator and Application Editor are invoked to
cooperatively generate the application software described by
each controller branch.
• The Series5 Configurator engineering utility is used to download
and configure each controller’s application software.
• Optional I/O Wiring and other engineering reports are printed
using the Project Builder program.
When custom logic is needed, additional elements are added to the
database to specify the IEC-61131 programming language and the
HMI variables, inputs, and outputs of each custom Program Organi-
zation Unit (POU). The control algorithms of those POUs are then
coded using the Application Editor, after which each controller’s
application software is generated and downloaded as above.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 81

UM5500 TrainTools Product Overview and Setupmanual

Chapter 7 Controller Emulation


This chapter discusses the Series 5 Controller emulation program.

Instructor’s
CCC Interface DCS
Series 5 Virtual Control
Emulator Process Modules
Series 5 OPC
OPC Server Server
TrainTools Operator
HMI Interface

Figure 7-1 Typical Operator Training Simulator Components

Introduction An operator training simulator (OTS) is often used not only for train-
ing purposes, but also for developing and testing the configuration
and tuning of control system features. They typically incorporate:
• a process simulation computer that has an integral or separate
engineering/instructor interface console;
• an emulated DCS (with real operator workstations) that interacts
with the process simulation via its OPC server; and
• emulated proprietary control and safety systems.
If the proprietary control system includes Series 5 Controllers and
TrainTools Workstations, the OTS can exactly duplicate their field
implementation by incorporating TrainTools Workstations running
identical HMI software in conjunction with the Series 5 Emulator
Program (see page 82).
That program can emulate the operation of up to sixteen Series 5
Controllers, which the process simulator interacts with and controls
via their Series 5 OPC Server. Those emulated controllers then run
exactly the same application software as their real-world counter-
parts, which is downloaded, configured, and operated in exactly the
same way.

May 2007 UM5500 (5.0.0)


82 Chapter 7: Controller Emulation

TrainTools Operator Training Station


Applications
Series 5 Series 5
Emulator Series 5 Parameters Configurator
OPC
Emulator Server Commands TrainView
Instances Program
Status Variables

Process Series 5 Inputs, Commands


Process
Simulation OPC Simulators
Computer Server Outputs, States

Figure 7-2 Series 5 Control System Emulation

Series 5 The Series 5 Emulator program can execute up to sixteen emulated


controller instances, each of which implements most functions of the
Emulator Series 5 Controller real-time operating system (RTOS). When used
Program in conjunction with Series 5 OPC Servers and third-party process
simulators, they allow a single PC to duplicate the operation of up to
sixteen interacting Series 5 Controllers.
Emulated controllers are configured and operated using other Train-
Tools programs running on the same or networked computers, thus
providing an inexpensive and versatile tool for training operators
and testing controller feature, tuning, and configuration changes.
Each emulated MPU can communicate with Series 5 OPC servers
running on only two or three PCs, depending on their clients.
The application software for each emulator instance is identical to
that of the emulated Reliant or Vanguard Controller, except that it
must be recompiled to run on the PC. It is uploaded to the emulated
controller (which stores it in a file on the PC’s hard drive) and config-
ured using the Series 5 Configurator engineering utility, just like it
would be for a real controller. Unlike a real controller, however:
• Emulated controllers have no field inputs and outputs. The
associated process simulators set their input signals and read
their output signals via a Series 5 OPC Server.
• Their execution can be paused at any time, so full snapshots
recording the values of all I/O and state variables at that exact
instant can be recorded.
• They can then be restored to any previously recorded state by
pausing them and downloading the desired snapshot.
• They can be “fast forwarded”, then stepped through periods of
special interest in “slow motion”.
In order to run this program, a hardware key provided by CCC must
be inserted into one of the host PC’s USB ports.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 83

Emulated Application Software and Data Buffers


Series 5 OS Input Input Control Output Output
Programs Signals Programs Signals Programs

Boot Loader Input Machine Output


PC File System Block Control Block
Application
Application Input Output
Software Block Block
Custom
Transit Emulator Input Logic Output
Files Globals Block Application Block

Battery RAM
File

S5 Protocol Driver HMI Data TrainLink and


Variables Packets IMCB Drivers

Shared
S5 OPC Server OPC Client Memory
Buffers

TrainTools S5 Configurator
Clients Process Simulator

Figure 7-3 Functional Diagram of Emulated Controller Instance

Emulator OS Figure 7-3 illustrates the flow of information within an emulated


Series5 Controller, which implements all facets of the Series 5 OS
except field I/O and serial communication:
• The input processing blocks of the emulated controllers are
forced to operate in an IO Simulation Mode (see page 84). The
customer-supplied process simulation programs can then vary
the control application input signals via the ext_Simulate_value
variables of their input blocks. Conversely, those simulators can
read intended control element positions via the ANO_field and
DGO_field variables of the output signal processing blocks.
• The TrainLink and IMCB data packets of all emulator instances
are written to and read from common memory buffers, instead
of being circulated via serial communication networks.
• Modbus communication is not supported, so hosts can commu-
nicate with emulated controllers only via a Modbus Slave OPC
Client Program (see page 43).
In addition, each emulated controller has several global variables for
configuring, starting, stopping, single-stepping, and monitoring the
emulation itself.

May 2007 UM5500 (5.0.0)


84 Chapter 7: Controller Emulation

Emulator Emulated controllers provide the same OPC variables as real ones,
Operation except that they have additional global variables that:
• define the scan time for the fastest task and report the number
of times it has executed;
• either specify that the control tasks should execute continuously
or allow the simulator to trigger single scans of the fastest task;
• trigger the loading of a control system snapshot that executes
the control loops a specified number of times to propagate the
loaded state through the entire system; and
• synchronize the emulated controller clock to that of the host PC.
The scan time and number of scans triggered by a reset are usually
set (before starting the emulation) using the Configurator, while the
simulator uses the others to control and monitor the emulation.
As with a real controller, slower tasks are triggered at specified clock
intervals relative to the fastest task’s scan time. If Tasks 1, 2 and 3
are set to run every 50, 100, and 200 milliseconds, for example,
Task 2 is triggered once for every other execution of Task 1 and
Task 3 once for every four Task 1 executions.
Once application software has been downloaded to the emulated
controllers, starting the Emulator program has the same effect as
plugging in real controllers (unless the emulators have been config-
ured for single-step operation).

IO Simulation Each input signal processing block of an emulated MPU automati-


Mode cally operates in its external simulation mode unless otherwise
configured (see I/O Simulations in Chapter 3 of UM5402):
• For an external simulation, the signal’s nominal value and health
are controlled by OPC commands that are set by an external
process simulator (such as an OTS or engineering simulation).
• For a manual simulation, the signal’s nominal value and health
are set by configuration parameters, which can be configured to
track the actual signal during normal operation.
• For a built-in simulation, the signal’s nominal value and health
are controlled by an analog or digital input that is presumably
set by a companion simulation block built in to the controller’s
application software.
In addition, the global SimulateEnable command is forced to True,
so any input block that has been configured for a different simulation
mode will use it.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 85

UM5500 TrainTools Product Overview and Setupmanual

Appendix A TrainTools Glossary


This appendix lists and defines the basic terms used to describe
TrainTools programs and their underlying concepts.
Accounts Database database file in which the name, password, and access rights of
each TrainTools User Account are stored
Acrobat Reader a third-party program that various TrainTools programs use to dis-
Adobe Reader play Portable Document Format help and documentation files

Active-X Control an independent operator-interface object that can be embedded in a


TrainView Picture to provide access to Distributed Component
Object Model data
Administrator program used to create and modify the Accounts Database
Alarm a structured Human-Machine Interface Variable that indicates
whether or not a particular abnormal condition currently exists,
whether its last occurrence has been acknowledged, and whether
posting of the corresponding alarm messages has been disabled
Alarm Control TrainTools Active-X Control that displays a list of alarm messages
Alarm Message a record of a particular occurrence of an alarm condition provided by
an Alarm and Event Server
Alarm Monitor TrainTools field engineering utility program that displays lists of
alarm and event messages
Alarm Notice a Notification Object Service record providing basic information
about an occurrence of a Series 5 Controller alarm condition
Alarm and Event TrainTools Workstation run-time process that distributes alarm and
Server event messages to its Alarm Control, Alarm Monitor, Archive Com-
munication, and Event Control clients
Application Editor TrainTools project engineering program used to code and compile
each controller’s IEC-61131 program organization units (POUs)
Application Generator TrainTools project engineering program used to generate Series 5
Controller application software and transit files
Application Software the application-specific software of a programmable controller
Archival Data Manager TrainTools run-time program that maintains the Archive Database
Archival Data Reports tabulated and summarized listings of the changing values of
selected archived data during a specified period of time, created by
the Report Generator and displayed by the Report Viewer
Archival Data Utilities a group of TrainTools programs that extract archived AE and OPC
Package data to files that can be replayed using a TrainView-like GUI and
compile archived OPC data into formal reports
Archival PC a Personal Computer running at least the Archive Server Package

May 2007 UM5500 (5.0.0)


86 Appendix A: TrainTools Glossary

Archive TrainTools Workstation run-time program that gathers data from


Communication OPC and AE servers and directs the Archive Server to record it
Archive Database a group of TrainTools Workstation files in which the Archival Data
Manager stores run-time process and control system data
Archive Exporter TrainTools program that the TrainView Program invokes to export
archival data subsets
Archive Reporter TrainTools program used to design and view Archival Data Reports
Archive Reporter Agent TrainTools program that automatically triggers the generation of
Archival Data Reports periodically or during specified events
Archive Server a component of the Archival Data Manager program that records
and shares data at the direction of Distributed Component Object
Model clients
Archive Server a group of TrainTools programs that collect, store, and share data
Package from one or more AE and OPC/DA servers
Archive Viewer TrainTools program for replaying archival data subsets exported
from the TrainView Program
Command a Human-Machine Interface Variable that can be changed to alter
the operation of a controller or workstation script, such as a local set
point or a startup command (in general, a Command would be
changed more frequently than a Configuration Parameter)
Communication TrainTools program that activates a redundant TrainView Program
Monitor instance if any of a primary TrainView’s OPC and AE servers fails
Component Object a Microsoft technology that allows multiple programs to share infor-
Model mation with each other
Compressor Map a two-dimensional plot of a turbocompressor’s operating character-
istics and limits, either in general or at a particular moment in time,
displayed by a TrainView Map Control
Configuration a group of IEC-61131 Resources, generally a group of controllers
that share data and control the same overall process
Configuration an externally-accessible variable that can be (but rarely is) changed
Parameter to alter the characteristics of a controller, such as a PID coefficient
Configurator any of the three field engineering utilities that display interactive lists
of Human-Machine Interface Variable values for Series 5, Series 4,
or Series 3 / 3 Plus / 3++ Controllers
Control System a combination of Controllers and workstations that collectively pro-
vide integrated control and monitoring of an industrial process
Control System the TrainTools implementation of an IEC-61131 Resource,
Resource extended to include both Controllers and TrainTools Workstations

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 87

Controller a single main processor unit and its associated input/output sub-
systems, which is generally used to provide integrated process and
sequencing control for one turbomachinery train
Critical Event a change in the control system or process (such as an emergency
shutdown) whose development is automatically recorded by the
data archiving system
Database Parameters any externally-accessible variable defined by a Series 4 Controller‘s
application software
Data Type the type of information represented by a control system variable,
which can be a simple value (such as a number) or a complex group
of values (such as a group of numbers representing a mathematical
function, a set of PID coefficients, or a description and time stamps
associated with an alarm condition)
DIAC acronym for Dynamic InterApplication Communication
Distributed Component a Microsoft technology that allows multiple programs running on
Object Model interconnected computers to share information with each other
Distributed Control a process control system used to control an entire plant or industrial
System process, generally incorporating several cooperating devices
Duplex Supervisor see: Series 5 Duplex Supervisor
Dynamic Host a TCP/IP protocol that allows each computer (host) to obtain an
Configuration Protocol appropriate IP address and subnet mask from a DHCP server
Dynamic a proprietary protocol that WOIS programs used to communicate
InterApplication with each other
Communication
Dynamic Link Library a computer file containing executable subroutines and other pro-
gram resources that can be used by more than one program
Dynamic Object TrainView Picture element that visually or numerically displays the
values of a controller Human-Machine Interface Variable and/or
changes the value of that variable or the appearance of the Train-
View interface in response to operator actions
Emulator see: Series 5 Emulator
Engineering a TrainTools Workstation that is primarily used to run Project Builder
Workstation and the Engineering Utilities
Event a structured Human-Machine Interface Variable that indicates
whether a particular (generally transitional) process or control
system condition currently exists and whether posting of the corre-
sponding event messages has been disabled
Event Control a TrainTools Active-X Control that displays a tabular list of alarm
and event messages
Event Message a record of a particular occurrence of an event condition provided by
an Alarm and Event Server

May 2007 UM5500 (5.0.0)


88 Appendix A: TrainTools Glossary

Event Notice a Notification Object Service record providing basic information


about an occurrence of a Series 5 Controller event condition
Excel Importer TrainTools program that can import field I/O information and logic
program alarm and event definitions into a Series 5 Controller
project database
Extended Attributes various characteristics of a Series 5 Controller’s Human-Machine
Interface Variables, such as their default values, range limits, mini-
mum security access levels, and Modbus accessibility, which are
used by the controller operating system and stored in its file system
Extraction Map a two-dimensional plot of a multi-section steam turbine’s power out-
put and steam flow rates as a function of the throttle and extraction
valve positions
Fast Recorder TrainTools field engineering utility that displays strip charts of con-
troller Human-Machine Interface Variable values
File Transfer Protocol the TCP/IP protocol for transferring files between computers
Function a Program Organization Unit that calculates a single output value
exclusively from the current values of one or more inputs, generally
used to implement mathematical functions (such as the trigonomet-
ric sine and boolean AND functions)
Function Block a Program Organization Unit that calculates one or more output
variables from the current values of its inputs and specified global
and internally-stored variables
Function Block graphical programming language that defines control functions by
Diagram showing the flow of data through a group of Function Blocks
Generic Controller AE TrainTools program that can post alarm and event messages that
Server are triggered by boolean OPC data items
Human-Machine features that communicate the operating state and variables of a
Interface controller to a human operator or companion device
Human-Machine any externally-accessible variable defined by a Series 5 Controller’s
Interface Variable application software, including every Alarm, Command, Configura-
tion Parameter, Event, or Status Variable
IEC 1131 an international standard for industrial control system programming
Instruction List textual programming language that uses low-level instructions (simi-
lar to those of assembly languages) to define control functions
International Electro- an organization that develops international quality and interchange-
technical Commission ability standards for industrial products and procedures
Internet Protocol the TCP/IP network-layer protocol, which routes individual data-
grams to other computers
JScript a standard Windows scripting language that is derived from the
Java Script Java programming language and can be used to code the behavior
of TrainView operator interface elements

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 89

Ladder Diagram graphical programming language that uses traditional relay logic
representations primarily to describe the calculation of a controller’s
discrete outputs from its discrete inputs
Libraries collections of externally-defined Program Organization Units that
can be incorporated into any Project
Logic Control Program a custom Series 5 Program that implements high-level process
sequencing and protection
Machine Control a TrainWare program organization unit that implements a set of
Function Block turbomachinery control and protection functions that would tradition-
ally have been satisfied by a single-loop device (turbine speed
control, for example)
Machine Control a Series 5 Controller Program that incorporates instances of one or
Program more TrainWare machine control function blocks
Map Control a TrainTools Active-X Control that displays a dynamic, two-dimen-
sional plot of turbocompressor or gas turbine operating conditions
Modbus an open master-slave communications protocol used to transmit
control system information via serial communication links
Modbus AE Server a TrainTools Alarm and Event Server that creates and distributes
alarm and event messages triggered by Modbus discrete bits
Modbus Data any slave device variable that can be accessed by a Modbus host
Modbus OPC Server a TrainTools OPC Server through which OPC clients can access
Modbus slave data points
Modbus Slave a TrainTools program through which Modbus TCP, RTU, and ASCII
OPC Client protocol masters can access OPC Server data items
Network Address a firewall technique that prevents external computers from learning
Translation the actual TCP/IP addresses of the protected computers
Network Interface Card a Personal Computer expansion bus circuit board that implements
an ethernet or other network communication channel
Network Time Protocol a message format computerized devices use to communicate the
current Universal Time, Coordinated with an accuracy of a few
microseconds
Notification Object a Series 5 Controller operating system task that communicates
Service Alarm Notices and Event Notices to Series 5 AE Servers
NT File System the standard format the Windows NT, 2000 Professional, and XP
operating systems use to record data to hard disk drives
Object Linking and a general term for the inclusion of automatically updated data from
Embedding one program within the display windows of or documents printed
from another program running on the same of different computers
OLE acronym for Object Linking and Embedding

May 2007 UM5500 (5.0.0)


90 Appendix A: TrainTools Glossary

OLE for Process a Microsoft Windows OLE-based protocol for the dynamic sharing of
Control data among process control and automation devices
OPC acronym for OLE for Process Control
OPC Online Data the OPC standard that defines COM interfaces for accessing the
Access current values of controller HMI variables
OPC/DIAC TrainTools program that allows DIAC clients to communicate with
OPC servers (the TrainView 1 OPC program provides the opposite
communication pathway)
OPC Server a computer program or background process that provides OPC
access to defined sets of variables within a process control device
or program
Operator Interface the proprietary communication protocol that Series 4 Controllers use
Station Protocol to communicate with Personal Computers
Operator Workstation see: TrainView Workstation
PComm Engine WOIS program that provided DIAC and SCI communication with
Series 4 Controllers
PC Workstation see: Personal Computer, TrainTools Workstation
Personal Computer an IBM-PC compatible computer capable of running the Microsoft
Windows operating system
Piping and a formal illustration of an industrial process and its control system
Instrumentation
Drawing
Platform a group of TrainTools programs that includes AE and OPC/DA
Communication server programs for CCC and generic controllers
Servers Package
Platform Engineering a group of TrainTools programs for configuring and tuning CCC
Utilities Package controllers
Portable Document a standard format used to record the content and appearance of
Format printed documents (including TrainTools program manuals, on-line
help, and archival data reports) to files that can be displayed and
printed using the Acrobat Reader program
Program an IEC-61131 controller software component that is generally a
combination of lower-level Functions and Function Blocks compris-
ing either an entire Task or one of its highest-level components
Program Organization an IEC-61131 Function, Function Block, or Program (generally,
Unit functions and function blocks are combined to form programs)
Project one or more Control Systems, generally being engineered for the
same customer or location
Project Builder a project engineering program that edits Project Databases

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 91

Project Database a group of computer files in which TrainTools programs store the
elements describing a control system project
Project Data Interface standard, password-protected methods that TrainTools programs
use to access and modify the Project Database
Project Engineering a group of TrainTools programs that create and modify the Train-
Utilities Package Tools HMI and the application software for Series 5 Controllers
Project Tree a hierarchical outline format that TrainTools programs use to display
the components of a control system project
Project Unzip a field engineering program that unzips project files from the com-
pressed revisions saved by Project Builder
Python an open-source scripting language or the software implementing it
Report Data Format archival data report file format that can only be viewed using the
Archive Reporter program’s View mode
Reporter Agent see: Archive Reporter Agent
Report Generator TrainTools program that generates Archival Data Reports at the
direction of the Archive Reporter Agent and TrainView Program
Report Layout Editor the report design mode of the Archive Reporter program
Report Viewer the report viewing mode of the Archive Reporter program
Resource a device (usually a controller) that executes IEC-61131 Tasks
see also: Control System Resource
Rich Text Format a standard format used to store formatted text to files that can be
displayed by most word processing programs
SCI acronym for Serial Communication Interface
SCI Interface an optional process provided by the Series 4 OPC Server program
that allows it to share its controller communication links with the
Series 4 Configurator utility and other SCI clients
Script Engine a TrainTools run-time program that periodically executes scripted
process control and operator-interface tasks on its host workstation
Script Engine AE an Alarm and Event Server component of the TrainTools Script
Server Engine, which distributes Alarm Messages and Event Messages to
TrainTools clients
Script Engine OPC a TrainTools OPC Server through which OPC clients can access
Server Script Engine variables
Sequential Function graphical programming language that uses flowchart representa-
Chart tions primarily to describe the selection of controller operating states
and the triggering of state transitions
Serial Communication a communication protocol that allowed several WOIS programs to
Interface communicate with a Series 4 Controller via a shared serial port

May 2007 UM5500 (5.0.0)


92 Appendix A: TrainTools Glossary

Series 3 Plus an engineering utility program for monitoring and changing Series 3
Configurator / 3 Plus / 3++ Controller Configuration Parameters
Series 3 Plus OPC a TrainTools OPC Server through which OPC clients can access
Server any Series 3 Controller’s Modbus Data, some of its configuration
parameters, and additional variables calculated from that data
Series 4 Configurator an engineering utility program for monitoring and changing Series 4
Controller Configuration Parameters
Series 4 Map TrainTools program the TrainView Program uses to display Series 4
compressor controller performance maps
Series 4 OPC Server a TrainTools OPC Server through which OPC clients can access
Series 4 Controller Database Parameters
Series 5 AE Server a TrainTools Alarm and Event Server that retrieves Alarm Notices
and Event Notices from the Series 5 Controller Notification Object
Service and converts them to and then shares the corresponding
Alarm Messages and Event Messages
Series 5 CheckTime TrainTools program (which can be invoked from the Series 5 Con-
figurator) that displays the deviation of Series 5 Controllers from the
host PC’s Windows system time
Series 5 Configurator an engineering utility program for monitoring and changing Series 5
Controller Human-Machine Interface Variables
Series 5 Duplex TrainTools program used to keep the operating system, application
Supervisor software, and configuration data of a backup controller the same as
those of its active peer
Series 5 Emulator TrainTools program that executes the Application Software of a
Series 5 Controller for testing and training purposes
Series 5 OPC Server TrainTools program with OPC Server and Alarm and Event Server
components through which client programs can access Series 5
Controller Human-Machine Interface Variables
Series 5 Operator TrainTools program that the Series 5 Configurator utility invokes to
Panels display simulated controller faceplates
Series 5 Protocol a proprietary protocol TrainTools Workstations use to communicate
with Series 5 Controllers
Series 5 TrainCalc TrainTools utility for calculating TrainLink configuration parameter
settings for Series 5 Controller networks
Snapshot Compare TrainTools program that the Series 5 Configurator utility invokes to
compare controller HMI variable snapshot files
Status Variable a Human-Machine Interface Variable that reports the current value
or state of some process or control system variable or condition,
which cannot be changed via that interface
Structured Text textual programming language that uses high-level abstractions
(similar to those of Fortran and Pascal) to describe control functions

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 93

Tagged Image Format a standard format used to store bit-mapped images to files that can
be opened using most photo editing and painting programs
Task one or more Programs that are executed as a group at defined inter-
vals or in response to defined triggers
Transmission Control a TCP/IP transport-layer protocol that provides verified transmission
Protocol of datagrams to specified TCP ports of other computers
TCP/IP a multi-layered set of network communication protocols developed
for UNIX and since added to most computer operating systems
TrainTools Information program that lists the host PC’s TrainTools program and data fold-
Utility ers, installed components, and license information
TrainTools Server a Personal Computer running at least the Platform Communication
Servers Package
TrainTools Software one of six groups of TrainTools programs that can be purchased for
Package installation on a single computer
TrainTools User an Accounts Database entry specifying the Project Data Interface
Account access rights of users who log into various TrainTools programs
using an associated user name and password
TrainTools Web a group of TrainTools programs that allow networked workstations
Package to communicate via WebServices
TrainTools program that routes requests from remote WebGateway programs
WebServices to the appropriate OPC, AE, and ADaM servers of its host PC
TrainTools Workstation a Personal Computer running a TrainTools Software Package,
which might more specifically be a TrainTools Server, Archival PC,
Engineering Workstation, or TrainView Workstation
TrainView 1 a name used to distinguish the WOIS TrainView package (TV1)
from the TrainTools program of the same name (TV2)
TrainView 1 OPC a TrainTools program that allows OPC clients to communicate with
DIAC servers (the OPC/DIAC program provides the opposite com-
munication pathway)
TrainView 2 a name used to distinguish the TrainTools TrainView Program (TV2)
from the WOIS software package of the same name (TV1)
TrainView Package a software package consisting of the TrainView Program, various
Active-X Controls, and our standard TrainView component libraries
TrainView Picture a TrainView program display consisting of static background draw-
ing with superimposed Dynamic Objects and Active-X Controls that
allow an operator to interact with controller Human-Machine Inter-
face Variables and display alternate pictures
TrainView Program a TrainTools Workstation run-time operator interface program that
displays interactive TrainView Pictures

May 2007 UM5500 (5.0.0)


94 Appendix A: TrainTools Glossary

TrainView Script customizable Visual Basic or Java script that controls interactions
between an associated TrainView picture element and controller
Human-Machine Interface Variables
TrainViewWeb Service software that allows the TrainView operator interface to be installed,
automatically updated, and run as Internet Explorer web pages
TrainView Workstation a personal computer that is specifically running the TrainView oper-
ator interface program
Transmission Control a TCP/IP transport-layer protocol that establishes reliable, session-
Protocol oriented communication between programs on separate computers
Trend Graph Control a TrainTools Active-X Control that plots the values of controller
Human-Machine Interface Variables as a function of time
Turbine Map a two-dimensional plot of a gas turbine’s operating condition relative
to its corresponding design limit, which can be displayed by a Train-
View Map Control
Turbomachinery refers to all the rotary machines in a train, such as compressors, tur-
bines, and generators
Uninterruptable Power a battery-backed-up power supply that continues to provide power
Supply to the system when the primary input power fails
Universal Time, the current official time along the zeroth meridian (through Green-
Coordinated wich, England), accurate to atomic clock standards, which serves as
an international time reference
User Datagram a TCP/IP transport-layer protocol that provides for the unverified
Protocol transmission of individual datagrams to specified UDP ports of other
computers, used by the Series 5 OPC program to broadcast time-
synchronizing data to Series 5 Controllers
VBScript a standard Windows scripting language that is derived from the
Visual Basic Script Basic programming language and can be used to code the behavior
of TrainView operator interface elements
Version Scanner an earlier version of the TrainTools Information Utility
WebServices tasks a host computer will perform in response to requests received
via a network HTML port
WebGateway client PC program that routes OPC/DA, AE, and ADaM requests to
remote servers via their TrainTools WebServices programs
WOIS acronym for Workstation Operator Interface Software
Workstation Operator an earlier family of programs for supporting Series 4 and 3 Plus
Interface Software Controllers from PCs running Windows 95

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 95

UM5500 TrainTools Product Overview and Setupmanual

Appendix B Installation and Maintenance


This appendix tells how to set up and maintain a TrainTools
workstation:
• Each workstation is created by copying appropriate software
and data files to its hard drive (see Installation below).
• In general, the only maintenance a TrainTools PC will need is
occasional defragmentation of its hard drive (see Maintenance
on page 119).

Installation TrainTools software packages are usually distributed as part of a


Total Train Control Release included on a project Distribution CD:
Step 1: Inserting such a CD into a PC will automatically launch its
CCC Installer (see page 96).
Step 2: Selecting that installer’s TrainTools Setup option will launch
the TTC Installer (see page 98).
Step 3: Invoking that installer’s TrainTools Release option will
launch the TrainTools Setup Utility (see page 99).
These installers might not run, or will refuse to install certain Train-
Tools programs, unless the following Windows operating system
requirements are met:
• If your PC is running Windows 2000, neither the TTC nor the
TrainTools Setup utility can be run unless it has been upgraded
to the required Windows 2000 Service Pack 4 (see page 111).
• The TTC Setup utility cannot be run unless Internet Explorer 6
Service Pack 1 (see page 113) or later is installed. TrainTools
Setup can be run (if started directly), but some TrainView scripts
might not run correctly until IE has been upgraded.
• The TrainTools Web Services will not be installed unless the
Internet Information Services (see page 114) component of
Windows has been installed.
You might also want to modify the computer’s Power Management
Settings (see page 115) and set up the Windows and TrainTools
security features discussed in Appendix D. Networked workstations
pose additional considerations that are discussed in Appendix E.

Before running any CCC installation utility, you should log onto your
Note: PC as a Windows administrator.

May 2007 UM5500 (5.0.0)


96 Appendix B: Installation and Maintenance

Figure B-1 CCC Installer Menu

CCC Installer TrainTools Workstations are set up by selecting options from the
CCC Installer menu, which starts automatically when a distribution
CD is inserted into a PC. Its ReadMe file (which is also automatically
displayed) will help you decide which of and in what order the follow-
ing options should be initiated:
• TrainTools Setup launches the TTC Installer (see page 98),
which optionally installs the most recent major release of the
licensed TrainTools software packages, TrainSys support files,
and/or TrainWare application development libraries.
• TrainTools Patch launches the TTC Patch Utility (see page
110), which will update the files installed by the TTC installer to
the most recent minor release versions.
• TrainTools Project Libraries will copy your Site Files (see page
117) from the Distribution CD to the appropriate TrainTools data
folders. It might also create custom startup aids (see Appendix
C) for certain TrainTools programs.
• TrainView 1.0 launches the WOIS TrainView setup utility, which
is documented in its own manual.
• The Series 3+ and 4 Configurator options are usually disabled
because those programs are now installed by TrainTools Setup.
• Adobe Reader launches the installer for the Adobe Reader Pro-
gram (see page 116), which is required by some TrainTools on-
line help functions.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 97

ccc_inst.exe (CCC Installer)


License.pdf (MS79)
ReadMe.txt (for CCC Installer)
TrainTools folder
Installation.pdf
Patch folder (TTC)
TotalTrain patch-#.#.#.exe
Setup folder (TTC)
Drivers folder
PPP folder
redist folder
IE6_SP1 folder
IE6SETUP.exe
W2KSP4 folder
W2KSP4_EN.exe
Setup.exe (TTC Installer)
TrainSys folder
TrainTools folder
Setup.exe (TrainTools)
Setup IE6 SP1.bat
TrainWare folder
Projects folder
project folders
Figure B-2 Partial Listing of Distribution CD Contents

• Selecting Internet Explorer 6.0 will install the Service Pack 1


version of that program (see page 113).
• Any other enabled options install the corresponding utility and/or
driver software.
• Selecting Browse this CD will open a desktop window displaying
the files and folders on the installation CD (see Figure B-2).
If you are running Windows 2000 and have not upgraded to Service
Pack 4, you must browse to the redist folder to launch its installer
(W2KSP4_EN.exe, see page 111).

May 2007 UM5500 (5.0.0)


98 Appendix B: Installation and Maintenance

TTC Installer You can install all or some of the licensed TrainTools packages and
optionally copy the Series 5 TrainWare application software libraries
and TrainSys operating system files to appropriate workstation fold-
ers by running the Total Train Control Setup utility:
Step 1: Selecting the CCC Installer’s TrainTools Setup option or
double-clicking the Setup icon in the Distribution CD’s Train-
Tools\Setup folder (see Figure B-2) will display this dialog:

Step 2: Enable or disable the following options:


• The TrainTools Release (PC Tools) option will install the
most recent major release versions of the TrainTools operator
interface and engineering programs. It can be unchecked only
if that software is already installed.
• The TrainSys Release (Series5 Firmware) option will install
the downloadable firmware and supporting files for the most
recent Reliant and Vanguard operating systems. These files
are needed only on computers used for Series 5 Controller
software development or to upgrade the operating systems of
such controllers in the field.
• The TrainWare Release (Series5 Applications) option will
install all included TrainWare libraries. These files are needed
only on computers to develop Series 5 Controller software.
Uncheck any options you do not want to install by clicking on
their selection boxes, then click on the Install button.
Step 3: The TrainTools Setup Utility (see page 99) will then be run
(unless the TrainTools option was unchecked). During that time,
the Total Train Control installer displays the message “Installing
TrainTools Release…please wait.”, but it is usually obscured by
other installer windows.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 99

Step 4: Unless the TrainSys option was unchecked, the following file
copy dialog will then be displayed to indicate the progress of the
controller operating system file installation:

Step 5: Unless the TrainWare option was unchecked, the following


file copy dialog will then be displayed to indicate the progress of
the controller application software library file installation:

When the installation is complete, the message box for the last
enabled option will be removed from the screen.

TrainTools Setup The TrainTools Setup utility can be used for the following purposes:
Utility • Default Installation of Licensed Packages (see page 100)
• Custom Installation of Selected Software (see page 106)
• Modification of Installed Software (see page 107)
• Repair of Installed Components (see page 109)
• Removal of All TrainTools Software (see page 109)
For a new installation, you should start this program from the TTC
Installer (see page 98). Thereafter, it can be started from the
Add/Remove Programs control panel, or by double-clicking the
Setup icon in the Distribution CD’s TrainTools\Setup\TrainTools
folder (see Figure B-2), and doing so would display its maintenance
(modify/repair/remove) screen.
You MUST halt the execution of any existing TrainTools programs
(including servers with external clients) before running this Setup
utility. Because you can not keep multiple versions of the TrainTools
programs in separate folders on a single computer or mix programs
from different releases, the version 6.1 installer will automatically
remove any earlier versions. If you are upgrading from version 2.6
or earlier, you should consult the Upgrading to TrainTools Version
3.0 technical note [TN31] for additional instructions.

May 2007 UM5500 (5.0.0)


100 Appendix B: Installation and Maintenance

Default Installation of The TrainTools 6.1 Setup utility will install only the components
Licensed Packages specified by the license key file (see page 120) in a selected folder,
removing or replacing all others:
Step 1: Launch the Setup utility as discussed on the previous page.
If the resulting dialog indicates your computer is not running the
required Windows service pack, proceed to page 111.
Step 2: The following alert will appear if older TrainTools software is
present on the PC:

If you do not want to remove the earlier version, click the Cancel
button to abort this installation. Otherwise, click the OK button to
initiate the removal process described on page 109, after which
the version 6.1 installation will automatically continue.
Step 3: Read the displayed Welcome information, then click the
Next button to display the License Agreement:

Step 4: Scroll to the end of that agreement while reading the terms
of our Software License Agreement [MS79]). The Next button
will be disabled until you click on the I accept … option.
If you do not agree with the stated license terms, click on the
Cancel button and contact your CCC sales representative.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 101

Step 5: Click the Next button to display the license selection dialog:
• If your computer is connected to the internal network at CCC
headquarters in Des Moines, the following dialog will appear:

The default Internal CCC License option is appropriate only if


you are installing TrainTools on a PC that is always connected
to that network. Select the Personal License option if you are
installing on a laptop that might be used in the field, or a desktop
that will be moved to another site or occasionally disconnected
from the network for testing purposes.
• If your PC is not connected to that network, or you selected the
Personal License option from the above dialog, the following
dialog will appear:

Click the Browse button to display a dialog for navigating to and


selecting the folder that contains this workstation’s license key
file (see page 120).

May 2007 UM5500 (5.0.0)


102 Appendix B: Installation and Maintenance

Step 6: After selecting the license key location, click the Next button
to display the Customer Information screen, then enter the
requested user and company names:

The next button will not be enabled until you have typed in both
a user and a company name.
Step 7: Click the Next button to display the Setup Type screen.
Leave the Complete option checked to install all TrainTools
components permitted by the previously-selected license key to
the default program folder:

To install only selected components or change the default pro-


gram or data folder, proceed as discussed under Custom
Installation of Selected Software on page 106.
Step 8: Click the Next button to display the Ready to Install pane:
Step 9: Click on its Install button to display the Setup Status pane
and begin copying the program files. During this process, alert
boxes and DOS command windows will occasionally be shown
but require no action on your part.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 103

Step 10: If you are installing TrainTools for the first time, or upgrad-
ing from version 2.6 or earlier, this dialog will eventually appear:

• If you are upgrading from version 2.6 or earlier, clicking the Yes
button displays a file-open dialog, from which you can select a
version 2 database whose accounts will then be imported into a
new accounts database (see Importing User Accounts in TN31).
• If you are installing TrainTools for the first time, clicking the Yes
button launches the Administrator utility and displays its admin-
istrator account dialog (see Creating the Accounts Database on
page 150). Clicking on No defers its creation until the next time
you run that utility.
Step 11: At some point, the installer for the required Python scripting
environment will be automatically launched:

You should simply click on the Next button of each of that


installer’s dialogs to accept their default options.

Some TrainTools Python scripts will execute only if revision 2.3


Note: is your PC’s most-recently installed version of Python (a later
version can also be present, as long as 2.3 is installed last).

May 2007 UM5500 (5.0.0)


104 Appendix B: Installation and Maintenance

Step 12: When the Ready to Install dialog appears, click on its Next
button to begin the actual installation. A progress dialog will then
be displayed while the program is being installed. When the
installation is complete, the following dialog will be displayed:

Click on its Finish button.


Step 13: The installer for the required Win32 Python extensions will
then be launched:

You should also click on the Next button of each of this


installer’s dialogs to accept their default options.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 105

Step 14: When the Ready to Install dialog appears, click on its Next
button to begin the actual installation. A progress dialog will then
be displayed while the program is being installed. When the
installation is complete, the following dialog will be displayed:

Click on its Finish button.


Step 15: If the Microsoft .NET 2.0 Framework is not installed on your
computer, the following message will be displayed while it is
being automatically installed:

That process will take at least four minutes, and possibly much
longer (depending on the speed of your PC).
Step 16: After the TrainTools Setup utility has copied all required
programs to your PC, it displays its Setup Complete pane:

Click the Finish button to dismiss the InstallShield Wizard.

May 2007 UM5500 (5.0.0)


106 Appendix B: Installation and Maintenance

Custom Installation To install only selected components of the packages permitted by a


of Selected Software license key, or change the default program or data folders, begin as
discussed under Default Installation of Licensed Packages on page
100. When you reach step 7, click on the Custom option and then:
Step 7a: Click on the Next button to display a dialog pane indicating
the default TrainTools program file folder:

If you have some reason for installing the TrainTools programs


to a different drive or folder, click the Browse button to display a
dialog for navigating to and selecting that folder.
Step 7b: Click on the Next button to display an expandable list of the
TrainTools packages permitted by the selected license key:

All components of all licensed packages are initially selected.


Click on the checkbox for each one you do not want to install on
this workstation to deselect it. Components that are required by
others can not be deselected until those dependent components
have been deselected.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 107

Step 7c: Click on the Next button to display the default data folder:

If you have some reason for installing the TrainTools data files
to a different drive or folder, click the Browse button to display a
dialog for navigating to and selecting that folder.
Step 7d: Click the Next button to display the Ready to Install pane,
then proceed with step 9 on page 102.

Modification of When the version 6.1 Setup utility is run on a PC that does have
Installed Software previously-installed version 6.1 TrainTools components, the follow-
ing procedure can be used to add to or remove some of them, or to
install a different license key file (see page 120):
Step 1: The TrainTools Setup utility will display the Maintenance
Type dialog with the Modify option selected by default:

Step 2: Click the Next button to display the License Key File dialog
shown on page 101. If necessary, click on the Browse button
and select the desired key folder. Any previously-installed soft-
ware not licensed by the select key will be removed.

May 2007 UM5500 (5.0.0)


108 Appendix B: Installation and Maintenance

Step 3: Click the Next button to display the Select Features dialog
with an expanded list of packages and components licensed by
the selected key file (only installed components are checked):

Click on any unchecked components you wish to add or any


checked ones you wish to remove (installed but unlicensed
components will not be listed but will be removed).
If no changes are made, this procedure will only install the new
license and/or remove any components it does not permit.
Step 4: Click the Next button to initiate the installation and removal
of the specified files (the Setup Status dialog will be displayed).
Step 5: When that process is completed, the Maintenance Complete
dialog will be displayed:

Step 6: Click the Finish button to complete the process and shut
down the Setup utility.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 109

Repair of Installed The following procedure can be used to reinstall any unintentionally
Components deleted TrainTools components:
Step 1: Launch the Setup utility from your distribution disk to display
the Maintenance Type dialog shown on page 107.
Step 2: Click on the Repair option and then on the Next button to
immediately initiate the reinstallation process.
Step 3: When that process is complete, the Maintenance Complete
dialog shown on page 108 will appear. Click on its Finish button.
You could also initiate this process from the Add/ Remove Programs
control panel.

Removal of All The following procedure can be used to remove all TrainTools soft-
TrainTools Software ware, its accounts database, and its license key from a PC:
Step 1: Select Settings -> Control Panels from the Start menu.
Step 2: In the Control Panel window, double-click on the Add/
Remove Programs icon to display the following dialog:

Step 3: In the program list, click on TrainTools and then on the


Change/Remove button to launch the TrainTools Setup utility
and display the Maintenance Type dialog shown on page 107.
Step 4: Click on the Remove option and then on the Next button to
display the following confirmation dialog:

Step 5: Click the OK button to begin the software removal (during


which the Setup Status screen will be displayed).
Step 6: When that process is complete, the Maintenance Complete
dialog shown on page 108 will appear. Click on its Finish button.
The .NET 2.0 framework and Python scripting environment will
remain even if they were installed by TrainTools Setup. You can
but need not remove either or both of them at this time.
Step 7: Close the Add/Remove Programs control panel.

May 2007 UM5500 (5.0.0)


110 Appendix B: Installation and Maintenance

TTC Patch Utility Each minor revision of the TrainTools, TrainSys, and TrainWare
programs and files is distributed as and installed by launching a
single self-extracting archive file:
Step 1: Display the following dialog by selecting the CCC Installer’s
TrainTools Patch option or double-clicking on the TotalTrain
patch-#.#.# program in the Distribution CD’s TrainTools\Patch
folder (see Figure B-2).

Step 2: Click the Setup button of that dialog. A progress bar will then
be displayed while the archived update files are extracted:

One of the extracted files is a compiled Python program that is


then launched to move each extracted file from your temporary
folder to the appropriate TrainTools program or data file folder.
This process, which can take several minutes, is chronicled by a
command window similar to the following:

Step 3: When all files have been installed, the Update was success-
ful message shown at the bottom of the above illustration will
appear. Press any key to close that window.
The Self-Extractor dialog will then indicate it is deleting the tem-
porary files, after which it automatically closes.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 111

Windows 2000 All version 6.1 TrainTools programs can be run under the Windows
Service Pack 4 2000, service pack 4 operating system. If your computer is running
an earlier version of Windows 2000, you can upgrade it using the
installer provided with TrainTools Setup:
Step 1: Select the CCC Installer’s Windows 2000 SP4 option or click
on the W2KSP4_EN program in the Train-
Tools\Setup\redist\W2KSP4 folder of the Distribution CD (see
Figure B-2).
• If the required (or newer) version of Windows is already
installed, a message to that effect will be displayed. Clicking
its OK button will terminate the installer.
• Otherwise, the following progress window is displayed while
the installation files are unpacked:

Step 2: Click the Next button of the Setup Wizard welcome screen
to display the Service Pack’s license agreement:

Click the I Agree option and then the Next button.

May 2007 UM5500 (5.0.0)


112 Appendix B: Installation and Maintenance

Step 3: In the next screen, you must indicate whether or not the
updater should archive the files you would need to restore your
current version of Windows 2000:

Click either option and then the Next button to initiate the
upgrade process.
Step 4: The installer will then chronicle its progress, ultimately dis-
playing the following to indicate it is done:

Unless you check the Do not restart now option box, clicking the
Finish button will not only close the installer but also reboot your
computer.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 113

Internet Explorer To run some TrainTools programs on a Windows 2000 PC, Internet
6 Service Pack 1 Explorer 6 Service Pack 1 must be installed. If you suspect it is not:
Step 1: Select the CCC Installer’s Internet Explorer 6.0 option or
click on the Setup IE6 SP1 batch file in the Train-
Tools\Setup\TrainTools folder of the Distribution CD (see Figure
B-2). If the required (or newer) version is already installed, a
message to that effect will be displayed.
If not, a series of dialogs will be displayed, beginning with:

Step 2: Scroll to the end of the license agreement while reading its
terms. Click on the I accept the terms… option button to enable
the Next button, then click on it to display the install pane:
Step 3: Click on the Next button to begin the installation. A progress
dialog will be displayed while the software is being installed.
Step 4: When the installation is complete, the following dialog will be
displayed:

Click on the Finish button to complete the installation and reboot


your computer (as required).

May 2007 UM5500 (5.0.0)


114 Appendix B: Installation and Maintenance

Internet The TrainTools Web Service components cannot be installed until


Information after the Windows IIS component has been.
Services Step 1: To determine if it has, open the Windows Control Panel and
double-click on the Administrative Tools icon. If the resulting
window includes an Internet Information Services icon, that
component is installed. Close the window and stop.
Step 2: If that icon is not present, click on the Back icon in the tool-
bar, then click on the Add or Remove Programs icon.
Step 3: Click on the Add/Remove Windows Components icon in the
left-hand pane of the resulting Add or Remove Programs dialog
to display the Windows Components Wizard:

Step 4: If the Internet Information Services option is checked, click


the Cancel button and then close the Add or Remove Programs
dialog. Otherwise, select that option and click the Next button.
The Components Wizard will then install and configure IIS, and
indicate whether or not it succeeded:

Step 5: Click the Finish button and then close the Add or Remove
Programs dialog.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 115

Power We recommend modifying the power management options of your


Management PC as follows:
Settings Step 1: Open the Windows Control Panel.
Step 2: Open the Power Options (or Settings) dialog:

Step 3: Make sure the Turn off hard disks and System standby
options are both set to Never, then click on the OK button.
Step 4: Open the Network & Dial-up Connections dialog, then right-
click on the icon for the network connecting your TrainTools
Workstations and Vanguard Controllers and select Properties
from its shortcut menu.
Step 5: Click on the Configure button and then the Power Manage-
ment tab of the resulting dialog:

Step 6: Uncheck all power saving options, then click the OK button.

May 2007 UM5500 (5.0.0)


116 Appendix B: Installation and Maintenance

Adobe Reader Some TrainTools on-line help functions use the Adobe (Acrobat)
Program Reader program to display portable document format (PDF) help
files. Because they will not use any of the other programs (such as
Adobe Acrobat) that could otherwise be used to read those and any
other PDF files installed by or provided with the TrainTools Setup
utility, that program must be installed if it is not already present.
We recommend using version 7 of that program, whose installer can
be launched by selecting the Adobe Reader option of the CCC
Installer (see page 96), or double-clicking its icon in the Distribution
CD’s Adobe folder or the redist subfolder of its TrainTools\Setup
folder (see Figure B-2). In either case:
Step 1: A message will be displayed asking you to wait while the
setup files are processed, followed by several Setup screens.
You should click the Next button of all such screens, except:
• If a Program Maintenance screen appears, thus indicating this
program is already installed, click its Cancel button.
• If the following screen appears, thus indicating that Windows
is currently configured to use some other program to open
PDF files, click the option box for the program that should
henceforth be opened if you double-click such a file:

The selected option will not apply to TrainTools on-line help


systems, which will always and can only use Adobe Reader.
Step 2: When the Ready to Install screen appears, click on its Next
button to begin the actual installation. A progress dialog will then
be displayed while the program is being installed.
Step 3: When the Setup Completed screen appears, click its Finish
button to close the installer.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 117

Site Files TrainTools Setup creates a data folder (C:\TrainTools by default)


with two subfolders named Lib and Projects to hold its library and
project files, respectively:
• The standard TrainTools libraries are copied into the Lib folder.
• Selecting the CCC Installer’s TrainTools Project Libraries option
will extract the compressed files that define each system’s HMI
from the Distribution CD’s TrainTools\Projects folder (see Figure
B-2) to the PC’s TrainTools\Projects folder. It might also copy
other files and/or create custom startup aids (see Appendix C)
for certain TrainTools programs.
The path to each copied file is listed in a command window.
When “Update was successful” is displayed, followed by “Press
any key to continue”, doing so will close that window.
If you later rerun the Total Train Control or TrainTools Setup utility to
upgrade or reinstall your software, it might add to or possibly replace
some of the standard library files. Other folders or files you might
have added will be unaffected.
If your installation includes multiple workstations, they might use
shared configuration files to synchronize their operation. In that
case, the site files only need to be copied to specific PCs.

Project Folders and As shown in Figure B-3, project information is stored in a hierarchy
Files of hard disk folders and files, the topmost element of which is a
Projects Folder that can contain one or more Project Folders.
Each project folder includes a project database file (SIP.fdb) and
some or all of the following folders:
• One named ADaM that contains the project’s Archive Database.
• One named AED that contains the folders and files defining
each controller’s application software.
• One named AG that contains Application Generator files.
• One named Backup that contains project backup files.
• One named CustomFiles that can contain a subfolder for each
of the project’s TrainTools Workstations, in which any custom
scripts and pictures defined for that workstation are stored.
• One named Reports that contains project report data files.
• Two named ReportFiles and ReportLayouts for archived data
reports and their formatting files.
• One named Revisions that contains project revision files.
• One named SE that contains Script Engine script files.
• One named TV that contains TrainView picture and script files.
• One named Users that contains subfolders in which TrainTools
programs store each user’s preference information.

May 2007 UM5500 (5.0.0)


118 Appendix B: Installation and Maintenance

Projects Folder (usually C:\TrainTools\Projects)


Project Folders
ADaM
Archive Database Files and Folders
AED
S5 CSR Database File and Folder
AG
Application Generator Files
Backup
Project Backup Files
CustomFiles
Workstation Folders (PC_Name)
Reports
IO List
IO List Report Files
IO Summary
IO Summary Report Files
IO Wiring
IO Wiring Report Files
ReportFiles
Archival Data Report Files
ReportLayouts
Archival Data Report Templates
RevisionInfo.txt
Revisions
Project Revision Files
SE
Script Engine Script Files
SIP.fdb (project database)
TV
TrainView Picture and Script Files
TVWeb
TrainViewWeb Folders and Cabinet Files
Users
User Preference Folders
User Preference Files
Figure B-3 Project Folders and Files

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 119

Figure B-4 General Pane of TrainTools Information Window

Maintenance If you ever require assistance from CCC, you will need to run the
TrainTools Information Utility. However, the only maintenance most
workstations will need is an occasional Hard Drive Defragmentation
(see page 122) or Software Upgrade (see page 121).

TrainTools This program will identify:


Information Utility • the TrainTools program and data folders (see below).
• all installed TrainTools software components (see Revision
Numbers on page 121); and
• the licensed TrainTools software packages and platforms (see
License Files on page 120).
That information is useful primarily to CCC engineers, who might
need it to troubleshoot your workstation, either at your site or via a
remote connection. However, you may need to run the program and
relay its output to them if such a connection cannot be made.
To launch this utility, select Programs -> TrainTools -> TrainTools
Information from the Start Menu. Alternately, you can select the
Help -> About command of any TrainTools program and click on the
General Info button in the resulting dialog.
To save the reported information to an XML file, invoke the File ->
Save Report command. Double-clicking the resulting TTInfo.xml file
in the Log folder of the TrainTools data folder (see page 117) will
display it as a series of tables in an Internet Explorer window.

TrainTools Folders The General pane of the TrainTools Information dialog will list:
• the TrainTools program folder (see page 106),
• the version of the TrainTools or Total Train Control Setup utility
used to install them,
• their data file folder (see page 117),
• the Default Projects Folder (see page 136), and
• the default library file folder (usually C:\TrainTools\Lib).

May 2007 UM5500 (5.0.0)


120 Appendix B: Installation and Maintenance

Figure B-5 License Pane of TrainTools Information Window

License Files TrainTools version 5.0 and later programs are divided into packages
that use license files to control their installation and execution:
• Unless the Internal CCC License option is selected (see page
101), TrainTools setup will install a hidden license key file that
specifies which programs will run on that PC. Trying to run an
unlicensed program will only display a message indicating the
component is not licensed or the license could not be found.
If the internal license is selected, TrainTools programs will not
run unless the PC is connected to our Des Moines network.
• Any modification of that setup based on a different key might
install additional programs and would remove any previously-
installed software not licensed by the new key.
• Uninstalling all TrainTools programs will delete the key.
The License pane of the information window displays:
• General information about the installed license key, including
when it was created and how long it will be valid; and
• the Packages that can be installed and run on the host PC, for
which CCC Controller Platforms.

The Series 5 Emulator program also requires that a key device be


Note: inserted into one of the PC’s USB ports.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 121

Figure B-6 Modules Pane of TrainTools Information Window

Revision Numbers The Modules pane of the information window lists all components
installed in the TrainTools program folder, along with the revision
number of each. It is similar to a Windows View -> Details file listing,
and can be manipulated using the same techniques.

Software From time to time, we might advise you to upgrade all or part of your
Upgrade TrainTools Software Package:
• For major upgrades, we will supply a new Distribution CD with
installers that will add or replace components as needed.
• For minor upgrades, we supply a TTC Patch Utility (see page
110) that installs or replaces several TrainTools files.
• If you encounter a software problem, its resolution might involve
copying CCC supplied files to your TrainTools program folder
(usually C:\Program Files\Compressor Controls\TrainTools).
None of these procedures would delete or replace any project or
library files in your project folders.

May 2007 UM5500 (5.0.0)


122 Appendix B: Installation and Maintenance

local drive list

initial fragmentation

final fragmentation

Figure B-7 Windows Disk Defragmenter Utility

Hard Drive When a Windows program creates or adds to a disk file, each data
Defragmentation segment is placed in the first available disk location. On a new disk,
those segments will be contiguous and can be read very quickly.
Over time, the deletion and revision of files will free widely scattered
segments for reuse, resulting in file fragmentation that slows the
reading, creation, and modification of most files. This is especially
true for TrainTools Workstations running data archiving tasks.
Disk performance can then be noticeably improved by running the
Disk Defragmenter utility, whose interface is shown in Figure B-7:
Step 1: Double-click the My Computer icon.
Step 2: Right-click any local hard drive’s icon and select Properties
from the resulting menu.
Step 3: Click the Tools tab of the resulting dialog and click its
Defragment Now button.
Step 4: Select the drive you might wish to defragment from the list
near the top, then click the Analyze button. The fragmentation of
that disk will then be analyzed and displayed:
• If nothing would be gained by defragmenting the disk, the
following dialog will be displayed:

Click its Close button, then close the Disk Defragmenter utility.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 123

• Otherwise, the following dialog is displayed:

Step 5: Click the Defragment button to initiate the rearrangement


of file segments. The Defragmentation Display pane and a bar
graph in the status bar at the bottom of the window show the
progress and results of that process.
The following dialog will appear when that process is finished:

Click its Close button, then close the Disk Defragmenter utility.

Because disk defragmentation is a CPU and disk intensive task that


can take hours (depending on disk size and fragmentation), it is not
feasible to simultaneously run any TrainTools programs. Thus, drive
Note: defragmentation must be scheduled for times when the workstation
is not needed for process monitoring, and defragmentation should
be done during all such down times if they are rare.

May 2007 UM5500 (5.0.0)


124 Appendix B: Installation and Maintenance

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 125

UM5500 TrainTools Product Overview and Setupmanual

Appendix C Starting TrainTools Programs


This appendix tells how to create custom and automated methods
for starting TrainTools programs.

Overview You can set up custom and automated methods for starting various
TrainTools programs by modifying and creating Shortcut Files in
various Documents and Settings Subdirectories (see page 129).
The Windows Run Dialog can also be used to start any program,
especially when you want to specify a behavior other than those
defined by your shortcut files. Using batch file Start commands to
launch multiple programs is not recommended due to timing issues.
No matter what method is used to launch a TrainTools program:
• The full path to its executable file must be provided unless the
Path Environment Variable includes the TrainTools program
folder (C:\Program Files\Compressor Controls\TrainTools).
• You can often use appropriate Command Arguments to specify
its startup behavior. Arguments identifying the location of a
project database can usually be expressed relative to the
Default Projects Folder (see page 136).
All programs with OPC/DA and other DCOM server components will
start automatically (if not already running) when any client attempts
to connect to them. However, the Generic Controller AE Server and
Script Engine programs will fail to launch if the project database is
not in the Default Projects Folder.

Run Dialog Any program can be launched by:


Step 1: Selecting the Run command from the Start menu to display
the following dialog:

Step 2: Typing the path to the desired program file (or clicking on
the Browse button to select it from a dialog) and appropriate
Command Arguments (see page 137) into the Open field. If that
path includes any spaces, enclose it in quotation marks.
Step 3: Clicking on the OK button.

May 2007 UM5500 (5.0.0)


126 Appendix C: Starting TrainTools Programs

Shortcut Files Shortcut files provide the benefits of putting a file in several folders
without the disadvantages of having multiple copies of it.
Each such file has a number of properties that specify its behavior
under various circumstances. These can be viewed or modified by
right-clicking on the shortcut and selecting its Properties command,
which will display the following dialog:

• The Target field specifies the path to the file that the shortcut will
open or execute. If it is a program, that path can be followed by
any desired Command Arguments (see page 137).
• The Run field specifies whether the associated program should
be opened in a normal, maximized, or minimized window.
• The Comment field specifies the quick help text that will be dis-
played if you position the mouse cursor over the shortcut file. If it
is blank, the location of the associated file will be displayed.
Shortcut files can be created in any of the following ways:
• Right-clicking the intended target file and selecting the Create
Shortcut command creates a shortcut to that file in the same
folder, which can then be moved to any desired location.
• Right-clicking on the intended target file and selecting the Send
To -> Desktop command creates a shortcut to that file in your
Desktop Folders (see page 129).
• Holding down the Alt key while dragging the intended target file
to any folder (in a separate window or the Windows Explorer
Folders pane), and then releasing the mouse button creates a
shortcut to that file in that location.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 127

Path The Windows PATH system variable defines a set of folders whose
executable programs can be launched by providing the names of
Environment (instead of the paths to) their program files followed by the desired
Variable command-line arguments.
The Setup utility installs most program files to the folder C:\Program
Files\Compressor Controls\TrainTools (or a specified alternative,
see page 106) but does not add that folder to the Windows PATH.
To launch such a TrainTools program from a Windows command
line, you would have to enter that folder path followed by the pro-
gram’s root name. For example, entering “C:\Program
Files\Compressor Controls\TrainTools\Con5” would launch the Con-
figurator utility (Con5.exe). Adding that folder to the PATH would
allow you to launch any of its programs by typing only its root name.
The following procedure will add TrainTools program folders to the
PATH variable:
Step 1: Right-click the My Computer desktop icon and select the
Properties command to display the System Properties dialog.
Step 2: Select its Advanced tab and click the Environment Variables
button to display this dialog:

Step 3: Double-click on the Path item in the lower, System Variables


list to display the Edit System Variable dialog for that variable:

Step 4: Press the down arrow to move the cursor to the end of the
current Path string.

May 2007 UM5500 (5.0.0)


128 Appendix C: Starting TrainTools Programs

Step 5: Type the path to the main TrainTools program folder to add
it to the end of the Path string:
;C:\Program Files\Compressor Controls\TrainTools\
Modify that path appropriately if your TrainTools programs were
installed on some other drive or in some other folder.
Step 6: Click on the OK button of the Edit System Variables dialog.
Step 7: Click on the OK button of the Environment Variables dialog.
Step 8: Click on the OK button of the System Properties dialog.
Some TrainTools programs are located in subfolders of the main
TrainTools program folder. If you want to be able to specify com-
mand lines for them without including the paths to them, you would
have to include those subfolders in the Path string adding above.
A notable example is the Modbus Slave Program (see page 139),
whose file is in the Modbus Slave subfolder. To include it in the
Path, append the following text to that environment variable:
;C:\Program Files\Compressor Controls\TrainTools\Modbus Slave
Because the Variable value field of the Edit System Variable dialog
is so small, you might find it easier to type the desired folder paths
into a Notepad (or other text editor) window:

That text can then be selected (Control-A) and copied (Control-C) to


the Windows clipboard, then pasted (Control-V) to the end of the
current Variable value string in the Edit System Variable dialog.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 129

Documents and The startup drive of a Windows XP or 2000 PC includes a root-level


folder named Documents and Settings with:
Settings
• one subdirectory named All Users, plus
Subdirectories • one for and with the same name as each account whose user
has ever logged onto that computer.
You can set up custom and automated methods for starting various
TrainTools programs by modifying and creating Shortcut Files in
various folders within those subdirectories:
• Startup aids defined by files nested in the All Users folder are
always available, no matter what user is logged in.
• Startup aids defined by files nested in a particular user’s folder
are available only when that user is logged in.

Desktop Folders Any files or folders added to the Documents & Settings\All Users\
Desktop folder appear on the Windows Desktop no matter what
user is logged in. Those placed in the Desktop folder for a particular
user will appear only when that user is logged in.
Windows XP can be configured to display desktop My Documents,
My Computer, My Network Places, and Internet Explorer icons by
right-clicking on the desktop, selecting the Properties shortcut com-
mand, selecting the Desktop tab of the resulting dialog, and clicking
on its Customize Desktop button.

Favorites Folders The Favorites folders for All Users and the currently-logged in user
jointly define the items that will appear in the Favorites menus of the
Start Menu and the Internet Explorer program. It can also be set to
display a Favorites icon by placing a shortcut to either folder in the
Desktop folder.

Start Menu The Start Menu folders for All Users and the currently-logged in user
Folders jointly define the Programs that will appear in the Start Menu (see
page 131):
• Shortcuts placed directly in either folder appear in the top part of
the Start menu or its All Programs submenu, depending on how
the Start Menu is configured.
• Shortcuts placed in either folder’s Programs subfolder appear in
the Programs or the bottom part of the All Programs menu, also
depending on how the Start Menu is configured.
• Shortcuts within subfolders in either of those locations define
Program Groups that appear as submenus in the corresponding
part of the Start Menu. Most software setup utilities add such
folders, which means the All Programs menu will include all pro-
grams installed on the PC unless you remove some of them.

May 2007 UM5500 (5.0.0)


130 Appendix C: Starting TrainTools Programs

Startup Program Placing shortcuts in the All Users\Start Menu\ Programs\Startup


Group folder causes Windows to automatically open the specified program
or document when any user logs on. Files in a specific user’s Start
Menu\ Programs\Startup folder are opened only if that user logs in.

TrainTools Program If the TrainTools Setup Utility (see page 99) is run under a Windows
Group administrator account and its default options are not changed, it will
create a TrainTools folder in the All Users\Start Menu\Programs
directory that includes shortcuts to most TrainTools programs. That
program group thus defines the Programs -> TrainTools submenu
(shown to the left), from which the listed programs can be started:
• To rearrange the listed programs alphabetically, right-click any-
where within that menu and select the Sort by Name command.
• To delete any program you do not use from that menu, right-
click on its entry and select the Delete command.
• To customize the startup behavior of any listed program, right-
click on its entry and select the Properties command (see Short-
cut Files on page 126).
You can add items to this menu by adding other Shortcut Files to the
All Users\Start Menu\Programs folder, or customize it for each user
by creating TrainTools folders in their Programs directories and
moving any startup aids that should be available only to certain
users to those private Programs\TrainTools folders.
Additional startup aids can be created by copying the shortcut files
in this folder to other Documents and Settings folders. In particular:
• You can configure your PC to automatically launch specific
TrainTools programs when you log into Windows by copying
their shortcuts from the TrainTools to the Startup folder.
• The TrainTools menu can be added to the upper section of the
Start or All Programs menu by moving or copying its program
group folder from the Programs to its parent Start Menu folder.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 131

Start Menu The appearance of the Windows Start menu, which provides several
methods for starting TrainTools and other application programs, will
depend on which version of Windows your PC is running:
• Windows 2000 (and its predecessors) display the Classic Start
Menu (see below). Various features can be modified by invoking
the Settings -> Taskbar and Start Menu command.
• Windows XP can be configured to display either of the Start
Menus shown in Figure C-1. By default, it will display the XP
Start Menu (see page 132) shown to the right. The desired style
and its included items can be specified by right-clicking the start
button and selecting the Properties shortcut command.

Classic Start Windows 2000 (and its predecessors) display what is now called the
Menu Classic Start Menu, as shown to the left:
• Its hierarchical Programs menu lists the programs and other
files specified by the shortcuts in the Programs subdirectories of
the Start Menu Folders (see page 129). Selecting an item from
that menu opens the associated program and/or document.
• Its upper portion can include similar menus defined by any other
subdirectories in the Start Menu folders. More commonly, it can
also include programs and other files specified by shortcuts at
their root levels. Clicking such an item will open the associated
program and/or document.
The commands listed in any program group can be:
• rearranged alphabetically by right-clicking anywhere within that
menu and selecting Sort by Name from the shortcut menu,
• deleted by right-clicking them and selecting Delete,
• renamed by right-clicking them and selecting Rename, or
• configured to open different programs or files by right-clicking
them and selecting Properties to open the Properties dialogs for
the associated Shortcut Files (see page 126).
Program groups can be added, deleted, and modified, and some of
the other Start Menu items can be hidden or configured to either
open their defining folders or operate as hierarchical menus, by
invoking the Settings -> Taskbar and Start Menu command and
selecting the Advanced tab of the resulting dialog.

May 2007 UM5500 (5.0.0)


132 Appendix C: Starting TrainTools Programs

Figure C-1 Windows XP Start Menu Options

XP Start Menu Windows XP can be configured to display either of the Start Menus
shown in Figure C-1. By default, it will display the two-column format
shown to the left, but either style can be selected and configured by:
Step 1: right-clicking the start button and selecting Properties from
the resulting shortcut menu to display the following dialog:

Step 2: clicking on the Start Menu or Classic Start Menu button to


select the desired style (which will be displayed in the upper half
of the dialog); and
Step 3: clicking the Configure button of the selected option.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 133

If you select the Classic Start Menu, it will look and operate as
described on page 131. Its program groups can be added, deleted,
and modified, and some of its other items can be hidden or config-
ured to either open their defining folders or operate as hierarchical
menus, by clicking its Customize button in the Taskbar and Start
Menu Properties dialog to display a dialog much like the Advanced
tab of the Windows 2000 Taskbar and Start Menu dialog.
Otherwise, the default two-column Start Menu will be displayed:
• The left tab provides:
• commands for opening a web browser or email program, and
other programs added using the Pin to Start Menu command
in the shortcut menus of program files and shortcuts to them.
• commands for restarting a user-configurable number of the
most recently run programs, and
• the All Programs Menu (see below).
• The right tab provides a configurable list of additional menus,
folders, and commands.

All Programs Menu The All Programs menu of the default Windows XP Start Menu has
two sections:
• The lower portion includes the programs, files, and program
groups specified by the Programs subdirectories of the Start
Menu Folders (see page 129).
• The upper portion includes the items specified by the other
shortcuts and folders in those locations.
Selecting an item from that hierarchical menu opens the associated
program and/or document.
As with Windows 2000, any program group’s commands can be:
• rearranged alphabetically by right-clicking anywhere within that
menu and selecting Sort by Name from the shortcut menu,
• deleted by right-clicking them and selecting Delete,
• renamed by right-clicking them and selecting Rename, or
• configured to open different programs or files by right-clicking
them and selecting Properties to open the Properties dialogs for
the associated Shortcut Files (see page 126).
The Advanced tab of the Customize Start Menu dialog can be used
to add, delete, and modify program group and hide or reconfigure
the operation of certain other Start Menu items. To access it, right-
click on the start button, select Properties to display the Taskbar and
Start Menu Properties dialog, display its Start Menu tab and click on
its Customize button.

May 2007 UM5500 (5.0.0)


134 Appendix C: Starting TrainTools Programs

Quick Launch Desktop Custom

Figure C-2 Manipulating the Desktop Toolbars

Toolbars The Taskbar along the bottom of the desktop (which you can move
to the top or either side) can include any of four standard toolbars:
• the Internet Explorer Address toolbar, which can be used to
start programs or open files by typing Run Dialog commands.
• the Quick Launch toolbar, which is a customizable set of icons
for launching files in the current user’s Quick Launch folder.
• the Desktop toolbar, which duplicates the Desktop icons.
• the Links toolbar, which provides icons for the files in the current
user’s Favorites\Links folder.
To hide or display each toolbar, right-click on the Taskbar, move the
mouse cursor over the Toolbars command, and select it from the
resulting menu. Selecting New Toolbar displays a dialog for creating
Custom Toolbars (see page 135).
Any Toolbar can be repositioned within the Taskbar or “torn off” to
any position on the desktop by dragging its handle (the shadowed
vertical bar along its left edge). Moving that handle to the left short-
ens the toolbar next to it, moving it to the right shortens the right-
most toolbar. If a toolbar is not long enough to accommodate all of
its icons, clicking on the double-arrow along its right edge will dis-
play a menu of the hidden items in which any folders (but not folder
shortcuts) become expandable submenus (as illustrated for the
Desktop toolbar in Figure C-2).
The icons in all but the Address toolbar are defined by the folders,
files, and shortcuts in an associated folder. To open such a folder,
right-click on the Toolbar and select the Open Folder command from
the resulting menu. Other commands in that menu can be used to
hide or display the icon labels (Show Text) or toolbar titles (Show
Title) or toggle between small or large icons (View menu).

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 135

Custom Toolbars You can create custom toolbars associated with any accessible disk
drives or folders. For example, you could create a TrainTools tool-
bar mapped to the TrainTools Program Group or a Projects toolbar
mapped to the TrainTools\Projects folder. To do so:
Step 1: Right-click on the Taskbar, move the mouse cursor over the
Toolbars submenu, and select the New Toolbar… command to
display the following dialog:

Step 2: Navigate to the parent of the folder whose contents will


define your new toolbar. To create a new folder for that purpose,
click on the New Folder button.
Step 3: Select the toolbar folder, then click on the OK button.
Step 4: Move the resulting toolbar to the desired location on that
Taskbar and use its shortcut menu to adjust its display settings.
Disabling a custom toolbar removes it from the Toolbars menu of
the Taskbar but does not delete its defining folder.

May 2007 UM5500 (5.0.0)


136 Appendix C: Starting TrainTools Programs

Default Projects When a TrainTools program is started, its client or user must often
specify the project folder that contains the data files it should use
Folder (such as the project and/or archival database). Because specifying
an absolute path from a program on one PC to a folder on another
can be problematic, a relative path can be provided instead. If the
supplied path does not begin with a drive letter and colon, the target
program will append it to a Default Projects Folder path stored in the
Windows Registry of its PC.
The installer initializes that default path to C:\TrainTools\Projects (or
a user-specified alternative, see page 106), but it can be changed
using the following procedure:
Step 1: Execute Project Builder or TrainView’s File -> Change
Default Projects Directory command, either of which will display
this dialog:

Step 2: Use the dialog’s navigation controls to open the folder con-
taining the desired project folders.
Step 3: Click on the Select button to define the path displayed in the
Current Folder field as the Default Projects Directory.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 137

Command The operation of the following TrainTools programs can be modified


by including appropriate parameters or arguments in the shortcut or
Arguments batch file commands used to start them.

Archival The operation of this program is governed by the ArcCom branch


Communication (see page 60 of UM5532) of a PC element and project specified by
Program the following ArcCom command arguments:
-pcid: the ID number of the PC element in which the ArcCom
branch is nested, which will be displayed in the Project
Builder status bar when that element is selected
-prj: the path to the project in which that branch is defined,
which can be absolute or relative to the Default Projects
Folder (see page 136)
No spaces are allowed between either argument’s keyword (‘-prj:’ or
‘-pcid:’) and its value, which must be enclosed in quotation marks if
it includes any spaces. For example:
ArcCom -prj:MyProject –pcid:2
would initiate the archiving of data as defined by the ArcCom branch
of PC element number 2 from the project database in the MyProject
folder of the Default Projects Folder. The program will abort if more
than one of that PC element’s PC Tasks has an ArcCom branch.

TrainView The operator interface that will be run or opened for development of
Program each instance of this program is governed by a TrainView branch of
a project specified by the following TrainView command arguments:
-res: the ID number of that TrainView database element, which
is displayed in the Project Builder status bar when that
element is selected (not needed if the specified project
includes only one TrainView element)
-prj: the path to the project in which that branch is defined,
which can be absolute or relative to the Default Projects
Folder (see page 136)
-design: starts the program in its interface design mode
No spaces are allowed between any argument keyword and its
value, which must be enclosed in quotation marks if it includes any
spaces. For example:
TrainView -prj:MyProject –res:21
would run the operator interface defined by TrainView element 21
from the project database in the MyProject folder of the Default
Projects Folder.

May 2007 UM5500 (5.0.0)


138 Appendix C: Starting TrainTools Programs

Archive Reporter This program can be invoked in any of three possible modes:
Program -c:edit invokes the Edit Layout mode
-c:run invokes the Run Report mode
-c:view invokes the default View Report mode
Edit Layout This mode opens the layout file assigned to a Report element of a
project database specified by the following command arguments:
-i: the ID number of the Report database element whose
Layout property equals the path to the desired layout file,
which is displayed in the Project Builder status bar when
that element is selected
-p: the absolute, case-insensitive path to the project in which
that element is defined
For example:
Reporter -c:edit -p:C:\TrainTools\Projects\MyProject
-i:1936
would open the layout file for the report defined by Report element
number 1936 from the project database within the project folder
C:\TrainTools\Projects\MyProject.
Run Report This mode executes a reporting action specified by the following
command arguments:
-a: the name (e-Mail, FTP, Print, Save, or View) of the data-
base element specifying the report action
-i:, -p: see Edit Layout
Omitting the “-a” argument initiates every action defined in the spec-
ified Report element.
For example:
Reporter -c:run -p:C:\TrainTools\Projects\MyProject
-i:1936 -a:Print
would generate and print the archived data report defined by the
Print action of Report element number 1936 from the project data-
base in the project folder C:\TrainTools\Projects\MyProject.
View Report This mode displays a Report Viewer window whose default project
folder can be specified by the following argument:
-p: the absolute, case-insensitive path to the default project
For example :
Reporter -c:view -p:c:\traintools\projects\acme_gas
would open a Report Viewer whose File Open dialog would list the
reports in the folder C:\TrainTools\Projects\Acme_Gas\ReportFiles.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 139

Reporter Agent The archived data reports that this program will direct the Archive
Program Reporter to generate are defined by a Reporter branch (see page 25
of UM5533) of a project that are both specified by the following com-
mand-line arguments:
-i: the ID number of the Reporter database element, which
will be displayed in the Project Builder status bar when
that element is selected
-p: the absolute path to the project in which that Reporter
branch is defined
No spaces are allowed between any argument keyword and its
value. For example:
Repa -p:C:\TrainTools\Projects\MyProject –i:123
would initiate the automatic generation of all archived data reports
defined by Reporter element number 123 from the project database
in the C:\TrainTools\Projects\MyProject folder.

Modbus Slave This operation of this program is governed by a configuration file


Program that must be manually opened and run when it is started up, unless
it has been set to resume its previous operating state upon startup.
If so, the configuration file it will open and run can be overridden by
supplying the path from the Default Projects Folder (see page 136)
to another such file as a command line argument.
For example, the command line:
Modbus Slave ModbusSlave\SlaveCfg1.csv
would launch this program and open the SlaveCfg1 configuration file
in the ModbusSlave subdirectory of the default projects folder.
If multiple instances of this program are run on a single PC, they
must be started using command lines that tell them to load different
configuration files.

The Modbus Slave executable file is located in the Modbus Slave


Note: subdirectory of the TrainTools program files folder.

May 2007 UM5500 (5.0.0)


140 Appendix C: Starting TrainTools Programs

Series 5 Operator Each instance of this program displays a simulated faceplate for a
Panel Program Series 5 Controller machine control application specified by the fol-
lowing OperatorPanel command arguments:
-a internet protocol Address of the controller MPU
-i dotted-path Instance name of the control function
(S5_Program.S5_Function)
-L Label to be displayed on the faceplate (optional)
-t function block Type:
AS for compressor antisurge control
EX for steam turbine extraction control
GN for turbine-driven generator control
GT for gas turbine fuel or nozzle control
PF for compressor performance control
SC for steam turbine speed control
These arguments can be provided in any order. The value of each
should be separated from its key letter by a space and can include
spaces but not hyphens. For example:
OperatorPanel -a 10.1.0.1 -i Prog1.AS1 -t AS -L UIC 2
would display an antisurge controller faceplate window with the label
UIC 2 in its title bar, which would display data for an instance of the
TrainWare AS function block named AS1 running in the Prog1 pro-
gram of a Series 5 Controller with the IP address 10.1.0.1.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 141

UM5500 TrainTools Product Overview and Setupmanual

Appendix D Security Features


This appendix discusses various Windows and TrainTools security
features and tells how to use the Administrator program.

Introduction Under the Windows XP and 2000 Professional operating systems,


programs can run and data files can be accessed by more than one
user at a time:
• Only one Interactive User can log on and use the PC’s monitor
and keyboard at a time.
• Multiple Remote Users can access its files and DCOM servers
simultaneously via any Windows-compatible network.
Access to each program or data file can be restricted to specified
users (see Windows Security on page 142). In a distributed HMI
system, the default DCOM settings can also be modified to specify
the ability of each server’s remote clients to access its data (see
DCOM Configuration on page 166).
Currently, all TrainTools programs must be run under the account of
the host PC’s interactive user, who must have run access to their
executable files and read-write access to most of their data files. If
that user logs out of Windows, all such programs will shut down.
Thus, it would be impractical to have individual operators log in and
out of a workstation’s operating system. Instead, project data is pro-
tected by a separate TrainTools security system (see page 149) and
access to each controller’s data is protected by its internal security
features (see page 154).

May 2007 UM5500 (5.0.0)


142 Appendix D: Security Features

Windows In order to use a Windows XP or 2000 Professional workstation, you


must log in by supplying the name and password of an authorized
Security user. You are then presented with a desktop, start menu, and task-
bar that can be customized to your needs (see Appendix C), and
can run any accessible programs (such as the TrainTools software).
Each user can be allowed or denied access to various operating
system features, files, and programs, either directly or via assigned
memberships in groups that have been given the desired rights.
Because logging out of Windows halts any running programs, it is
usually impractical to have TrainView operators log in and out of that
operating system. Thus, we suggest setting up a single Windows
account to be shared by all operators, and setting the computer to
automatically log into this account upon booting up the workstation.
Each operator’s access to your process can then be managed
exclusively by the TrainTools security features (see page 154).

When they are different, this section shows each dialog box as it
Note: appears in both Windows XP (on the left) and 2000 (on the right).

Domains and To log on to a Windows PC, each user must supply a user name
Workgroups and password and select the domain in which they are defined:
• The credentials for local domain accounts can only be used to
log on to the PC on which they were defined. The name of each
PC’s local domain is its computer name.
• The credentials for network domain accounts are stored on a file
server or other domain controller and can potentially be used to
log on to any PC that is a member of that domain.
Each PC can be assigned to a single network domain, in which case
any user or group of users defined by either its own administrator or
that of the specified network domain can be permitted to log on to
that computer or remotely access its files and DCOM servers.
Any PC that is not assigned to a network domain can alternately be
assigned to a Workgroup, in which case only its local user accounts
can be used to log on or access its data. Accessing one workgroup
computer’s data from another PC can be facilitated by creating
accounts with identical names and passwords on both.
If your plant has a network domain that includes file servers or other
network resources that you might want to access from a TrainTools
workstation, it should be assigned to that domain. However, that
does not mean the Windows account used by TrainTools operators
should be defined in that network domain or allow them to access its
resources (as discussed under Local Account Setup on page 144).

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 143

Network Identity Each computer’s name and network domain or workgroup affiliation
are set via the Network Identity tab of its System Properties dialog:
Step 1: Right-click on the My Computer desktop or start menu icon,
then select Properties from its shortcut menu.
Step 2: Click on the Computer Name [or Network Identification] tab
of the resulting dialog:

Step 3: Click on the Change [or Properties] button to display the cor-
responding Changes dialog:

Step 4: Type the desired Computer Name into that field. If this PC
will host any TrainTools OPC, AE, or ADaM servers, this name
must match the Network ID property of the project PC element
under which those server tasks are specified (see Network Con-
nections on page 158).
Step 5: If desired, type in a Workgroup name or click on the Domain
option and type in the name of the desired network domain.
Step 6: Click the OK button.

May 2007 UM5500 (5.0.0)


144 Appendix D: Security Features

Local Account Unless DCOM security considerations (see DCOM Configuration on


Setup page 166) or your company’s Information Technology (IT) policies
dictate otherwise, TrainTools operators should log into Windows
using a local account. Assuming those computers are connected to
a network with a domain controller, operators would then have to
supply their individual domain user names and passwords to access
network file servers and other resources.
This can but probably should not be the built-in Guest account,
because enabling it (it is disabled by default) would potentially allow
any user of any network-connected PC to access those computers.
In fact, any account whose user name and password are widely
known would present a security risk, so it is best to configure each
workstation to automatically log into the chosen local account (its
password can then be kept secret). However, the administrators of
your network might have remotely precluded this possibility.
To set up a local user account:
Step 1: Select Settings -> Control Panel from the Start menu.
Step 2: Double-click on User Accounts [or Users and Passwords] to
launch that control panel, then select its Advanced tab:

Step 3: Click on the Advanced button to display the Local Users and
Groups dialog, and click on the Users folder in its left panel to
display a list of the currently-defined local domain accounts in
the right panel:

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 145

Step 4: Select New Users from the Action menu to display the New
User dialog.
Step 5: Type the desired User name into that field and the desired
password into the Password and Confirm password fields.
Step 6: Uncheck the User must change password and Account is
disabled options.
Step 7: Check the User cannot change password and Password
never expires options.

Step 8: When the dialog appears as shown above, click the Create
button to create the account.
Step 9: Click the Close button to return to the User Accounts [or
Users and Passwords] dialog. If your computer is a member of a
network domain, click the Cancel button to close that dialog and
set up the automatic logon by editing the Windows Registry (as
described on the next page). Otherwise, select the Users tab.
Step 10: Click on the User Name of the account you just created,
then uncheck the “Users must enter a user name and password
to use this computer” option:

May 2007 UM5500 (5.0.0)


146 Appendix D: Security Features

Step 11: Click on the OK button. The following dialog will appear:

Step 12: Type that account’s password into the Password and Con-
firm Password fields, then click the OK button.
Each time this PC is rebooted, it will then automatically log in the
TrainTools operator account as its interactive user, unless the Shift
key is held down. However, if that user logs out, a password would
have to be supplied to log back in.
To configure the automatic logon for a PC that is a member of a net-
work domain, you must edit the Windows Registry:
Step 1: Select Run from the Start menu.
Step 2: Type “Regedit” in the Open field and click on the OK button
to display the Registry Editor window.
Step 3: Expand the registry tree in the left panel to display the
HKEY_LOCAL_MACHINE\SOFTWARE\Windows NT\Current-
Version\Winlogon key, then click on it to select it and display its
entries in the right pane.
Step 4: Double-click on the DefaultDomainName entry, type the
computer name into the Value data field of the resulting Edit
String dialog, then click its OK button.
Step 5: Double-click on the DefaultUserName entry, type the user
name for the TrainTools operator account into its Value data
field, then click OK.
Step 6: Select New -> String Value from the edit menu to create a
New Value #1 entry. Press the Backspace key and type “Default
Password” to change its name. Double-click on that entry, type
the TrainTools operator account’s password into its Value data
field, then click OK.
Step 7: Double-click on the AutoAdminLogon entry, type “1” into its
Value data field, then click the OK button.
Step 8: Select New -> String Value from the edit menu to create
another New Value #1 entry. Press the Backspace key and type
“ForceAutoLogon” to change its name. Double-click on that
entry, type “1” into its Value data field, then click the OK button.
Step 9: Close the Registry Editor.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 147

File System Windows XP and 2000 can use hard drives formatted to a variety of
Security standards, the most common being FAT16, FAT32, and NTFS (the
defaults are NTFS for XP and FAT32 for W2K). Because NTFS pro-
vides enhanced performance and security, we strongly recommend
it for any computer used exclusively as a TrainTools workstation.
Under any drive format, remote users can only access explicitly
shared drives or folders (see Share Points on page 164), subject to
access restrictions (read or change) that are specified for each
shared drive or folder and apply to all folders and files within it:
• For a FAT16 or FAT32 drive, those are the only access restric-
tions. Interactive users can access any file or folder.
• For an NTFS drive, every file and folder has a more varied set of
permissions that can be independently allowed or denied to any
user or group. Each user’s rights to a specific file or folder will be
the aggregate of all rights allowed to him or her and any group
he or she is a member of, provided that same right is not denied
to that user or to any of his or her groups. For example, if Power
Users are allowed to run a program Users are explicitly denied
access to, a member of both groups can not execute it:
• The interactive user can access any file or folder, subject only
to the NTFS access restrictions.
• Remote users can only access files or folders within drives or
folders that have been explicitly shared, subject to both the
NTFS and share access restrictions.

Converting From It is best to format a drive in the NTFS format when it is partitioned,
FAT to NTFS but you can convert a FAT drive to NTFS (without harming installed
programs and existing data) by running the DOS Convert utility:
Step 1: Select Run from the Start menu.
Step 2: Type “Convert C: /fs:ntfs” in the Open field and click on the
OK button. Assuming you are trying to convert your boot drive, a
DOS command window will open and display this message:

Step 3: Press the Y and then the Return key to set your computer to
convert the drive the next time it is rebooted.

Before running the Convert utility, you should back up any files you
Note: wouldn’t be able to replace if anything goes wrong.

May 2007 UM5500 (5.0.0)


148 Appendix D: Security Features

Figure D-1 Setting a File or Folder’s Access Rights

NTFS File Any user can change the access rights of any file or folder to which
Permissions she or he has been allowed Full Control (in general, workstation
administrators have that right to most files and folders). To do so,
open the enclosing folder in the Windows Explorer or My Computer
window, right-click on the file or folder’s icon, execute the Properties
command, and select the Security pane of the resulting dialog (as
shown on the left side of Figure D-1):
• The upper portion of this dialog lists the groups that have been
assigned rights to that file or folder. You can select any of these
groups by clicking on it. You can also remove groups from this
list, or add additional groups or even individual users.
• The bottom portion of the dialog will show which basic permis-
sions users in the selected group are allowed or denied.
• Each basic permission includes one or more elemental access
rights, which can be independently allowed or denied from a
subdialog (shown on the right side of Figure D-1) that is opened
by clicking on the Advanced button.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 149

TrainTools The Project Builder, TrainView, and Web Communication programs


use a common security mechanism to prevent unauthorized users
Security from modifying project files or operating control systems. Each PC’s
software creates a single database of TrainTools account names
and passwords that applies to every project stored on or communi-
cation service supplied by that computer. Each account is assigned
an access level that determines the corresponding user’s ability to
create, modify, or operate control system projects. In general:
• Guests can examine (but not change) projects and monitor (but
not operate) the resulting control systems.
• Operators can also operate a control system, but can not
change or reconfigure it or modify its operator interface.
• Engineers can also change or reconfigure a control system and
its interface, with some limitations.
• Managers have unrestricted access to a control system and its
underlying project, but not the workstation’s accounts database.
• Administrators can also modify the accounts database.
Projects stored on “host” workstations can be accessed from other,
“client” workstations only if each of them provides an account name
and password defined in the host workstation’s accounts database.
As a result, access to a project from any workstation is controlled by
common accounts stored on the same computer as the project, as
discussed under Project Database Access on page 164.
Prior to TrainTools version 3.0, access to a project was controlled by
an accounts database stored in its project folder’s parent directory,
which was referred to as its administrator folder. More than one
administrator folder could be created, each with its own accounts.
Beginning with TrainTools 3.0, project folder parent directories are
called projects folders, which are governed by a common accounts
database. When you upgrade from version 2.6 (or earlier) software,
previously defined accounts can be imported from a single adminis-
trator folder, as described in the Importing User Accounts section of
the Upgrading to TrainTools Version 3.0 technical note [TN31].

May 2007 UM5500 (5.0.0)


150 Appendix D: Security Features

Administrator The accounts database is created and modified by the TrainTools


Program Administrator program, which is launched by selecting Programs ->
TrainTools from the Windows Start menu.

Creating the A local accounts database can be created when the TrainTools soft-
Accounts Database ware is installed (see page 103) or the first time that the
Administrator utility is run. In either case, the following dialog is
displayed:

Clicking on its OK button displays the New Account dialog:

Clicking on the Cancel button would close the program. To create


the accounts database, type the administrator account name in the
Name field, the administrator password in the Password and Verify
fields, and then click on OK. Unless the passwords disagreed, the
following dialog would indicate your workstation’s accounts data-
base and administrator account had been successfully created:

If you initiated this project by launching the Administrator program,


clicking on OK would display the accounts window (see Figure D-2),
which will initially list only the specified administrator account. It will
also include a hidden Guest account that has no password and can-
not be modified.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 151

Figure D-2 Administrator Accounts Window

Modifying the Once the administrator account has been created, launching the
Accounts Database Administrator program will display the following dialog:

To modify the accounts on any accessible workstation, you must log


in as a user with administrator rights to the accounts database on
that PC. To do so, select any project folder on that workstation (see
Project Database Access on page 164), type an administrator’s
name and password (the project folder and user name entered
when you last ran the administrator are suggested), and click on the
OK button.
The Administrator program will then display its accounts window
(see Figure D-2), which lists all users with access to the specified
folder except the hidden Guest account. You can then add new
users and modify or delete any listed account except the one you
used to log in.

When logging in to any TrainTools program, the user name is not


Note: case sensitive but the password is.

May 2007 UM5500 (5.0.0)


152 Appendix D: Security Features

Adding a User To add a new user, click on the account window’s New… button to
display the New Account dialog:

Step 1: Enter the desired user name (which can include spaces) in
the Name field.
Step 2: Type the desired password (which cannot include spaces) in
the Password and Verify fields.
Step 3: Click the OK button.
Provided you typed the same password in both fields, that account
will then be added with Guest level access.
Changing a User’s To change a user’s access level:
Access Level Step 1: Highlight that user name by clicking on it in the User List.
The Group field will then display that user’s current access level.
Step 2: Click on the down arrow at the end of the Group field.
Step 3: Click on the desired access level in the resulting menu.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 153

Changing a User’s To change an account’s password, click on the corresponding name


Password in the Users List, then click on the Change Password… button. The
following dialog will then appear:

Type the new password in the Password and Verify fields, then click
on the OK button. Provided you typed the same password in both
fields, an alert will appear to verify that it was successfully changed.

Click on its OK button to acknowledge this notification.


Deleting a User To delete an account, click on the corresponding name in the User
List, then click on the Delete… button. A confirmation dialog will
then appear—clicking on its OK button will remove the selected
user from the User List and accounts database:

May 2007 UM5500 (5.0.0)


154 Appendix D: Security Features

Controller The ability of platform server clients to access controller variables is


governed by the security features of the controllers and their server
Security programs. In a networked TrainTools system, client access is also
affected by the server DCOM security settings (see page 166).

Series 5 Each Series 5 Controller HMI variable has an associated security


Controllers level and can be changed only if the Series 5 OPC Server has an
equal or higher level of access. All clients inherit the server’s access
to each controller, which can be changed by setting that controller’s
Password global variable equal to the firmware password for the
desired new level. The default access level (operator) will then be
automatically restored after 30 minutes.
In addition, TrainView scripts can read the access level of each con-
troller variable from the project database and restrict access to it
based on the user’s project security level (see page 149).
Various TrainTools OPC clients provide different methods for
changing a Series 5 OPC Server’s access level:
• The Series 5 Configurator utility provides menu and toolbar
Password commands for changing its access to individual con-
trollers, as well as direct access to their Password variables.
• TrainView operator interface elements can be programmed to
change those variables by modifying the associated scripts.

Series 4 As with Series 5, each Series 4 Controller database parameter can


Controllers be changed only if the Series 4 OPC Server has a sufficient access
level; all clients inherit the server’s access to each controller; and
that access is governed by an integer Password parameter Train-
View scripts can be programmed to change as needed.
The minimum/default access level for each Series 4 Controller and
each level’s password are parametrically defined, as described in
the “Database Access” section in Chapter 6 of the Series 4 Appli-
cation Function Module Concepts manual {UM4002]. Setting the
Password to 0 (zero) will restore the minimum/default access level.

Series 3 Series 3 Plus OPC Server clients can change only those data items
Controllers corresponding to the Modbus coils and holding registers of Series 3,
3 Plus, and Series 3++ Controllers. Configuration parameters can be
changed only from the controller engineering panels or by using the
Series 3 Plus Configurator utility.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 155

UM5500 TrainTools Product Overview and Setupmanual

Appendix E Networked TrainTools HMIs


This appendix discusses various issues that arise when TrainTools
client and server functions are distributed among a group of PCs.

plant network TrainTools network


DCS or SCADA
TV Console S5 Server 1 S5 Server 2

TrainTools
TV Web Clients Router Server

Internet Explorer Project Database Vanguard Controllers


TV Web Plug-In TV Web Service

Figure E-1 Distributed TrainTools Example

Introduction Although all TrainTools run-time programs can be run on a single or


each of several workstations, it is better to run the communication
and data archiving programs on dedicated server PCs and the oper-
ator interface programs on workstation PCs. This can minimize the
communication loads on the controllers and prevent operator inter-
face programs from interfering with the timely execution of critical
data acquisition and archiving processes.
However, some or all of the following issues must be addressed
when setting up such a distributed human-machine interface:
• Distributed Communication Options (see page 156)
• Network Connections (see page 158)
• Controller Communication Limits (see page 163)
• Project Database Access (see page 164)
• DCOM Configuration (see page 166)
• Firewall Configuration (see page 172)
• Time Synchronization (see page 175)

May 2007 UM5500 (5.0.0)


156 Appendix E: Networked TrainTools HMIs

Server PC DCOM Client PC


ADaM, AE & DCOM
Controllers TrainView Program
OPC Servers

COM Project
Windows File Sharing

WebServices
Key
Program Installed Component
HTTP
Downloaded Component
TVWeb Client PC
Internet Explorer
Web Client PC
TVWeb Plug-In TrainView Program

COM
Project COM Project

WebGateway Program WebGateway Program


HTTP

Figure E-2 Workstation Communication Options

Distributed When the client and server components of a TrainTools HMI are run
on a single workstation, they share information using the Windows
Communication Component Object Model (COM) service. When they are distributed
Options among a group of PCs, they can communicate using the distributed
component object model (DCOM) and/or TrainTools web services,
which employ the hypertext transport protocol (HTTP). As shown in
Figure E-2, three options are available:
• The DCOM option (upper right) configures the OPC, AE, and
ADaM client programs to communicate with their servers using
DCOM. All client programs are installed using TrainTools Setup,
while the project database is installed on a server PC and
accessed via Windows file sharing.
• The Web Services option (lower right) avoids DCOM-related
problems by “tunnelling” the OPC, AE, and ADaM connections
between the WebServices and WebGateway programs (see
Chapter 4). All client programs are installed using TrainTools
Setup, and the project database must usually be copied to each
client or a server they can easily connect to.
• The TVWeb option (lower left) not only avoids DCOM problems
but also eliminates the need to run TrainTools Setup on the
client workstations — TrainTools components and the project
database are downloaded from the WebServices program.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 157

The DCOM option is more direct but can be difficult to configure and
problematic when there are multiple clients and servers:
• The Windows security settings that specify the servers and data
each client can access can be difficult to figure out and some-
times violate corporate information technology (IT) policies (see
DCOM Configuration on page 166).
• Even if the security problems can be solved, network routers
and firewalls might have to be reconfigured to allow DCOM
communication (see Firewall Configuration on page 172).
• Each DCOM client opens persistent server connections when it
starts up, and cannot subsequently re-establish them without
being restarted. Thus, the failure of a server PC mandates the
manual restarting of all of its DCOM client programs. If those cli-
ents are connected to only one server PC, this might only be an
inconvenience. If they are connected to multiple servers, the
monitoring of those that did not fail (and their controllers) will
also be disrupted.
The web services option is easier to use but requires each PC to run
the additional WebServices or WebGateway program:
• The HTTP protocol those programs use is rarely blocked by fire-
walls and routers.
• Access to controller data is governed by TrainTools security fea-
tures (see TrainTools Security on page 149).
• Web services connections disrupted by computer or network
problems are re-established automatically when the problems
are resolved.

WebServices should not be used to connect clients to servers run-


ning on the same PC.
Note: Unless it is run under the Windows Server 2003 operating system or
set up for .Net remoting, the TrainTools Web Services program can
support only four simultaneously-connected TrainView client PCs.

May 2007 UM5500 (5.0.0)


158 Appendix E: Networked TrainTools HMIs

Network Windows PCs can be equipped with one or more network interface
cards (NICs), each of which can be used to communicate with a
Connections separate group of interconnected computers:
• Each NIC is configured to support specific network services and
protocols, and is assigned an appropriate address for each such
protocol, by setting its Connection Properties (see page 159).
• Each PC is assigned a single computer name (see Network
Identity on page 143) that must be unique on each network it
is connected to.
When the functions of a TrainTools HMI are distributed among
a group of networked PCs:
• All NICs for that network must be configured to support the
TCP/IP protocol suite.
• Such NICs must be assigned IP addresses and subnet masks
that allow their host PCs to communicate (see IP Addresses on
page 160):
• If the network has a domain name system (DNS) service that
will resolve your computer names to the variable IP addresses
assigned by a dynamic host configuration protocol (DHCP)
service, those computers can be set to automatically obtain
their IP addresses from that DHCP server.
• If the network does not provide both of those services, each
PC must be manually assigned a static IP address.
• The Computer Name or TCP/IP address that is assigned to any
PC that will host an OPC, AE, or ADaM server must match the
Network ID property of the project PC element under which
those server tasks are specified.
• If the PCs are configured to obtain their IP addresses from a
DHCP server, their Network ID project database properties
must match their actual Computer Names, because their IP
address can change.
• If they are assigned static IP addresses, those addresses can
be used as their project database Network IDs. However, it
might still be advantageous to use their Computer Names if
there is a DNS service or Hosts file that will resolve them (see
Name Resolution on page 162).
Chapter 2 of the PC Communication Engineering manual
[UM5532] tells how to set, determine, or change the Network ID
project database property for each computer.
If TrainTools PCs are correctly interconnected and configured, each
will be able to ping the Network IDs of the others.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 159

Connection Each NIC’s networking protocols and addresses are set by selecting
Properties Network Connections (or Settings -> Network Connections) from the
Start Menu. This will open a window that includes an icon for each
installed NIC. To view or change the settings for any one of them:
Step 1: Double-click the corresponding network connection icon,
then click the Properties button of the resulting Status dialog to
display the General tab of its Properties dialog:

Step 2: Make sure the Internet Protocol (TCP/IP) component is


checked, then select it and click the Properties button to display
the TCP/IP settings for that NIC.
Step 3: As discussed on the previous page, choose the Obtain an IP
address automatically and Obtain DNS server address automat-
ically options only if the network has a DHCP server and a DNS
service that will resolve local names:

May 2007 UM5500 (5.0.0)


160 Appendix E: Networked TrainTools HMIs

Otherwise, choose the Use the following IP address option and


enter appropriate IP address, Subnet mask, Default gateway,
and DNS settings (see IP Addresses below):

Click the Advanced tab if you need to assign the PC to more


than one subnet (see IP Addresses on page 160).
Step 4: Click the OK button.
If TrainTools PCs are correctly interconnected and configured, each
will be able to ping the Network IDs of the others. To test this:
Step 1: Select the Run command from the Start menu.
Step 2: Type “cmd” in the Open field, then press the Return key to
display a command window.
Step 3: Type the word “ping” followed by a space and the Network
ID (computer name or IP address) specified in the project data-
base for the target PC, then press the Return key:
• If you specified a computer name and it could not be resolved,
the ping program will indicate that host is unknown or could
not be found (see Name Resolution on page 162).
• Otherwise, that program will indicate it is pinging the specified
IP address (or the specified host at its resolved address) and
send four ping requests to it. It then displays messages that
indicate how quickly that PC responded (if at all). If all four
requests time out, the IP Addresses of the host and target
PCs are incompatible.

IP Addresses Any two NICs can directly communicate with each other only if they
are assigned to a common IP subnet and connected via a common
cable or interconnected hubs. Otherwise, each can contact the other
only via its specified default gateway router.
Each network connection’s subnet and host number are specified by
its 32-bit Subnet Mask and IP Address properties, whose values are
commonly expressed as four decimal octets separated by dots or

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 161

periods. Because each octet can range from 0 to 255, those values
can in principal range from 0.0.0.0 to 255.255.255.255:
• The set bits (ones) of the Subnet Mask select the IP Address
bits that specify the subnet.
• The remaining IP Address bits specify the host number.
Manually-assigned IP Addresses should always be selected from
one of the private address spaces allowed by the Internet Assigned
Numbers Authority (IANA). Because NICs assigned such addresses
can connect to the Internet only via proxies, such as routers that
provide network address translation (NAT), their addresses only
need to be unique to the local network. We recommend assigning
addresses whose first octet is 10 (for example, 10.9.1.10), all of
which are private.
Each octet of the mask is usually (but not necessarily) set to zero or
all ones (255). The subnet is then specified by the IP Address octets
corresponding to the 255 octets of the mask:
• If their masks are set to 255.0.0.0, all of your computers will
share a common 10. subnet with over 4 million potential hosts.
• If their masks are set to 255.255.0.0, they can be assigned to up
to 256 10.# subnets, each with over 65,000 potential hosts.
• If their masks are set to 255.255.255.0, they can be assigned to
over 65,000 10.#.# subnets, each with up to 250 potential hosts.
A NIC can be assigned multiple addresses on more than one subnet
by clicking the Advanced button of the TCP/IP Properties dialog
(see page 160) to display the following dialog:

Each NIC can communicate with NICs on other subnets only if its
Default Gateway property specifies the addresses of one or more
routers assigned to any of its subnets and connected via a common
cable or interconnected hubs.

May 2007 UM5500 (5.0.0)


162 Appendix E: Networked TrainTools HMIs

Name Resolution Because IP addresses are hard to remember and can change, the
TCP/IP protocol allows computers to address each other by name—
provided a means is provided for resolving them to IP addresses:
• PCs should be set to automatically obtain their IP addresses
from a DHCP server only if it also provides a DNS from which
they can obtain the IP addresses of named local computers.
• If no such service is available, PCs can address each other by
name only if their static IP addresses and names are correlated
by one of the following files:
• WINDOWS\system32\drivers\etc\hosts
• WINDOWS\system32\drivers\etc\lmhosts
Either is a text file, each line of which is a comment or an IP
address and associated name, separated by spaces or tabs.
For example:
10.9.0.2 Prj_Server
10.9.0.11 S5Server_1
10.9.0.12 S5Server_2
10.9.0.21 Console_1
10.9.0.22 Console_2
Changes take effect immediately. More information can be
found in the hosts and sample lmhost files in the drivers\etc
folder. The lmhosts file can include information from a master
file on another PC, which can make changes easier to apply.
A PC will always try to resolve unknown names using its hosts file,
but must be configured to use lmhosts:
Step 1: Click the Advanced button of the TCP/IP Properties dialog
(see page 160) and select the WINS tab of the resulting dialog:

Step 2: Check the Enable LMHOSTS lookup option, then click the
Import LMHOSTS button to display a dialog for selecting the
desired file and copying it to the required location.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 163

TrainTools LAN or plant-wide network


TrainTools
Server PPP serial links
A
POWER
HEALTHY

Vanguard Network IN CONTROL


ALARMS

R
FAULT

Turbomachinery Control System %

A
POWER
HEALTHY
IN CONTROL
ALARMS

R
FAULT

Turbomachinery Control System %

Vanguard Controllers Reliant Controllers


Figure E-3 Isolating Vanguard Controllers from Other Networks

Controller Due to the finite communication capacities of CCC controllers, the


number of TrainTools Servers that can be set up for each is limited:
Communication
• Each Series 3 or 3 Plus Controller can communicate with at
Limits most two instances of the Series 3 Plus OPC Server program.
• Each Series 4 Application Function Module can communicate
with at most four (and usually fewer) instances of the Series 4
OPC Server program.
• Each Reliant Controller supports up to six Series 5 Protocol
communication sessions (via serial connections to one or two
workstations), while each Vanguard Controller can support up
to 16 (via sharable ethernet connections). Each instance of the
Series 5 OPC Server program uses at least two such sessions,
plus an additional dedicated session for each of its ArcCom or
Fast Recorder client programs.
In addition, Vanguard Controllers should be protected from heavy
network traffic by using a dedicated TCP/IP network to connect
them to their Series 5 OPC Server PCs. Separate network interface
cards (NICs) should be installed in each such PC for any other net-
works you want to connect them to. Internet connection sharing,
which can route network traffic from one NIC to another, is disabled
by default and should not be enabled.
The PPP protocol that Reliant Controllers use to communicate with
TrainTools Servers automatically shields them from network traffic
that is not directed specifically to them.

May 2007 UM5500 (5.0.0)


164 Appendix E: Networked TrainTools HMIs

Project The project database that defines various TrainTools HMI tasks
must often be accessed by multiple computers. Instead of trying to
Database keep multiple, identical copies of such a database, it is best to keep
Access it on one “host” computer that is set up to allow programs on other
“client” computers to access it. This is possible only if:
• TrainTools software is installed on the host computer,
• the project folder is within a share point of that PC,
• each client PC has mapped that share point as a local drive that
it accesses using a workgroup or domain account that is valid
on the host PC (see Domains and Workgroups on page 142 and
File System Security on page 147),
• the host PC project folder is specified as the Default Projects
Folder (see page 136) of each client PC, and
• any firewall service (see page 172) separating the client and
host PCs has been configured to permit access via port 3050.

Share Points To make any folder of a Windows PC a share point:


Step 1: Right-click on its icon in a desktop or Explorer window and
select Sharing… from the resulting menu to display the Sharing
pane of that folder’s Properties dialog:

Step 2: Click on the Share this folder option and (if desired) edit the
suggested Share name. You can also add a comment that can
be viewed from other computers.
Step 3: Click on the OK button to make the contents of this shared
folder available to any user of a network-connected computer
whose credentials are valid for this PC and folder (see File Sys-
tem Security on page 147).

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 165

Mapping Drives To access a share point on another computer as the root directory
of a local drive, use the following procedure to map it to a drive letter
(for example, a share can be set up as your local “D:\” drive):
Step 1: Right-click on the desktop My Computer icon and select
Map Network Drive… from the resulting menu to display the
Map Network Drive dialog:

Step 2: Select a drive letter from the Drive menu (the next available
drive letter will be suggested) and:
• type the share point (\\server\sharename) in the Folder field,
• select it from that menu of previously-mapped share points, or
• click on the Browse… button and select the share point from
the hierarchical list of available shares in the result dialog.
Step 3: If you only want this connect to last until you log out of your
current Windows session, leave the Reconnect at logon option
unchecked. Check that box if you want to connect to that share
point every time you log onto this PC.
Step 4: If the Windows account you are using does not have access
to the selected share, click on the Connect using a different user
name link and provide the account name and password for a
Windows user who has the needed NTFS access to that share.
Step 5: Click on the Finish button to connect to the selected share
and begin using it as though it was the specified local drive.

May 2007 UM5500 (5.0.0)


166 Appendix E: Networked TrainTools HMIs

DCOM Several configuration issues arise when distributed component


object model (DCOM) clients on one workstation must access serv-
Configuration ers running on another PC:
• the Network Protocols (see page 167) and DCOM Settings (see
page 168) of all client and server PCs must be properly set, and
• PCs running XP Service Pack 2 (see page 171) must be custom
configured to enable DCOM communication.
All of these settings can be configured using a single Windows utility
that can be invoked by selecting Run from the Start menu, typing
“dcomcnfg” in the Open box, and pressing the Return key:
• If your PC is running Windows 2000, this invokes the Distributed
COM Configuration Properties dialog, whose Default Protocols,
Default Properties, Default Security, and Applications tabs can
be used to configure DCOM communication.
• If your PC is running Windows XP, this invokes the Component
Services administrative tool. Expand the Console Root tree in its
left panel to display the Component Services \ Computers \ My
Computer folder:
• Right-clicking on that folder and selecting its Properties short-
cut command will display the My Computer Properties dialog,
which has Default Protocols, Default Properties, and COM
Security tabs.
• Expanding that folder will reveal a DCOM Config folder that
takes the place of the Applications tab of the W2K DCOM
Configuration dialog.
In either case, any changes you make will not take effect until you
reboot the PC.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 167

Network Under Windows XP and 2000, all DCOM communication employs


Protocols connection-oriented communication protocols, and communication
problems can arise if any datagram protocols are enabled.
To forestall such problems:
Step 1: Display the Default Protocols tab of the My Computer Prop-
erties or DCOM Configuration dialog (see page 166):

Step 2: If any datagram protocol is listed, delete it by clicking on it


and then on the Remove button.
Step 3: If Connection-oriented TCP/IP is not listed, click on the Add
button and select it from the menu of the resulting dialog.
Step 4: Move the Connection-oriented TCP/IP protocol to the top
(if it is not already there) by selecting it and then clicking on the
MoveUp button.
Step 5: Click on the Apply button. If you do not need to make any
other DCOM configuration changes, close the dialog and reboot
the PC.

May 2007 UM5500 (5.0.0)


168 Appendix E: Networked TrainTools HMIs

DCOM Settings The security features of the Windows operating system impose
restrictions that can prevent DCOM clients from accessing servers
running on other computers. In essence, the DCOM service of a
server PC will only allow remote client programs run by specified
Windows users to launch and access its DCOM servers.
In addition, improper DCOM configuration can cause a TrainTools
Server PC to launch a separate server instance for each client:
• Because communication with Reliant, Series 4, and Series 3
Controllers employs serial ports that can only be used by the
first instance of the corresponding server program, clients of any
subsequently-launched instances would have no access to the
data from those controllers.
• Vanguard Controllers can be accessed by multiple instances of
the S5_OPC program, but the increased communication load
can interfere with the timely execution of their control tasks.
These problems can be avoided by logging onto all of the involved
PCs using local accounts with the same names and passwords, or
the same network domain account. If that is not acceptable, the
default DCOM settings or those of each server must be modified.

We recommend logging into all workstations using identical local


accounts. Customers who choose not to do that must accept the
Note: responsibility of making their own DCOM Configuration changes.
Other approaches discussed here are only suggestions (some from
other sources) that are not guaranteed to work.

DCOM security is a standard Windows feature whose operation and


complex configuration options are fully documented by Microsoft
and various other sources. As such, it is beyond the scope of this
document to do more than provide information on the DCOM config-
uration requirements of the TrainTools programs.

Improper configuration of a DCOM server program can prevent


clients from launching and accessing it, while improper configuration
Caution: of client PCs can prevent them from receiving subscribed data from
their servers.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 169

Default Security To modify the DCOM configuration settings applied to all programs
Settings that do not override them:
Step 1: Display the Default Properties tab of the My Computer Prop-
erties or DCOM Configuration dialog (see page 166):

Step 2: Verify that the Enable Distributed COM on this computer


option is checked.
Step 3: If your TrainTools Workstations are isolated from your plant
network and the Internet, or separated from them by an external
firewall device, you might consider disabling DCOM security by:
• selecting None from the Default Authorization Level menu for
all client and server PCs, and
• configuring all server PCs to allow all users to launch and
access their DCOM servers (see following steps).
Otherwise, display the COM or DCOM Security tab:

Set the default launch and/or access permissions by clicking the


Edit Defaults button in the corresponding section.
Step 4: Click on the OK button.

May 2007 UM5500 (5.0.0)


170 Appendix E: Networked TrainTools HMIs

Customizing DCOM can be set up to apply different configuration settings to any


Individual Servers individual server program using the following procedure:
Step 1: Expand the Computers \ My Computer \DCOM Config folder
in the left pane of the Component Services window (Windows
XP), right-click on the desired server program icon in the right
pane, and select its Properties shortcut command,
or
Display the Applications tab of the DCOM Configuration dialog
(Windows 2000), select the desired server program, and click
on the Properties button.
To disable DCOM security for just this program, select None
from the Authorization Level menu.
Step 2: To specify that all clients should connect to a single instance
of this server running under a specified account, display the
Identity tab and configure the desired option:

All TrainTools version 6.1 (and earlier) server programs must be


run under the interactive user account. The default Launching
user option will yield this result if all workstations are logged into
the same local or network domain account. Otherwise, each
must be specifically set to use the Interactive user option.
Step 3: To specify custom DCOM launch and access permissions
for this server only, display the Security tab. Then click on the
Customize option of the launch or access permissions section,
click its Edit button, and set the corresponding permissions.
Step 4: Click on the OK button.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 171

XP Service Pack 2 Service Pack 2 for Windows XP added the ability to limit the extent
to which the default DCOM security settings can be overridden.
Because all remote access is denied by default, these limits must be
modified to allow DCOM clients and servers to communicate:
Step 1: Display the My Computer Properties dialog’s COM Security
tab (see page 166):

Step 2: Click on the Edit Limits button in the Access Permissions


section to display the left dialog shown below:

Click on each group listed in the upper pane, then allow or deny
it local and remote access in the lower pane. Other groups can
be added by clicking the Add button. The Anonymous Logon
group must be allowed remote access to let remote OPC clients
obtain a list of this PC’s servers.
Step 3: Click on the Edit Limits button in the Launch Permissions
section to display the right dialog shown above. Click on each
group listed in the upper pane, then allow or deny local and
remote launch and activation in the lower pane.
Step 4: Click on the OK button.

May 2007 UM5500 (5.0.0)


172 Appendix E: Networked TrainTools HMIs

Firewall Networked computers are sometimes protected by a firewall service


or device that can:
Configuration
• block or permit communication with computers with specific IP
addresses or domain names, via specific TCP and UDP ports,
or with specific programs, and/or
• use Network Address Translation (NAT) to prevent remote com-
puters from initiating communication with local PCs.
The Windows XP operating system includes such a firewall, which is
enabled by default if Service Pack 2 is installed. Windows 2000
does not, although third-party firewall programs are often installed.
In addition, network routers usually offer firewall features.
Any firewall separating TrainTools servers from their client PCs
must be configured to allow them to communicate. In particular:
• NAT must be disabled and port 135 must be unblocked in
order for DCOM clients and servers to communicate.
• Port 80 (HTTP) must be unblocked in order for client worksta-
tions to access a host’s TrainTools web services.
• Port 3050 must be unblocked in order for client workstations
to access a host workstation’s project and user databases.
• Port 502 must be unblocked to allow Modbus TCP masters to
access Modbus TCP slaves.

Windows XP The Windows XP operating system includes a Windows Firewall


Firewall control panel that is enabled by default. The following configuration
changes must be made in order for TrainTools clients and servers to
communicate across a network.
Step 1: Select Settings -> Control Panel from the Start menu, then
double-click the Windows Firewall icon to display the General
tab of its dialog box:

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 173

If your TrainTools Workstations are isolated from your plant net-


work and the Internet, or separated from them by an external
firewall device, you can disable their internal firewalls by clicking
on the Off option. Then click on the OK button. Otherwise, leave
the On option checked, make sure the Don’t allow exceptions
option is not checked, and proceed to Step 2.
Step 2: Click on the Exceptions tab to display it:

Step 3: If the Microsoft Management Console is listed, click on its


checkbox to enable communication with it. If not, use the steps
below to add it.
Step 4: Click on the Add Program button to display this dialog:

Select the entry for an OPC, AE, or ADaM client or server pro-
gram that will be run on this PC, then click the OK button.
Step 5: Repeat Step 4 until you have added all OPC, AE, and ADaM
client and server programs that will be run on this PC. Any that
are not listed can be added by clicking on the Browse button.

May 2007 UM5500 (5.0.0)


174 Appendix E: Networked TrainTools HMIs

Step 6: Click on the Add Program button, then on its Browse button
to display the following file selection dialog:

Step 7: Navigate to the Windows\system32 folder of your boot drive,


scroll to and select the OPCENUM.EXE icon, then click on the
Open button to add it to the Add Programs list.
Step 8: Select that program and click on the OK button.
Step 9: Click on the Add Port button to display the following dialog:

Type DCOM into the Name field and 135 into the Port number
field. Click on the TCP option, then the OK button.
Step 10: Repeat Step 9 to add Port 3050 (Firebird), which is used to
communication account and project database information.
Step 11: Repeat Step 9 to add Port 502 if this PC will be hosting any
Modbus TCP master or slave programs.
Step 12: Click on the OK button to dismiss the Windows Firewall
control panel.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 175

Time Master TrainTools PCs (NTP Clients)

NTP

Figure E-4 TrainTools Workstation Time Synchronization

Time When a control system includes multiple TrainTools Workstations,


their clocks should be synchronized by installing and configuring an
Synchronization operating system service implementing the Network Time Protocol
(NTP). In addition, the internal clocks of any Series 5 Controllers
must be synchronized to those of the workstations.
The Series 5 Control System Time Synchronization technical note
[TN29] describes the procedures for synchronizing workstation and
controller clocks, using the Windows operating system time of one
workstation as a reference. However, the resulting control system
time will usually gain or lose several seconds a day unless the time
master workstation is provided with a more accurate time source
than its motherboard timing circuit.

May 2007 UM5500 (5.0.0)


176 Appendix E: Networked TrainTools HMIs

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 177

UM5500 TrainTools Product Overview and Setupmanual

Revision History
This appendix lists and describes the changes incorporated into each version of
this manual and the TrainTools programs it documents.

Table R-1 Manual and Product Revisions

Manual TrainTools
Version Release Revised Software Features
1.0.0 2.6 reference version
various fixes and improvements, plus:
redesigned Alarm Monitor Utility
modified Project Database, Folder Hierarchy, and Security
2.0.0 3.0
added Series 4 OPC Server
added Series 5 CheckTime Utility
modified Series 5 Library Function List
various fixes and improvements, plus:
added ActiveX Control Alternate Languages
added Duplex Supervisor Program
added Excel Importer Utility
2.1.0 3.1
added SCI Bridge Program
modified Series 3 Plus OPC Program
modified Series 5 OPC Program
added TrainView Library Version Support
major revision of manual and program files:
separated programs into Software Packages
added License Keys
added Modbus Slave Program
3.0.0 4.0
added Modbus TCP Support
improved Project Revision Management
improved Series 5 Field Engineering Features
added Windows XP Compatibility
added the TrainTools Web software package
extended Duplex Supervisor Program to Reliant Controllers
4.0.0
5.0 revised Fast Recorder Configuration commands
4.0.1
added Project Builder Interface Customization
added Series 5 Modbus Data engineering
added support for Series 3++ Controllers
added SCI interface to Series 4 OPC Server
added the Series 5 Emulator software package
5.0.0 6.1 added Series 5 Extended Diagnostics
added online Series 5 Modbus and AE Changes
added Project Unzip Utility
added support for Series 5 MPU-1002

May 2007 UM5500 (5.0.0)


178 Revision History

TrainTools The initial version of this manual documented Release 2.6 of the
TrainTools Software Package. The following sections of this publi-
Releases cation describe only the subsequent major changes to that package.

Release 3.0 Version 3.0 of the TrainTools Software Package was released in
May of 2004. The following programs were added or significantly
modified relative to Release 2.6:
Alarm Monitor Utility The Alarm Monitor field engineering utility was redesigned so its
user interface matches that of the TrainView Alarm control.
Project Database, All TrainTools programs were modified to employ a new database
Folder Hierarchy, engine, which required the conversion of pre-existing control system
and Security project databases to a new file format.
The use of administrator folders, each with an accounts database
that controlled access to the projects stored within it, was replaced
by the use of a single accounts database on each workstation that
controls access to all projects stored on any drive of that computer.
Series 4 OPC Server The new Series 4 OPC Server program provides OPC data access
to the parameter databases of Series 4 Controllers.
Series 5 CheckTime The new Series 5 CheckTime utility displays the difference between
Utility the host PC’s operating system time and those of specified Series 5
Controllers.
Series 5 Library The Project Builder system engineering program was modified to
Function List allow only the inclusion of S5 Functions defined in the TrainWare
libraries specified by each S5 MPU element’s library list property.

Release 3.1 Version 3.1 of the TrainTools Software Package was released in
January of 2005. The following programs were added or significantly
modified relative to Release 3.0:
ActiveX Control The Alarm, Event, IOView, and Trend ActiveX controls, which are
Alternate Languages used primarily by the TrainView program, were modified to display
field labels and table headings in the project’s current language if
supporting DLLs are present (as of the release date, only English
and Russian DLLs were available and installed by the Setup utility).
Duplex Supervisor A new Series 5 Duplex Supervisor run-time program was added to
Program monitor and keep the operating system, application software, and
configuration data of a redundant Vanguard Controller identical to
those of its active peer.
Excel Importer Utility A new Excel Importer project engineering utility was added that can
import field I/O information and logic program alarm and event defi-
nitions into a Series 5 Controller project database.
SCI Bridge Program A new SCI Bridge program was added to enable the WOIS Series 4
Configurator program to communicate with Series 4 Controllers via
the Series 4 OPC Server program.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 179

Series 3 Plus OPC The Series 3 Plus OPC program was modified to also provide OPC
Program access to Series 3 Controller data.
Series 5 OPC Program The Series 5 OPC program was modified to automatically detect the
loading of new controller application software and modify its address
space accordingly; determine the quality of subscribed data items
dynamically; and automatically maintain data access to controllers
whose simplex/duplex status changes.
TrainView Library The TrainView program was modified to use true object libraries.
Version Support Pictures, scripts, and other operator interface elements are now
incorporated into projects as instances of library objects that cannot
be modified independently of the libraries, and the program’s design
mode provides for the assisted synchronization of a project to
updated versions of its libraries.

Release 4.0 TrainTools Version 4.0 introduced the following changes relative to
Release 3.1:
Software Packages The TrainTools programs are now grouped into six packages that
can be separately installed in combinations appropriate to each host
PC using a single Setup utility.
License Keys The TrainTools programs are now provided with a license key that
determines which of them can be installed and run on each host PC.
Modbus Slave Program The new Modbus Slave OPC Client program makes data from
TrainTools OPC/DA servers available to Modbus Master devices.
Modbus TCP Support The Series 3 and Modbus OPC server programs now support the
Modbus ethernet (TCP) protocol as well as serial (RTU and ASCII)
communication with Series 3/3 Plus and third-party Modbus slaves.
Project Revision The Project Builder program now maintains and can display revision
Management history information for each project, and provides additional options
regarding the scope of each new revision it saves.
Series 5 Field The Series 5 Configurator program can now download upgraded
Engineering Features firmware to Reliant Controllers and Vanguard IOCs.
The Series 5 Duplex Supervisor program now supports Reliant as
well as Vanguard Controllers.
Windows XP The TrainTools programs can now be run under either the Windows
Compatibility 2000 or XP Professional operating system.

May 2007 UM5500 (5.0.0)


180 Revision History

Release 5.0 TrainTools Version 5.0 introduced the following changes relative to
Release 4.0:
TrainTools Web The TrainTools Web software package was added to allow client
and server programs to communicate via web services rather than
the Windows distributed component object model (DCOM) service.
Duplex Supervisor The Duplex Supervisor utility was modified to support Reliant as
Program well as Vanguard Controllers.
Fast Recorder The user interface for configuring the variables plotted by the Fast
Configuration Recorder engineering utility was completely revised In particular,
you can now easily change the variables plotted on each page when
replaying previously recorded data.
Project Builder User defined commands can now be added to the Project Builder
Interface Customization program’s user interface.
Series 5 Modbus Data The Project Builder program can now be used to define the Modbus
data points of Series 5 Controllers.

Release 6.1 TrainTools Version 6.1 introduced the following changes relative to
Release 5.0:
Project Unzip Utility Any TrainTools installation now includes the Project Unzip utility,
which extracts the files from compressed project revision folders.
Series 3++ Controllers The Series 3 Plus OPC and Configurator programs were modified to
also work with Series 3++ Controllers.
Series 4 OPC Server The Series 4 OPC Server program was enhanced so the Series 4
Configurator program can communicate with AFMs through it.
Series 5 Emulator The Series 5 Emulator software package was added, which allows a
single PC to execute the application software of up to sixteen Series
5 Controllers for testing and training purposes.
Series 5 Extended The Series 5 Configurator program can now save Series 5 Control-
Diagnostics ler diagnostic information to a zip file.
Series 5 Modbus and The Series 5 Configurator program can now download revised AE
AE Changes definitions and extended attributes files to running controllers:
• If the AE definitions are changed, Series 5 AE Servers will use
them for subsequently-posted messages, without having to
restart either the controller or the Series 5 OPC program.
• If the Modbus attributes are changed, all hosts must be modified
accordingly, as the controller’s Modbus data set will change
immediately without having to restart it.
Series 5 MPU-1002 Support for the new Vanguard MPU-1002 was added to the Project
Builder program, including a command for converting MPU-750
projects to use the new card.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 181

Manual Version 1.0.0 of this manual was released in January of 2002, and
documented the features of TrainTools release 2.6. This document
Revisions describes changes made subsequent to that release.

Version 2.0.0 Revision 2.0.0 of this manual documented the new, revised, and
previously undocumented features of TrainTools Release 3.0:
• The Series 5 Roadmap was removed from the front matter to
reflect the expanded applicability of TrainTools programs to
Series 4 and Series 3 Plus Control Systems.
• Chapter 1 was extensively revised to more specifically discuss
the various run-time programs (OPC and AE Servers, Script
Engine, Archival Data System, and TrainView); as well as the
added support for Series 4 and Series 3 Plus Controllers.
The distribution of the main TrainTools Release as part of the
Total Train Control Release was explained, as was the separate
availability and documentation of the Series 3 Plus Engineering
Utilities package.
• Chapter 2 was revised to match current installation procedures,
especially the new Total Train Control installer. The Project File
Installation section was revised to reflect the current methods of
providing such files to customers. A discussion of disk defrag-
mentation was added to the Maintenance section.
• Chapter 3 was revised to document the revised TrainTools
security features and Administrator program procedures. The
Server Security section was also added.

Version 2.1.0 Revision 2.1.0 of this manual documented the new, revised, and
previously undocumented features of TrainTools Release 3.1:
• The Workstation Setup section of Chapter 2 was updated to
reflect the product version change and the new InstallShield
screens. In addition, an overview of the standard About dialog
was added to the Workstation Maintenance section.
• The Engineering Utilities section of Chapter 1 was revised to
include the new Series 5 Duplex Supervisor and the ability for
the Series 4 Configurator to communicate with the Series 4
OPC Server via the new TrainTools SciBridge program.
• Appendix B was created by adding information on the command
line arguments of various programs to the information on creat-
ing program shortcuts that was formerly part of Chapter 2.
• Appendix C was created by revising Appendix D of the Series 5
System Overview manual [UM5000], in order to put the generic
information about TrainTools alarms and events in this manual
while making the UM5000 appendix Series 5 specific. Also, the

May 2007 UM5500 (5.0.0)


182 Revision History

TrainTools data archiving appendix was added to this manual


(as Appendix D) and removed from UM5000 (Appendix E).
• The Project Engineering section of Chapter 1 was revised to
specifically mention the project engineering uses of the Script
Engine and Archive Reporter programs. In addition, the Site
Files section of Chapter 2 was updated to mention the Report-
Files folder for the Archive Reporter.
• An explanation of the Default Projects Folder setting was added
to the Project Sharing Section of Chapter 3.
• Glossary entries for recently added programs and features were
added to Appendix A.

Version 3.0.0 Revision 3.0.0 of this manual was completely reorganized and
rewritten to explain the separation of the TrainTools programs into
multiple software packages, as well as the other new, revised, and
previously undocumented features of TrainTools Release 4.0:
• The Overview chapter (1) was rewritten to introduce and briefly
describe the six software packages.
• The remaining chapters provide more information on the Plat-
form Communication and Archive Server (2), TrainView and
Archival Data Utilities (3), Platform Engineering (4), and Project
Engineering (5) software packages. In particular, most of the
information formerly found in Appendices C (alarms and events)
and D (archival data system) is now in Chapter 2.
• The information that formerly comprised Chapters 2 through 4
was reorganized into the new Appendices B (installation and
maintenance) and D (security).
• The program startup information formerly in Appendix B is now
in Appendix C.
• Appendix E of this revision discusses the issues that must be
addressed when setting up a networked group of TrainTools
human-machine interface workstations.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 183

Version 4.0.0 Revision 4.0.0 of this manual documented the new, revised, and
previously undocumented features of the final beta version of Train-
Tools Release 5.0:
• A new Chapter 4 was inserted to describe the new TrainTools
Web software package, and some web services definitions were
also added to the Glossary.
The Field Engineering Utilities and Project Engineering chapters
(formerly 4 and 5) were renumbered as Chapters 5 and 6.
• Chapter 2 was revised to only cover COM communication
between programs running on a single PC. All discussion of
DCOM is now in Appendix E, including a new discussion of the
relative merits of web services and DCOM.
• Instructions for installing the Windows Internet Information Ser-
vices component required to provide TrainTools and TrainView
web services was added to Appendix B.
• Appendix C was revised to cover program startup options that
are new or different in Windows XP.

Version 4.0.1 Revision 4.0.1 of this manual documented the final release version
of TrainTools Release 5.0:
• The Duplex Supervisor section of Chapter 5 was updated to
indicate that program can now be used with both Reliant and
Vanguard Controllers.
• Appendix B was revised to indicate TrainTools Setup no longer
installs the Adobe Reader program, but that program’s Setup
utility can be launched from the CCC Installer or from within the
TrainTools Setup\redist folder.

May 2007 UM5500 (5.0.0)


184 Revision History

Version 5.0.0 Revision 5.0.0 of this manual documented the new, revised, and
previously undocumented features of the final beta version of Train-
Tools Release 6.1:
• Most mentions of Series 3 and 3 Plus Controllers were changed
to Series 3 / 3 Plus / 3++ to stress that Series 3++ Controllers are
supported by the same programs as their older counterparts.
• A new Chapter 7 was added to briefly describe the purpose and
operation of the new Series 5 Emulator software package.
• The Project Engineering Programs section of Chapter 6 was
extended to introduce the new Project Unzip utility and indicate
the Project Builder program can now be used to modify the
Modbus dataset and/or alarm and event definitions of a running
Series 5 Controller. That capability is now mentioned in the
Series 5 Configurator section of Chapter 5 and Series 5 AES
section of Chapter 2 as well.
• The Series 4 Configurator section of Chapter 5 and the TV1
OPC Server Program section of Chapter 2 were revised to indi-
cate that Configurator program can now connect to controllers
via the Series 4 OPC Server program.
• A statement was added to the Series 5 Controller Engineering
section of Chapter 6 to indicate that TrainTools version 6.1 is
needed for Vanguard Controllers using the new MPU-1002.
• A statement was added to the Series 5 Configurator section of
Chapter 5 to indicate that program can now save diagnostic
information to a zip file.
• The Distributed Communications Options section of Appendix D
was revised to explicitly illustrate and describe those options.

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 185

UM5500 TrainTools Product Overview and Setupmanual

Index
A Accounts Database . . . . . . . . . . . . . . . . . . . . . . . . . 103, 149–153
ActiveX Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . 28, 49, 50–55
Administrator Program. . . . . . . . . . . . . . . . . . . . . . . . . . . 149–153
Adobe Reader Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
AE Definitions, Series 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 68
Alarm Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Alarms ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Alarms and Events
Modbus Slaves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Script Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Series 3 Controllers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Series 4 Controllers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Series 5 Controllers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Third-Party OPC Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
TrainTools AE Protocol and Server Programs . . . . . . . . . . . 31
via Web AEService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
see also: Platform Communication Servers
Application Editor and Generator . . . . . . . . . . . . . . . . . . . . 76, 80
Archival Communication Program (ArcCom). . . . . . . . . . . . . . . 47
Archival Data Manager (ADaM). . . . . . . . . . . . . . . . . . . . . . 33, 46
Archival Data Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Archival Data Utilities Package . . . . . . . . . . . . . . . . 21, 49, 60–62
Archival Data Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Archival Database
Critical Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Disk Space Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Tagged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Archive Exporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 62
Archive Reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 61, 76
Archive Server Package . . . . . . . . . . . . . . . . . . . . . . . . 20, 45–48
Archive Viewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 62

May 2007 UM5500 (5.0.0)


186 Index

C CCC Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Client-Server Communication . . . . . . . . . . . . . . . . . . . . . . . 26–33
Command Arguments
ArcCom Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Archive Reporter Program . . . . . . . . . . . . . . . . . . . . . . . . . 138
Modbus Slave Program . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Reporter Agent Program . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Series 5 Operator Panel Program . . . . . . . . . . . . . . . . . . . 140
TrainView Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Communication Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Communication Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . 26–33
Component Object Model (COM) . . . . . . . . . . . . . . . . . . . . . . . 28
Compressor Operating Maps . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Computer Names and Addresses. . . . . . . . . . . . . . 143, 158–162
Configurator Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68–70
Controller Communication Limits . . . . . . . . . . . . . . . . . . . . . . 163
Controller Emulation, Series 5 . . . . . . . . . . . . . . . . . . . . . . 81–84
Controller Programming, Series 5. . . . . . . . . . . . . . . . . . . . . . . 80
Critical Event Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
D Data Archiving and Reporting — see: Archival Database
Data Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117, 119
Default Gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Default Projects Folder . . . . . . . . . . . . . . . . . . . . . . 119, 136, 164
Desktop Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Disk Defragmentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Distributed Communication Options . . . . . . . . . . . . . . . . . . . . 156
Distributed Component Object Model (DCOM). . . . . . . . 156, 166
Distribution CD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95–97
Domains, Windows Networks . . . . . . . . . . . . . . . . . . . . . 142–143
Duplex Supervisor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Dynamic Groups, TrainView Program . . . . . . . . . . . . . . . . . . . 58
Dynamic InterApplication Communication (DIAC) . . . . . . . . . . 44
Dynamic Objects, TrainView Program . . . . . . . . . . . . . . . . 49, 57

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 187

E Emulation, Series 5 Controllers . . . . . . . . . . . . . . . . . . . . . . 81–84


Events — see: Alarms and Events
Events ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Events Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Extended Diagnostics, Series 5. . . . . . . . . . . . . . . . . . . . . . . . . 68
F Fast Recorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Favorites Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Field Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 67–73
File Formats
Archival Data Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Exported Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Firewall Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
G Gas Turbine Operating Maps . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Gateway PCs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Generic Controller AE Server . . . . . . . . . . . . . . . . . . . . . . . . . . 40
I IEC-61131 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Installation
Adding and Removing Packages . . . . . . . . . . . . . . . . . . . . 107
Adobe Reader Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Internet Explorer 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Internet Installation Services . . . . . . . . . . . . . . . . . . . . . . . . 114
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Python Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Selected TrainTools Packages . . . . . . . . . . . . . . . . . . . . . . 106
Windows 2000 Service Pack 4 . . . . . . . . . . . . . . . . . . . . . . 111
Internet Explorer
Favorites Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Service Pack 1 for IE 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
TrainView Web Plug-In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Internet Information Services, Installing . . . . . . . . . . . . . . . . . 114
IOView ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
IP Addresses and Subnets . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
J Java Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

K Knob Dynamic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

L License Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19, 106, 120


Logic Control Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

May 2007 UM5500 (5.0.0)


188 Index

M Machine Control Application Programming. . . . . . . . . . . . . . . . 80


Maintenance, TrainTools Workstations. . . . . . . . . . 109, 119–123
Map ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54–55
Master-Slave Communication. . . . . . . . . . . . . . . . . . . . . . . . . . 26
Microsoft .NET Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Modbus Data, Series 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Modbus Master OPC Server. . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Modbus Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Modbus Slave OPC Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
MPU-1002, Requires Project Builder 6.1 . . . . . . . . . . . . . . . . . 79
N Network Communication Options . . . . . . . . . . . . . . . . . . . . . . 156
Network Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142–143
Network Name Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Networked Workstations — see: Workstation Networks
Numeric Dynamic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
O OLE for Process Control (OPC) . . . . . . . . . . . . . . . . . . . . . . . . 30
OPC Access to Controller Data . . . . . . . . . . . . . . . . . . . . . . . 154
OPC Online Data Access
Standard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
via Web DAService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
OpcDiac Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Operator Account, Windows — see: Windows Security
P Passwords — see: TrainTools Security, Windows Security
Path Environment Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Platform Communication Servers
Generic Controller AE Server . . . . . . . . . . . . . . . . . . . . . . . . 40
Modbus OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Modbus Slave OPC Client . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Program List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Script Engine Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Series 3 OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Series 4 OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Series 5 OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
TV1 OPC Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Platform Communication Servers Package . . . . . . . . . 20, 34–44

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 189

Platform Engineering Utilities


Alarm Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Configurator Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68–70
Duplex Supervisor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Fast Recorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Platform Engineering Utilities Package . . . . . . . . . . . . . 23, 67–73
Programs Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Project Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61, 76, 80
Project Data Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Project Database
Creating and Modifying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Sharing Among Networked Workstations . . . . . . . . . . . . . . 164
Project Engineering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Archival Data Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Series 5 Control Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
TrainTools HMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
TrainTools Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Project Engineering Utilities Package . . . . . . . . . . . . . . 24, 75–80
Project Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Python Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
R Removing Installed Programs . . . . . . . . . . . . . . . . . . . . . . . . . 109
Repairing Software Installation . . . . . . . . . . . . . . . . . . . . . . . . 109
Reporter Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Revision Numbers, TrainTools Components. . . . . . . . . . . . . . 121
Run Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
S Script Engine
Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
OPC Online Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Security — see: TrainTools Security, Windows Security
Sequence Dynamic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Serial Communication Interface (SCI) . . . . . . . . . . . . . . . . . 44, 69
Series 3 OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Series 3 Plus Configurator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Series 4 Configurator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44, 69
Series 4 Controller Alarms and Events . . . . . . . . . . . . . . . . . . . 42
Series 4 OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 37, 44, 69

May 2007 UM5500 (5.0.0)


190 Index

Series 5 AE Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Series 5 Configurator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Series 5 Control System Engineering . . . . . . . . . . . . . . . . . . . . 79
Series 5 Control System Time Synchronization . . . . . . . . . . . 175
Series 5 Controller Emulation . . . . . . . . . . . . . . . . . . . . . . . 81–84
Series 5 Controller Programming . . . . . . . . . . . . . . . . . . . . . . . 80
Series 5 Duplex Supervisor . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Series 5 OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Service Packs
Internet Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Windows 2000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Windows XP SP2 Configuration . . . . . . . . . . . . . . . . . . . . . 171
Setup Utilities
CCC Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Total Train Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
TrainTools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99–109
Shortcut Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Site Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Software Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18–24
Start Menu
All Programs Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Classic Start Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Customization. . . . . . . . . . . . . . . . . . . . . . . . . . . 129, 131–133
Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
TrainTools Program Group. . . . . . . . . . . . . . . . . . . . . . . . . 130
Windows XP Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Subnets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Switcher Dynamic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
System Engineering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
T TCP/IP Addresses and Subnets . . . . . . . . . . . . . . . . . . . . . . . 160
Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Toolbar Customization . . . . . . . . . . . . . . . . . . . . . . . . . . 134–135
Total Train Control Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
TrainTools Information Utility . . . . . . . . . . . . . . . . . . . . . 119–121
TrainTools Security
Administrator Program . . . . . . . . . . . . . . . . . . . . . . . . 149–153
Server Data Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

May 2007 UM5500 (5.0.0)


TrainTools Product Overview and Setup 191

TrainTools Software
Automatic Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Command Arguments . . . . . . . . . . . . . . . . . . . . . . . . . 137–140
Default Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
HMI Workstation Development . . . . . . . . . . . . . . . . . . . . . . . 78
License Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119–123
Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18–24
Removing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Repairing Software Installation . . . . . . . . . . . . . . . . . . . . . . 109
Revision Numbers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Setup Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99–109
Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
TrainTools Web Package . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 63
TrainView Libraries
Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Using TV Objects From. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
TrainView Package . . . . . . . . . . . . . . . . . . . . . . . . . 21, 49, 56–59
TrainView Program . . . . . . . . . . . . . . . . . . . . . . 49, 56–58, 62, 76
TrainView Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 66
Trends ActiveX Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Trends Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
TV Pictures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
TV1 OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
U Upgrading Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
User Accounts — see: TrainTools Security, Windows Security
V Version Scanner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119–121
Viewing Archival Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Visual Basic Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
W Web AEService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Web ARCService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Web Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 63
Web DAService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63, 156
WebG_AES Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
WebG_ARC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
WebG_OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

May 2007 UM5500 (5.0.0)


192 Index

WebGateway Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
WebServices Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Windows OS
Automatically Starting Programs . . . . . . . . . . . . . . . . . . . . 130
Computer Addresses . . . . . . . . . . . . . . . . . . . . . . . . . 158–162
Computer Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Customizing Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Customizing User Interface . . . . . . . . . . . . . . . . . . . . 125–140
DCOM Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 166–171
Desktop Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134–135
Documents and Settings Folders . . . . . . . . . . . . . . . . . . . . 129
Drive Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Favorites Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Firewalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Installing Internet Information Services . . . . . . . . . . . . . . . 114
Installing Windows 2000 Service Pack 4 . . . . . . . . . . . . . . 111
Local User Accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Path Environment Variable. . . . . . . . . . . . . . . . . . . . . . . . . 127
Power Management Settings . . . . . . . . . . . . . . . . . . . . . . . 115
Program Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Run Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Share Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Start Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131–133
Windows Security
Accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
NTFS Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Workgroups, Windows . . . . . . . . . . . . . . . . . . . . . . . . . . 142–143
Workstation Development. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Workstation Maintenance . . . . . . . . . . . . . . . . . . . . . . . . 119–123
Workstation Networks
Computer Addresses . . . . . . . . . . . . . . . . . . . . . . . . . 158–162
Computer Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Controller Communication Limits . . . . . . . . . . . . . . . . . . . . 163
DCOM Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 166–171
Firewall Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Network Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Sharing Project Database. . . . . . . . . . . . . . . . . . . . . . . . . . 164
Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Workstation Operator Interface Software (WOIS). . . . . . . . . . . 44
Workstation Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95–118

May 2007 UM5500 (5.0.0)


FM73

U Documentation Feedback Form


Publication Title: TrainTools Product Overview and Setup Guide
Publication No.: UM5500 (5.0.0) Publication Date: May 2007

If you have questions or comments concerning the information provided in this user manual or
in any of our technical documents please contact CCC’s Technical Documentation Department:
E-mail: [email protected]

Which Series of Controllers do you have, and are you using our TrainTools software?

Series 3+/3++ Series 4 Series 5 TrainTools Guardian Vantage Air Miser


❒ ❒ ❒ ❒ ❒ ❒ ❒

Some additional information we would like to know: Printed Online


1. How do you prefer to access our documentation? ❒ ❒

Yes No
2. Did you find what you were looking for? ❒ ❒

3. Do you require system installation information? ❒ ❒

4. Do you require system maintenance information? ❒ ❒

5. Do you require system configuration information? ❒ ❒

6. Do you require system operation information? ❒ ❒

Please provide the following information if you wish to be contacted:


Company:
Name:
Email:

You may also fax your questions or comments to:


Fax: (515) 334-2500
ATTN: Manager, Technical Documentation
Comments:

May 2006 FM73 (3.0)


a NO POSTAGE
NECESSARY
IF MAILED
IN THE
UNITED STATES

BUSINESS REPLY MAIL


FIRST CLASS MAIL PERMIT NO. 7515 DES MOINES, IOWA

POSTAGE WILL BE PAID BY ADDRESSEE

COMPRESSOR CONTROLS CORPORATION


Technical Documentation Department
4725 121st Street
Des Moines, Iowa 50323-9906

Fold Along Dotted Line

Please Fasten Here With Tape — Do Not Staple

You might also like