GE Energy

ToolboxST* User Guide

for WorkstationST*
GEH-6706G

g
These instructions do not purport to cover all details or variations in equipment, nor to
provide for every possible contingency to be met during installation, operation, and
maintenance. The information is supplied for informational purposes only, and GE makes
no warranty as to the accuracy of the information included herein. Changes,
modifications and/or improvements to equipment and specifications are made
periodically and these changes may or may not be reflected herein. It is understood that
GE may make changes, modifications, or improvements to the equipment referenced
herein or to the document itself at any time. This document is intended for trained
personnel familiar with the GE products referenced herein.
GE may have patents or pending patent applications covering subject matter in this
document. The furnishing of this document does not provide any license whatsoever to
any of these patents.

This document contains proprietary information of General Electric Company, USA and
is furnished to its customer solely to assist that customer in the installation, testing,
operation, and/or maintenance of the equipment described. This document shall not be
reproduced in whole or in part nor shall its contents be disclosed to any third party
without the written approval of GE Energy.
GE provides the following document and the information included therein as is and
without warranty of any kind, expressed or implied, including but not limited to any
implied statutory warranty of merchantability or fitness for particular purpose.

If further assistance or technical information is desired, contact the nearest GE Sales or

Service Office, or an authorized GE Sales Representative.

© 2007 - 2009 General Electric Company, USA. All rights reserved.

Revised: 090415
Issued: 070511

* Trademark of General Electric Company

CIMPLICITY is a registered trademark of GE Fanuc Automation North America, Inc.
CompactFlash is a trademark of Sandisk Corporation.
Modbus is a registered trademark of Schneider Automation.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
OPC is a registered trademark of The OPC Foundation..
 g
To:

Reader Comments GE Energy

Documentation Design, Rm. 293
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA
Fax: 1-540-387-8651
(GE Internal DC 8-278-8651)

We welcome comments and suggestions to make this publication more useful.

Your Name Today’s Date If needed, how can we contact you?

Fax No.
Your Company’s Name and Address Job Site
Phone No.
GE Requisition No.
E-mail
Your Job Function / How You Use This Publication Publication No.
Address

Publication Issue/Revision Date

General Rating
Excellent Good Fair Poor Additional Comments
Contents { { { { ____________________________________________________________
Organization { { { { ____________________________________________________________
Technical Accuracy { { { { ____________________________________________________________
Clarity { { { { ____________________________________________________________
Completeness { { { { ____________________________________________________________
Drawings / Figures { { { { ____________________________________________________________
Tables { { { { ____________________________________________________________
Referencing { { { { ____________________________________________________________
Readability { { { { ____________________________________________________________

Specific Suggestions (Corrections, information that could be expanded on, and such.)
Page No. Comments
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________
_____ _________________________________________________________________________________

Other Comments (What you like, what could be added, how to improve, and such.) ________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________
__________________________________________________________________________________________

Overall grade (Compared to publications from other manufacturers of similar products, how do you rate this publication?)
{ Superior { Comparable { Inferior { Do not know Comment ____________________________________________

Detach and fax or mail to the address noted above.

........................................................................ Fold here and close with staple or tape ..........................................................................................

____________________________ Place
stamp
____________________________ here.

____________________________

GE Energy
Documentation Design, Rm. 293
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA

.......................................................................................... Fold here first ........................................................................................................

Safety Symbol Legend

Indicates a procedure, condition, or statement that, if not

strictly observed, could result in personal injury or death.

Indicates a procedure, condition, or statement that, if not

strictly observed, could result in damage to or destruction of
equipment.

Indicates a procedure, condition, or statement that should be

strictly followed in order to optimize these applications.

Note Indicates an essential or important procedure, condition, or statement.

This equipment contains a potential hazard of electric shock
or burn. Only personnel who are adequately trained and
thoroughly familiar with the equipment and the instructions
should install, operate, or maintain this equipment.

Isolation of test equipment from the equipment under test

presents potential electrical hazards. If the test equipment
cannot be grounded to the equipment under test, the test
equipment’s case must be shielded to prevent contact by
personnel.

To minimize hazard of electrical shock or burn, approved

grounding practices and procedures must be strictly followed.

To prevent personal injury or equipment damage caused by

equipment malfunction, only adequately trained personnel
should modify any programmable machine.
 Contents

Chapter 1 About the ToolboxST Application 1-1

System Requirements ................................................................................................................................1-1
Installation.................................................................................................................................................1-2
Command Line Arguments .......................................................................................................................1-5
Licensing .................................................................................................................................................1-10
Installing the UPD........................................................................................................................1-10
Reinstalling UPD .........................................................................................................................1-11
Acronyms and Abbreviations ..................................................................................................................1-11

Chapter 2 System Configuration 2-1

Opening and Creating Systems .................................................................................................................2-2
Components and Tools...................................................................................................................2-4
System Editor Status ......................................................................................................................2-6
Configuring External Devices ...................................................................................................................2-8
Saving Systems .........................................................................................................................................2-8
Configuration Files....................................................................................................................................2-9
Folder Structure..............................................................................................................................2-9
File Formats .................................................................................................................................2-10
System Options ............................................................................................................................2-11
System Editor Menus ..............................................................................................................................2-13
System Information Editor ......................................................................................................................2-14
Alarm Classes ..............................................................................................................................2-15
Diagnostic Translations................................................................................................................2-17
Sound Options..............................................................................................................................2-24
Plant Areas ...................................................................................................................................2-26
Format Specifications...................................................................................................................2-27
Measurement Systems..................................................................................................................2-29
HMI Resources ............................................................................................................................2-29
HMI Screens ................................................................................................................................2-30
System Database (SDB) ..........................................................................................................................2-43
Master File ..............................................................................................................................................2-44
EGD Configuration Server......................................................................................................................2-45
Working Online with the EGD Configuration Server..................................................................2-46
ToolboxST/EGD Configuration Server Interaction .....................................................................2-46
Viewing Differences ....................................................................................................................2-47
Configuring an External EGD Device .........................................................................................2-49
Starting ToolboxST from an Existing System Configuration .................................................................2-50
SecurityST...............................................................................................................................................2-51
Configuring SecurityST Logon....................................................................................................2-52
Displaying Current User ..............................................................................................................2-53
Logging On ..................................................................................................................................2-54
Auto Logging Off.........................................................................................................................2-56
Logging Off .................................................................................................................................2-56

GEH-6706G ToolboxST Contents • i

Chapter 3 WorkstationST Component Editor 3-1
Creation Wizard ........................................................................................................................................3-1
Summary View..........................................................................................................................................3-4
Property Editor ..........................................................................................................................................3-5
Component InfoView ................................................................................................................................3-6
Log Tab ..........................................................................................................................................3-7
Data Grids..................................................................................................................................................3-8
Editing Data ...................................................................................................................................3-8
Organizing Columns ......................................................................................................................3-9
Copying and Moving Data ...........................................................................................................3-10
WorkstationST Status Monitor................................................................................................................3-11
Status Monitor Shortcut Menu .....................................................................................................3-12
Security....................................................................................................................................................3-19
Passwords.....................................................................................................................................3-19
Password Caching ........................................................................................................................3-20
Viewing Protection Status ............................................................................................................3-21
Protected Objects .........................................................................................................................3-21
WorkstationST Menus.............................................................................................................................3-22
WorkstationST Alarm Viewer......................................................................................................3-23
General Tab .............................................................................................................................................3-24
Consumed Devices.......................................................................................................................3-26
Features ........................................................................................................................................3-27
Timecard ......................................................................................................................................3-28
Configuring NTP..........................................................................................................................3-29
Scheduled Tasks...........................................................................................................................3-30
Network Adapters ........................................................................................................................3-31
On Site Monitor............................................................................................................................3-32
Network Monitor Tab..............................................................................................................................3-34
Configuration ...............................................................................................................................3-35
Network Switches ........................................................................................................................3-37
Network Status Display................................................................................................................3-39
Alarms Tab ..............................................................................................................................................3-43
Configuring the Alarms Tab.........................................................................................................3-43
Alarm Scanner..............................................................................................................................3-45
External OPC AE Servers ............................................................................................................3-46
HMI Config Tab ......................................................................................................................................3-48
Adding an HMI Feature ...............................................................................................................3-49
HMI Configuration.......................................................................................................................3-50
Global Parameters ........................................................................................................................3-51
HMI Screens.................................................................................................................................3-53
OPC DA Server Tab................................................................................................................................3-64
Configuring the OPC DA Server Tab ..........................................................................................3-65
Test OPC Client ...........................................................................................................................3-67
Live Data.csv File Interface .........................................................................................................3-70
Redundant EGD Produced Pages .................................................................................................3-73
Determining Produced Page Health .............................................................................................3-74
OPC AE Server Tab ................................................................................................................................3-77
Routing.........................................................................................................................................3-78
Server Attributes ..........................................................................................................................3-78
Variable Translations ...................................................................................................................3-79
State Translations .........................................................................................................................3-79
Configuring the OPC AE Server ..................................................................................................3-80
Data Update Rates........................................................................................................................3-83
Recorder Tab ...........................................................................................................................................3-84
Collections....................................................................................................................................3-85
Adding a Collection .....................................................................................................................3-85
Live Data......................................................................................................................................3-86
Trip Log .......................................................................................................................................3-89
Capture Buffer..............................................................................................................................3-90
Deleting a Collection....................................................................................................................3-91

ii • Contents GEH-6706G ToolboxST

 Adding a Variable ........................................................................................................................3-91
Deleting a Variable ......................................................................................................................3-92
Refreshing a Collection................................................................................................................3-93
Modbus Tab.............................................................................................................................................3-93
Historian Tab...........................................................................................................................................3-93
Ethernet Global Data (EGD) Tab ............................................................................................................3-93
EGD Configuration ......................................................................................................................3-94
Produced Pages ............................................................................................................................3-94
Editing Produced Pages................................................................................................................3-95
Page Compression........................................................................................................................3-97
Variables ......................................................................................................................................3-97
Editing Exchange Signatures and Configuration Time ................................................................3-99
Referenced Devices....................................................................................................................3-101
EGD Diagnostics........................................................................................................................3-102
EGD Packet Logging .................................................................................................................3-103
EGD Configuration Server Reports ...........................................................................................3-107
Global Variables ........................................................................................................................3-108
Watch Windows ....................................................................................................................................3-109
Adding a Variable ......................................................................................................................3-113
Managing Variables ...................................................................................................................3-117
Forcing Live Values...................................................................................................................3-117
Reconciling Constant Differences..............................................................................................3-118
Drag-and-Drop ...........................................................................................................................3-118
Importing and Exporting ............................................................................................................3-118

Chapter 4 Working Online With WorkstationST 4-1

Connecting to a WorkstationST ................................................................................................................4-1
Status Tab..................................................................................................................................................4-2
Downloading to WorkstationST................................................................................................................4-2
WorkstationST Initial Setup...........................................................................................................4-2
Download Wizard ..........................................................................................................................4-3

Chapter 5 Finder 5-1

Find Methods.............................................................................................................................................5-2
Replace Options ........................................................................................................................................5-4

Chapter 6 Trender 6-1

Accessing a Trender Window ...................................................................................................................6-1
Trender Window Features .........................................................................................................................6-2
Trender Toolbar .............................................................................................................................6-3
Data Toolbar ..................................................................................................................................6-3
Working in Trender ...................................................................................................................................6-3
Acquiring Data...............................................................................................................................6-3
Adding Traces ................................................................................................................................6-3
Live Trends ....................................................................................................................................6-7
Capture Buffer Trends....................................................................................................................6-7
Static File Trends ...........................................................................................................................6-8
Obtaining Data ...............................................................................................................................6-9
Trender Concepts ....................................................................................................................................6-10
Chapters .......................................................................................................................................6-10
Cursors .........................................................................................................................................6-10
Value ScreenTips .........................................................................................................................6-11
Events...........................................................................................................................................6-11
Working With Trender Data....................................................................................................................6-12
Graph View Options ....................................................................................................................6-12
Grid Lines ....................................................................................................................................6-12

GEH-6706G ToolboxST Contents • iii

 Sample Markers ...........................................................................................................................6-13
Time Axis.....................................................................................................................................6-14
Traces ...........................................................................................................................................6-14
Auto-Range Trace ........................................................................................................................6-14
Manual Range Adjustment...........................................................................................................6-15
Trace Colors .................................................................................................................................6-15
Hiding Traces ...............................................................................................................................6-15
Statistical Calculations .................................................................................................................6-16
Exchanging Trender Data........................................................................................................................6-17
Exporting to a File........................................................................................................................6-17
Printing Graphs ............................................................................................................................6-17
Spectral Analysis .....................................................................................................................................6-18
FFT Options .................................................................................................................................6-20

Chapter 7 EGD Editor for External Devices 7-1

Network Adapters......................................................................................................................................7-1
EGD Configuration ...................................................................................................................................7-3
Produced Pages..........................................................................................................................................7-3
Editing Produced Pages..................................................................................................................7-4
Page Compression .....................................................................................................................................7-5
Variables....................................................................................................................................................7-6
Editing Exchange Signatures and Configuration Time .............................................................................7-7
Referenced Devices ...................................................................................................................................7-8
Implementation Profile..............................................................................................................................7-9
Viewing Live Data Values ......................................................................................................................7-11
EGD Diagnostics..........................................................................................................................7-12
EGD Configuration Server Tab...............................................................................................................7-13
External Device Menus ...........................................................................................................................7-14

Chapter 8 Configuration Management System (CMS) 8-1

Installing the CMS Server .........................................................................................................................8-3
Creating Windows User Accounts ............................................................................................................8-5
Configuring the CMS Server.....................................................................................................................8-9
Accessing the Administrator Tool................................................................................................8-10
Working Folder .......................................................................................................................................8-12
Repository Working Folder..........................................................................................................8-13
System Working Folder ...............................................................................................................8-14
Add System / System Working Folder.........................................................................................8-15
Recommendations ...................................................................................................................................8-16
CMS Stand-alone Client..........................................................................................................................8-17
Opening the CMS Stand-alone Client ..........................................................................................8-18
Adding a System to a Repository .................................................................................................8-19
Getting the Latest Version............................................................................................................8-20
CMS Stand-alone Client Menus...................................................................................................8-21
CMS Integrated Client.............................................................................................................................8-22
Opening the CMS Integrated Client .............................................................................................8-24
CMS Menu Items .........................................................................................................................8-27
Troubleshooting.......................................................................................................................................8-28

Glossary of Terms 9-1

Index 10-1

iv • Contents GEH-6706G ToolboxST

 CHAPTER 1

Chapter 1 About the ToolboxST

Application

The ControlST* CD includes the ToolboxST* application and support packages for
the various components. Before you install the software:
®
• It is recommended that you exit all Windows programs.
• All products are installed under a common folder on your hard disk. You can
define this location the first time you install the CD, but any subsequent releases
will be installed to the previously defined location.
• No license key is required to install this product, but to run the ToolboxST
application after installation, a valid hardware key (dongle) plugged into any
Universal Serial Bus (USB) port is required. Refer to the section, Licensing.

System Requirements
The following is the recommended hardware and operating system requirements
needed to run the ToolboxST application.
Recommended
CPU 2.8 GHz Pentium (or faster)
OS Windows® XP Professional
Memory 3 GB RAM (or more)
HD 40 GB (or more)
Video 1280 x 1024 x Truecolor (24 million or better)
Drive DVD
Network Ethernet 10/100 mb
USB Two available USB Ports

Note Windows 2000 Professional is supported for legacy systems only. Windows
Server 2003 is supported using a single user configuration. Windows 64-bit
Operating Systems are not supported.

For assistance, contact the nearest GE Sales or Service office, or an authorized GE

sales representative.

GEH-6706G ToolboxST Chapter 1 About the ToolboxST Application • 1-1

Installation
To install the software

1 Place the ControlST* CD in the CD-ROM drive. The installation starts

automatically. The Setup-GE ControlST dialog box displays.

Note If the installation does not start automatically, use Windows Explorer to
navigate to your CD-ROM drive and run setup.exe. The Alarm Viewer is part of the
GE WorkstationST option.

1-2 • Chapter 1 About the ToolboxST Application GEH-6706G ToolboxST

 If you are upgrading from a previous version, and you select GE
HMI Viewer Tools, a message displays to let you know that
viewer tools are already installed.
The GE CMS Server and GE Hart Message Server options are
typically only installed on one computer at a site. Therefore, if
either of these options is selected, a message displays asking you
to verify that you want to install the option at more than one
location.

Click Next to continue.

2 Select the installation options to install, then click the Install button.
3 The Welcome dialog box displays. Click Next. The License Agreement
dialog box displays.
4 To continue the installation, you must accept this agreement. Select Agree.
5 Click Next. The User Information dialog box displays.
6 Click Next. The Destination Folder dialog box displays. If this is the first
time the ToolboxST application has been installed on this computer, the browse
button allows you to change the default install location (C:\Program
Files\GE Energy\). If this is a subsequent installation, this dialog box
displays where this version of the product will be installed.
7 Click Next. The Select Features dialog box displays and allows you to select
which features to install or not install. All components are installed by default.

Note The WorkstationST Alarm Viewer can be installed by itself for use on a
remote computer.

GEH-6706G ToolboxST Chapter 1 About the ToolboxST Application • 1-3

To select a component
not to be installed, click
the icon next to the
component name, then
select the red X.

8 Once your selections are made, click the Next button until the installation starts.
Click the Finish button when the installation has completed successfully.

1-4 • Chapter 1 About the ToolboxST Application GEH-6706G ToolboxST

 To remove or change the ToolboxST application
From the Start menu, select Settings, Control Panel, then Add/Remove
Programs.

Use the scroll bar to find GE Click Change or Remove to

WorkstationST Package. change or uninstall features
from the installation.

Command Line Arguments

The ToolboxST application contains the following command line arguments:

• EGD Management Tool (EMT) arguments, including

- /EGDAction:ADD /EGDDevice:

- /EGDAction:MODIFY /EGDDevice:

• Go To Variable
• Go To Hardware Diagnostic
• Go To Locator
• -NoSplash
• Archive a ToolboxST System

Note If the ToolboxST application is already opened, starting it again with the
/variable option sends a message to the already running ToolboxST application to
cause it to navigate to the appropriate location.

GEH-6706G ToolboxST Chapter 1 About the ToolboxST Application • 1-5

 EMT

The EMT opens a ToolboxST application and navigates to the EGD configuration
tab of a component. It can also add a device with a specified producer ID.

Note If EMT command line arguments are used, the /Variable, /VariableDevice,
/Hardware Diagnostic, and /Navigate to Locator arguments are ignored.

Standard Action Arguments

/EGDAction:ADD /EGDDevice allows a device to be added.

Note Using /EGDAction:ADD requires no /EGDDevice identifier. The application

started determines the ProducerID(s) and device names(s) to be used.

/EGDAction:MODIFY /EGDDevice:<producer ID> allows the device-assigned

Producer ID to be modified.

/EGDCollection:<collection name> is defined for tools that can manage collections

of device configurations. Collection names are defined in the GuiDevice.xml file.

EMT Argument Rules

The following rules apply to EMT arguments:

• The /EGDAction must be the first argument, followed by the /EGDDevice

argument.
• Only one set of //EGDAction and /EGDDevice pairs should be defined.
The ProducerID value must be represented as a four-byte unsigned integer. An IP
address in dotted-quad format must be converted to the unsigned decimal equivalent
before it can be used in the argument (for example: the IP address 1.2.3.4 converts to
the value 67305985).

To provide consistency, a common set of command arguments are defined for each
application. The standard format is

/<keyword>:<value>

where

/ (slash) is a required delimiter start of an argument.

<keyword> defines the operation or action (the <, > are not used).

: (colon) is a required delimiter that separates the keyword and value.

<value> defines the value to be used in the operation or action (the <, > are not
used).

1-6 • Chapter 1 About the ToolboxST Application GEH-6706G ToolboxST

 Formatting Command Line Arguments

The following rules apply to all command line arguments:

• Process keywords, ignoring case.

• Process values, ignoring case.
• Do not use spaces around colons (:) and after slashes (/).
• A space is required between keyword-value pairs (Example: after MODIFY and
before /EGDDevice).
• The /EGDAction must be the first argument, followed by the /EGDDevice
argument.
• Define only one set of //EGDAction and /EGDDevice pairs.

Go To Variable

/Variable:<variableName> [/VariableDevice:<deviceName>] searches a

ToolboxST application for the first write occurrence of the specified variable. If
never written, the first read-only location is used. If the variable is not found, a
message box displays.

If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST application is opened.

Note If the EMT command line arguments are used, the /Variable and
/VariableDevice arguments are ignored.

Opening a ToolboxST System

If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST application is opened.

Opening a ToolboxST Component and Navigating to a Variable

The format for ToolboxST variable names is

<deviceName>.<variableName>

The search for the variable uses the deviceName component of the system. The
/VariableDevice keyword can also be used to specify a particular device to search.
This is useful for third-party interfaces where you may want to control the device
that is searched (see the third example below). A message displays if nothing is
found in the component.

Examples

ToolboxST /Variable: G1.Var - the G1 component of the most recently loaded

ToolboxST system will be searched.

ToolboxST c:\site\mySystem\mySystem.tcw /Variable: G1.Var - the G1 component of

the c:\site\mySystem\MySystem.tcw system will be searched.

ToolboxST /Variable:ext1.myPermissive /VariableDevice: G2 - the G2 component of

the most recently loaded ToolboxST system will be searched. In this example, G2
references an external EGD device variable. Use the /VariableDevice option to open
the G2 component.

GEH-6706G ToolboxST Chapter 1 About the ToolboxST Application • 1-7

 Go To Hardware Diagnostic

/HardwareDiagnostic:<devName> [.HardwareGroup] - navigates to either the

Device Diagnostics window or the Hardware Module Group.

If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST system is opened.

Examples

/HardwareDiagnostic:Marky

This causes the last opened system to be opened, the Marky controller to be opened,
and the Device Diagnostic window to display (View/Diagnostics/Controller
Diagnostics item).

/HardwareDiagnostic:Marky.23GROUP

This causes the last opened system to be opened, the Marky controller to be opened,
and the Hardware tab 23GROUP hardware group to be selected.

Go To Locator

This argument opens any locator string displayed in the Find Results tab.

/NavigateToLocator:<locator string shown in Find results>

If the first command line argument is a valid path to a .tcw file, that system file is
used for the variable search. Otherwise, the first file in the most recently started
ToolboxST system is opened.

To open a ToolboxST component and navigate to a desired point, use the Finder to
search for a string in a component. Then, from the Find Results tab, select one of the
locator text strings, as shown in the window below.

Copy the selected Find results to the clipboard to

use as a locator command argument. ToolboxST
opens the component, then navigates to the
specified location in the configuration.

1-8 • Chapter 1 About the ToolboxST Application GEH-6706G ToolboxST

 -NoSplash

If the text –NoSplash is contained in an argument, the splash screen does not display
when the ToolboxST application starts.

Archive a ToolboxST System

This argument opens the most recent ToolboxST system, creates a system archive,
then exits the system. Archiving the most recent ToolboxST system can be
overridden by using the first argument to specify the path to the desired system.

The target file name is optional. If not specified, the file name is the ToolboxST
system name plus the creation date and time. If the target file name is a directory, the
archive file is placed in that directory with the file name of the ToolboxST system
name plus the creation date and time.

Examples

ToolboxST /Archive

The most recent system is opened. An archive.zip file, with the opened system name
and date/time, is created. The archive is placed in the parent folder for the
ToolboxST system. If the parent folder cannot be opened, the archive is placed in the
ToolboxST system’s working folder.

ToolboxST c:\MySystem.tcw /archive

The system c:\MySystem.tcw is opened. An archive.zip file, with the opened system
name and date/time, is created. The archive is placed in the parent folder for the
ToolboxST system. If the parent folder cannot be opened, the archive is placed in the
ToolboxST system’s working folder.

ToolboxST c:\MySystem.tcw
/archive:c:\MyArchiveFolder\MySystemArchive.zip

The system c:\MySystem.tcw is opened. An archive.zip file, with the specified

archive name, is created.

ToolboxST c:\MySystem.tcw /archive:c:\MyArchiveFolder

The system c:\MySystem.tcw is opened. An archive.zip file, with the opened system
name and date/time, is created. The archive is placed in the specified folder.

GEH-6706G ToolboxST Chapter 1 About the ToolboxST Application • 1-9

Licensing
To use the GE ControlST system software, you must purchase a license. The license
includes a hardware key, called a Universal Serial Bus (USB) Protection Device
(UPD). Hardware keys are also known as dongles.

USB Protection Device (UPD or dongle)

The UPD must be installed in an empty USB port on your computer. Each UPD is
programmed at the factory with one or more application keys that control access to
software products produced by GE. The ToolboxST application will only function if
your UPD contains a valid ToolboxST application key.

Installing the UPD

It is very important to NOT plug the UPD into your

computer until after you have installed the
ToolboxST application.

To install the UPD

1 Install the ToolboxST application (refer to the section, Installation (on page
2)).
2 Plug the UPD into any empty USB port on your computer.

Only one UPD may be installed at a time. If you have valid licenses for more than
one product, your UPD must contain a valid application key for each product.

Note If you install the UPD before installing the ToolboxST application, the device
may appear to be installed, but it is not associated with the correct drivers.You can
correct this after the application is installed.

1-10 • Chapter 1 About the ToolboxST Application GEH-6706G ToolboxST

 Reinstalling UPD
To reinstall the UPD

1 Save and close any open applications/systems.

2 Unplug the UPD.
3 From Windows, click Start, Settings, and then select Control Panel.
4 From the Control Panel, select Administrative Tools and Computer
Management and use the Device Manager to reinstall the UPD.
5 Reinstall the UPD. Windows should now detect the UPD and reinstall it with the
correct drivers.

To make sure that the UPD is correctly installed and your ToolboxST installation is
correctly licensed, start the application. If the installation is not correct, the following
dialog box displays.

Check that you have

installed the proper UPD
correctly and click Retry.

Acronyms and Abbreviations

EGD Ethernet Global Data
EMT EGD Management Tool
EU Engineering Units
HMI Human-Machine Interface
M&D Maintenance & Diagnostic
NTP Network Time Protocol
NVRAM Non-volatile Random Access Memory
® OLE (Object Linking and Embedding) process control server
OPC
OSM On Site Monitor
SDB System Database
SOE Sequence of Events
TMR Triple modular redundant
UDH Unit Data Highway
UDP User Datagram Protocol
UOSM Universal OnSite Monitor
UPC Universal Product Code
UPD USB Protective Device
USB Universal Serial Bus
xml eXtensible Markup Language

GEH-6706G ToolboxST Chapter 1 About the ToolboxST Application • 1-11

Notes

1-12 • Chapter 1 About the ToolboxST Application GEH-6706G ToolboxST

 CHAPTER 2

Chapter 2 System Configuration

When you start the ToolboxST application, the first window that displays is an
empty System Editor.

Before you can begin using the ToolboxST application, you must create or open a
system. Systems contain components, which are the basic unit representing devices
or tools in the system. A system is stored in its own folder on disk, which contains
both a .tcw configuration file and a collection of supporting files and folders
representing the system components. Refer to the section, Configuration Files .

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-1

Opening and Creating Systems
To create a new system

1 From the File menu, select New System to display the New System dialog
box.

2 Specify the working directory to contain the new system by typing in a path or
by clicking the Browse button. (If you enter a path that does not exist, the
ToolboxST application creates it for you.)
3 Enter a name for the system. Some characters are prohibited; if you enter an
invalid character, a small red exclamation mark displays.
4 Click OK to create the new system. The new system is created, and opens in the
System Editor.

2-2 • Chapter 2 System Configuration GEH-6706G ToolboxST

 To open an existing system

1 From the File menu, select Open System.

2 Locate the .tcw configuration file for the system and select Open. The system
displays in the System Editor.

When a system is open, the System Editor displays overview information about all
configured components in the system. The window consists of three major areas as
displayed.

The Summary View displays a graphic

representation of all system components and
their network connectivity.

The Tree View

displays a list
of all
components in
the system.

The Property
Editor allows
you to edit the
selected
component.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-3

 Components and Tools
Systems consist of multiple components that display in both the Tree View and the
Summary View of the System Editor. The System Editor serves as a navigation tool
to open more detailed Component Editors for editing or viewing. You can double-
click most components in either the Tree View or the Summary View to edit them.

ToolboxST component icons that display in the Tree View are as follows:
Icon Components
System

Group of Components

Mark VIe component

Mark VIeS component

Mark VI component

EX2100ST component

Power Conversion component

WorkstationST

Printer

Library Container

Network

Trender

Watch Windows

LiveView

External Device (not associated

with an application)

Network Switch

Network Time Server

2-4 • Chapter 2 System Configuration GEH-6706G ToolboxST

 You can add components to the root component of a system (represented by the

icon) or a group (represented by a icon). Some components display a

wizard or dialog box that prompts you for additional information when you add them
to the system.

Grouping Components

The ToolboxST application provides a special component called group to help you
organize system components. Groups are similar to file folders in that they can
contain one or more other components (including additional groups). You can use
groups to create any organizational system that you like, including division by
physical component location and a variety of logical divisions.

Groups

Moving and Copying Components

Components can be moved within a ToolboxST application using a drag-and drop

operation. Drag-and-drop editing is only available if the System Editor is in View By
Group mode, as the components are automatically organized when View By Type
mode is selected. The default drag-and-drop operation for most components is move.
Some components support a secondary drag-and-drop operation (usually copy) that
can be accessed by holding down the CTRL key while dragging.

The cursor changes to one of the following cursors during a drag-and-drop operation
to indicate the predicted outcome of the operation:

• indicates that the item being dragged cannot be dropped at the location
currently beneath the cursor.

• indicates that the item being dragged will be moved to the location beneath
the cursor.

• indicates that the item being dragged will be copied and the copy will be
placed at the location beneath the cursor
Most components can be moved and copied in the Tree View, with a few exceptions:

• Library Containers cannot be contained inside groups, so they can only be

copied to the system item and never moved.
• When a group is copied, a new group is created. The contents of the old group
remain in place and are not copied to the new group.
• No drag-and-drop operations are supported for networks.

Tip You can import components and Library Containers from either another copy
of the ToolboxST application or from the Windows file system using drag-and-drop
operations. (To import from the file system, drag the Device.xml or Library.xml file
that represents the component.)

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-5

 System Editor Status
When a ToolboxST system goes online, the status for all active components in that
system displays next to the component icon in the Summary View.

2-6 • Chapter 2 System Configuration GEH-6706G ToolboxST

 The following status icons can display.
Icon Status Indicates
Healthy Component Diagnostics – No

NTP Diagnostics – No
EGD Diagnostics – No
I/O Diagnostics – No
Number of Forced Variables – 0
DDR Equality – Equal
Configuration Equality - Equal
Unhealthy NTP Diagnostics – No

EGD Diagnostics – No
I/O Diagnostics – No
Number of Forced Variables – 0
DDR Equality – Equal
Configuration Equality – major
difference
Warning NTP Diagnostics – Yes

EGD Diagnostics – Yes

I/O Diagnostics – Yes
Number of Forced Variables – 1
DDR Equality – Not equal
Configuration Equality – Not equal
Component was added after the
system went online

Logic forcing procedures can result in personal injury or

death, if not strictly followed. Only adequately trained
personnel should modify any programmable machine.
Forcing of control logic for an operating process is strongly
discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly
enforced in conjunction with this procedure.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-7

Configuring External Devices
When you add an External Device to the system, you must configure the component
with information about both the external application and the configuration file
connected to the device. When an External Device is properly configured, the
external application starts and opens the configuration device when the component is
double-clicked in the ToolboxST application.

If the configuration for the external device is stored in a file with a special extension,
you can specify the path to the configuration file and omit the path to the external
application. The ToolboxST application automatically opens the application
associated with the configuration file. In all other cases, you must specify the exact
application to be run for the external device.

To configure an external device

1 From the Tree View, select an External Device to configure. (External

devices that have not been configured are represented by a question mark
icon.)

2 In the Property Editor, select the App Path item. Click the ellipsis button
at the right side of the text field to display the Open dialog box.
3 Locate the application executable file used to configure the device, and then
click Open. The App Path property is updated to reflect the new path.

Optional procedures:

• If the External Device requires a specific configuration file, select the Doc
Path item and provide the location of the file.
• If the External Device application requires switches (provided for the external
application on the command line before the contents of Doc Path), configure the
Switches property.
• If the External Device application requires a specific working directory (which
is the folder assumed when no path is specified), configure the Start Directory
property.
• If the External Device supports Ethernet Global Data (EGD), set the Enable
EGD Editor property to True.
• If the external component does not have a configuration file that is associated
with a particular application, select the App Path item. Click the ellipsis button
to display the Open dialog box.

Saving Systems
When you make changes to a system, the changes are stored in memory. Save your
work to prevent your changes being lost.

In the ToolboxST application, Save commands affect only the data in the current
editor. As such, the Save command in the System Editor only saves changes to the
system itself. If you have made changes in any other component editors (like a
controller or a library container), you must select the Save command in each of those
editors, as well.

To save changes to the current system

From the File menu, select Save System. (Or, click the button on the
toolbar.)

2-8 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Configuration Files
Folder Structure
Each system is saved in its own folder. Inside the main system folder is a set of sub-
folders and configuration files. The folder structure depends on the components in
the currently opened system. A typical system and its associated file structure is as
follows:

System Editor Tree View Windows Explorer Folder View

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-9

 System Folder is the top-level folder that contains all others. It always has the
same name as the system. (In the example for this section, the system folder is
named System1.) Files in the folder include:

• System1.tcw, containing top-level information for each component in the

system.
• FormatSpecifications.xml, containing format specifications that define units and
scaling information for data display.
• SystemDiagram.xml, containing information about the system block diagram
including both the basic diagram structure and additional drawing shapes that
have been added.
Component Folders contain configuration files for each component in the
system. In the example system, the G1 folder corresponds to a controller named G1.
The exact structure of each component folder varies with the type of component, but
all component folders have a Device.xml file that contains basic information about
the component.

Tools Folder contains definitions for all tool components in a system. A folder for
each type of tool is contained inside the tools folder. In the example, the system
contains a Trender window, so a TrendRecorder folder is stored inside the tools
folder. Inside the folders for each tool type are additional folders for each instance of
the tool. Since the example system has one Trender window named Trender1, a
single Trender1 folder is stored inside the TrendRecorder folder.

Library Container Folders are created for each library container in the system. In
the example system, the library container named Libraries is stored in a folder
correspondingly named Libraries. Objects in this folder include:

• Library.xml, containing attributes of the Library Container and a listing of all

libraries.
• _Mylibname.xml, a file created for each library in the Container (where
Mylibname is the name of the library).
• BlockwareDiagrams, a folder containing the diagrams for user blocks defined in
each library.

File Formats
All configuration data for the ToolboxST application is stored in eXtensible Markup
Language (.xml) format.

The .xml files used by the ToolboxST application should NEVER be

modified by ANY other application.

Configuration files can be both compressed and encrypted. If you select the
Compress When Saving option in the System Options dialog box, the configuration
data is stored in a compressed format that is not readable with a text editor but
occupies much less disk space. Some portions of .xml configuration files may be also
stored in encrypted format to prevent unauthorized users from viewing the design of
password-protected system components.

Some controller components offer a Build command that produces files to be

downloaded directly to the controller. These files, which are stored in the Output
folder of a component, are in a binary format, and are not human-readable.

2-10 • Chapter 2 System Configuration GEH-6706G ToolboxST

 System Options
The ToolboxST application provides a variety of settings that change the way
various functions operate. While you can also configure settings from inside the
component that they affect, settings for all available components display when the
Settings dialog box is opened from the System Editor.

To view system options

From the System Editor, select the Options menu, and then select Settings
to display the Settings dialog box.
In the Settings dialog box, categories are listed in the Tree View.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-11

 The System Options category includes options that affect the system as a whole.
It is available in addition to any other component settings that may display in the
Tree View.

Main Font is the font used for most application text.

Build, when set to True, prompts for confirmation before each build.

Developer Mode, when set to True, allows the developer access to the application
on the GE Salem Intranet.

Force Enable UPD, when set to True, makes the UPD a requirement when on the
GE Salem Intranet with privileges.

Auto Backup, when set to True, creates backup copies of configuration files during
the Save command.

Controller Backup Option determines how controller backup files are handled in
the Build and Download commands, as well as the status control.

• Automatic mode creates backup files in a device.zip file during a Build

command, and provides an option to download the device.zip in the Download
Wizard.
• Manual mode does not create a device.zip file so there is no option to download
back-up files from the Download Wizard.
Incremental Build Enabled, if set to True, enables incremental downloads with
controllers that support them.

Load Last System, when set to True, automatically loads the previously loaded
system when the application starts.

Maximum Build Errors is the maximum number of errors to occur before exiting
a Build. For unlimited errors, set to zero.

User Identification is the three-character ID of the user making the changes.

2-12 • Chapter 2 System Configuration GEH-6706G ToolboxST

 System Editor Menus
Menu Command Use to
File New System Create a new system
Open System Open an existing system
Close System Close the current system
Save System Save system-level changes to the current system (does not save component-
level changes)
Save System As Save the current system with a new name or to a new location
Archive System Select system components to be archived
Recent Files List the eight most currently accessed systems
Exit Close the ToolboxST application and all associated component editors

Edit Delete Remove the item currently selected in the Tree View
Insert New Add a new component to the current system
Insert Existing Add an existing component from a folder
Cut Cut the selected item in the Tree View
Copy Copy the selected item in the Tree View
Paste Paste the copied item in the Tree View into the Summary View
System Display the System Information Editor (refer to the section System Information
Information Editor)
Selected Display the Component Editor for the item currently selected in the Tree View
component
View By Type Automatically organize the Tree View by component type
By Group Organize the Tree View by components
Track Synchronize Tree View selections with Summary View selections
Memory Usage Display the currently allocated memory
EGD Diagnostics Access the following EGD diagnostic tools:
EGD Management Tool opens the EGD Management Tool (EMT)
View Online Statistics displays EGD exchange status from the selected
component. Only EGD Class 2 or higher components that respond to EGD
Command Message Protocol (CMP) have this diagnostic window.
WorkstationST Capture Live UDP Packets provides an EGD window only
enabled in a WorkstationST component with an OPC DA server configured.
This allows the WorkstationST runtime to capture up to 10,000 EGD UDP
messages, then upload them for display, printing, and exporting to .csv
format.
EGD Network Load Calculation provides network load calculation to
determine memory usage.
EGD Perform one of the following:
Configuration View Differences opens a configuration view window.
Server Work Offline allows you to work offline.

Network Status Display defined networks in the system

Viewer
System Online Work online
Options Settings Configure system settings (refer to the section System Options)
Window Cascade Arrange open Component Editors in a layered style
Tile Arrange open Component Editors in a grid style

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-13

 Close All Close all open Component Editors

CMS Refer to the section CMS Menu Items.

Help Contents Display the online product documentation
Release Notes Display current information about your ToolboxST software version.
Send Problem Send a problem or suggestion to the ToolboxST team
Report

System Information Editor

The System Information Editor edits alarm classes, format specifications, and other
items available to all components in the system. If access to a System Database
(SDB) is enabled, the contents of the System Information Editor can be stored to the
SDB.

To open the System Information Editor

From the System Editor, select System Information from the Edit menu.
Or,

From the System Editor, double-click the System item in the Tree
View.

2-14 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Alarm Classes
Alarm classes are groups or collections of related alarms that share a common
priority and color scheme.

To edit Alarm Classes

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, select Alarm Classes. A data grid with the existing
Alarm Classes displays in the Summary View.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-15

 The following properties are available in the Property Editor when an Alarm Class is
selected:

Name displays the name of the Alarm Class. Limited to five characters if using an
SDB.

Description displays the Alarm Classes description. Only the first 50 characters are
stored in an SDB.

Priority shows alarm class priority (1 to 99 where 1 is the highest priority).

Ack Foreground Color shows foreground color for an alarm in the

Acknowledged state.

Ack Background Color shows background color for an alarm in the

Acknowledged state.

Alarm Foreground Color displays the foreground color for an alarm in the Alarm
state.

Alarm Background Color displays the background color for an alarm in the
Alarm state.

Blink Background Color displays the background color for the blink state of the
active unacknowledged alarm.

Blink Enabled, if set to True, enables blinking ability.

Blink Foreground Color displays the foreground color for the blink state of the
active unacknowledged alarm.

Normal Foreground Color displays the foreground color for an alarm in the
Normal state.

Normal Background Color displays the background color for an alarm in the
Normal state.

Sound Reference is the sound definition to select when an active alarm displays
in the WorkstationST Alarm Viewer.

2-16 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Diagnostic Translations
The Diagnostic Translations option allows you to display alarm diagnostic text in a
second language.

Note The second Language option must be selected in the System Editor Property
Editor.

To export diagnostics to a .csv file

1 From the System Editor Tree View, double-click the system item. The
System Information Editor displays.

From the Tree View, right-click

Diagnostic Translations, then
select Export Product
Diagnostics….

The Please select a file to Export

the Product Diagnostic
Translations to window displays.

Note The Export Product Diagnostics option creates a .csv file that contains
diagnostics for all I/O packs installed on this computer. The default file name is
All_Product_Diagnostic Translations.csv. It can be opened in Notepad or in an .xml
spreadsheet.

2 From the Tree View, right-click the Diagnostic Translations item to select
the .csv file just created.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-17

 Note Expand the Diagnostic Translations item to display each I/O pack in the
system, as well as packs for Mark VIe and certain diagnostics grouped as Common.
Translations for common diagnostics only need to be entered once.

Diagnostics text can be translated in either the

.csv file or in the System Information Editor.

2-18 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Export These Diagnostics

The Export these Diagnostics….

option exports the translated text
back to the .csv file. This can be
done from either Tree View item.

Note Selecting the Diagnostic Translations item exports all pack items beneath to a
single .csv file. However, if an individual pack is selected, the diagnostics for that
pack only are exported.

Validate Diagnostics

If you are using CMS, perform a Get Latest for all controllers on your computer. The
Validate Diagnostics option verifies the I/O packs attached to a particular system,
then checks to see that a translation has been entered for each I/O pack in the list of
required packs.

Any errors or warnings occurring from the Validation display in the Component
InfoView. Double-click an error or warning to be connected to that diagnostic.

The Validation option applies to all translations entered into a system. Even if you
have Common selected when you start to validate, all translations are validated.
Warnings and errors do not prevent controllers from running the Build and
Download commands, but rather ensure that all second-language diagnostic text
displays correctly at run time. If there is no second-language translation for a
particular diagnostic, the text displays in English. .

Delete Diagnostics

Only I/O packs used on your job need to have translations entered. Unused I/O packs
can be selected from the Tree View and deleted. You have the opportunity to cancel
the Delete command before it’s performed. However, once it’s performed, it cannot
be Undone.

Note This command only deletes these translation records. If a diagnostic occurs
whose translation record was deleted, it still displays in English.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-19

 To add a missing translation to a running system

1 From the Tree View, select a pack, add the translated text in the Second
Language Message Text column, then click Save.
2 Open all controllers that use the I/O pack with the missing translation and
perform a Save command.

Note If the controller configuration in the ToolboxST application is equal to the

configuration running on the controller, the new information is published to the EGD
Config Server. The next time the diagnostic occurs, the translated text displays. If the
configuration and the running controller are not equal, the controller must be
downloaded for the changes to take effect.

2-20 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Displaying Second-Language Diagnostics

Displaying second-language diagnostics can be selected from two different locations.

To display second-language diagnostics

From the
WorkstationST
component Tree
View, select the
General tab and
the General item.

From the Property

Editor, select Use
Second Language.
If you want all other
users of this
WorkstationST to be
able to display a
second language,
select True.

Or

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-21

 From the WorkstationST tray icon, right-
click to display Regional Settings and
select User Second Language.

Note When you select Use Second Language from Regional Settings, that becomes
your permanent default setting, regardless of what is configured in the General tab in
the ToolboxST application.

The WorkstationST Alarm Viewer provides a means to override this setting. For
more information, refer to GHT-200009, How to Configure a Second Language for
the ToolboxST Application and HMIs.

The option Select Active Measurement System allows you to specify either English
or metric measurements. Refer to GHT-200016, How to Configure a Measurement
System for Use by ControlST HMI Applications.

2-22 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Creating a Master WorkstationST

To avoid having diagnostic alarm text stored on every WorkstationST in a system, a

Master WorkstationST can be configured.

To configure a Master WorkstationST

From the System Editor

Property Editor, select
Master Location. From
the drop-down list, select
the WorkstationST to
designate as the master.
Enter the Path to the files.

An example is RootPath\Help\Diagnostics\PAIC\PAICDiags.sp.chm, where

RootPath is the path configured in the System Property Editor. Refer to GEI-100620,
WorkstationST Alarm Viewer, for more information about viewing language options.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-23

 Sound Options
Use the System Information Editor to define sound options that can annunciate
certain sounds within the Alarm Viewer. A specific sound definition is assigned to
an alarm class.

To configure sounds

♦ From the System Editor, select the Edit menu, then select System
Information.

From the Tree View,

select Sounds.
In the Data Grid, enter a
sound Name, for example,
Chimes. Right-click the
Sound Type column, then
select from the drop-down
list (for example, Wave File).

From the Wave File column,

click the ellipsis button to display
a Windows Open screen.

From the Open screen, navigate to

Windows \ Media to select the desired .wav
file. The path displays.

2-24 • Chapter 2 System Configuration GEH-6706G ToolboxST

 To edit sounds
From the System Editor, select the Edit menu, then select System
Information.

From the Tree View, Currently configured sounds

select Sounds . display in the Data Grid .

The following properties are available in the Property Editor when a sound is
selected in the Data Grid.

Delay displays the time lapse between sounds (from 100 to 10,000 ms). The Repeat
Quantity property must be 1 or more.

Duration displays the sound’s duration (from 100 to 10,000 ms).

Frequency displays the sound’s frequency (range is 100 to 500 Hz).

Name is the sound’s name.

Repeat Quantity displays the number of times the sound is repeated.

Sound Type displays the type of sound annunciated. The options are Tone, Wave
File, and Text to Speech.

Wave File, if selected as the Sound Type, displays the name of the Wave File.
When the system information is saved, the wave files are published to the Master
WorkstationST.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-25

 Plant Areas
Plant areas are locations that represent a plant or facility within the control system.
These locations are selected from the Plant Area property of all variables defined in
each system component. One or more variables can use the same location. These
locations are used for filtering the alarms that display in the Alarm Viewer.

To edit plant areas

From the System Editor, select the Edit menu, then select System
Information.

Right- click any plant area to display a

drop- down menu with additional options.

2-26 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Format Specifications
Format specifications control how variables are presented in an HMI. Format
specifications are grouped into sets, which establish a relationship between different
measurement systems for a particular type of data. For example, a Format
Specification Set for temperature could contain two specifications for temperature –
one for degrees Fahrenheit in the U.S. measurement system and one for degrees
Celsius in the International System of Units (commonly referred to as the Metric
system).

The Engineering Min and Max values for both format specifications control the
conversions that take place when a measurement system is selected at an HMI. For
example, if a temperature variable is assigned to the Celsius format specification and
the measurement system in use on the HMI is Metric, no conversion is performed on
the HMI displayed value. If the HMI’s measurement system is changed to U.S., the
value of the variable is converted from Celsius to Fahrenheit using the linear
equation defined by the Engineering Min and Max of the Celsius and Fahrenheit
format specifications. Variables are scaled as follows by the HMI:

(val fs1 − fs1min ) ∗ ( fs 2 max − fs 2 min )

Val fs 2 = + fs 2 min
( fs1max − fs1min )

Val fs 2 : The converted value, in Format Specification 2

Val fs1 : The initial value, in Format Specification 1

fs1max : The engineering max for Format Specification 1

fs 1min : The engineering min for Format Specification 1

fs 2 max : The engineering max for Format Specification 2

fs 2 min : The engineering min for Format Specification 2

Using this formula, a conversion from Celsius to Fahrenheit would be calculated by

the HMI as follows:

(val o c − fs oCmin ) ∗ ( fs oFmax − fs oFmin )

Val o F = + fs o Fmin
( fs Cmax − fs Cmin )
o o

(val o c − 0) ∗ (212 − 32)

Val o F = + 32
(100 − 0)
Within a Format Specification Set, all Engineering Min values must represent the
same physical value and all Engineering Max values must represent the same
physical value.

Note In the previous example, the minimum value for Fahrenheit (32) and the
minimum value for Celsius (0) represent the same temperature, the freezing point of
water.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-27

 To create a Format Specification Set

1 From the System Editor Edit menu, select System Information.

2 In the System Information Editor, right-click the Format Specification
Sets item in the Tree View and select Add Format Specification Set.
3 Enter a name for the new set and click OK.

To add format specifications to a Format Specification Set

1 From the System Editor Edit Menu, select System Information.

2 In the System Information Editor Tree View, click a Format
Specification Set. A grid of format specifications displays in the Summary
View.

The properties from the Click the Name box in the

Summary View also display append row, then enter a new
in the Property Editor for the name to add a new format Click in a grid cell
currently selected row(s). specification. to edit its contents.

2-28 • Chapter 2 System Configuration GEH-6706G ToolboxST

 The following properties are available in the Property Editor when a Format
Specification Set is selected:

Format Spec Set displays the Format Specification Set that contains the selected
format specification.

Precision displays the number of digits to display to the right of the decimal point
(for example, a precision of two displays the fraction 1/3 as .33).

Engineering Max displays the maximum value of the range used for unit
conversions.

Engineering Min displays the minimum value of the range used for unit
conversions.

Units displays the text that identifies the format specification unit.

Measurement System displays the measurement system (for example, Metric or

U.S.) to which the unit belongs. (Refer to the section, Measurement Systems )

Name displays a unique name for the format specification. If the system data is Put
to an SDB, a limit of 12 characters is enforced for the Name.

Measurement Systems
Each format specification is assigned to a measurement system. Within a format set,
which represents a particular type of measurement (like temperature), only one unit
per measurement system can be created. (For example, you could not add both
Celsius and Kelvin within the Metric system as units of temperature.) You can select
the two measurement systems that are stored in the SDB in the System Information
Editor.

To select the measurement systems used by the SDB

1 In the System Information Editor Tree View, select Format

Specification Sets.
2 Click SDB Meas Sys 1 or SDB Meas Sys 2 in the Property Editor, then
select a measurement system from the drop-down list.

HMI Resources
An HMI (Human-Machine Interface) allows you to organize and customize access to
alarms and live data. Variables have an HMI resource property that can be set to one
of the HMI resources defined here. Each resource has a name and an optional
description.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-29

 HMI Screens
HMI screen files are managed from a master location and downloaded to the HMI
WorkstationSTs. These screen files can be managed from either the System Editor or
from any of the HMI WorkstationST components that use them. HMI screen file
management consists of the following functions:

• Adding and deleting screen files to the system (only from the System
Information Editor)
• Editing use of screen files by HMI WorkstationSTs
• Downloading screen files from Master location to HMI WorkstationSTs
• Editing screen files (from the Master location)
To view HMI screen files from the System Information Editor

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, select HMI Screens. HMI WorkstationSTs and HMI
screen files display in the Summary View.

Different views of HMI screen files can be obtained by selecting any one of the
WorkstationST component items in the Tree View.

2-30 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Adding and Deleting HMI Screen Files

To add an HMI screen file to the system

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, right-click the HMI Screens item (or any item under it,
or in the Summary View) and select Add HMI screen file from the short-cut
menu. An Open file window displays.

3 From the Open file window, select the screen file or files you wish to add, then
click Open.
4 The screen file(s) is added to the system and displays in the Summary View.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-31

 To delete an HMI screen file from the system

1 From the Summary View, select the screen file to be deleted.

2 Either right-click the screen file and select Delete or from the toolbar, click the
Delete icon, or from the Edit menu, select Delete.

Archiving Files

A project (or system) can be archived into a zip file from the System Editor,
however, the archive does not retrieve the files stored in the Master location. Also,
when a archived system is unzipped to a specific location, the files in the archive do
not automatically get distributed to the Master location.

When an archive is unzipped, the HMI screen files are located in a subdirectory
relative to the location of the system’s .tcw file. For example, if the system is called
abcSystem, and is stored in C:\Site, the .tcw file is located at
C:\site\acbSystem\abcSystem.tcw. The HMI Screen files are located at
C:\site\abcSystem\HMIScreens. This is the system location of the HMI
screen Files.

To copy files from the system to the Master location or from the
Master location to the System:

1 Open the System Editor. From the Edit menu, select System Information.
2 To copy to the Master location, from the System menu, select Copy Local
to Master.
3 To copy from the Master location to the system, from the System menu,
select Copy Master to Local.

Note If files already exist in the Master location when copying from the system to
the Master location, a warning dialog displays to ask if you wish to overwrite the
existing files.

2-32 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Defining HMI Screen Use

A particular HMI WorkstationST may not require all screen files in the system.
Defining use of specific screens for each WorkstationST can be done from either the
System Information Editor or from the HMI WorkstationST component. When a
screen is added to the system, all HMI WorkstationSTs use that screen by default.

To define the use of HMI screens for a WorkstationST

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, select HMI screen.
3 From the Summary View, select a screen, then in the WorkstationST column
(HMIws1 in the example below), select True to enable HMIws1 to use that
screen or False to disable use.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-33

 When a particular WorkstationST is selected in the Tree View, the Use property can
also be changed from both the Summary View and the Property Editor.

From the Summary

View, the use of a
particular screen
From the Tree View, can be enabled by
select a WorkstationST selecting True.
(for example, HMIws1).

The use of the screen

selected in the
Summary View can
also be enabled in the
Property Editor.

Downloading HMI Screen Files

The HMI screen files are downloaded from the Master location in either the System
Information Editor or a particular HMI WorkstationST component. Downloading
can either occur automatically though a configuration property set for the
WorkstationST component or downloaded manually.

When pre-configured, WorkstationST runtime periodically compares the date of the

Master screen file to the file being used by the HMI project on the WorkstationST.
When an HMI screen file is saved to the Master location, it’s date changes. The
WorkstationST detects the change and automatically copies the new file to the
WorkstationST’s HMI project.

Note If a WorkstationST is configured for automatic download, a manual download

cannot be performed.

2-34 • Chapter 2 System Configuration GEH-6706G ToolboxST

 To download HMI screen files from the Master location to all HMI
WorkstationSTs

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, select HMI screen or HMI WorkstationSTs.
3 From the Summary View, select one or more HMI screen files.
4 From the Summary View, right-click to select Download selected HMI
screens from the short-cut menu.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-35

 To download HMI screen files from the Master location to a single
HMI WorkstationST

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, expand the HMI Workstations item, then select a
WorkstationST component.
3 Select one or more HMI screen files in the Summary View.
4 From the Summary View, right-click to select Download selected HMI
Screens from the short-cut menu.

Displaying HMI Screen File Status

The System Information Editor can display the status of HMI screen files, including
the date and size of the master HMI screen file and the WorkstationST component’s
screen file.

Note The most important status property is whether the HMI WorkstationST screen
file is current with the master file.

2-36 • Chapter 2 System Configuration GEH-6706G ToolboxST

 To update HMI screen file status

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, select the HMI Screens item, or an HMI
WorkstationST item or a WorkstationST component.
3 From either the Tree View or the Summary View, right-click to select
Refresh HMI screen data from the short-cut menu.

From the Summary View, the

Status column displays either Up to
Date or Out of Date for the HMI
WorkstationST using those files.

The size and date of both the master and the local HMI screen file display in the
Property Editor.

Editing an HMI Screen File

To edit an HMI screen file, there must be a Windows association between the editing
application and the extension of the HMI screen file name. For example,
CIMPLICITY CimEdit is the application to edit CIMPLICITY screen files. The
standard extension for CIMPLICITY screen files is .cim. To edit CIMPLICITY
screen files in the ToolboxST application, CIMPLICITY must be installed on the
computer, and there must be a file association between the .cim extension and
CimEdit.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-37

 To edit an HMI screen file

1 From the System Editor, open a WorkstationST Component Editor.

2 From the Component Editor, select the HMI Config tab.
3 From the Tree View, select the HMI Screens item.
4 From the Summary View, select an HMI screen file.
5 From the Summary View, right-click to select Edit selected HMI screen
from the short-cut menu.

The process of editing an HMI screen file is different, depending on whether CMS is
enabled.

Editing an HMI screen file with CMS enabled

When CMS is used, the CMS repository is the source of the HMI screen files. When
editing is completed, the screen file is checked back into the CMS repository, then
copied, at the users discretion, to the master location so it can be used by all the HMI
Workstations that are configured to use it.

• If the HMI screen file is not checked out, you are prompted to check it out.
• If you click Yes, the file is checked out and the screen file is opened in the
appropriate editor.
• If you click No, you are asked if you wish to edit without CMS. If you click No,
editing does not take place. If you click Yes, the screen file opens in the
appropriate editor. Because the file is read-only, perform a Save As..
• Once you save the file and exit the editor, this message displays

2-38 • Chapter 2 System Configuration GEH-6706G ToolboxST

 • If you click Yes, the HMI screen file is copied to the master location. All HMI
WorkstationSTs that have the Auto Download option set to True get the
modified file next time the file status is checked.
• If you click No, the HMI screen file remains on the computer from which the
editing occurred.
• Check the file back into CMS. Once this is done, you again have the option to
copy the HMI screen file to the master location.
Editing an HMI screen file without CMS enabled

The source of these HMI screen files is the master location. When CMS is disabled,
the Check Out function copies the file from the master location to the computer
where the editing is taking place. The file is then checked back in to the master
location.

The edit dialog box that displays depends on the state of both the master file and
your system file.

Note The system file is NOT the one used by the CIMPLICITY application, rather,
it is the one stored in the HMI screens directory that also stores the .tcw file.

There are three possible states, as follows.

• The master file is not locked for editing

• The master file is locked by another user
• The master file is locked by you from a previous edit session
The master file is not locked for editing

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-39

 The options are as follows.

Check out the HMI screen file and edit. This will overwrite your local file
locks the master file so that it cannot be edited by another user. The file is copied to
the computer from which you are running the ToolboxST application, and overwrites
any existing system file.

Check out the HMI screen file, but edit the local file locks the master file so
that it cannot be edited by another user at the same time, but does not copy it to the
computer from which you are running the ToolboxST application. The system file
currently on your computer is opened for editing.

Get the master HMI screen file and edit. This will overwrite your local
file does not lock the master file. It is copied to the computer from which you are
running the ToolboxST application and overwrites any existing system file. When
editing is complete, it cannot be saved to the master location.

Just edit local file does not lock the master file. It is not copied to the computer
from which you are running the ToolboxST application. The system file currently on
your computer is opened for editing. Once editing is complete, it cannot be saved to
the master location.

The master file is locked by someone else

2-40 • Chapter 2 System Configuration GEH-6706G ToolboxST

 The options are as follows.

Get the master HMI screen and edit (the edit will be local only) copies to
the computer from which you are running the ToolboxST application and overwrites
any existing system file. The file is then opened for editing. Once editing is
complete, the file cannot be saved to the master location.

Edit only the local file is not copied to the computer from which you are running
the ToolboxST application. The system file currently on your computer is opened for
editing. Once editing is complete, the file cannot be saved to the master location.

Cancel the edit allows you to cancel without saving.

The master file is locked by you from a previous edit session

The options are as follows.

Get the master HMI screen and edit (the edit will be local only) copies to
the computer from which you are running the ToolboxST application, and overwrites
any existing system file. This file is then opened for editing. Once editing is
complete, you can save the file to the master location.

Edit only the local file is not copied to the computer from which you are running
the ToolboxST application. The system file currently on your computer is opened for
editing. Once editing is complete, you can save the file to the master location.

Cancel the edit allows you to cancel without saving.

When editing the screen file, all edits are saved in the system file. Once you exit
from the edit application, the ToolboxST application provides two options,
depending on the state of the files when you started the edit session.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-41

 You are either allowed do a Check In, which saves the file to the master location or
you are not. If you are not allowed (either the file is being edited by someone else or
you choose to edit only the system file), the following dialog displays.

If you are allowed to do a Check In, the following dialog displays:

The options are as follows.

Check in the HMI screen file copies the file to the master location, where it is
unlocked so it can be edited by another user.

Check in the HMI screen file, but leave checked out copies the file to the
master location, but the master file is not unlocked. It cannot be edited by another
user.

Do not check in the HMI screen file, but undo the check out does not copy
the file to the master location, but the master file will be unlocked, so another user
can edit it.

Do not check in the HMI screen file, but leave file checked out does not
copy the file to the master location, and the master file is not unlocked. It cannot be
edited by another user.

2-42 • Chapter 2 System Configuration GEH-6706G ToolboxST

 System Database (SDB)
The ToolboxST application can interface with an SDB from the System Editor.

Click the System item in

the Tree View to access
SDB properties.

A Second Language
must be selected before
diagnostic text can be
translated in the System
Information Editor.

This property must be set

to True before other SDB
properties can be
configured.

The host name where

the SDB is located.

The path where the

SDB is located.

The ToolboxST configuration for alarm classes and format specifications can be
stored, or put, to an SDB from the System Information Editor.

To put the system configuration to an SDB

1 Open the System Information Editor. From the System menu, select Put
System to SDB. (Refer to the section, System Information Editor.) A dialog
box displays to confirm the destination SDB Host and Path.
2 Click OK. When the process is complete, the results display on the Log tab of
the InfoView.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-43

Master File
Files that are used by multiple WorkstationST runtimes are stored in a defined
Master location. These files include HMI screen files, sound files, and alarm help
files.

From the Tree View,

select the system item to
display system properties
in the Property Editor.

The WorkstationST
where the master
files are located.

The path on the

WorkstationST
where the master
files are located.

2-44 • Chapter 2 System Configuration GEH-6706G ToolboxST

 EGD Configuration Server
The EGD Configuration Server is a repository for EGD device and system
configurations. Like the SDB, the EGD Configuration Server allows configuration
information to be available to multiple tools or runtime platforms.

The EGD Configuration Server maintains a group of .xml documents for each EGD
device. The EGD Configuration Server also maintains a MasterSymbolTable.xml file
that contains format specifications, alarm classes, and other system-level
information.

The protocol used to get and put these .xml documents to and from the EGD
Configuration Server is a published HTTP protocol. This protocol is available for
other tools, and is currently used by GE Fanuc’s CIMPLICITY ME. The ToolboxST
application uses the EGD Configuration Server if it has been enabled in the System
Editor.

The EGD Configuration Server properties are as follows:

Base Path is the URL on the EGD Configuration Server where EGD documents
reside. This is normally /EGD.

Note This is normally /EGD and should not be changed unless the system
administrator has installed a custom EGD Configuration Server.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-45

 Enable, if set to True, enables the interface to the EGD Configuration Server. If this
is enabled, the EGD configuration is sent to the server when a device is saved. An
EGD configuration for referenced devices is obtained from the EGD Configuration
Server if the configuration time is newer in the server than in the ToolboxST
application's local directory for that referenced device. For example, if your
ToolboxST system was located at C:\MySystem and a device was referencing a
device Dev1, the EGD configuration for Dev1 would be obtained from the EGD
Configuration Server if that configuration had a newer timestamp than the
configuration at c:\MySystem\Dev1. Otherwise the local c:\MySystem\Dev1
configuration would be used.

Host Name is the Host Name or IP address of the host running the EGD
Configuration Server.

Port is the server port value. The default is 7938.

Note This should not be changed unless the system administrator has installed a
custom EGD Configuration Server.

Timeout is the server connection timeout in milliseconds.

Use IE Proxy selects the Internet Explorer proxy settings, if set to True. If set to
False, no proxy is used. The default is false and it is recommended not to use a
proxy.

Working Online with the EGD Configuration Server

Work Online with the EGD Configuration Server is the default in the ToolboxST
application to open, build, or save components. You can select Work Offline from
the View menu or from the Status bar shortcut menu.

When the EGD Configuration Server is enabled, a status bar indicates the
Online/Offline status. Right-click the status bar to obtain a shortcut menu, which
allows you to toggle between the two modes. If Work Offline is selected, the server
is bypassed when components are opened, built, or saved. This means that any
component saved results in a difference between the EGD Configuration server and
the ToolboxST application.

ToolboxST/EGD Configuration Server Interaction

When the ToolboxST application is online, and the EGD Configuration Server is
enabled, the application reads any new EGD Configuration Server data. It then saves
or builds to the EGD Configuration Server.

When a component is opened, the configuration of any EGD referenced device is

read from the local file location (in that referenced device’s ToolboxST device folder
for the opened system). It is then requested from the server if the server has a newer
version.

When a component is saved, the EGD configuration is saved to the EGD

Configuration Server. If communication with the EGD Configuration Server fails
during an open, build, or save procedure, a dialog box to select Work Offline or
Retry displays.

2-46 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Viewing Differences
Use the System Editor View menu or right-click the status bar shortcut menu to
compare the local configuration to the server configuration.

Or

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-47

 The following options are available:

View Differences displays a difference report for any consumed or produced data
file that exists in both the server and the local system.

View Server File allows you to view the server version of a selected document.

View Local File allows you to view the local version of a selected document.

Equalize Server to Match all Local System nodes makes equal any node that
is marked Not Equal by publishing the local configuration to the EGD Configuration
Server.

Empty Server, then Send all Local System nodes causes all EGD
configuration server content to be removed before the local system nodes are
published.

Note If a component in a .tcw file is not the latest configuration (for example, if the
most current configuration is on another computer), publishing the local EGD
configuration sends the old configuration to the server.

Send This Node Local To Server sends a local copy of a selected document to
the EGD Configuration Server. If the device’s tree node is selected, all documents
under the device are sent to the server.

Delete This Node in Server allows you to delete a selected device in the server.

Refresh Display compares the local system to the EGD Configuration Server and
updates the display.

2-48 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Configuring an External EGD Device
The EGD configuration for a device in the SDB can be retrieved for use in a
ToolboxST system. Before you can reference an external device in the SDB, the
SDB Enable property of the system must be set to True. Refer to the section, System
Database (SDB) .

To get an external device's EGD configuration from the SDB

1 If the external device does not already exist as a ToolboxST component, create

an External Device component to represent it. Refer to the section,

Components.
2 Select the external device in the System Editor Tree View. The component
properties display in the Property Editor.
3 Set the Enable Get from SDB property to True.
4 Right-click the external device in the Tree View and select Get EGD from
SDB. A dialog box displays confirming the destination SDB Host and Path.
5 Click OK to proceed with the Get EGD from SDB operation. When it is
complete, the results display on the Log tab of the InfoView.

Note If the EGD Configuration Server option is enabled for the system, the EGD
configuration will also be put to the EGD Configuration server.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-49

Starting ToolboxST from an Existing System
Configuration
Each system configuration has a top level .tcw file that describes the entire system.
Upon installation, the ToolboxST installer associated these system configuration
files (*.tcw) with a dialog box that automatically starts the ToolboxST application .
This allows you to select a system configuration (xxxx.tcw) by double-clicking it. In
most cases, when there is ONLY one version of ToolboxST.exe, this starts the
compatible version of ToolboxST.exe without displaying any additional user
interface.

When there are either multiple versions of ToolboxST.exe (for example, during an
upgrade) or no installed versions of ToolboxST.exe, this dialog box displays all
versions that are equal to, or at a higher version than the selected .tcw file. When this
happens, the following dialog box displays to allow you to browse to and select an
appropriate version of ToolboxST.exe.

In this example, one of the ToolboxST.exe versions exactly matches the .tcw file
version so that entry is the default selection. Click the OK button to start
ToolboxST.exe v03.03.11B. Open the SystemConfigSample.tcw system
configuration after logging on to CMS. The Browse button allows you to locate and
start a version of ToolboxST.exe that is not installed.

2-50 • Chapter 2 System Configuration GEH-6706G ToolboxST

 SecurityST
The SecurityST feature is embedded within the WorkstationST or SecurityST tray
icon. A list of Users and a list of Roles can be configured for a ControlST system
using the system information editor. Each user is assigned a role and an optional set
of resources. User names correspond to Windows users, (work groups or domain
users). The diagram that follows displays how ToolboxST, CimView and CimEdit
authenticate with the Security function.

Remote computer

CIMPLICITY CimView/
Communication CimEdit
Processes

OPC DA Private Security

WorkstationST CIMPLICITY CimView /

OPC DA Private Security Communication
OPC DA Server CimEdit
Processes

Authentication UI
- Right-click allows for logon
or change of user (logout /
logon)
Get Current User * - UI displays to request
logon if users are configured
and a user is not already
logged on.
-The current user and role
display

ToolboxST

Tray Icon
Security Login Get Current User *
Logon Changed Application
Intercom Message **
WorkstationST
Get Current User *
Alarm Viewer

*Request for the current logged-on user update message

.
The requestor sends an
“ LogonSecurityGetCurrentUserIntercomMsg ” message
with a scope of “Send to Master”

**When a user is logged on or off or a request for

current logged-on user is sent , the logon manager
application sends a
“LogonSecurityGetCurrentUserIntercomMsg ” intercom
message with a scope of “Send to all Clients”

Logged-on response messages contain the Logon

Security object as well as the current user name. For a
logged-on scenario, the new user is sent as
Logged On. When that user is logged off , the previous
user is sent as a logged-on intercom.

Messages also contain the current windows session ID .

ToolboxST, CimView and CimEdit Security Authentication

For more specific details regarding the security function, including configuration,
refer to GEH-6706, ToolboxST* User Guide for WorkstationST*.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-51

 Configuring SecurityST Logon
Users and roles are configured from the System Information Editor in the ToolboxST
System Component. An example of configured users and roles is as follows.

Each of the five users created

has been assigned a role.

The following property is associated with the Users and Roles item.

Auto LogOff Timeout is the time, in minutes, after which a user who has
temporarily logged on over the existing user, is automatically logged off. If set to 0,
auto logoff does not occur. When the temporary user is logged off, the previous user
is again active.

User settings include the following:

Name is the user name. In Windows Domains, the name can be the
Domain/UserName.

Role is the role associated with the user, which defines the user’s access privileges.

HMI Resources are the HMI resources associated with a user. They are configured
in the System Information Editor, with assigned variables. Users who have a
resource that matches a variable’s resource can write to live data for that variable if
that privilege is assigned. If a variable does not have a resource, it defaults to
allowing the user to modify the data if the user’s role supports that privilege. Users
with an empty list of resources are only allowed to modify variables without an HMI
resource defined.

Role settings include the following:

Name is the role name, which can be assigned to a user with all the privileges of
that role.

Live Data Modify Privilege allows you to modify live values.

Live Data Force Privilege allows you to force live values.

2-52 • Chapter 2 System Configuration GEH-6706G ToolboxST

 Logic forcing procedures can result in personal injury or
death, if not strictly followed. Only adequately trained
personnel should modify any programmable machine.
Forcing of control logic for an operating process is strongly
discouraged. Forcing of protective functions is never
permissible for an operating unit. All safety measures should
be strictly enforced in conjunction with this procedure.

Alarm Privilege allows you to acknowledge and reset alarms in the WorkstationST
Alarm Viewer.

GoTo Definition From HMI Graphics Privilege allows you to right-click

within an HMI graphics window and enable GoTo Definition in ToolboxST.

Tag Out Privilege allows you to tag out areas of the control system.

Displaying Current User

The SecurityST user interface is displayed by using the WorkstationST icon in the
taskbar notification area.

To display the current SecurityST user

Right-click the WorkstationST icon in the taskbar notification area. A shortcut
menu displays.

Select Show Current

SecurityST User. The
SecurityST Current User
Information dialog box
displays.

The Privilege check

boxes display the
privileges of the current
user.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-53

 Logging On
From within the SecurityST User Logon Manager, you can:

• Logon and replace the current user

• Logon to override the current user temporarily
To log on and replace the current user

♦ Right-click the WorkstationST or SecurityST icon in the taskbar notification

area to display the shortcut menu.

Select SecurityST Log

On. The SecurityST User
Logon Manager dialog
box displays.

From the drop-down list, select the User,

then enter the Password. Click OK.

The user selected replaces the current user. The previously defined user privileges
take effect.

2-54 • Chapter 2 System Configuration GEH-6706G ToolboxST

 To temporarily override the current user

Select the User, then

enter the Password.

Select the Temporary Log On Leaving Current

User Logged On check box, then click OK.

The user Maint is now logged on over the current user (or now sub-user) operator.
The previously defined user privileges for maint take effect.

GEH-6706G ToolboxST Chapter 2 System Configuration • 2-55

 Auto Logging Off
The SecurityST feature LogOff Timeout is activated when one user is logged on over
another user. This feature is set in the Property Editor when the Users and Roles item
is selected in the Tree View.

To set the Auto LogOff Timeout feature time

From the Tree View of the ToolboxST System Editor, double-click

the icon.

From the Tree

View, select Users
And Roles.

In the Property
Editor, enter the Auto
LogOff Timeout in
minutes.

If the temporary user remains inactive through the timeout period, that user is logged
off and this message displays.

Logging Off
To log off the Current User
Right-click the WorkstationST or SecurityST icon in the taskbar notification
area to display the shortcut menu.

Select SecurityST Log Off .

The current user is now logged off. If the current user was the temporary user, the
sub-user now becomes the current user and previously defined user privileges take
effect.

2-56 • Chapter 2 System Configuration GEH-6706G ToolboxST

 CHAPTER 3

Chapter 3 WorkstationST
Component Editor

Creation Wizard
WorkstationST components are created from the System Editor by using the
WorkstationST Creation Wizard screen.

To create a component
From the System Editor Tree View, right-click the system name and select
Insert New from the shortcut menu.

Select WorkstationST. The WorkstationST

Creation Wizard displays.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-1

 Enter a name for the new
WorkstationST.

Click Next to continue.

Click Next to continue.

3-2 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Click Finish. A new WorkstationST is
added to the system, and the System
Editor updates to reflect the change.

The WorkstationST Component Editor displays in the Tree View and in the
Summary View.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-3

 To open a WorkstationST Component Editor
From the System Editor Tree View, double-click the WorkstationST
component. The WorkstationST Component Editor displays.

The Summary View provides an overview of

the item selected in the Tree View. It can be
used to monitor or edit an item.

Tabbed pages organize

the different elements of
the component’s
configuration.

The Tree View list all

major items in the
component. The list of
items changes when a
different tab is selected.

The Property Editor

allows you to edit the
item selected in the
Tree View or
Summary View.

The Component
InfoView displays specific
feedback information
about the currently
selected tab.

To edit the component

From the Component Editor, click an item in the Tree View. The
configuration information for that item displays in the Summary View and
Property Editor.
Existing components can also be imported from a file.

To import an existing component

In the Tree View, right-click a parent component (either a system or a group),
select Insert Existing, then select Device. Select the Device .xml file for the
component to be imported and click Open.

Summary View
The information displayed in the Summary View depends on the item selected in the
Tree View. There are many types of summary views ranging from the block
diagram, which is specialized to edit application software, to simple lists of
referenced files where no editing is possible.

3-4 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Property Editor
The Property Editor allows you to view and edit the properties of the selected item.
Properties are named values associated with the selected item. The configuration
item displays in the left field and the value displays in the right field.

The Min-max button Double-click on the

allows you to quickly double bar to view the
resize the Tree View and Property Editor in a
the Property Editor separate detached
within their shared view. window.

The Alphabetical List

The List by Category
button allows you to view
button allows you to view
the list of properties
the list of properties
arranged alphabetically
organized by category.
by name.

To edit a property in the Property Editor

From the Property Editor, select an item by clicking its value field. The field
can display several options:

Click the Ellipsis button to change the value from a dialog box.

Click the drop-down list button to change the value from a drop-down list.

If no button displays, edit the value directly in the corresponding text box on the
right side of the Property Editor.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-5

Component InfoView
The color on the Status
tab indicates the overall
state of the controller.

The Component InfoView contains several tabs that provide status information.
(Depending on the open component type, additional tabs may also be available.)

Log tab displays messages related to user commands or system events issued in the
ToolboxST configuration.

Tip If there is a build problem, the error is listed on the Log tab. Double-click the
error. The input focus goes to the location in the component configuration where the
error occurred.

Status tab displays operating state and equality information about the
WorkstationST component.

History tab keeps a navigation history for each user session and allows you to return
to different places in the editor. Each time an item is selected in the Tree View or
Summary View, the name of that item is added to the top of this list.

Where Used tab tracks variables in the Tree View or Summary View and displays
all other places in the controller where they are used.

Tip From the Where Used tab, double-click the desired item. The input focus
goes to the view represented by that line and the item is selected.

The write icon that displays at the beginning of some lines indicates that the
variable is being written at that location.

Find Results tab displays the results of the Finder.

Info tab displays context-sensitive descriptions for the selected Tree View or
Summary View item.

3-6 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Log Tab
When the Log tab is selected, three buttons display in the toolbar at the bottom of the
Component Editor.

Click each of the buttons to hide the corresponding

items (for example, click the Warning button to hide
the warnings in the Log tab).

Each time a Build command is performed, the Log tab is updated with current errors,
warnings, and general information. Concurrently, with each Build command, a file is
generated in the component folder that reflects the contents of the Log tab. This file,
called Build.log, remains until the next Build command then is updated.

The build.log is generated each

time a Build command is performed.

Note To go to its location in ToolboxST, right-click either an Error or a Warning,

then select Go To.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-7

Data Grids
Data Grids are used to view or edit many of the configuration properties available in
ToolboxST component editors. While each Data Grid contains different columns and
properties, several features are common to all Data Grids, including column resizing,
clipboard operations, and multi-row editing.

Note Some Data Grids, especially those without an Append Row, may not support
all features described in this chapter.

Drag borders to Column

Click to select Sort indicator headers
resize columns
entire grid.

Row
headers

Currently
selected row

Append
row

Selected cell

Editing Data
To... Do this:

Edit a text or numeric value

Left-click inside the cell to be modified. The cell
changes into a text box. Edit the contents of the cell as desired, and then press Enter
to save your changes.
Edit an enumerated value
Left-click inside the cell to be modified. The cell
changes into a drop-down list. Click the down arrow and select the desired value for
the cell.
Edit a complex value
Left-click inside the cell to be modified. The cell
changes into a text box with an ellipsis button, indicating that a dialog box is
available to change the cell contents. To display the dialog box, click the
ellipsis button.
Quickly set a property to the Left-click the row header for the first row to be edited. Then, while pressing the CTRL
same value for multiple rows key, left-click added row headers. After selecting all desired rows, use the Property
Editor to change properties for all selected rows. (Some properties are omitted when
a group of rows is selected, and properties with conflicting values will display no
value in the property editor.)

3-8 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Organizing Columns
The columns of a Data Grid can be customized. You can select the columns that
display, the column order from left to right, the column width, and the sort criteria.

To... Do this:
Resize a column Drag the vertical bar on the right of the column header to a new location.
Quickly remove a single column Right-click the column header and select Hide Column.
Move a column to a different location Drag the column header to a new location.
Sort by a column Click a column header. The column sorts in ascending order. To sort in
descending order, click the column header again.
Reset columns to the original Right-click any column header and select Default Column Organization.
configuration
Add or remove columns Right-click any column header and select Organize Columns to display the
Organize Columns dialog box.

Add all available

columns to the
data grid.

Add selected
column to the
data grid.
Move the
selected
column up or
down in the
Remove selected column order.
columns from the
data grid.
Remove all
columns from the
data grid.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-9

 Copying and Moving Data

To… Do this:
Copy and paste a single row Right-click the header for the source row and select Copy Selected/Current Rows to
place the source row on the clipboard. Then, right-click the header for the append
row in the destination grid and select Paste Row(s) to insert the row into its
new location.
Copy and paste multiple rows Left-click the row header for the first source row. Then, while pressing the CTRL
key, left-click added row headers. After selecting all desired rows, continue to hold
down the CTRL key and right-click any selected header. From the shortcut menu,
select Copy Selected/Current Rows to place the rows on the clipboard. Then, right-
click the header for the append row in the destination grid and select Paste
Row(s) to insert the rows into their new location.
Copy and paste a range of two or Click the top left cell of the desired range and drag to the bottom right cell. Right-
more cells click the selected region and select Copy Selected/Current Rows to place the cells
on the clipboard. Then, click the top left cell of the destination range and drag to
select the same number of columns and rows that were copied to the clipboard.
Right-click inside the destination region and select Paste Row(s).
Move rows between data grids Arrange windows on screen so both the source and destination grid are visible. (An
entry in a Tree View is acceptable as a destination) Left click the row header for
the first row. Then, while pressing CTRL, click any added row headers to be moved.
Release the CTRL key and drag a row header to the new data grid.

Add a variable to a block diagram, Arrange windows on screen so both the source grid and a destination block
Trender window or Watch Window diagram, Trender window or watch window are visible. Then, drag the row header
from a data grid for the variable to the destination window.

Tip You can copy and paste rows between different data grids if the columns
match by following the above procedures and navigating to a different data grid
before pasting the data.

Tip Cells in a data grid can also be copied to and pasted from Microsoft Excel. The
copied data is stored in .csv format, which contains no information about column
names. To make sure pasted data is placed into the proper columns, do not change
column ordering and always select the exact destination range in the ToolboxST
configuration before pasting data from Excel.

3-10 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 WorkstationST Status Monitor
The WorkstationST Status Monitor provides status and control of the WorkstationST
features on the local computer. The Status Monitor is included in the Status tab in the
Component Info View of the configured WorkstationST component.

The WorkstationST Status Monitor is configured to start when you logon to

Windows, and then runs as a tray icon . When a warning or error occurs with
the WorkstationST Service or any configured feature, an error icon

displays .

To monitor and configure WorkstationST features

From the toolbar, click the Launch Toolbox button.

To start or stop WorkstationST features

From the toolbar, click the Start or Stop button. Or right-click

the feature, then select Start or Stop from the shortcut menu. Start and stop
requests are sent to the WorkstationST Service.

A service control manager is used to start the WorkstationST Service.

Note When the WorkstationST Service starts, it attempts to start all configured
features, and to keep the features running. If a feature is stopped from the Status
Monitor, WorkstationST Service will not attempt to restart it. If the feature is started
again from the Status Monitor (or WorkstationST Service is restarted), the feature
starts again.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-11

 Status Monitor Shortcut Menu
The WorkstationST Status Monitor provides the following right-click menu options.

Select Start Selected Feature(s)

to display the following dialog
box.

Click OK to start the

selected sub features.

3-12 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 View Additional Status Detail Option

To display additional status information

Double-click the Tray icon. The WorkstationST Status of Features dialog
box displays.

Right-click the Feature

and select View
Additional Status Detail.
The WorkstationST
additional status dialog
box displays.

Information displays for each configured feature. The WorkstationST Service runs a
System Data Interface (SDI) server. The Status Monitor uses an SDI client to obtain
the information displayed. Information is not available when the WorkstationST
Service is not running.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-13

 View NTP (Time Sync) Detail Option

This menu option, which displays time synchronization information, is accessible

when any feature in the status monitor list is selected.

Click the Details tab to display Place the cursor on each column
additional details. header to display a column data tooltip.

3-14 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 NTP Status Viewer File Menu

Specify Remote Host allows you to display NTP service status on a remote
computer (the local computer is the default display).

Data Logging displays a dialog box that allows you to log the Status Viewer’s data
to a log file.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-15

 Alarm Server Status

When the Alarm Server feature is selected in the WorkstationST Status Monitor, the
server status displays with the Alarm Server Status menu item.

Select the Alarm Sources tab to display detailed

information for all configured controllers or other
alarm sources.

3-16 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Select the Alarm Clients tab to
display alarm client information.

Select the Alarm Queues tab to Click any ellipsis button to display
display alarm queue information information for the selected queue.
from the Alarm Server.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-17

 Alarm Status Viewer File Menu

Alarm Server Hostname is the hostname on the local computer (default) that has
the Alarm Server enabled.

Save Status to Text File allows you to save the current Alarm Server status to a
text file.

Copy Selected Option

This menu option allows you to copy the selected WorkstationST Status Viewer list
to the clipboard.

Advanced Menu

View Detail Log allows you to display detailed events for the selected feature.

Save and Zip all feature logs allows you to save configured log files to a
specified zip archive.

3-18 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Security
The security provided in the ToolboxST application is based on passwords entered
by the user. Passwords ensure that only authorized persons can view or make
changes to system components.

The two types of protection available are called Access Rights.

• Modify Data allows you to make changes to data values associated with an
object without changing how it works. For example, it protects the initial value
of a variable defined in a controller. The purpose of this right is generally to
keep unauthorized persons from making unsafe changes to settings.
• Modify Design allows you to change the way a protected object works. For
example, this protects block creation and editing of connections within a library
block diagram. The purpose of this right is to limit the ability to change how the
system works to authorized persons.
A protected object can have one or more of these access rights (refer to the section,
Protected Objects ). Each right can have a different password set. Some objects can
be protected if they are contained in another parent object, which is protected by its
own password(s).

Passwords
Whenever you attempt to perform an operation on a protected object, the Enter
Password dialog box displays.

The title bar indicates which access right is protected.

Protected Location
indicates which object is
protected within the system.
Although some object(s)
may not be protected, the
object can be contained
within another protected
object. It is important to
know which object is asking
you to enter a password.

Enter the password, then

click OK.

Note Passwords are case-sensitive – secret and Secret are not considered to be the
same password.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-19

 To change an existing password

1 From the Property Editor, expand the Protection item.

2 Select the desired access right, such as Modify Design, and then click the

Ellipsis button. If there is already a password on that access right and it has
not yet been entered, you are first asked for the password before being allowed
to change it. The Change Modify Design Password dialog box opens.

The title bar indicates

which access right the
change will apply to, for
example, Modify Design.

Enter the new

password twice. A valid
password consists of
six or more characters,
letters, or numbers, and
is case-sensitive.
Click OK to apply
the change.

Password Caching
The security system caches passwords that were previously entered so that once you
enter a unique password, you don’t have to enter that password again. Separate
caches are maintained for the system and each major component (such as a Library
Container). A cached password remains until the component is closed.

Note From the Device menu, select Restore Password Protection to clear all
passwords and protect the component.

Tip If you have performed an operation in the ToolboxST application that requires
entering a password, it is recommended to close the protected component when you
are done so that an unauthorized user does not gain inappropriate access.

3-20 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Viewing Protection Status
The protection status for a component displays in the Property Editor. The following
example shows the protection for a WorkstationST component.

The Protection properties are as follows:

Modify Data allows you to modify data values and forcing of variables.

Logic forcing procedures can result in personal injury or

death, if not strictly followed. Only adequately trained
personnel should modify any programmable machine.
Forcing of control logic for an operating process is strongly
discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly
enforced in conjunction with this procedure.

Modify Design allows you to modify the component design.

Protected Objects
Specific actions governed by each access right depend on the specific component
type. Examples of protected objects are:

System can only have a Modify Design password. If present, it prevents you from
adding or deleting system components.

Device can have Modify Data and Modify Design passwords. Modify Data prevents
you from saving changes or changing initial values for variables defined in the
component's application software. Modify Design prevents you from modifying any
aspect of the hardware or software configuration for the component.

User Block Library can have passwords for all three access rights. They have no
direct effect on the block library, but are inherited by all block definitions within that
library.

User Block Definition can have passwords for all three access rights. If block
passwords are not applied, the passwords on the library container apply to the
definition.

User Block Instanced in a program can be given its own passwords for Modify
Data, Modify Design, or View Design. If none are assigned, it takes on the Modify
Data and Modify Design protection for the parent component. The passwords
assigned to an instance of some block in a user block library are initially set to the
passwords that were in force in the definition of that block. Once instanced though,
any changes to the protection on the block definition do not propagate to instances of
that block.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-21

WorkstationST Menus
Menu Command Use to
File Save Save changes to the current system
Print Generate a paper copy of the entire component configuration
Export Open the Export to Legacy PI Historian Wizard.
Close End the component editing session and return to the System
Editor
Edit Undo Remove the item currently selected in the Tree View
Redo Add a new component to the current system
Cut Cut the selected item in the Tree View
Copy Copy the selected item in the Tree View
Paste Paste the copied item in the Tree View into the Summary View
Delete Display the System Information Editor (refer to the section
System Information Editor
)
Find Display the Component Editor for the item currently selected in
the Tree View
View Go Back Return to the view that immediately preceded the current view
in the history
Go Forward Return to the view that immediately follows the current view in
the history
Global Variables Display a list of global variables
Trenders Display a list of Trenders for this component (refer to Chapter
6, Trender)
Watch Windows Display a list of Watch Windows for this component (refer to
the section, Watch Windows)
Test OPC DA Client Open an OPC client window that connects to any OPC DA
Server to verify communication.
Test OPC AE Client Open the Test OPC Client window.
EGD Management Start the EGD Management Tool (refer to GEI-100619, EGD
Tool… Management Tool (EMT).
WorkstationST Alarm Open the Alarm Viewer (this only displays if an Alarm Viewer
Viewer… was installed).
Device Online Connect to or disconnect from a controller.
Build Convert the current configuration into binary files that can be
downloaded to a controller.
Download Download the application configuration.
Upload Retrieve configuration information from the controller to create
a new controller component in the system.
Put Device to SDB Store the component configuration to a System Database
(SDB).
Restore Password Clear all passwords and protect the component.
Protection

3-22 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Help Runtime Open release notes for any of the following features:
WorkstationST Service
EGD Configutation Server
OPC Server
OPC AE Server
Alarm Server
Recorder
HMI Config
Historian
Network Monitor
WorkstationST Web
Modbus
Release Notes Open the ToolboxST Release Notes Viewer for the current
version
About Display version and copyright information.

WorkstationST Alarm Viewer

The WorkstationST Alarm Viewer displays and manages live and historical alarm
and event information from a computer configured with WorkstationST, and running
the WorkstationST Alarm Server.

Alarm and event information displays by using advanced filtering and sorting
capabilities, as well as functions such as Acknowledging, Locking, and Silencing
Alarm and Events. Refer to GEI-100620, WorkstationST Alarm Viewer, for detailed
information.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-23

General Tab
The General tab configures general properties and attributes of a WorkstationST
component. Features unique to WorkstationST that can be configured on the General
tab include the OPC DA Server, Recorder, Human-Machine Interface (HMI)
Configuration, and Alarm Server. The Ethernet network and Network Time Protocol
(NTP) can also be configured.

To change the WorkstationST general configuration

From the System Editor, double-click the WorkstationST component to
display the WorkstationST Component Editor. The General tab is
selected by default.

3-24 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 The following properties are available in the Property Editor when the General item
is selected in the Tree View:

Alarm Server To Use allows you to select the WorkstationST currently running
the Alarm Server to get alarms.

Description is a freeform field to store comments about the current controller.

Name reflects the name of the current controller as set in the System Editor. It is
read-only in the WorkstationST Component Editor, and must be changed from the
System Editor.

Protection provides the following access rights:

Modify Data allows you to modify data values and force variables.

Logic forcing procedures can result in personal injury or death,

if not strictly followed. Only adequately trained personnel
should modify any programmable machine. Forcing of control
logic for an operating process is strongly discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly enforced
in conjunction with this procedure.

Modify Design allows the controller design to be modified.

Minor Revision is the time that the last WorkstationST Build command was started
after a minor component change. When a minor change is made, the revision is set to
zero until a Build command starts.

Web Access, if set to True, allows the WorkstationST Web server to interact with
Web clients.

WinXP Firewall Exceptions, if set to True, adds Windows XP firewall

exceptions for ports and applications a WorkstationST requires for receiving EGD,
SDI, and OPC DCOM communications from external devices and clients.

Use Second Language, if True, allows the second language description to be

used by WorkstationST features. Typically, the features have both the primary and
the secondary language descriptions. The HMI Config feature, when importing to a
CIMPLICITY project, can only import one description. Therefore, this flag will
control which description is imported. Likewise, the External Alarm Manager of the
Alarm Server will drive CIMPLICITY alarms with the second language description.

Active Diagnostics Severity defines the OPC AE severity value for a diagnostic
alarm in the active condition. This value is used for display purposes on the
WorkstationST Alarm Viewer.

Normal Diagnostics Severity defines the OPC AE severity value for diagnostic
alarm in the normal condition. This value is used for display purposes on the
WorkstationST Alarm Viewer.

Config Path defines the path for downloading the WorkstationST runtime
configuration.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-25

 Consumed Devices
When the Consumed Devices item is selected in the Tree View, the devices listed in
the Summary View are ones from which this WorkstationST obtains information.
They can be edited in the Summary View by toggling the referenced column value or
by selecting Devices in the Property Editor.

3-26 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Features
WorkstationST features are enabled or disabled from the Summary View. When a
feature is enabled, a tab for that feature displays.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-27

 Timecard
If a timecard is used by this WorkstationST, information about the timecard must be
configured with NTP.

Timecard selects the type

of timecard installed in the
WorkstationST computer.

3-28 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Configuring NTP
The NTP is configured on the System Editor. The configuration can be overridden
on each WorkstationST component.

Configuration Manual Override overrides the system NTP settings, and uses
local WorkstationST component settings only.

Configuration Option selects the supported NTP configuration option to start on

the WorkstationST computer.

Disable NTP Broadcasts disables NTP broadcasts from this WorkstationST

computer.

Site Time Reference Option specifies the method that this WorkstationST
computer uses to synchronize to a time source, either another computer or a Time
Server, outside the system configuration.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-29

 Scheduled Tasks
Any configured executable file can be scheduled for starting. The configuration
includes recurrence pattern options and start/end options.

To schedule a task

From the General tab, right-

click the Scheduled Tasks
item and select Add
Scheduled Task.

Click the My Task item to

display the following dialog
box.

Task Description
(optional)

Specify the file to

execute and any
optional startup
arguments, as well as
a window style.

From the Recurrence

Pattern options,
specify how the task
should run.

Specify an optional Start

time. If No Start Time is
specified, the Recurrence
Pattern selections are
used.

Specify an optional
end time.

3-30 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Network Adapters
The network adapters display as items in the General tab Tree View. The
WorkstationST configuration determines the number of adapters. Most applications
have two network adapters. One connects to the Unit Data Highway (UDH); the
other connects to the Plant Data Highway (PDH).

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-31

 When a Network Adapter item is selected in the Tree View, the following properties
display in the Property Editor:

Enabled, if set to False, disables the selected network adapter.

Host Name is the Internet Protocol (IP) host name for the selected network adapter.

IP Address is the Internet Protocol address for the selected network adapter.

Redundant, if set to True, indicates that the adapter is part of a redundant pair.

Wire Speed is the speed of the network to which the selected adapter connects.

Network sets the network connected to the selected adapter. (Available networks
are determined in the System Editor.)

Subnet Mask controls the significant portions of the IP address. (This property is
usually unavailable; for I/O networks, the subnet mask is always a fixed value, and
for other networks defined at the system level, the subnet mask is configured in the
System Editor.)

Network Switch is the network switch device to which this network adapter is set.

Port Number is the network switch port to which this network adapter is
connected.

Backup Network Switch is the backup switch for this network connection.

Backup Port Number is the network switch port to which the backup port is
connected.

On Site Monitor
The On Site Monitor (OSM) feature of WorkstationST supports the Universal OnSite
Monitor (UOSM). The UOSM is a standalone computer that serves as a gateway to
the customer’s system data, which is used by GE’s Maintenance and Diagnostic
(M&D) group to detect and diagnose system problems.

The OSM collects system configuration data from the WorkstationST Config Reader
and writes data files for the UPC (Universal Product Code), which communicates
with the M&D group. The OSM provides realtime data using the WorkstationST
OPC DA Server.

3-32 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Enabling the OSM

The On Site Monitor displays in the Summary View of the WorkstationST.

To enable OSM

1 From the WorkstationST General tab Tree View, select Features to

display all features in the Summary View.

The OPC DA Server

must be set toTrue
before the On Site
Monitor can be enabled.

2 From the drop-down list, select True to enable the On Site Monitor.

Note The OSM should only be enabled on a UOSM computer.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-33

Network Monitor Tab
The WorkstationST Network Monitor provides the status of all devices (controllers,
computers, network switches) that are defined in the system, and connected to at
least one of the Ethernet-based networks. Information is also provided about the
health of each network switch and its ports. The Network Monitor also allows
proactive network maintenance by providing visual indications and alarms of
abnormal conditions. These include devices not connected in their configured
location, unknown devices being connected to a switch, or attempts to gain
unauthorized access to switch Simple Network Management Protocol (SNMP) data.

During system startup, the Network Monitor determines where the devices are
physically connected. During normal system operation, changes in network topology
should not occur, therefore, any changes would indicate an abnormal condition. For
example, devices may be incorrectly reconnected after a network switch is replaced
or new network cables are run. This feature is also an important debugging tool
because it allows network issues to be spotted or ruled out very quickly. The
Network Monitor also enhances network stability and security by providing alarms
in the event of an unauthorized connection to the network.

ToolboxST System
Overview Screen
Computers, Controllers, Network Monitor Service
Network Switches...
Network Monitor Network
Data Client Monitor Data
Device Status Connection Client
Monitor threads

Network Monitor
Data Client Network Status Display
Connection Utility
Alarm Queue

Network
Network Monitor
Monitor Data
Alarm Client
Client
connection

WorkstationST Alarm
Viewer
Alarm Server

Alarm Client
Network Alarm Client
Connection
Monitor
Alarm Client

Network Monitor Data Flow

3-34 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Configuration
The Network Monitor is configured in a WorkstationST component.

To configure Network Monitor

1 From the General tab Tree View, select Features.

2 From the Summary View, in the Enabled column for Network Monitor,
select True. The Network Monitor tab displays.
3 Click the Network Monitor tab. The Network Monitor Configuration
screen displays.
4 Select the alarms or events to be generated by the Network Monitor.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-35

 The data acquisition rate parameters allow the level of SNMP network traffic to be
adjusted based on network bandwidth rather than display update rate needs. The
switch data request rate is separate from the device SNMP data because the amount
of SNMP data exchanged with the switches is very large compared to the data
retrieved from the devices. Specifying a fast device scan rate allows for fast detection
of a device going online or offline, while fast switch data rates detect an unknown
device being added to the network or a device being moved to a different port.
Knowing the device location is less important than knowing whether the device is
online. The network bandwidth necessary to retrieve the forwarding database from
the switches can be large in large systems, so separate parameters allows for
tradeoffs to be made between bandwidth and the speed of detection of abnormal
conditions.

The system network drawing displays all physical networks, as well as network
switches and devices, their physical locations, and their interconnection. The host
name and IP address of each device network connection on a per network basis, as
well as the switch and port where the physical connection is made is also provided.
This information is entered for the network switches and devices as they are added to
the system in ToolboxST.

When a new system is created in ToolboxST, it automatically includes a Unit Data

Highway (UDH) network. This is the default controller-level network to which all
controllers are connected. The Network Monitor only attempts to monitor devices
configured as Ethernet, IP networks. Additional networks are added as needed.

The UDH network has a default

Media value of Ethernet and a
default Transport value of IP.

3-36 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Network Switches
Network switches should be created after the networks have been added. This allows
the device network connections to be defined as the devices are added to the system.

To create a network switch

1 From the System Editor Tree View, right-click the system name and select
Insert New from the shortcut menu.

Select Network Switch. The Network Switch

Device Creation Wizard displays.

Enter a Name for the

switch, then enter the
number of ports to be
configured. Click Finish.

The Network Switch

displays as an item in
the Tree View.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-37

 2 From the Tree View, double-click the Network Switch item. The Network
Switch window displays.

Configure the switch

by defining the
properties in the
Property Editor .

The properties to configure in the Property Editor are as follows:

Connected Network is the communication path to the switch.

Description allows you to enter a description for the switch.

GE Part Number is an optional setting.

Host Name is part of the communication path.

IP Address is part of the communication path.

Number of Ports displays a physical attribute of the switch.

3-38 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 SNMP Community displays a password that retrieves data from the SNMP switch.
This value must match the SNMP Community value configured in the switch.

Switch Type is a physical attribute of the switch.

Vendor Configuration Tool is a optional setting.

Network Status Display

The system network status can be used to troubleshoot issues with the network. The
system network status can be viewed in several ways.

System Editor Summary View

The Summary View in the ToolboxST System Editor displays all system devices and
their simplified connections to the defined networks. It also displays the composite
health of the connection of each device to each network by displaying healthy
connections with a green line and unhealthy connections with a red or orange line.

An example of a
network error

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-39

Click on a network
connection or
device to open the
Network Status
Viewer for more
detailed information.

An example of a
healthy network

3-40 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Network Status Viewer

The Network Status Viewer allows you to troubleshoot network issues down to the
device level. This utility retrieves status data from the Network Monitor.

To open the Network Status Viewer

From the View menu, click Network Status Viewer.

The Network Status Viewer screen displays.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-41

 Network View Tab

The Network View tab displays the network hierarchy; the networks are the top-level
items. The switches are at the next level, followed by the devices.

Device View As Configured Tab

The Device View As Configured tab displays the devices in their configured
locations, as well as deviations of the device connections from their configured
locations. This is used to find occurrences of a device connected to the wrong port
that is masking the location of an offline device, but configured to be connected to
that port.

Device View By Connection Tab

The Device View By Connection tab displays the actual location of each device’s
switch and port.

3-42 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Alarms Tab
The Alarms tab is used to configure the WorkstationST alarm server feature, the
alarm scanner option and external OPC AE servers. The alarm server connects to the
enabled devices when a True reference is selected in the Consumed Devices list in
the Tree View. The alarm server receives alarm messages sent from these devices to
provide live alarm viewing. The alarm messages can also be saved in log files.

The alarm scanner option scans variables from the OPC DA server running on the
local workstation, and generates alarms and events based on the variable
configuration.

The external OPC AE server selections provide the configuration necessary to

consume alarm/events from these external servers.

Configuring the Alarms Tab

To configure the Alarms tab

1 From the Tree View, select the Features item. The available features display
in the Summary View.

2 In the Summary View, enable the Alarm Server by selecting True. The
Alarms tab displays, and the Alarms configuration form also displays in the
Summary View.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-43

 The Alarms tab displays the Alarm Server configuration options.

The tables below describe the configuration properties and values of the Alarm
Server.

CIMPLICITY Alarm Manager Interface Category

Send Alarms to If True, sends alarms to the CIMPLICITY alarm manager, if False, disables the
CIMPLICITY sending of alarms.

Disk Category

Disk Cleanup Enabled If True, all files in the Historical Alarm Path directory are deleted if the file age
exceeds the value specified in Historical File Age. If False, the files are left on disk.
Historical File Age Indicates the elapsed time in days from when the file was last updated. The default is
30 days.

General Category

Automatically Reset If True, an acknowledged alarm in the normal state is automatically reset. If False,
Acknowledged Alarms select and reset the alarm manually.
Emulate CIMPLICITY and If True, the Alarm Server maintains event queues and manages events the same as
Sequence of Events (SOE) alarms. This allows the WorkstationST Alarm Viewer to emulate CIMPLICITY alarm
behavior view behavior.

Enable Controller If True, controller and pack diagnostics are logged to the historical alarm log. If False,
Diagnostic Alarm Support pack and controller diagnostics must be retrieved using the ToolboxST application.

3-44 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Historical Category

Historical Alarm Path The path used to hold the historical alarm data files written by the Alarm Server.
Historical WorkstationST If True, the Alarm Server writes the WorkstationST style of alarm data into the
Alarms Enabled Historical alarm path. The file extension used is .bin. The default value is True.

Legacy Alarm System Interface Category

Connect to Legacy Alarm If True, connects to the Legacy Alarm system.

System
Network Monitor Interface Category

Connect To Network If True, connects to the Network Monitor.

Monitor
Printing Category

Alarm Printer The name of the printer to be used by the alarm server for printing alarms. The format
of the name must be \\ServerName\PrinterName if it is a network printer or just the
printer name if the printer is local to the computer.
Alarm Printing Enabled If True, activates the printing of alarms received by the WorkstationST runtime. The
Alarm Printer and Print Device Configuration must be defined.
Print Device Specifies one or more devices in the system from which alarm data is received and
Configurations printed. Alarm information is printed to the printer configured in Alarm Printer.
Print Queue Limit The maximum number of alarms allowed in the internal alarm manager queue to be
printed. Any alarms received after this limit is reached are discarded.

Alarm Scanner
The alarm scanner periodically scans the values of the configured variables. Based
on the conditions of the variables, an alarm and/or an event is generated.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-45

 External OPC AE Servers
The Alarm Server connects to each of the listed external OPC AE servers in the Tree
View. The translation of OPC conditions must be defined for each OPC AE server
added. When an alarm/event is received, it is handled by the Alarm Server like any
other incoming alarm/event. The alarm/event, if archived and enabled, displays as a
live alarm in the WorkstationST Alarm Viewer.

Note Each OPC AE server must be installed and configured before you add the
server to the list and get the published categories/condition names.

When an OPC AE server is added and selected in the Tree View, the data grid
displays the translation of each event category/condition name published by the OPC
AE server. Additional properties are available in the property grid display. These are:

General

Enable Connection To If True, the alarm server uses this configuration to process alarm/events from the external
Server server. If False, the configuration is preserved but NOT used.
OPC Server Time Units These specifies how to interpret the time stamps coming from the AE server. The choices
are UTC Time or Local Time.

Simple Event Type

Enable Simple Events If True, consumes and translates these OPC AE simple events to an EVENT type. If
False, ignores all simple event types from the server.
Simple Events Alarm Class This is the alarm class to be used by the WorkstationST Alarm Viewer for the display of
color for this event.

Tracking Event Type

Enable Tracking Events If True, consumes and translates these OPC AE tracking events to an EVENT type. If
False, ignores all tracking event types from the server.
Simple Events Alarm Class This is the alarm class to be used by the WorkstationST Alarm Viewer for the display of
color for this event.

3-46 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 To display alarm and event types
Click the OPC AE Server tab. The alarm and event types display in the
Summary View.

Note The GeCssOpcAeServer is a WorkstationST runtime feature, and must be

installed and running for this configuration to work.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-47

HMI Config Tab
As a feature of WorkstationST Service, the Human-Machine Interface (HMI)
imports component data into a defined CIMPLICITY project and allows you to
manage HMI screen files.

Imported data includes:

• OPC DA/EGD variables

• Alarms
• Alarm classes
• Components
• Ports
• Enumerations
• Measurement units
Components are selected in the General tab. Component variables are those
published on Ethernet Global Data (EGD).

The HMI screen file management functions include the following.

• Selecting screen files for a particular HMI to use

• Editing HMI screen files
• Downloading HMI screen files from a Master location to a particular HMI
• Enabling or disabling auto-downloads
• Displaying the status of HMI and master screen files

3-48 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Adding an HMI Feature
To add an HMI feature

1 In the Tree View, select Features.

In the Outline View, set the Enabled property for the HMI feature to True. The
HMI Config tab displays.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-49

 HMI Configuration
When the HMI Config feature is set to True, the HMI Config tab displays as follows.

3-50 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 The following properties display in the Property Editor.

HMI Screen Files are listed in the Summary View, and when selected, are those
used by this HMI.

HMI Graphics without a Project, if set to True (the default), requires you to
define the CIMPLICITY project file path, if CIMPLICITY 7.x is being used.
CIMPLICITY 7.x allow you to view and edit screens with a direct connection to
WorkstationST Services. This eliminates the need to synchronize a CIMPLICITY
project database. Refer to GEI-100697, WorkstationST CIMPLICITY Advanced
Viewer Integration.

Auto Download Screen Files enables the automatic download of HMI screen
files when the master screen files change.

Screen Editor overrides the default editor, which is based on the screen file
extension.

Screen File Path overrides the default local screen directory.This path can be
absolute or relative. When relative, it is based on the location of the CIMPLICITY
project (defined in the Project File Path). If the screen file path is blank, the default
screen file path is \screens, relative to the project file path parameter (for example, if
the project file path is c:\site\cimproj, the screen file path is c:\site\cimproj\screens.)

Note If the HMI Graphics without a Project property is set to False, Global Project
Parameters displays in the Tree View and the following properties display in the
Property Editor.

Project File Path is the location and file name for the CIMPLICITY project into
which data will be imported.

Set Point Audit Trail enables CIMPLICITY to send information to the Event Log
about user-defined setpoints.

Override Use Second Language is used to override the Use Second Language
property in the WorkstationST General tab when importing into CIMPLICITY. If the
override is False, the Importer follows the setting in the General tab. If the override
is True, the HMI Importer always imports the primary language description into
CIMPLICITY.

Global Parameters
Global System Parameters are user-defined, system-level global parameters that are
imported into a CIMPLICITY project. Global Project Parameters are user-defined,
project-level global parameters that are imported into a CIMPLICITY project.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-51

 Adding a Global Parameter

To add a Global Parameter

From the Tree View, right-click either Global System Parameters or
Global Project Parameters and select Add.

The new parameter displays in the Summary View.

Editing a Global Parameter

To edit a Global Parameter

1 From the Tree View, select either Global System Parameters or Global
Project Parameters.
2 In the Summary View, select the parameter to edit.

From either the Summary

View or the Property Editor,
edit the Name and/or Value.

3-52 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Deleting a Global Parameter

To delete a Global Parameter

1 From the Tree View, select either Global System Parameters or Global
Project Parameters.
2 In the Summary View, select the parameter(s) to delete.

Right- click the desired row, then

select Delete Selected Row(s).

HMI Screens
HMI screen files are managed from a master location and downloaded to the HMI
WorkstationSTs. These screen files can be managed from either the System Editor or
from any of the HMI WorkstationST components that use them. HMI screen file
management consists of the following functions:

• Adding and deleting screen files to the system (only from the System
Information Editor)
• Editing use of screen files by HMI WorkstationSTs
• Downloading screen files from Master location to HMI WorkstationSTs
• Editing screen files (from CMS or from the Master location if CMS is not
enabled)
If the CMS is enabled for your project, certain operations are restricted based on
whether or not files are checked out of CMS. The affected operations are as follows.

• The System must be checked out to add and/or delete HMI Screens (only from
the System Information Editor)
• The System must be checked out to edit the use of screens by any HMI
WorkstationST.
• Only the HMI screen file need be checked out to edit it.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-53

 To view HMI screen files from the System Information Editor

1 From the System Editor, open the WorkstationST Component Editor.

2 From the Component Editor, select the HMI Config tab.
3 From the Tree View, select HMI Screens. HMI screen files display in the
Summary View.

3-54 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 CMS and HMI Screen Files

Various CMS commands can be performed on individual HMI screen files when
CMS is enabled for the project.

To perform CMS commands

From the Summary View, right-click an HMI screen file to select the desired
CMS command.

Note The options depend on the CMS state of the HMI screen file selected.

Note When starting an edit session of an HMI screen file, you are prompted to first
check it out.

Defining HMI Screen Use

A particular HMI WorkstationST may not require all screen files in the system.
Defining use of specific screens for each WorkstationST can be done from either the
System Information Editor or from the HMI WorkstationST component. When a
screen is added to the system, all HMI WorkstationSTs use that screen by default.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-55

 To define the use of HMI screens from the WorkstationST
component

1 From the System Editor, open the WorkstationST Component Editor.

2 From the Component Editor, select the HMI Config tab.
3 From the Tree View, select HMI Screens.
4 From the Summary View, select a screen, then in the Use column, select
True to enable that screen or False to disable it.

From the Tree From the Summary

View, select the View, the use of a
HMI Screen particular screen
Files item. can be enabled by
selecting True.

The use of the

screen selected
in the Summary
View can also be
enabled in the
Property Editor.

Downloading HMI Screen Files

The HMI screen files are downloaded from the Master location in either the System
Information Editor or a particular HMI WorkstationST component. Downloading
can either occur automatically though a configuration property set for the
WorkstationST component or downloaded manually.

When pre-configured, WorkstationST runtime periodically compares the date of the

Master screen file to the file being used by the HMI project on the WorkstationST.
When an HMI screen file is saved to the Master location, it’s date changes. The
WorkstationST detects the change and automatically copies the new file to the
WorkstationST’s HMI project. HMI screen files can be downloaded to an HMI
WorkstationST without the system or individual HMI screen files in CMS being
checked out.

Note If a WorkstationST is configured for automatic download, a manual download

cannot be performed.

3-56 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 To download HMI screen files from the Master location to all HMI
WorkstationSTs

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, select HMI Screens Files.
3 From the Summary View, select one or more HMI screen files.
4 From the Summary View, right-click to select Download selected HMI
Screens from the short-cut menu.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-57

 To download HMI screen files from the Master location to an HMI
WorkstationST from a WorkstationST Component Editor

1 From the System Editor, open a WorkstationST Component Editor.

2 From the Component Editor, select the HMI Config tab.
3 From the Tree View, select the HMI Screens item.
4 From the Summary View, select one or more HMI screen files, then right-
click to select Download selected HMI Screens from the shortcut menu.

3-58 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 To download HMI screen files from the Master location to an HMI
WorkstationST

1 From the System Editor, open a WorkstationST Component Editor.

2 From the Component Editor, select the HMI Config tab.
3 From the toolbar, perform a Build command.
4 From the Device menu, select Download. The Download WorkstationST
wizard screen displays.

The Download WorkstationST wizard displays the items that can and need to be
downloaded. A scan is done automatically, with the parts that are not equal being
selected for download.

Displaying HMI Screen File Status

The System Information Editor can display the status of HMI screen files, including
the date and size of the master HMI screen file and the WorkstationST component’s
screen file.

Note The most important status property is whether the HMI WorkstationST screen
file is current with the master file.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-59

 To update HMI screen file status

1 From the System Editor, open a WorkstationST Component Editor.

2 From the Component Editor, select the HMI Config tab.
3 From the Tree View, select the HMI Screens item.
4 From either the Tree View or the Summary View, right-click to select
Refresh HMI screen data from the short-cut menu.

The Status column displays such

status conditions as Up to Date
and Out of Date for the HMI
WorkstationST using those files.

The CMS Status

column displays here.

The size and date of

both the master and the
local HMI screen display
in the Property Editor.

Editing an HMI Screen File

To edit an HMI screen file, there must be a Windows association between the editing
application and the extension of the HMI screen file name. For example,
CIMPLICITY CimEdit is the application to edit CIMPLICITY screen files. The
standard extension for CIMPLICITY screen files is .cim. To edit CIMPLICITY
screen files in the ToolboxST application, CIMPLICITY must be installed on the
computer, and there must be a file association between the .cim extension and
CimEdit.

3-60 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 To edit an HMI screen file

1 Open the System Editor. From the Edit menu, select System Information.
2 From the Tree View, select the HMI Screens item or an HMI
WorkstationST item or a WorkstationST component.
3 From the Summary View, select an HMI screen file.
4 From the Summary View, right-click to select Edit selected HMI Screen
from the short-cut menu.

The edit dialog box that displays depends on the state of both the master file and
your system file.

Note The system file is NOT the one used by the CIMPLICITY application, rather,
it is the one stored in the HMI screens directory that also stores the .tcw file.

There are three possible states, as follows.

• The master file is not locked for editing

• The master file is locked by another user
• The master file is locked by you from a previous edit session
The master file is not locked for editing

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-61

 The options are as follows.

Check out the HMI screen file and edit. This will overwrite your local file
locks the master file so that it cannot be edited by another user. The file is copied to
the computer from which you are running the ToolboxST application, and overwrites
any existing system file.

Check out the HMI screen file, but edit the local file locks the master file so
that it cannot be edited by another user at the same time, but does not copy it to the
computer from which you are running the ToolboxST application. The system file
currently on your computer is opened for editing.

Get the master HMI screen file and edit. This will overwrite your local
file does not lock the master file. It is copied to the computer from which you are
running the ToolboxST application and overwrites any existing system file. When
editing is complete, it cannot be saved to the master location.

Just edit local file does not lock the master file. It is not copied to the computer
from which you are running the ToolboxST application. The system file currently on
your computer is opened for editing. Once editing is complete, it cannot be saved to
the master location.

The master file is locked by someone else

3-62 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 The options are as follows.

Get the master HMI screen and edit (the edit will be local only) copies to
the computer from which you are running the ToolboxST application and overwrites
any existing system file. The file is then opened for editing. Once editing is
complete, the file cannot be saved to the master location.

Edit only the local file is not copied to the computer from which you are running
the ToolboxST application. The system file currently on your computer is opened for
editing. Once editing is complete, the file cannot be saved to the master location.

Cancel the edit allows you to cancel without saving.

The master file is locked by you from a previous edit session

The options are as follows.

Get the master HMI screen and edit (the edit will be local only) copies to
the computer from which you are running the ToolboxST application, and overwrites
any existing system file. This file is then opened for editing. Once editing is
complete, you can save the file to the master location.

Edit only the local file is not copied to the computer from which you are running
the ToolboxST application. The system file currently on your computer is opened for
editing. Once editing is complete, you can save the file to the master location.

Cancel the edit allows you to cancel without saving.

When editing the screen file, all edits are saved in the system file. Once you exit
from the edit application, the ToolboxST application provides two options,
depending on the state of the files when you started the edit session.

You are either allowed do a Check In, which saves the file to the master location or
you are not. If you are not allowed (either the file is being edited by someone else or
you choose to edit only the system file), the following dialog displays.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-63

 If you are allowed to do a Check In, the following dialog displays:

The options are as follows.

Check in the HMI screen file copies the file to the master location, where it is
unlocked so it can be edited by another user.

Check in the HMI screen file, but leave checked out copies the file to the
master location, but the master file is not unlocked. It cannot be edited by another
user.

Do not check in the HMI screen file, but undo the check out does not copy
the file to the master location, but the master file will be unlocked, so another user
can edit it.

Do not check in the HMI screen file, but leave file checked out does not
copy the file to the master location, and the master file is not unlocked. It cannot be
edited by another user.

OPC DA Server Tab

OLE for Process Control (OPC) is an industrial standard for communication between
various platforms using the Microsoft COM and DCOM model. The DCOM utility
allows components to communicate across network boundaries. The OPC DA Server
is configured from the WorkstationST component OPC DA Server tab.

The OPC DA Server receives Ethernet Global Data (EGD) from all EGD-referenced
devices consumed by the workstation (refer to the section General Tab). The OPC
DA Server provides live, timestamped data. Write access allows you to write to
variables. These writes are channeled to the EGD devices through EGD Command
Message Protocol writes. The OPC DA Server can also own variables defined under
the OPC DA Server Variables area, or in the OPC DA client. The OPC DA Server
has various data plug-ins. If enabled, an SDI data plug-in allows access to named
variables from a device that speaks SDI protocol, such as a MarkVIe, MarkVI, or
UC2000. The OPC DA client data plug-in allows the server to obtain variables from
an external OPC DA Server. Refer to www.opcfoundation.org for more information.

3-64 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Configuring the OPC DA Server Tab
To configure the OPC DA Server tab

1 From the Tree View, select the Features item.

2 In the Summary View, enable the OPC DA Server by selecting True. The
OPC DA Server tab displays.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-65

 3 Select the OPC DA Server tab.

From the Property

Editor, configure the
OPC DA properties.

The OPC DA properties are as follows:

Enable Client Writes is enabled by default. If set to False, OPC and SDI clients
(for example, ToolboxST) cannot write to a variable.

Maximum Client Rate is the maximum client data update rate in milliseconds.

Enable Client Driven Setpoint Logging, if enabled, logs writes of client-driven

variables from connected OPC clients. to the OPC server.

Enable Setpoint Logging enables or disables the logging of variables to the OPC
server from connected OPC clients. It writes to the OPC server's optional EGD-
produced variables from another EGD node through EGD Command Message
Protocol (from an HMI computer). The logging occurs in the OPC Server Service’s
log file.

Number of Backup Files are the number of backup log files to keep. The log files
are two megabytes in size, and are kept in the application startup directory (normally
C:\Program Files\GE Energy\GeCssOpcServer). After changing this
setting, the OPC Server Service must be re-started.

SDI Data Enabled enables solicited data through the SDI protocol. If enabled, the
server contains additional internal variables for UC2000, Mark VI, and Mark VIe
controllers. These variables are in addition to the public EGD variables. Although
the internal variables are present in the server and available for OPC browsing, they
are not updated with live data until an OPC client assigns them to a group.

3-66 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Test OPC Client
WorkstationST provides an OPC DA Server that can be configured with an OPC DA
client, which consumes data from other OPC DA Servers. The OPC DA test client
allows browsing and live data callback connections (OPC DA 2.0) to any OPC DA
Server. Detailed information displays in the Log window.

Note DCOM security issues may be encountered when OPC DA client-to-server

communications are configured. Refer to GEI-100621, WorkstationST OPC DA
Server.

To use the Test OPC Client feature

From the WorkstationST component View menu, select Test OPC DA Client
from the drop-down list. The Test OPC Client window displays.

From the OPC DA

client Tree View,
you can add
connections to OPC
DA Servers. Groups
containing variables
are added to a
connection from
here.

The Log tab displays

connection information
between the OPC Test
Client and the OPC DA
Server(s). This
information can be
selected and copied to
The Logging Level drop-down list controls how much
the clipboard.
information appears in the Log tab:
Verbose displays all available messages.
Info displays informational, error, and warning messages.
Warning displays error and warning messages.
Error displays error messages.
Off causes no messages to be displayed.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-67

 To add a server connection

1 From the OPC DA client Tree View, right-click the OPC Server
Connections item, then select Add Server Connection.

The Select OPC Server dialog box displays.

2 Enter a host name, then select an OPC DA Server from the OPC Server
drop-down list.

An OPC connection contains one or more groups that are collections of variables to
be updated.

To add an OPC group to the connection

1 From the Tree View, right-click the created connection and select Add Group.
The Add OPC Client Group dialog box displays.

2 Enter a group name and click OK.

3-68 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 To add variables to a group
From the Tree View, select a Group. Select a Name in the Summary View
to browse and add variables from the configured OPC DA Server.

To connect all
items in the
Tree View, select
the top-level item,
then click the
Go On/Offline
icon or right-click
and select
Connect.

If an individual server
connection is
selected, only that
connection is made
when the
Go On/Offline icon
is clicked.

Viewing Live Data

If a connection is successful, live values display in the Summary View.

A connection between the client and the OPC DA Server requires access and launch
permissions by the client on the server computer. Since OPC servers often run as
System users (not Administrators), the server must be able to access the client
computer to return data values. The client computer must allow access by the System
account to the client. For information on DCOM settings, refer to GEI-100621,
WorkstationST OPC DA Server.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-69

 Live Data.csv File Interface
WorkstationST allows you to read and save variable live values in a .csv file. The
OPC DA Server tab contains a CSV To Live Data option in the Tree View that
configures the OPC DA Server to read and monitor one or more .csv files for live
variable values.

3-70 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 When the OPC DA Server is started, and whenever the specified .csv file is changed,
the live values are read and set to the variables specified in the .csv file. The
variables can be any writable variables to which the WorkstationST has access. For
example, a client-driven variable can be defined and put onto an EGD Produced
Page. This variable’s value is then updated from the .csv file values. Any errors
display in the Status tab.

The .csv file format is one line of variable names and a second line of data values,
for example:

Var1,Var2,Var3

3.7,true,4.5

The utility LiveVarsToCsv.exe, which is in the GeCssOpcServer installation folder,

is used to read a snapshot of live values and write them to an output .csv file. The
command line utility’s syntax is as follows:

LiveVarsToCsv [options] <varCfgFileName |

var1,var2,var3...> <outputFileName>

Where options are:

/opcClient - use an OPC client to the WorkstationST live

data core, otherwise an SDI connection is used by
default.

/host="name" - an optional host name. If not specified,

local host is used.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-71

 /Horiz - Without this option, the output format has one line of comma separated
variables and a second line with comma separated values. With this option the output
format has one line per variable with name, value and optional extended data.

/Extended - Additional information is appended to the variable column or row

/Header - Includes a column header line. This option is only used when the /Horiz
option is used

/SeparateDateTimeColumns - Creates two columns for the variable's timestamp

rather than one combined date/time column. This is only valid when used with the

/Horiz option /AdditionalColumns=col,val which allows the inclusion of a column

header(s) col with value val. For example, if you use:

/AdditionalColumn=Area,Train1, another column with a header text of Area and

column values of Train1, would be appended to the output. Multiple columns/values
can be specified (for example Area,Train1,Customer,GE). This is only valid when
used with the /Horiz option /ColumnOrder=list which allows the order of the
columns to be specified. The list is a comma separated list of column header names.

Valid header names are:

Name, Value, Type, Time Stamp,Units,Description, Second Language Description

If the /SeparateDateTimeColumns options was specified, Date and Time are also
valid column headers

If the /AdditionalColumns option was used, the headers specified are also valid for
the ColumnOrder list. This is only valid when used with the /Horiz option.

If the argument following the options is a valid file path, the file is expected to
contain a list of variables, one per line with optional comma separated columns for
scale, offset and a translated output name (see an example below). Otherwise, the
argument following the options can be a list of comma-separated variable names

Example varCfgFile format:

# Comments are allowed anywhere in the file if preceded

by a ‘#’

var,scale,offset,translatedName

G1.Celcius,1.8,32,G1.Farenheit

Example using advanced options:

LiveVarsToCsv /Horiz /Extended /Header /SeparateDateTimeColumns

/AdditionalColumns="Plant Area,Train1"

/ColumnOrder="Area,Name,Value,Date,Time,Description,Units,Second Language
Description" var1,var2,var3 outputfile.csv

This utility can be used with the WorkstationST Task Scheduler to provide periodic
writing of .csv data.

3-72 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Redundant EGD Produced Pages
WorkstationST EGD Produced Pages can be configured with primary or secondary
redundancy. A primary redundancy sends the Produced Page if the page’s data
source is healthy. (Refer to Determining Produced Page Health). A secondary
Produced Page is sent by another WorkstationST if the primary Produced Page is not
heard for three periods. Typically a consumer of an EGD Produced Page declares the
page unhealthy if the page is not received after five periods. If the secondary
redundancy again detects the production of the primary page, data production is
stopped. Like the primary, the secondary producer sends the page if the page’s data
source is healthy.

Note The period, which is user-configured as an exchange on a page, is the rate at

which the exchange is sent.

To show redundancy
On the EGD tab, select a Produced Page.

The Property Editor

allows you to change
Redundancy by
selecting the level from
the drop-down list.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-73

 Determining Produced Page Health
Each Produced Page contains WorkstationST variables. A data source for the
variable values can be an OPC DA client connected to the WorkstationST OPC DA
Server, an OPC DA Server connected to the WorkstationST OPC DA client, or a .csv
file watched by the WorkstationST .csv file watcher.

3-74 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Health Timeout Multiplier can be configured for each Produced Page. If the
health timeout multiplier is greater than 0, and at least one page variable is written by
a data source within the timeout multiplied by the page period, the page is sent by the
primary producer (or the secondary if the primary is not producing). A flag allows
the first variable in the page (the one at offset 0.0) to be the only variable monitored
to determine the data source health.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-75

 OPC DA Client Page Health indicates the health of the Produced Page, which is
sent if the OPC DA client is connected to its configured OPC DA Server and the
server’s status is healthy.

Primary produced page configuration is a page configured as primary in the

WorkstationST component EGD page.

Secondary produced page configuration is a page configured as secondary in

the WorkstationST component. The secondary must be configured with the same
page name as the primary page.

3-76 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 The data source variables (typically OPC DA Server client-driven variables) must be
present in the secondary WorkstationST component, but it is not necessary to
configure the EGD Produced Page layout in the secondary. At runtime, the
secondary adapts to certain primary configuration changes such as data type and
offset changes to primary variables. When variables are added or deleted from the
primary, they must also be added to the secondary and downloaded, to allow the data
source to drive them.

The following example displays variables defined in the OPC DA Server tab to be
written by an external OPC DA client.

The WorkstationST OPC DA Server provides EGD and other data to OPC DA
clients. If redundant data must be sent to multiple OPC DA clients, multiple
WorkstationST computers can be configured and each OPC DA client can connect to
a different WorkstationST OPC DA Server. The OPC DA client must determine
page health and select the best source.

OPC AE Server Tab

OPC is an industry standard for communication between vendors in an industrial
environment. The non-profit OPC Foundation provides the specification for the
standard, as well as programming proxy stubs for OPC. OPC Alarms and Events
(AE) is the standard for real time alarm/event data.

The OPC AE Server is OPC AE version 1.10-compliant. Optional interfaces that are
provided allow browsing of published content, enabling/disabling content by Area or
Source, and providing a keep-alive heart-beat to maintain the client connection.

OPC AE Server, configured in a WorkstationST component requires ToolboxST

Version 2.2 or later.

The server is based on the Microsoft.Net Framework, and runs on Windows 2000
and Windows XP. The server is implemented as a service with the name
GeCssOpcAeServer.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-77

 Routing
Alarm and event routing is shown below. The OPC AE Server can be connected
locally or remotely from another computer.

WorkstationST
Mark VIe, Mark VI, Computer
Wind, and Pitch
Controllers Acknowledgements

GeCssOpcAeServer
Alarm Server V1.10 Compliant Acknowledgements
Acknowledgements
Alarm/Event
Notifications Alarm/Event
Translation
Alarm/Event Alarm/Event Alarm/Event
Notifications Notifications Notifications

Acknowledgements OPC AE Client

WorkstationST
HMI
Alarm Viewer

OPC AE Server Alarm/Event Routing

Server Attributes
When an alarm/event is received by the Alarm Server, it is sent to the OPC AE
Server through an internal client connection. Before connected OPC AE clients are
notified, variable name and condition states must be translated.

Note Variable is used to describe an entity within the ToolboxST application.

Source is the comparable OPC AE term; the comparable OPC DA term is Item.

3-78 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Variable Translations
Example 1

In the table below, the component name is G1, the boolean variable name is TooHot,
and variable properties are Alarm = True, Event = True and Hold = True.
WorkstationST Alarm Viewer

ToolboxST HMI Source Displayed Device Variable Type

Component = G1 G1.Alarm.TooHot G1 TooHot Alarm
Variable = TooHot G1.Event.TooHot G1 TooHot Event
Alarm Property = True G1.Hold.TooHot G1 TooHot Hold
Event Property = True
Hold Property = True

Example 2

In the table below, the component name is G1, the boolean variable name is TooHot,
and the variable properties are Alarm = True, Event = False and Hold = False.
WorkstationST Alarm Viewer

ToolboxST HMI Source Displayed Device Variable Type

Component = G1 G1.TooHot G1 TooHot Alarm

Variable = TooHot G1.TooHot
Alarm Property = True G1.TooHot
Event Property = False
Hold Property = False

State Translations
The three alarm/event types that can have a state are Alarm, Diagnostic, and Hold.

Event and Sequence of Events (SOE) are considered simple by OPC AE, and do not
have states.

Note There is a dot delimiter between condition name and state.

WorkstationST Alarm Viewer OPC AE Server

Type Condition Condition Name and State
Alarm Alarm Alarm.Active
Alarm Normal Alarm.Normal
Hold Active Hold.Active
Hold Normal Hold.Normal
Hold Override Hold.Override
Diagnostic Alarm Diagnostic.Active
Diagnostic Normal Diagnostic.Normal

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-79

 The OPC AE Server implements and acknowledges Alarms, Diagnostics and Holds
as condition-related states.

Note Events and SOEs are simple events, and cannot be acknowledged from any
external OPC AE client.

Configuring the OPC AE Server

The ToolboxST application version 2.2 or higher is used to configure OPC AE
Server features. The OPC severity values associated with variables are defined in the
alarm class definition. Both Active and Normal values are set here. For events and
SOEs, the Normal value is used from the alarm class assigned.

To display the alarm class definition

From the Component Editor Tree View, double-click the top level item to
display the following window.

3-80 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Diagnostic Alarm Severity

The Diagnostics Severity is edited in the General tab Property Editor for each
configured component. For variables, the severity is used based on the alarm class
assigned to the variable. If no alarm class is assigned, the default alarm class is used
based on the alarm type.

To display a component diagnostic definition

From the System Editor Tree View, double-click each component to display
the following window.

Diagnostics
Severity items.

The OPC AE Server is configured as a feature of the WorkstationST component.

To configure the OPC AE Server

1 From the General tab Tree View, click the Features item.
2 From the Summary View, click the Enabled column for Alarm Server and
OPC AE Server, then select True for each. The Alarms and OPC AE
Server tabs display.

Note The Alarm Server must be enabled for the OPC AE Server to be used.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-81

 3 From the Tree View, click the Consumed Devices item, then select all
components from which the alarm server and OPC AE Server will receive
alarms and events.

4 Click the Alarms tab to verify that the necessary options have been set. There
are no options defined here that affect the operation of the OPC AE Server.

3-82 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 5 Click the OPC AE Server tab, then from the Tree View, select Publish
Settings. All alarm and event types are published by default. These settings are
for each consumed device.

The WorkstationST can be built and downloaded. Use the status monitor to check
the running health of the OPC AE Server. The DCOM configuration settings may
need to be modified for the GeCssOpcAeServer application before external clients
may successfully connect.

Data Update Rates

When a client connects to the OPC AE Server, update notifications rates can be
specified. The OPC AE Server imposes a restriction on this rate and this restriction is
returned when the subscription is created by the client. The maximum number of
events that will be sent in one notification is 1024.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-83

Recorder Tab
The Recorder tab is used to configure the WorkstationST recorder feature. The
Recorder collects and saves data values from the system components. The data is
saved in a Data Collection and Analysis (.dcaST) file format.

Data values are available from the following sources:

• EGD through the OPC DA Server

• Component capture buffers
• Directly from the component through SDI
The root directory where recorder files are created is shown below in the Tree View.

The Outline View contains an entry for each component selected on the General tab.
A system entry will be created for collecting data from multiple components.

3-84 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Collections
Within the component, data can be configured to be automatically collected by the
Recorder.

Signals on the EGD network are automatically routed to a continuous live collection
if their short-term dead band property contains a value.

For components with an Upload Type property on the Capture Buffer, setting this
property to Automatic creates a collection for this capture buffer. Setting the
property to Trip creates a Trip Log that includes this capture buffer.

A capture buffer collection is automatically created for the Power Conversion

components.

Automatic collections only allow modification on the storage, scan rate, and
description properties. All other modifications must be done in the component.

User defined collections are configured from the Recorder Tab.

Adding a Collection
To add a collection

1 From the Tree View, select the desired device.

2 Click the right-mouse button, then select Add Collection.
3 From the drop-down list, select the collection type.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-85

 Live Data
The Live Data collection collects data samples continuously during and/or after an
event. An example of a continuous sampling is as follows:

3-86 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Communication

Source is the network (Ethernet through the OPC DA server) over which data
values are obtained.

General

Method is the method, either Automatic or Manual, used to configure this

collection.

Type is the type of collection (Live Data)

Life Span

Disk Usage is the amount of disk space, in megabytes, that this collection is
allowed.

Storage Time is the time, in days, that the files are maintained on disk.

Setup

Description provides a description of the collection.

Method is the method, either Triggered Level or ContinuousLiveData, used for data
collection.

Name, the collection name, is used as part of the file name.

Scan Rate is the rate, in milliseconds, that the data is scanned for changes.

Variable Count is the number of variables in the collection.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-87

 Triggered Sampling

Trigger Setup

Mode is the mode by which the trigger variable is triggered.

Post-Sample Time is the amount of time, in seconds, that data is collected after
the trigger occurs.

Pre-Sample Time is the amount of time, in seconds, that data is collected before
the trigger occurs.

Threshold is the threshold value.

Trigger is the variable used to trigger the collection.

Variable Count is the number of variables in the collection.

3-88 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Trip Log
Trip logs contain data from capture buffers along with data collected for each
variable defined in the capture buffers for the previous 24 hours.

General

Method is the method, either Automatic or Manual used to configure this collection.

Type is the type of collection (Trip Log).

Setup

Description provides the description of the collection.

Name, the collection name, is used as part of the file name.

Variable Count is the number of variables in the collection.

Note The last 30 trips are maintained on disk.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-89

 Capture Buffer
Capture buffers are high-speed data buffers located in the component. The Capture
Buffer collection uploads and writes to the buffer specified by the status variable in
the collection.

CSV File Setup

Characters Per Line is the number of characters the printer can fit on one line.

Create CSV File creates a Comma Separated Value (.csv) file in addition to the
.dcaST file.

Print CSV File prints the .csv file.

Printer is the printer location for the .csv file.

Variable Count is the number of variables in the collection.

3-90 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Deleting a Collection

To delete a collection

1 From the Tree View, select the collection to be deleted.

2 Click the right-mouse button, then select Delete from the drop-down list.

Note Removing a component from the Tree View causes that component and all of
its collections to be deleted. An automatic collection can only be deleted by removal
from the component’s configuration.

Adding a Variable

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-91

 To add a variable

1 From the Tree View, select the collection to which a variable will be added.
2 Click the right-mouse button, then select Add Variable.

3 Select the variable(s) from the variable browser.

4 Click OK to add the variables.

Deleting a Variable

3-92 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 To delete a variable

1 From the grid, select the variables to be deleted.

2 Click the right-mouse button, then select Delete Selected Row(s).

Refreshing a Collection
The Refresh command reloads the automatic collections from a selected component
or for all the components, if selected from the Recorder tab.

Modbus Tab
Modbus is an application layer messaging protocol for client/server communications
between components connected on different types of busses or networks. The
WorkstationST application supports both serial and Ethernet communication, and
can operate as both a Master and a Slave. Refer to GEI-100696, WorkstationST
Modbus, for detailed information.

Historian Tab
The WorkstationST Historian is the configuration interface between ToolboxST and
WorkstationST components and third-party Historian systems used for collecting
long-term data from the system components. Refer to GEI-100628, WorkstationST
Historian for detailed information.

Ethernet Global Data (EGD) Tab

The Ethernet Global Data (EGD) protocol allows you to share information globally
between controller components (sometimes known as nodes) in a networked
environment. EGD allows one controller component, referred to as the producer of
the data, to simultaneously send information to any number of peer controller
components (consumers) at a fixed periodic rate. This network supports a large
number of controller components capable of both producing and consuming
information.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-93

 EGD Configuration
To configure EGD for a WorkstationST

1 From the WorkstationST Component Editor, select the EGD tab.

2 In the Tree View, select Ethernet Global Data. The Ethernet Global Data
properties display in the Property Editor.

The following properties display in the Property Editor when Ethernet Global Data is
selected in the Tree View:

Collection controls the collection to which this EGD component belongs when
viewed in the EGD management tool (EMT). Refer to GEI-100625, Ethernet Global
Data (EGD) Generic Editor.

Producer ID sets and displays the EGD Producer ID for this component. This is
assigned when the component is created. The Property Editor displays the EGD
Producer ID formatted as an unsigned integer, but dotted and hexadecimal

representations are available by clicking the ellipsis button.

Produced Pages
Produced Pages are data sets configured to be available to other components on the
network.

To add a new Produced Page

1 From the Tree View, right-click the Produced Pages item, then select Add
Page.
2 Enter a unique name for the new page in the Page Name dialog box, then click
OK.

To delete a Produced Page

From the Tree View, right-click the page you wish to delete, then select
Delete.

3-94 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Editing Produced Pages
To configure a Produced Page
From the EGD tab Tree View, expand Ethernet Global Data.

Under Produced
Pages, select the
desired page.

The page properties

display in the
Property Editor .

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-95

 The following properties are available for configuration when a Produced Page is
selected in the Tree View:

Ethernet 0, if selected, broadcasts EGD on Ethernet 0. (If more than one Ethernet
Adapter has been configured for EGD, additional Ethernet properties display.)

Mode, when set to Broadcast, sends the page to all EGD nodes. When set to Unicast
or Multicast, the page is only sent to a single destination.

Exchanges indicate the number of exchanges in the selected page. It is updated

after a build.

Redundancy is the redundancy mode for the produced exchanges in this page.

Address Zero Health, when set to True, prevents the health of the produced
exchange from being affected (except by a variable at offset 0).

Health Timeout Multiplier gets or sets the timeout multiplier for all produced
exchanges within this page. Setting this property to zero means each exchange is
always healthy.

Layout Mode if set to Auto, exchanges numbers and automatically assigns offsets
at build time. If it is set to Manual, exchange numbers and offsets can be entered
manually.

Minimum Length sets the Minimum Length of the exchanges on this page. Some
components look only at the length of the exchange. This property can be set to a
value larger than the current size of the exchange so that as variables are added, the
component continues to receive the exchange.

Name uses this property to rename the selected page.

Period indicates the transmission period of the page in milliseconds.

Skew is used to prevent exchanges with the same period from being produced at
exactly the same instant. The skew for the first exchange in the page is set to this
value, and each additional exchange skew differs from the previous exchange’s skew
by exactly this value. For example, if you have three exchanges in a page and a skew
value of 2, the first exchange’s skew is two, the second exchange’s skew is four and
the third exchange’s skew is six. (The skew property is measured in nanoseconds.)

Starting Exchange ID is used for the first exchange on this page. Each additional
exchange will be incremented from this number. When this property is changed, all
exchanges are renumbered.

3-96 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Page Compression
When a page compression is performed, the variable locations are optimized. The
variables are located in increasing size order, starting with Booleans, then Words,
Double Words, and finally all other variables.

To compress a single page

From the Tree View, right-click the page to compress, then select Compress.

To compress all Produced Pages in a component

From the Tree View, right-click Produced Pages, then select Compress
All.
Variables
To add a variable to an EGD page

1 From the Component Editor, select the EGD tab.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-97

 2 From the Tree View, right-click the desired page, then select Add Variable to
display the Select a Variable dialog box.

From the Select a Variable

dialog box, select one or more
variables, then click OK.

The Summary View updates to display

the new variables. The Exchange IDs and
Locations are assigned during the build.

3-98 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Tip If the variable to be added to the EGD page is already in use on the OPC DA
Server tab, you can add the variable without using the EGD tab. To add a variable
from the OPC DA Server tab, select the desired variable(s) in the Summary View,
then set the EGD Page property using either the Summary View or the Property
Editor.

To delete a variable from an EGD Page

From the Summary View, right-click the variable to delete, then select Delete
Selected Row(s).

To copy variable information from an EGD Page to the clipboard

From the Summary View, right-click a variable, then select Copy
Selected/Current Row(s). The data is copied in Comma Separated Value
(.csv) format.

Editing Exchange Signatures and Configuration

Time
Normally, the exchange signature is managed automatically. The major signature
must be incremented when the exchange content changes in any way other than
additions to the end. If you are using the EGD Device Editor to configure EGD for a
device and the device signature changes only when the manufacturer updates the
configuration, you may need to manually set the signature.

Note To edit exchange signatures and configuration time, set Layout Mode to
Manual.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-99

 To edit exchange signatures and configuration time

1 From the EGD tab, select the Configuration tab, then select a Produced
Page in the Tree View.
2 Right-click an exchange in the Summary View, then select Edit Exchange
Signatures and Configuration Time.

3 Review the warning about manual Exchange Signature editing, then click
OK.
4 Make any desired changes to the signatures and configuration time, then click
OK to close the dialog box.

3-100 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Referenced Devices
The EGD variables defined in other components can be added to the current
component’s variable list by adding a reference. References can only be created to
EGD-capable devices that are producers of pages.

To select referenced devices

From the Tree View, right-click the Referenced Devices item, then select
Select Devices to display the Select Devices dialog box.

Select or clear the

check boxes next
to each component
name. Click OK.

The EGD configuration for the selected devices are loaded and the variables display
in the Summary View.

Grayed
exchanges are
not available to
this component.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-101

 When EGD configurations are edited in remote devices, refresh the configuration to
ensure that the latest variable information is used. A refresh automatically occurs
when a WorkstationST component is opened, and when it is built.

To refresh the configuration of a referenced device

In the Tree View, right-click the device to be refreshed, and select Refresh.

EGD Diagnostics
The EGD protocol includes a Command Message Protocol (CMP) to obtain the
status of a Class 2 or higher EGD device. WorkstationST is a Class 3 EGD device.
When any EGD item in the Tree View other than a referenced device is selected, the
EGD Statistics from [Device] tab displays the statistics from the open component.
When a Referenced Devices item is selected, the statistics are obtained from that
device, and the name of the tab page changes accordingly.

Note You must be online to view diagnostic information.

3-102 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Status columns in the Summary View include the following:

Exchange is the Exchange identifier <device name>.<exchange number>.

Configuration Time is the time that the exchange was configured.

Due Time is the time that a consumer data packet must be received for an exchange
to remain valid.

Status is the health of the exchange.

Length is the value for a produced exchange. This length may be the highest
variable offset in the exchange or the highest offset of a variable, which may have
been removed. For a consumed exchange, the value may be the highest variable
offset used or the length of the produced exchange, depending on the bind algorithm
of the individual tool.

Message Count is the number of data production packets produced or consumed

since initialization.

Missed Count is the number of data production packets missed since initialization.
A missed packet occurs when a data production message is received that has a
request ID greater by more than one than the last message received (accounting for
counter roll-over).

Refresh Errors are the number of times a refreshment fault has occurred. A
refreshment fault occurs when a subsequent data production packet (or initial packet
at startup time) does not arrive at a consumer within a pre-defined update period.

EGD Packet Logging

The WorkstationST Runtime allows EGD messages to be logged to a limited size
queue (10000 messages) for a limited time (two minutes maximum). The
WorkstationST Component EGD section contains an EGD Packet Log tab that
allows for:
Starting the collection of EGD messages

Stopping the collection and uploading the data

Enabling the translation of the data in the Source Address column to a host
name with a Tool Tip. This translation can take some time, so the feature is only
enabled upon request.
Saving the data to csv format

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-103

 When the collection is started, the runtime will begin storing all EGD messages
received. When the queue gets full, old messages are deleted. When the UI stops the
collection and uploads the data, all messages display in the grid.

The collection status displays in the status bar.

The following columns of data are available:

Receive Time is the UTC time when the message was received.

Source Address sources the IP Address.

Producer ID Dotted is a four-byte unsigned integer that uniquely identifies the

producer of an exchange in a given network. This ID is used by the protocol to
identify the node (or set of redundant nodes), so even nodes that do not produce any
data must be assigned a unique Producer ID. The Producer ID value is generally
assigned by a configuration tool set to the IP address of the producing node (in
network-byte order) by default. Where displayed in dotted decimal form, the
Producer ID is treated as a four-byte field whose data is in network-byte order.
Where displayed in any other form, the Producer ID is treated as a four-byte little-
endian unsigned integer value (example: 3.4.5.6 = 0x06050403 =
100992003).Producer IDs of 0 and of 0xFFFFFFFF are reserved and cannot be used.
Multiple nodes in a redundant system may use the same producer ID. For the
purposes of this specification, the redundant system may be treated as a single-
producer node. Controlling what devices within the redundant system are producing
EGD is a local matter within the redundant system.

3-104 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Producer ID is a four-byte unsigned integer that uniquely identifies the producer of
an exchange in a given network. This ID is used by the protocol to identify the node
(or set of redundant nodes), so even nodes that do not produce any data must be
assigned a unique Producer ID. The Producer ID value is generally assigned by a
configuration tool set to the IP address of the producing node (in network-byte order)
by default. Where displayed in dotted decimal form, the Producer ID is treated as a
four-byte field whose data is in network-byte order. Where displayed in any other
form, the Producer ID is treated as a four-byte little-endian unsigned integer value
(example: 3.4.5.6 = 0x06050403 = 100992003). Producer IDs of 0 and of
0xFFFFFFFF are reserved and cannot be used. Multiple nodes in a redundant system
may use the same producer ID. For the purposes of this specification, the redundant
system may be treated as a single-producer node. Controlling what devices within
the redundant system are producing EGD is a local matter within the redundant
system.

Exchange ID is a four-byte unsigned integer that uniquely identifies a particular

exchange definition on a specific producing node. The most significant two bytes of
the Exchange ID must be zero for version 3.04 of the protocol. Pre-defined static
exchanges are assigned a value between 1 and 16383 (0x3fff). The value of bits 14
and 15 (the high order bits in the lower half of the long word) are normally 0, but
may be used to differentiate normal static exchanges from those defined during
runtime.

Bit 15, 14 meaning

0,0 = Static Exchange

0,1 = Reserved

1,0 = Logic Driven Exchanges

1,1 = Reserved

Major Signature is the major number reflecting the primary exchange format, and
must be equal in both Producer and Consumer. Truncating or rearranging data within
an exchange is not backward-compatible and requires a change in the major number.

Minor Signature is the minor number reflecting backward-compatible

modifications made to the format of an exchange, such as adding more variables to
the end of the data portion.

Time Stamp is a time value in POSIX 1003.4 timespec format (32-bit unsigned
integer seconds followed by 32-bit nanoseconds) correlated with the data contained
in the message. The nanoseconds field is limited to values greater than or equal to 0,
and less than 1000000000.

Production Status Flags are bit marks that indicate the validity of the data
sample produced: Bit 0: Set if production error or invalid (old) dataBit 1: Set if
timestamp is not synchronized on producer node (see Table 5: Consumed Exchange
Conditions) Bit 2: A producer that knows of a pending configuration change may set
this to 1 until the configuration change occurs. Otherwise 0.

Config Time is the timestamp of the configuration.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-105

 PDU Type are the data and command messages transmitted using the UDP/IP
protocol, defined in terms of Protocol Data Units (PDUs).

Data_Production 13. / 0x0d

RDS_Query 0

Retrieve_Configuration_Rqst 3. / 0x03

Retrieve_Configuration_Resp 4. / 0x04

Summary_Rqst 7. / 0x07

Summary_Resp 8. / 0x08

Capabilties_Rqst 9. / 0x09

Capabilties_Resp 10. / 0x0A

Statistics_Rqst 15. / 0x0F

Statistics_Resp 16. / 0x10

Command_NAK 18. / 0x12

Read_Rqst 32. / 0x20

Read_Resp 33. / 0x21

Write_Rqst 34. / 0x22

Write_Resp 35. / 0x23

Masked_Rqst 36. / 0x24

Masked_Resp 37. / 0x25

Dynamic_Bind_Status Rqst 40. / 0x28

Dynamic_Bind_Status_Resp 41. / 0x29

ApplicationSpecific_Req 240. / 0xF0

ApplicationSpecific_Resp 241. / 0xF1

Reserved for RDS Statistics_Rqst 254. / 0xFE

Reserved for RDS Statistics_Rqst 255. / 0xFF

PDU Version Number is the Protocol Version Number identifying the PDU
format. It must be set to 1.

Message Number is the Request ID or message number maintained by the

application layer used to identify unique messages and associate response messages
with their requests.

Message Bytes are the total number of bytes, including header and data.

Data Bytes are data message bytes, excluding header.

3-106 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Number Data Bytes are the number of data bytes in the message. (Total message
size minus 32-byte header).

Reserved 1 is reserved.

Reserved 2 is reserved.

EGD Configuration Server Reports

With the System item selected in the System Editor, set the EGD Config Server
Enable to True in the Property Editor. Refer to Chapter 2, System Configuration , the
section System Database (SDB) . When enabled, the Produced Pages item has two
additional menu items, Compare and UnConsumed Data.

Compare command compares the component's EGD-produced data configuration

with the EGD configuration server’s content.

UnConsumed Data command generates a report showing variables produced by

this component that are not listed in any other device’s consumed data file.

Note You can select devices to search against. The individual pages, with just
variables, perform the same Compare.

The Referenced Devices item on the EGD tab also has a Compare command that
compares the consumed variable information for the open component against the
EGD configuration server’s content.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-107

 Global Variables
The Global Variables window displays all controller variables that have been
configured as Global in one central location.

To display the Global Variables window

Open a WorkstationST. From the View menu, select Global Variables.

The Property Editor displays Click to toggle between a display of

properties for the currently all global variables and a display of
selected row in the data grid. only modifiable global variables.

The Global Variables window is particularly useful when you want to modify a
property for multiple variables. For example, to move multiple variables onto an
EGD page, select the rows for the desired variables and then change the EGD Page
property in the Property Editor. Refer to the section, Data Grids.

Because only existing global variables can be changed, new variables cannot be
added from the Global Variables window. You cannot make any change that affects
the name of the global variable (like Name or Global Name Prefix). Finally,
variables from an instanced library user block can only be modified if the Merge
Variables at Instance property of the Programs item on the Software tab is set to
True.

3-108 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Watch Windows
A Watch Window is a collection of variables that display, along with their attributes
and live values, in a stand-alone window. The Watch Windows feature can also be
accessed from the ToolboxST System Editor, as well as from the individual
Component Editors. Once a Watch Window is created, it can be exported to .xml and
.csv files.

To open a stand-alone Watch Window

From the Start menu, select All Programs, GE ControlST, ToolboxST,
and Watch Window.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-109

 To open a Watch Window from the System Editor
From the Tree View, right-click the system and select Insert New. From the
sub-menus, select Tool and Watch Window.

The New Watch Window dialog box displays.

Enter a Name for the

Watch Window, add a
Description ( optional),
then click OK.

3-110 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 The Watch Window displays as an item in the Tree View.

Add Variable Remove Selected

Export button Import button button Variable(s) button

Note If this is the first time the Watch Windows dialog box has been opened for the
selected component, the list is empty. Add or import a new Watch Window.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-111

 To open an existing Watch Window
From the System Editor Tree View, right-click the system and select Insert
Existing. From the sub-menu, select Watch Window.

The Watch Window dialog box displays.

To open a Watch Window from a Component Editor

1 From the View menu, select Watch Windows.

3-112 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 The Watch Window dialog box displays.

2 From the Watch Window dialog box, either add a new Watch Window or
double-click to open an existing one.
Adding a Variable
Use the Add Wizard to add a variable to a Watch Window.

To add a variable

1 From the Tree View, double-click a Watch Window to open it.

2 From the Edit menu, select Add Variable and Using Add Wizard…

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-113

 The Add Item Wizard displays.

Click the Next button to continue.

Select the data

source from which
to add the variable,
then click Next.

3-114 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 If you selected
System Component
in the previous
screen, select the
desired component
from the drop- down
list, then click Next .

Click the Add

button to
display the
Select a
Variable
dialog box.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-115

 From the list, either
double-click a
variable, or select
one and click OK.

To remove a
variable, select it
and click the
Remove button.
When all variables
have been added,
click Finish.

3-116 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 Managing Variables
Once a variable has been added to a Watch Window, right-clicking the variable
allows you to perform the following actions.

Add Variable allows you to add additional variables.

Select All selects all variables for removing, pasting, or copying to the clipboard.

Remove Variable(s) removes selected variables.

Go to Definition allows you to display the variable definition from it’s location.

Change Live Value allows you to change the live value when the Watch Window
is online with the controller.

Copy to Clipboard allows you to copy the selected variable to the clipboard.

Paste allows you to paste a variable to another location, such as a Trender.

Add to Trender allows you to add selected variables to a Trender.

Organizing Watch Window Columns

To organize columns in a Watch Window

From the View menu, select Organize Columns from the drop-down list. The
Organize Columns dialog box displays. Refer to Chapter 4, the section
Organizing Columns.

Forcing Live Values

Logic forcing procedures can result in personal injury or
death, if not strictly followed. Only adequately trained
personnel should modify any programmable machine.
Forcing of control logic for an operating process is strongly
discouraged.
Forcing of protective functions is never permissible for an
operating unit. All safety measures should be strictly
enforced in conjunction with this procedure.

To force the live value of a variable

1 From the Watch Window, double-click the live value of a selected variable.
The Send Value dialog box displays.
2 Enter the desired value, select the Force Value check box, then click Send
and Close.

The forced value is sent to the controller.

Reconciling Constant Differences

The Reconcile Constant Differences feature allows you to synchronize the live value
and the initial value for constants. The live value is the value of the constant
currently being used in the running controller. The initial value is the value of the
constant in the ToolboxST configuration.

Note The initial value for a variable is not available from the OPC Server.

GEH-6706G ToolboxST Chapter 3 WorkstationST Component Editor • 3-117

 To reconcile differences in the constants

1 From the File menu, select Reconcile Constant Differences. The

Constants Reconciliation dialog box displays all constants in which the
Live Value and the Initial Value are different.
2 Select the check box next to the correct value to synchronize the constant, then
click OK.

The constants are synchronized as follows.

• For constants in which the Initial Value was checked, the Initial Value is sent to
the controller, making the Live Value equal to the Initial Value.
• For constants in which the Live Value was checked, the Initial Value is set equal
to the Live Value.

Drag-and-Drop
Variables can be moved to other windows and editors using the drag-and-drop
feature. For example, you can drag:

• A block pin from the Block Diagram Editor, and drop it into a Watch Window.
• A variable in the Watch Window to a block pin on the Block Diagram Editor,
forming a connection.
• A variable from one Watch Window to another Watch Window, copying the
selected variable into the target window.

Importing and Exporting

Watch Windows only exports A Watch Window can be saved to either an .xml or a .csv file, which can then be
grid columns necessary to imported into another component. This allows you to use a previously selected
retrieve variable information. collection of variables.
As an example,
DatasourceName from the To export a Watch Window to an .xml file
exported file is used to retrieve
the variable’s remaining 1 From the Watch Windows dialog box File menu, select Save As. The Save
properties from the system. Watch Window File dialog box dipslays.
User-defined columns such as 2 Select the desired destination, then click Save.
User Comment are also
included. To export a Watch Window to a .csv file
1 In the Watch Windows List dialog box, select the desired Watch Window,
then click the Export button. The Export Watch Windows dialog box
displays.
2 Select the desired destination, then click Save.
To import a Watch Window from a .csv file

1 In the Watch Windows List dialog box, click the Import button. The Import
Watch Windows dialog box displays.

2 Select the desired .csv file, then click Open.

To add a .watch file

1 From the Watch Windows List dialog box File menu, select Add Existing.
The Add Existing Watch Window dialog box displays.

2 Select the desired .watch file, then click Open.

3-118 • Chapter 3 WorkstationST Component Editor GEH-6706G ToolboxST

 CHAPTER 4

Chapter 4 Working Online With

WorkstationST

The WorkstationST Runtime features include Monitoring, Data Collection, Alarm

Collection, and Human Machine Interface (HMI). The WorkstationST Service is one
of two processes with which toolbox interfaces to obtain status and live data, and to
perform downloading.

The ToolboxST configuration is the maintenance software tool for WorkstationST

platforms.

Connecting to a WorkstationST
To connect to a WorkstationST
From the System Editor, open a WorkstationST Component Editor.
From the Device menu, select Online.
-or-
From the System Editor, open a WorkstationST Component Editor.
From the toolbar, click the Online button.
The WorkstationST Service provides a command for obtaining feature status, and
sending download requests. Live Data Connection provides live data values for
WorkstationST-monitored variables. The OPC DA Server Service of WorkstationST
Runtime provides the live data connection. When the WorkstationST Component
Editor connects to the WorkstationST Runtime, both the command connection and
the live connection are established.

The Status tab shows information about the running WorkstationST platform.

GEH-6706G ToolboxST Chapter 4 Working Online With WorkstationST • 4-1

Status Tab
When the ToolboxST configuration is connected to a WorkstationST, operating state
and equality information is available from the Status tab of the Component InfoView
window. This view is identical to that of the local workstation status monitor, which
provides a tray icon control with status viewed on the local workstation.

Colored text is used to display state information at a glance. Green indicates a

normal state.

Color Conditions
Green All features functioning normally.
Yellow One or more of the following:
- There is a minor configuration difference
between the tool and runtime.
- One or more features has a warning.
Red One or more of the following:
- There is a minor configuration difference
between the tool and runtime.
- One or more configured features is not running
or has a fault.

Downloading to WorkstationST
The ToolboxST configuration defines the features of the WorkstationST. The
WorkstationST runtime has a WorkstationST service, which receives the download
request. It expands the zipped download file into the computer's configuration folder
(c:\Config by default). After a bind of consumed EGD configuration is performed,
all running WorkstationST features are informed of a completed download through a
workstation intercom message.

WorkstationST Initial Setup

The WorkstationST install package installs the WorkstationST Service, as well as
any other features (such as the OPC DA Server and the EGD Configuration Server)
required for your application. Once the WorkstationST Service is installed and
running, download the application configuration.

4-2 • Chapter 4 Working Online With WorkstationST GEH-6706G ToolboxST

 Download Wizard
The Download wizard is the primary method of transferring application software to a
WorkstationST over an Ethernet connection. The wizard can automatically examine
the system configuration to locate out-of-date software, or you can manually select
individual items to download.

To download software to a controller

1 Open a WorkstationST Component Editor. From the Device menu, select

Download to display the Download WorkstationST wizard.
2 If you have changed configuration settings since the last Build operation, a
message box displays indicating that the software is out of date. Click Yes to
build the current configuration. The Download WorkstationST wizard
opens.

GEH-6706G ToolboxST Chapter 4 Working Online With WorkstationST • 4-3

 Click the Next button to advance past the wizard’s introductory page.

Click the Scan button to

examine the system
configuration and locate
out-of-date software. This
operation automatically
selects any software items
that need to be
downloaded.

If checked, software
identified as up-to-date
is displayed.

When the appropriate

software is selected for
download, click the Next
button. Review the warning
that displays, then click
Next again to display the
download page.

Click Start to begin the

download process.

4-4 • Chapter 4 Working Online With WorkstationST GEH-6706G ToolboxST

 Displays the overall
progress of the
download.

Displays the progress

of the current file
download.

When the download has completed, click Finish to close the wizard. In the
Component InfoView, click the Log tab and review the status messages to check
for potential warnings or errors that may have occurred during the download.

GEH-6706G ToolboxST Chapter 4 Working Online With WorkstationST • 4-5

Notes

4-6 • Chapter 4 Working Online With WorkstationST GEH-6706G ToolboxST

 CHAPTER 5

Chapter 5 Finder

The Finder is a separate window in the toolbox, which contains several useful tools.
It can help you find items, such as text, overrides, differences, and variable usage
from the different types of components.

To open the Finder

From the toolbar, click the Finder button.

-or-
From the Edit menu, select Find.

Enter text to Select a Click to display

Select Match search for search type available wildcards
Case to Click Find to
distinguish begin search
between upper process
and lower case
in the search Click Replace
Select to for options to
include variable replace text
descriptions in
the search Select Entire
System to search
Select to include every component in
libraries in the the System Editor
search if a library
editor is open Select Open
Select to Components to
include block search all those
diagram items open in the
in the search System Editor
Select to search inside Select to keep Select to search Select to search
blocks below the current Finder open inside the current inside the currently
location. If not selected, only between searches component selected item
the current level is searched.

When a search is completed, the results display on the Find Results tab of the
Component InfoView. To jump directly to a location, double-click it in the list.

GEH-6706G ToolboxST Chapter 5 Finder • 5-1

Find Methods
A variety of find methods are available that control how the text entered in the Find
box is matched to text in the ToolboxST application.

Anywhere finds the specified text anywhere within a searchable text string.

A search for matches but does not match:

abc abc abdc
abcde ab
xyzabc bc
zabcz

Begins with finds the specified text only at the beginning of a searchable text
string.
A search for matches but does not match:
abc abc xyzabc
abcde abdc
ab
bc

Ends with finds the specified text only at the end of a searchable text string.
A search for matches but does not match:
abc abc abcde
abdc
xyzabc ab
bc

Match Exactly finds the specified text only when it is exactly equal to an entire
searchable text string.
A search for matches but does not match:
abc abc abcde
xyzabc
abdc
ab
bc
abc cde

Match Whole Word finds the named text only when it is exactly equal to an entire
word of a searchable text string, meaning it is surrounded on both sides by either
punctuation or white space.
A search for matches but does not match:
abc abc abcde
abc cde xyzabc
spell your abc's. abdc
ab
bc
spell your abcs.

5-2 • Chapter 5 Finder GEH-6706G ToolboxST

 Wildcards is similar to Match Exactly, except any single letter can substitute for a ?
character and any sequence of zero or more letters can substitute for a * character.
A search for matches but does not match:
a?c abc abdc
adc bc
abc cde
abcde
xyzabc
a* abc bc
adc cde abc
abcde
abdc
ab
abc cde

Regular Expressions processes the text entered in the Find box as a regular
expression (sometimes abbreviated regex). A regular expression is an advanced
system of wildcards used to match a specific set of text. The ToolboxST
configuration supports a standard set of regular expression commands similar to
many popular third-party tools. While a detailed discussion of regular expression
syntax is out of the scope of this document, there are many excellent books and
online resources available with details about regular expressions.
A search for matches but does not match:
[cvrm]at cat sat
cats bat
vat
rat
mat
(Mon|Tues|Wednes|Thurs|Fri)day Monday Saturday
Tuesday Sunday
Wednesday Fries
Thursday
Friday
Fridays
var[0-9]+ var0 varx
var9 var7a
var7 var
var48
var[a-zA-Z]* var var5
variable var!
varZZZZ

GEH-6706G ToolboxST Chapter 5 Finder • 5-3

Replace Options
Besides performing simple searches, the Finder also supports search-and-replace
operations.

To display the Replace options

In the Finder window, click the Replace button. The window expands to
include new options.

In the Replace With: The Replace button replaces The Find First button
text box, add the text the currently displayed Find navigates to the next
to be substituted text with the Replace With text occurrence of the Find text

Select to keep the Replaces all occurrences

Finder open between of the Find text with the
searches Replaced With text

5-4 • Chapter 5 Finder GEH-6706G ToolboxST

 CHAPTER 6

Chapter 6 Trender

The Trender is a tool used to capture and display trend graphs of variables in the
system. It can collect and display values in real time from controllers and other
sources, and can display data collected by high-speed coherent data collection
systems, such as capture buffers and dynamic data recorders. The Trender also can
display previously captured data from a saved data file.

Accessing a Trender Window

Before you can analyze data trends, you must first open a Trender window. A
Trender window displays a collection of traces and data that is saved between uses.
You can open a Trender window from inside the ToolboxST application or
separately from the Start menu. If you open a Trender window from inside the
ToolboxST application, the window is stored inside a component or the system, and
you can create as many Trender windows as necessary. If you open the Trender from
the Start menu, files are saved with a .trend file extension.

To create a Trender window outside the ToolboxST application

From the Start menu, select All Programs, GE Control ST, and
ToolboxST. Click Trender. A new Trender window displays.

GEH-6706G ToolboxST Chapter 6 Trender • 6-1

 To create a Trender window from the System Editor
From the Tree View, right-click the system name, then select Insert New,
Tool, and Trender. A new Trender window displays.
To create a Trender window from a Component Editor
From the Component Editor, click Device and select Trenders. A new
Trender window displays.
To save a Trender window
From the Trender toolbar, select the Save button. If you opened the current
Trender window from within the ToolboxST application, the Trender window
saves automatically. If you opened the Trender window from the Start menu,
the Trender window saves to a file.

Note While Trender windows opened from the Component Editor are associated
with one particular component for storage purposes, they are not restricted to
trending only that component, and may be used to monitor any variables.

Trender Window Features

Trender toolbar
contains commands
for commonly used
tasks in the Trender
window.

Graph View
contains the trend
graphs, which
display the values
represented by
each trace.

X-Axis markers
designate alarm
and event times.
Property Editor
allows you to change
settings that affect the
capture and display of
data.

Data toolbar
contains commands
that manipulate the
current data.
User Note tab Sources tab Events tab lists Auxiliary View Mode Indicator
Traces tab allows you to save displays sources all events that contains tabs that displays the
displays traces comments, where data is have occurred display current mode
currently being instructions, and collected. during the information about (Live or Replay).
monitored by the notes about the current chapter. the current data.
Trender window. current chapter.

6-2 • Chapter 6 Trender GEH-6706G ToolboxST

 Trender Toolbar
Note The Trender toolbar may have fewer buttons if the current Trender window
was opened from the ToolboxST application.

Open existing Save current Undo Redo

Trender window Trender

Create new
Trender Window

Print Print Preview Go Online

Data Toolbar
Note The buttons available on the Data toolbar may vary according to the current
trace source type.

Record data from Add traces Time Axis Reverse

live source & Forward

Pause Remove Zoom In & Auto-range

selected traces Zoom Out selected traces

Working in Trender
Acquiring Data
Before you can analyze data, you must import it into a Trender window. Variables
can be added to the Trender window live, from capture buffers, or from static files.
While you may add as many variables as you like to a given Trender window, all of
them must come from the same type of data source. (For example, you cannot
display both live and static file variables simultaneously.)

Adding Traces
The Trender represents each variable with a trace. (The term trace is used since the
Trender works similarly to a digital storage oscilloscope, which displays data by
tracing a line across the screen as values are acquired.) As you add traces to a
Trender window, the new traces display in the Traces Tab. (Refer to the section,
Traces .)

GEH-6706G ToolboxST Chapter 6 Trender • 6-3

 To add traces

1 From the Edit menu in the Trender window, select Add Traces. If there are
currently no traces on the Trender, the Trender – Add Trace Wizard
Welcome screen displays. From the Welcome screen, click Next to continue.
2 From the following wizard screen, select the data type you wish to trend.

Historical data is stored in all

Historians associated with the
currently configured controller.

Static data is stored in .csv files in

the currently configured controller.

3 From the next wizard screen, select the data source from which to add the
variables to trend.

4 From the next wizard screen, select the specific component from which to select
the variables to trend.

5 From the next wizard screen, select the time period at which the variables will
trend.

6-4 • Chapter 6 Trender GEH-6706G ToolboxST

 The final wizard screen allows you to select variables to trend.

Click the Add button to display the

Select a Variable dialog box.

Select a variable,
then click OK.

GEH-6706G ToolboxST Chapter 6 Trender • 6-5

 The selected variable displays in the wizard
screen. Click the Add button.

If there are already traces on the Trender, you can add additional traces from the
same component.

To add additional traces

1 From the Edit menu, select Add Traces. The Select a Variable dialog box
displays available variables for that component.
2 Add variables from a different component by clicking the drop-down button
next to the Add Traces button.

Note You can add traces from the currently selected component or add traces from a
new component by selecting Add using Add Trace Wizard from the drop-down list.

The selected variable displays in the Traces tab in

the Trender window’s Auxiliary View.

6-6 • Chapter 6 Trender GEH-6706G ToolboxST

 Live Trends
When a Trender window contains live trends, it displays the incoming data onscreen
in real time. Live trends are useful for monitoring systems in continuous operation.

To add one or more traces from a live source

1 If the Trender window to which you would like to add the trace is not already
open, refer to the section, Accessing a Trender Window .
2 From the Edit menu, select Add Traces. (or click the Add Traces button on
the data toolbar). If there are already traces on the trender, the Select a
Variable dialog box for the current data source displays, which you can use to
select the variables to monitor. If there are no traces on the trender, the Add
Trace Wizard displays. If there are traces and you would like to add traces for
a different live data source, you can also invoke the Add Trace Wizard by
clicking the drop-down list attached to the Add Traces button.
3 If this is the first trace added to the Trender window, the Add Trace Wizard
prompts you for the type of trend to configure. Select Live, then click Next.
4 Select System Component, then click Next.
5 If you did not open the current Trender window from the ToolboxST
application, the Add Trace Wizard prompts you for the name of the system
file that contains the source component. Click the Browse button to locate the
system file, then select Next.
6 Select the component from which you wish to trend variables, then click Next.
7 Select the sampling period you wish to use, then click Next. (The sample period
represents the time in milliseconds between samples, so larger numbers result in
fewer samples.)
8 From the next wizard screen, click the Add button to display the Select a
Variable dialog box, then select one or more variables to monitor. When you
are finished, click OK in the Select a Variable dialog box, then click Finish
in the wizard screen. The newly created traces display in the Traces tab.

Capture Buffer Trends

Many components feature different methods of high-speed synchronous data capture.
While each method addresses different needs, all methods are accessed as capture
buffers in the Trender because they have similar underlying data collection
mechanisms.

To add one or more traces from a capture buffer

1 If the Trender window to contain the new trace is not already open, refer to the
section, Accessing a Trender Window.
2 From the Edit menu, select Add Traces. The Add Trace wizard displays.
3 If this is the first trace added to the Trender window, the Add Trace wizard
prompts you for the type of trend to configure. Select Capture Buffer /
Dynamic Data Recorder, and then click Next.
4 Select the component from which to trend variables, then click Next. A list of
all available capture buffers displays.
5 Select one capture buffer, and then click Finish. All of the variables from the
selected buffer convert into traces and the Trace tab is updated to reflect the
changes.

GEH-6706G ToolboxST Chapter 6 Trender • 6-7

 Static File Trends
In addition to acquiring data from a component, the Trender can also display data
from a static file stored on a hard disk. Four formats: Data Collection and Analysis
(.dcaST), Comma Separated Value (.csv), COMTRADE, and GE Control System
Toolbox Trend (.trn) are currently supported as static file sources. While each of
these formats is unique, the procedure to add a trace is identical for all.

To add one or more traces from a static file

1 If the Trender window to contain the new trace is not already open, refer to the
section, Accessing a Trender Window.
2 From the Edit menu, select Add Traces. The Add Trace wizard displays.
3 If this is the first trace added to the Trender window, the Add Trace wizard
prompts you for the type of trend to configure. Select Static, and then click
Next.
4 Select the type of data source to import from and click Next to display an Open
dialog box.
5 Select the desired static file source, then click Open.
6 The Select Variables wizard page displays. Click the Add button to display
the Select a Variable dialog box. The ToolboxST application analyzes the
selected file and displays a list of available variables. Select one or more
variables to convert to traces. When you are finished, click OK in the Select a
Variable dialog box, then click Finish in the wizard. The newly created traces
display on the Trace tab.

6-8 • Chapter 6 Trender GEH-6706G ToolboxST

 Obtaining Data
As they depend on the presence of a controller, live and capture buffer traces do not
initially contain any data. (The data from static file traces is automatically imported
and displays as soon as the trace is added.) Once connected to the controller, the
procedure for obtaining data depends on the type of traces present. Data from live
traces is captured in much the same way that a video recorder operates (with record
and pause buttons), while data from a capture buffer is uploaded from the controller
in a single operation.

To connect to the controller

Select the Online button on the Trender toolbar. (If any of the source
controllers are redundant controllers, the Trender prompts you to select a
redundant channel before opening the connection.)
To begin capturing a trend from live traces

On the Data toolbar, select the Record Data button. The Trender
switches to Live mode, and the Graph View continuously scrolls the time axis
to display the latest incoming data while recording.
To freeze the display while capturing a trend from live traces

On the Data toolbar, select the Pause button. Data continues to be

collected but the Trender switches to Replay mode until the Pause button is
selected again.
To stop capturing a trend from live traces

On the Data toolbar, select the Record Data button. The Trender
returns to Replay mode.
To retrieve data from a capture buffer

On the Data toolbar, select the Upload button.

GEH-6706G ToolboxST Chapter 6 Trender • 6-9

Trender Concepts
Chapters
When working with live, or capture buffer, or some historical sources, the Trender
can record more than one set of data. The basic unit of data capture in the Trender is
a chapter. A chapter represents one acquisition session, which is either a single
upload for a capture buffer source or a single period between clicks of the Record
Data button for a live source. Chapters are organized chronologically, so the first
acquisition session is always the first chapter and the most recent session is always
the last chapter.

A Trender window only displays one chapter of information at a time. Each chapter
maintains its own traces and events. The Events tab only displays events applicable
to the currently displayed data. Similarly, the user data field is unique to each
chapter, so comments about a data set are stored alongside each chapter.

To navigate between Chapters

Click the Previous Chapter or Next Chapter button on the Data

toolbar. (If these options are disabled, there are no other chapters available.)

Cursors
In Replay Mode in the Graph View, two cursors individually select values of time
and together select ranges of time. The cursors are used by a number of functions in
the Trender, such as trace statistics, user events, and data export. The time
represented by each cursor is displayed in the status bar at the bottom of the Trender.

Cursor Active cursor

To select a range of time

1 Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired left boundary location.
2 Place the mouse pointer over the diamond at the top of the other cursor and drag
the diamond to the desired right boundary location.

To select a single time

1 Place the mouse pointer over the diamond at the top of a cursor and drag the
diamond to the desired value.
2 If the diamond for the cursor that represents the time value you wish to select is
not colored white, click the diamond to select it as the active cursor.

6-10 • Chapter 6 Trender GEH-6706G ToolboxST

 Tip When selecting a range of values, there is no left or right cursor – you may
arrange the cursors in whichever way is most convenient. The Trender automatically
identifies the leftmost and right most cursors.

Tip While there are always two cursors on the Graph View, it may appear that
there is only one cursor on the Graph View if both cursors are set to the same time
value.

Value ScreenTips

If you place the mouse pointer over

an axis or a trace in the Graph
View, the Trender displays the
exact value in a ScreenTip. The
ScreenTip remains as long as the
pointer is over the selected item.

Events
During real time monitoring of the controller, certain events may occur such as
alarms and diagnostics. As these events occur, they display in the Trender as a small
triangle on the time axis. All events in the current Chapter appear on the Events tab,
which displays the time and description of each event.

Event Indicator

To jump to an event
From the Event tab, double-click on the description of the desired event.
In addition to events added by the controller, you can add your own User Events. If
added during Live mode, the User Event is placed at the time of the most recently
received sample at the instant the Add User Event command is selected. During
Replay mode, new User Events are added at the time indicated by the active cursor.
(Refer to the section, Cursors .)

To add a user event

1 Select an active cursor.

2 From the Edit menu, select Add User Event. (Or, press the shortcut keys
CTRL+M.)
3 Enter a name for the new event, and select OK.

GEH-6706G ToolboxST Chapter 6 Trender • 6-11

Working With Trender Data
Graph View Options
The Graph View can display data on either a single graph or a set of stacked graphs.
Single Trace mode displays all traces on the same graph, while Stacked Trace mode
displays each trace on an individual graph. In both modes, all traces share the same
time axis, but each trace maintains its own vertical axis. (If there are too many traces
to display stacked graphs effectively in the available space, the Trender may revert to
Single Trace mode even if you have selected Stacked Trace mode.)

Note In Single Graph mode, the vertical axis markings correspond to the trace
listed first on the Trace Tab. Each trace is drawn according to its own scale and, as
such, traces other than the first trace may not correspond to the displayed axis
markings.

Stacked Trace Mode, Single Trace Mode

To turn Stacked Trace mode on or off

From the View menu, select Stacked Traces.

Grid Lines
The Trender can display grid lines that correspond to major axis divisions on the
Graph View. These lines, which only display when the Trender is in Replay mode,
can be useful when the exact trace values are important.

Grid Lines On, Grid Lines Off

6-12 • Chapter 6 Trender GEH-6706G ToolboxST

 To enable or disable grid lines

1 From the Options menu, select Settings. The System Options dialog box
displays with Trender selected in the Tree View.
2 From the Property Editor, locate the category Grid Lines and set the values
for Horizontal and Vertical to either True or False.
3 Click OK to close the Settings dialog box.

Sample Markers
When exact values at each sample reading are important, the Trender can display
Sample Markers at each sample collection point. By default, Sample Markers display
when the current Graph View contains ten or fewer samples. If desired, you can
change the Sample Marker threshold.

To set the Sample Marker threshold

1 From the Options menu, select Settings. The System Options dialog box
displays with Trender selected in the Tree View.
2 In the Property Editor, under the category General, enter a new value for
Sample Markers.
3 Click OK to close the Settings dialog box.

GEH-6706G ToolboxST Chapter 6 Trender • 6-13

 Time Axis
The Time Axis controls the range of samples that display in the Graph View. All
traces share a single Time Axis, even when Stacked Trace Mode is enabled.

To change the range displayed on the Time Axis

Click the Reverse or Forward buttons on the Data toolbar.

To display a shorter or longer period of time on the Time Axis

Click the Zoom In (to reduce the duration) or Zoom Out (to
increase the duration) buttons on the Data toolbar / Click on the time axis and
edit the Duration property in the Property Editor.
The Zoom In and Zoom Out commands behave differently depending on the current
mode. In Live mode, the Zoom In command sets the duration to one third of the
current value and the Zoom Out command sets the duration to three times the current
value. In Replay mode, the Zoom Out command still sets the duration to three times
the current value, but the Zoom In command sets the duration to the exact region
selected by the two cursors. (For more information on selecting a range, refer to the
section, Cursors .)

Tip To quickly change the range of an axis, you can click any point on the axis
and drag it to a new location. This operation works for both the value and time axes
and is frequently the most effective way to change the displayed set of data.

Traces
The Trender window maintains separate settings for each trace. These settings,
which include trace color, sample capacity, and pen width, are accessed through the
Property Editor when a trace is selected on the Trace tab. In addition, Value
(vertical) Axis settings managed through each trace allow an appropriate scale and
range to be determined for each item.

Auto-Range Trace
To display a set of collected samples in the Graph View, an appropriate Value Axis
scale and range must be selected. For most data sets, an optimal scale and range
would display all collected samples in the selected time range with minimal wasted
space. The Auto-Range Trace feature sets the range of the Value Axis for the
currently selected trace(s) to the optimal values. Even if you decide to further refine
the range of the trace, the Auto-Range Trace feature provides a convenient starting
point.

To auto-range a trace
From the Traces tab, select one or more traces, then select the Auto-Range

Selected Traces button on the Data toolbar.

6-14 • Chapter 6 Trender GEH-6706G ToolboxST

 Manual Range Adjustment
When the Auto-Range Trace feature selects an inappropriate range, or if you want
precise control over the range, you can provide a minimum and maximum value for
the Value (vertical) Axis.

To manually adjust the range for a trace

From the Traces tab, select one or more traces, then adjust the Bottom Value
and Top Value properties under Range in the Property Editor.

Trace Colors
The Trender assigns each new trace a color from a set of eight colors stored in the
Settings window. After eight traces are created, these colors are reused. You may
wish to change the color of a trace, especially when multiple traces display on a
single graph.

To change the color assigned to a trace

1 From the Traces tab, select a trace.

2 In the Property Editor, locate the Pen category and select the Color
property.
3 Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.
4 Click the square that corresponds to the desired trace color. The trace updates
automatically.

To modify the default trace colors

1 From the Options menu, select Settings.

2 Locate and select the Trender item in the Settings window.
3 In the Property Editor, select the number of the trace (for example, 2nd Trace)
to be changed.
4 Click the drop-down list and select the Custom (for a color palette) or Web
(for a list of named colors) tab.
5 Click the square that corresponds to the desired trace color.
6 When you have finished changing trace colors, click OK.

Hiding Traces
In some situations, especially with capture buffers, a Trender window contains more
traces than you want to monitor at a particular time. Traces in a Trender window can
be hidden. They still collect data, but they do not display in the Graph View or the
Trace tab.

GEH-6706G ToolboxST Chapter 6 Trender • 6-15

 To hide traces

1 From the Traces tab, select one or more traces.

2 From the Edit menu, select Hide Selected Traces, or right-click on the
selected traces and select Hide Selected from the context menu.

-or-

♦ Select the check box next to the variable name in the Traces tab or the
Auxiliary View to hide or show the trace on the graph.

To show or hide a trace

From the Edit menu, select Show Traces. Select and clear the check boxes
next to the trace names as desired, then click OK.
-or-

♦ Select the check box next to the variable name in the Traces tab or the
Auxiliary View to hide or show the trace on the graph.

Statistical Calculations
The Trender can calculate a set of basic one variable descriptive statistics for
collected data while in the Replay mode. These statistics, which are calculated only
on data in the time range selected by the two cursors, include average, standard
deviation, minimum, maximum, and difference (calculated as final – initial). The
calculated values display as columns on the Trend tab when enabled.

To display statistical calculations

1 From the Options menu, select Settings.

2 Locate and expand the Trender item in the Settings window. Under the
Trender item, select Replay Columns.
3 In the Available list, select one or more columns to enable. (To make multiple
selections, hold down the CTRL key while selecting additional items.)

4 Click the Add button to move the statistics to the Selected list.
5 When you have finished enabling statistics, select OK.

6-16 • Chapter 6 Trender GEH-6706G ToolboxST

 Exchanging Trender Data
Exporting to a File
The Trender can export all traces contained in a Trender window to a file for external
analysis. This file can be imported into third-party applications or exchanged with
other users. All traces, including ones currently hidden, are exported.

To export all traces to a file

1 From the File menu, select Export Data.

2 In the Trender Export Data Options box, adjust options as desired to
produce a file compatible with your desired format. The default options produce
a standard .csv file. (See below for a description of each option.)
3 Select OK when you have finished selecting options. A Save dialog box
displays.
4 Select a location for the exported file and click OK.

Controls whether the first line of Controls the character

the exported file contains header used to separate values
information for each column. in the exported file.

Controls whether a
column containing Controls the text
timestamps is added exported when no
to the output. data is available
for a trace at a
given point in time.
Controls whether a
column containing
increasing integers is Selects the
added to the output. precision
of the exported
timestamp.
If selected, only the
time range selected
by the cursors is
exported.

Printing Graphs
The Trender can print the currently displayed graph to any printer attached to the
system. Printed graphs reflect the current appearance of the Graph View, including
displayed traces, colors, and axis boundaries.

To preview the results of a print command

From the File menu, select Print Preview.
To print the current Graph View
From the File menu, select Print. Adjust printing options as desired and click
OK.

GEH-6706G ToolboxST Chapter 6 Trender • 6-17

Spectral Analysis
The Trender provides the ability to perform a spectral analysis on a dataset.

To perform a spectral analysis

From the View menu, select Spectral Analysis.

A digital spectrum analysis of a waveform changes this time domain data into
frequency domain data, also called a frequency spectrum of the dataset. This is also
referred to as a Fast Fourier Transform (FFT).

The effect of an FFT on a sample dataset is shown below. The first is an input
dataset showing actual generator speed (RPM) and PWA accelerometer Y/Z
direction data (force in Gs).

Note The spectral analysis of this data is able to quickly isolate the most common
frequencies at which this data is varying.

6-18 • Chapter 6 Trender GEH-6706G ToolboxST

 In the example above, analyzing the input waveform (top) produces the frequency
spectrum below it, where three distinct groupings display at frequencies centered on
0.1, 0.35, and 0.9.

GEH-6706G ToolboxST Chapter 6 Trender • 6-19

 FFT Options
The Fast Fourier Transform (FFT), activated by the Spectral Analysis option, is
configurable.

To access FFT settings

Click the Trender Properties

icon. The Trender Settings
dialog box displays.

6-20 • Chapter 6 Trender GEH-6706G ToolboxST

 FFT options include the following:

Between Cursors, if set to True, applies an FFT between the left and right cursors
that can be positioned inside the graphics window.

Padding Factor provides a way to interpolate between real points with copies of
the same data, which enhances the spectrum resolution.

Remove Mean, if set to True, improves the ability to scale the data for
visualization.

Windowing Mode affects the equations used by the FFT. The following
windowing modes are available:

• None
• Hann
• Hamming
• Barlett
• Welch

GEH-6706G ToolboxST Chapter 6 Trender • 6-21

Notes

6-22 • Chapter 6 Trender GEH-6706G ToolboxST

 CHAPTER 7

Chapter 7 EGD Editor for External

Devices

The EGD Component Editor for external devices allows you to configure Ethernet
Global Data (EGD) for an external or third-party device. The EGD protocol allows
controller devices (sometimes known as nodes) to share information in a networked
environment. EGD allows one controller device, referred to as the producer of the
data, to simultaneously send information to any number of peer controller devices
(consumers) at a fixed periodic rate. This network supports a large number of
controller devices capable of both producing and consuming.

Network Adapters
The General tab configures Ethernet adapters for an external EGD-capable
components. One adapter is created by default, and up to four adapters can be added.

To add a network adapter

1 From the System Editor, right-click an external device, then select Edit
Selected Component. (If Edit Selected Component is not available, the
EGD Editor Enable property of the component may be set to False.) The
EGD Component Editor opens.
2 From the Component Editor, select the General tab.
3 From the Tree View, right-click the Network Adapters item, then select
Add Adapter.

To remove a network adapter

1 From the System Editor, right-click an external device, then select Edit EGD.
(If Edit EGD is not available, the EGD Editor Enable property of the
component may be set to False.) The EGD Component Editor opens.
2 From the Component Editor, select the General tab.
3 From the Tree View, right-click the network adapter to be removed, then select
Delete Adapter.

GEH-6706G ToolboxST Chapter 7 EGD Editor for External Devices • 7-1

 The following properties are available for configuration when a Network Adapter is
selected in the Tree View:

Configuration options for the Network Adapter are as follows:

Adapter Settings Category

Host Name This is the Internet Protocol (IP) host name for the selected network adapter.
IP Address This is the IP address for the selected network adapter.
Wire Speed This is the speed of the connected network.

Network Settings Category

Network Name This is the name of the connected network.

Subnet Mask This is the subnet mask associated with the connected network.

Network Switch Connection Settings Category

Network Switch This is the network switch the network adapter is attached to.
Port Number This is the network switch port the network adapter is attached to.

7-2 • Chapter 7 EGD Editor for External Devices GEH-6706G ToolboxST

 EGD Configuration
To configure EGD for an external device

1 From the System Editor, right-click an external device component and select
Edit EGD. (If Edit EGD is not available, the EGD Editor Enable property of the
component may be set to False. The EGD Component Editor opens.)
2 From the Component Editor, select the EGD tab.
3 In the Tree View, select Ethernet Global Data. The Ethernet Global Data
properties display in the Property Editor.

In the Tree View, select

Ethernet Global Data.
The Ethernet Global Data
properties display in the
Property Editor.

These properties are available for configuration when Ethernet Global Data is
selected in the Tree View:

Collection controls the Collection to which this EGD component belongs when
viewed in the EMT tool. This information is published to the EGD Configuration
server in the GUI component document, GUIDevice.xml.

Producer ID sets and displays the EGD Producer ID for this component. This is
assigned when the component is created. The Property Editor displays the EGD
Producer ID formatted as an unsigned integer, but dotted and hexadecimal
representations are available by clicking the ellipsis button.

Produced Pages
Produced Pages are data sets configured to be available to other components on the
network.

To add a new Produced Page

1 From the Tree View, right-click the Produced Pages item, then select Add
Page.
2 Enter a unique name for the new page in the Page Name dialog box, then click
OK.

To delete a Produced Page

From the Tree View, right-click the page you wish to delete, then select
Delete.

GEH-6706G ToolboxST Chapter 7 EGD Editor for External Devices • 7-3

 Editing Produced Pages
To configure a Produced Page
From the Tree View, select the EGD tab, then expand the Produced Pages.

From the Tree View

Produced Pages item,
select the desired page.

The page properties

display in the
Property Editor.

The following properties are available for configuration when a Produced Page is
selected in the Tree View:

Destination Category

Destination IP This sets the IP address to which the exchanges on this page are unicast or
Address multicast. (If the Mode property is set to Broadcast, this property is not
available.)

Ethernet 0 If set to True, EGD is broadcast on Ethernet 0. (If more than one Ethernet
Adapter has been configured for EGD, additional Ethernet properties display.)
Mode This can be set to Broadcast, Unicast, or Multicast, depending on the modes
supported by the component’s EGD implementation profile.
- Broadcast sends the page to all EGD components.
- Unicast sends the page to a single destination.
- Multicast sends the page to the specified multicast addresses.

7-4 • Chapter 7 EGD Editor for External Devices GEH-6706G ToolboxST

 General Category

Exchanges This indicates the number of exchanges in the selected page. It is updated
after selecting the Build command.

Setup Category

Layout Mode This determines whether the exchange numbers and offsets are assigned
automatically at build time or are entered manually.
Name Use this property to rename the selected page.
Period This is the transmission period of the page in milliseconds.
Skew This is used to prevent exchanges with the same period from being produced
at exactly the same instant. The skew for the first exchange in the page is set
to this value, and each additional exchange skew differs from the previous
exchange’s skew by exactly this value (in nanoseconds). For example, if you
have three exchanges in a page and a skew value of 2, the first exchange’s
skew is two, the second exchange’s skew is four and the third exchange’s
skew is six.
Note The Skew property will not be visible if it is not supported in the
implementation profile configuration.
Starting This sets the Exchange ID used for this page. Each additional exchange will
Exchange ID be incremented from the number.

Page Compression
When a page compression is performed, the variables are located in increasing size
order, starting with Booleans, then Words, Double Words, and finally all other
variables. A page compression causes an exchange major signature. Consumers can
mark the exchange variables as unhealthy until the consumed configuratuion can be
rebound.

To compress a single page

From the Tree View, right-click the page to compress, and then select
Compress.

To compress all Produced Pages in a component

From the Tree View, right-click Produced Pages, and then select
Compress All.

GEH-6706G ToolboxST Chapter 7 EGD Editor for External Devices • 7-5

Variables
To add a variable to a produced page
From the Tree View, select a Produced Page to display a Data Grid in the
Summary View.

Click the Name cell in the Append row,

type a variable name, and then click
Enter. The variable will display in a new
row, where you can change other properties.

To delete a variable from an EGD Page

From the Summary View, right-click the variable to delete, and then select
Delete Selected Row(s).

To copy variable information from an EGD page to the clipboard

From the Summary View, right-click a variable, and then select Copy
Selection. The data is copied in .csv format.

7-6 • Chapter 7 EGD Editor for External Devices GEH-6706G ToolboxST

 Editing Exchange Signatures and Configuration Time
Normally, the exchange signature is managed automatically. The major signature
must be incremented when the exchange content changes in any way other than
additions to the end. If you are using the EGD Device Editor to configure EGD for a
device and the device signature changes only when the manufacturer updates the
configuration, you may need to manually set the signature.

Note To edit exchange signatures and configuration time, set Layout Mode to
Manual.

To edit exchange signatures and configuration time

1 From the EGD tab, select the Configuration tab, then select a Produced
Page in the Tree View.
2 Right-click an exchange in the Summary View, then select Edit Exchange
Signatures and Configuration Time.

3 Review the warning about manual Exchange Signature editing, then click
OK.
4 Make any desired changes to the signatures and configuration time, then click
OK to close the dialog box.

GEH-6706G ToolboxST Chapter 7 EGD Editor for External Devices • 7-7

Referenced Devices
The EGD variables defined in other components can be added to the current
component’s variable list by adding a reference. References can only be created to
EGD-capable devices that are consumers of Produced Pages, and as such only EGD-
capable devices are available for referencing.

To select referenced devices

From the Tree View, right-click the Referenced Devices item, and then
select Select Devices to display the Select Devices dialog box.

Select or clear the

check boxes next
to each component
name. Click OK.

The EGD configuration for the selected devices is loaded and the variables display in
the Summary View.

When EGD configurations are edited in remote devices, you must refresh the
configuration periodically to ensure that the latest variable information is used. This
is automatically done during a Bind and Build operation as well as when a
configuration is saved.

To refresh the configuration of a referenced device

In the Tree View, right-click the device to be refreshed, and then select
Refresh.

7-8 • Chapter 7 EGD Editor for External Devices GEH-6706G ToolboxST

 Implementation Profile
Each EGD node type has a set of supported EGD features. For example, a device
might have an EGD implementation that only supports broadcast-produced data. The
implementation profile contains details about the EGD implementation of a
particular device.

GEH-6706G ToolboxST Chapter 7 EGD Editor for External Devices • 7-9

 The following properties are available when editing an Implementation Profile:\

Configuration Category

Configuration Support Allows you to edit various configuration features as follows:

• Accepts Deletes indicates device support for HTTP deletes.
• Accepts Puts indicates device support for HTTP Put commands.
• Multiple Producer IDs indicates device support for multiple producer
IDs.
• Zip Content indicates device support for zipped transfers.
Data Category

Data Types This allows you to configure supported data types. (Clicking the ellipsis
button will open an editor window.)
Double Word Alignment The offset of a DWORD length variable must be evenly divisible by this
number.
Word Alignment This is set to True if the component requires that all WORD length variables
be aligned on an even boundary.

Feature Support Category

Broadcast This is set to True if the component supports broadcast destinations for EGD
data or command packets and False otherwise.
Masked Write This is set to True if the component supports the MaskedWrite command and
False otherwise.
Max Coherent Data This returns the maximum size (in bytes) of a variable that still is guaranteed
coherent transfer. If the attribute is not present, then all data is guaranteed
coherent transfer regardless of size. It is optional and is initialized to 0.
Max Exchanges This returns the maximum number of exchanges supported by the device. It is
optional and is initialized to 0.
Max String This returns the maximum size string supported by the component. If the
attribute is not present, then the component has no set maximum size for
strings. It is optional and is initialized to 0.
Multicast This is set to True if the component supports multicast destinations for EGD
data or command packets and False otherwise.
Skew This is a Boolean value representing the capability of the producer to support
the skewing of produced exchanges with respect to time.
Unicast This is a Boolean value that is set to True if the component supports unicast
destinations for EGD data or command packets. Otherwise, it is set to False.

General Category

Device Class This is the class of the device as defined in the EGD Protocol Specification:
Class Description
0 Supports only the configuration port.
1 Supports the data port and the Data Production PDU.
2 Supports all class 1 services, plus at least acts as a responder for the
command port, and the commands associated with that port.
3 Supports all class 2 services, plus the configuration port, and the required
commands associated with that port. Such devices support responding to
configuration requests but do not dynamically bind their consumed variables.
4 Supports all class 3 services, plus dynamically binding consumed
variables.
Device Name This is the name of the class of device to which this device belongs

7-10 • Chapter 7 EGD Editor for External Devices GEH-6706G ToolboxST

 Viewing Live Data Values
The EGD specification defines a Command Message Protocol (CMP), which allows
for reading and writing values. It allows you to obtain statistical and configuration
information from an EGD device. The EGD device must be Class 2 or greater for
CMP support.

The generic editor uses CMP to display live data values on a produced or referenced
device summary grid view. The Connection Toolbar button sends the CMP message
to the device to obtain the data.

Once connected, the Produced Pages or Referenced Devices option displays

the values. Use the Refresh button in the column header to update the grid.

GEH-6706G ToolboxST Chapter 7 EGD Editor for External Devices • 7-11

 EGD Diagnostics
A CMP can be used to obtain the status of a Class 2 or higher EGD device. When
any EGD tree node other than a Referenced Device is selected, the EGD Statistics
from [Device] tab displays the statistics from the open component. When a
Referenced Device tree node is selected, statistics are obtained from that referenced
device, and the name of the tab page changes accordingly.

Exchange is the Exchange identifier: <device name>.<exchange number>

Configuration Time is the time that the exchange was configured.

Due Time is the time that a consumer data packet must be received for an exchange
to remain valid.

Status is the health of the exchange

Length is the value for a produced exchange. This length may be the highest
variable offset in the exchange or the highest offset of a variable, which may have
been removed. For a consumed exchange, the value may be the highest variable
offset used or the length of the produced exchange, depending on the bind algorithm
of the individual tool.

Message Count is the number of data production packets produced or consumed

since initialization

7-12 • Chapter 7 EGD Editor for External Devices GEH-6706G ToolboxST

 Missed Count is the number of data production packets missed since initialization.
A missed packet occurs when a data production message is received that has a
request ID greater by more than one than the last message received (accounting for
counter roll-over).

Refresh Errors are the number of times a refreshment fault has occurred. A
refreshment fault occurs when a subsequent data production packet (or initial packet
at startup time) does not arrive at a consumer within a pre-defined update period.

EGD Configuration Server Tab

The EGD Configuration Server tab in the Summary View allows you to view and
delete EGD nodes currently residing in the configuration server. The configuration
server used is the one defined in the System Editor in the Tree View. If the server is
enabled, this tab displays information from that server.

Note The EMT provides a detailed view of the configuration server contents.

The tab control contains a toolbar with two buttons:

The Filter Toggle button defaults to a filtered state. It displays items that have
the same name but have a different Producer ID as the open component.

The Delete button deletes the selected item(s). If the item(s) were saved as part
of the configuration, they can be added again.

The EGD configuration server uses the producer ID to store all the documents for an
EGD node.

Note A system can have one EGD Configuration Server only.

If you open two systems, then point to the same configuration server and save a
device of the same name with two different producer IDs to that server, you can end
up with two producer ID nodes with the same device name.

GEH-6706G ToolboxST Chapter 7 EGD Editor for External Devices • 7-13

External Device Menus
Menu Command Use to
File Save Update the EGD configuration files, refreshes consumed exchanges
and variables, assigns produced variables to exchanges, and, if an
EGD configuration server has been specified, publishes the
configuration to the server
Import and Export Transfer produced data, consumed data, symbols, implementation
profiles, and GUI device EGD configuration files to and from a variety
of file formats
Print Print the summary grid view with the column selection, order, and width
currently visible in the view
Close Close the currently opened device

Edit Undo Remove the item currently selected in the Tree View
Redo Add a new component to the current system

Cut Cut the selected item in the Tree View

Copy Copy the selected item in the Tree View

Paste Paste the copied item in the Tree View into the Summary View

Delete Display the System Information Editor (refer to the section System
Information Editor)
Find Display the Component Editor for the item currently selected in the
Tree View
View Go Forward Return to the view that immediately follows the current view in the
history.
EGD Management Open the EGD Management Tool screen.
Tool
Device Online Send CMP messages to EGD Class 2 or higher devices to view live
values from the device.
Bind and Build Refresh the consumed information for all referenced devices,
automatically sets the layout of any unassigned produced variables,
and, if no errors occur, publishes the configuration to the EGD
configuration server.
Put Device to Store the current EGD configuration to the System Database (SDB). It
SDB is only available if the system has an SDB enabled and configured.

Help Release Notes Display the release notes for the current version of the application.
About Display version and copyright information about the application.

7-14 • Chapter 7 EGD Editor for External Devices GEH-6706G ToolboxST

 CHAPTER 8

Chapter 8 Configuration
Management System (CMS)

The ControlST software suite includes a Configuration Management System (CMS),

which provides revision control and history tracking for ToolboxST systems. It
consists of three components:

• CMS server
• Stand-alone Client is accessed through the Start menu
• Integrated Client is accessed through the ToolboxST* application

CMS Server
CMS Stand-alone Client
The CMS Server software
manages and tracks configuration Separate application
changes on a ToolboxST system CMS Client Functions accessed from Start menu

CMS Repository - Login to CMS Server

- System(s) under CMS control - Update CMS status in client
- History of changes - Add ToolboxST system
- Backup and Restore feature - Get Latest Version
- Check Out /Check in
CMS Users - Show History/ Difference
- Database of CMS users CMS Integrated Client
associated with a repository
- Validates CMS clients to Accessed from within
permit access to repository ToolboxST application

CMS Overview

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-1

 The CMS server application performs the following functions:

• Establishes a security model for the server. CMS security uses Windows
(Domain or Workgroup) security for user authentication (CMS users must exist
as valid domain or workgroup users).
• Creates (or deletes) a master location, called the repository. The repository is a
place where configuration files are stored and maintained. All change revision
history is maintained in the repository.
• Adds (or deletes) CMS user names and privileges to control access to the
systems in the repository.
• Provides a mechanism to Backup and Restore the Repository. The backups
include revision history for all the ToolboxST systems in that repository. User
information for the repository can also be included or excluded from the backup
copy.
• Starts and stops the CMS server application.
The CMS client applications (Stand-alone and Integrated) perform the following
functions:

• Log on to the CMS server to use CMS

• Establish a Working folder for each CMS user. A copy of the configuration file
from the repository is placed in the user’s working folder.
• Add a configuration file to the repository, which enables revision tracking on the
system.
• Update the current CMS status for all components in a system in the user’s
working folder as compared to the system in the repository. Icons in the CMS
client indicate equal, old, missing, or checked out (for example, by User xyz on
computer name)
• Get a copy of the latest version of the configuration file from the repository.
This copies the latest system from repository to the user’s working folder.
• Check out a configuration file and/or component from the repository to make
changes. Changes are made to the system in the users’s working folder.
• Check in the configuration file and/or component into the repository. The user
can add a change description for each component during check in. Changes and
comments are recorded in the repository with a revision number.
• Show a history of all changes for a configuration file or component.
• Show the difference between the configuration file or component in the user’s
working folder and the latest copy in the repository
• Get an earlier version of the configuration file or component.

8-2 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 Installing the CMS Server
A CMS server must be installed separately on a single master computer and
configured for a specific site. A user must have administrator privileges to control
access to the systems and perform certain tasks.

The CMS server uses a repository to track system changes, and to control client
access. Each repository contains a list of CMS users and permissions for the
repository. The repository maintains the revision change history for ToolboxST
systems that are added to the repository. A CMS server can have one or more
repositories, and each repository can contain one or more ToolboxST systems.

To install the CMS server

1 Place the CD in the CD-ROM drive. The installation starts automatically. The
Setup dialog box displays.

From the Setup – GE

ControlST dialog
box, select the GE
CMS Server check
box.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-3

 The GE CMS Server option is typically only installed on one computer at
a site. Therefore, if either of these options is selected, a message displays
asking you to verify that you want to install the option at more than one
location.

2 The Welcome dialog box displays. Click Next. The License Agreement
dialog box displays.
3 To continue the installation, you must accept this agreement. Select Agree.
4 Click Next. The User Information dialog box displays.
5 Click Next. The Destination Folder dialog box displays. If this is the first
time the ToolboxST application has been installed on this computer, the Browse
button allows you to change the default install location (C:\Program
Files\GE Energy\). If this is a subsequent installation, this dialog box
displays where this version of the product is installed.
6 Continue to click the Next until the installation starts. Click Finish when the
installation has completed successfully.

Note For the CMS server to work correctly, the Use Simple File Sharing option
check box must be cleared.

Right-click Start and select Explore. From

the Tools menu, select Folder Options to
display the Folder Options dialog box.

From Advanced settings, clear the Use

simple file sharing check box, then click OK.

8-4 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 Creating Windows User Accounts
Note You must have administrator privileges to create user accounts on the server
computer.

CMS uses Windows security (domain or workgroup) for authentication. All CMS
user names must exist in Windows (domain or workgroup) before they can be added
in the CMS server.

For workgroup security, the CMS user names only need to be added as Windows
users on the CMS server computer (users do not need to be added on all CMS client
computers).

For domain security, the CMS user names must be added by the domain
administrator if they do not exist.

To create users in Windows

1 From the Start menu, select Control Panel, Administrative Tools, and
Computer Management. The Computer Management screen displays.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-5

 From the tree view, select
Local Users and Groups.
Right-click Users and
select New User….

The New User dialog box displays.

Enter the User

name. Enter
an optional
Full name and
Description, if
desired.

Enter a
Password,
then re-enter
it to confirm.

Select any of
these options,
if necessary,
then click the
Create button.

Note When creating accounts specifically for CMS use in a workgroup, select the
options User cannot change password, and Password never expires.

8-6 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 To make the new user an administrator

1 From the Computer Management screen, right-click the new user and select
Properties. The Properties dialog box displays.

Select the Member Of

tab.

Select the
Administrators group
and click Apply and
OK.

If the Members Of
tab is blank, click the
Add button.

The Select Groups

dialog box displays.

Click the Advanced

button to select the
Administrators group.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-7

 Click the Find Now
button to display
available groups.

Select
Administrators
then click OK.

2 The dialog box closes and the previous Select Groups dialog box displays
again, with the Administrators group displayed in the object name text box.
3 Click OK. The User Properties dialog box displays again with the Member
Of tab selected.
4 From the Member Of tab, select the Administrators group, click Apply and
OK.

8-8 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 Configuring the CMS Server
The CMS administrator tool is installed with the CMS server. The tool allows you to
perform administrator tasks on the server as follows:

Menu Command Use to

Repository Select Select a repository to store and maintain files.
Create Create a new repository.

Delete Delete an existing repository. It is a good idea to back up the repository

before deleting it.
Backup Create a copy of the repository.

Restore Restore a repository from a backup copy.

Users Add Add a new user. Enter the user ID and configure Permissions. If you select
User can modify system, that user cannot access the CMS Administrator.
Delete Remove a user from the system.

Edit Edit permissions for a particular user.

Tools Server Start and stop the server.

Note: Stopping the server disables all repository operations.
Settings Select the User Type depending on the Windows security model for your site.
Changing this option will delete all repositories on the server. You will be
prompted to backup all repositories.
Note: If you select Domain Users you must know the Administrator domain
name and password.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-9

 Accessing the Administrator Tool
To access the Administrator Tool

1 From the Start menu, select All Programs, GE Control ST, and CMS
Server. Click Administrator Tool.

When the CMS Administrator Tool is started for the first time, the CMS Settings dialog box displays.

Note To run the Administrator Tool and log in, you must have administrative
permissions on your computer. The first time you start the CMS Administrator Tool,
you must select the user type (before login). This determines the security model to be
used with the CMS server.

Select CMS Users are

Workgroup Users,
then click OK.

8-10 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 If there are any existing repositories with current user types, use this dialog box to
back up all existing repositories in the CMS server.

The repositories
to be backed up
display in the list
box.

Click the Browse

button to specify
the backup
location, then
click OK.

The Please Login to CMS Server dialog box displays.

2 Enter a Name and Password, then click OK. The CMS Administrator
dialog box displays.
3 Select the Create a new Repository option and click OK.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-11

 4 The Create New Repository dialog box displays. Enter the path or click
Browse to find the repository location. To create a new repository folder, click
Browse to open the Browse For Folder and select Make New Folder.
5 Enter the folder and the name of the repository and click OK. The CMS
Administrator screen displays.

Working Folder
CMS has two types of working folders:

• Repository working folders are the root folder location for systems from the
repository
• System working folders have a folder location for each system configuration
added to the repository, or obtained from the repository.

Note Working folders are specific to a particular user. Different users cannot
designate the same working folder.

If a user attempts to use a working folder already selected by another user, the
following message displays:

8-12 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 Repository Working Folder
The repository working folder is the primary root folder location for a user. Before
adding a system to CMS, the system configuration files are copied under the user’s
repository working folder, then added to CMS. Each user must specify a repository
working folder the first time they log on to CMS. A dialog box displays to enter this
information.

Note Anytime CMS requests a working folder, it is requesting the repository

working folder.

The user must enter the root location as the working folder, not the system working
folder (described in next section).

CMS maintains a list of users and their repository working folders on each computer.
The repository working folder for a user is only shown in the CMS Stand-alone
client (with repository name selected).

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-13

 System Working Folder
Similar to the repository working folder, the system working folder must be unique
for each user. However, each user’s system working folder is initially determined in
one of two ways:.

• If the user is adding the system to the repository, that user’s system working
folder is set to the current location of the system configuration.
• If a new user performs a Get Latest command on a system that was not added by
them, the system working folder defaults to a location under the repository
working folder (and the Get Latest command places a copy of the system
configuration in that location).
The system working folder is not the repository working folder. Typically, the
system working folder is located in the repository working folder (but it can also be
in any folder). This location can also be changed from within the Stand-alone client
(but is not recommended).

The user’s system working folder is shown in the Stand-alone client when a system
name is selected.

8-14 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 For the Integrated client, the current folder location of the system (.tcw file) is
assumed to be the working folder for that user. The CMS logon fails, and an invalid
working folder dialog box displays if a different user is associated with the system in
that location.

Add System / System Working Folder

When a system configuration is added to CMS, several things occur:

• A copy of the system is placed in the repository. This serves as the starting point
to begin CMS revision tracking for all CMS users.
• The user’s system working folder is set to the current location of the system
configuration.
• Changes are made to the system in the system working folder for use by CMS.
• A CVS folder (hidden) is added at the system level and in each component in the
system
• System and component configuration files (cf.dat and .xml ) are made Read-only

Once a system configuration is added to the repository, any user can log on to the
CMS Server to begin using CMS . After log on, the user obtains the current copy of
the configuration (Get Latest), modifies a component (Check Out), then saves the
changes (Check In).

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-15

Recommendations
• Use only one CMS user and one working folder for all workstations. This user
should have administrator privileges.
• When accessing a system through CMS for the first time, use the Stand-alone
client to log on and assign the working folder.
• Do not add system to a different repository through the Integrated client. Do not
add a system through the Integrated Client. If you choose to do this, make sure
to first save the desired system’s .tcw file to the working folder and add it to the
selected repository from that location.
• The following are recommended settings to enable auto log in to the CMS
Integrated Client when a system configuration is opened in the ToolboxST
application.

In the System View, select the Options menu,

Settings, System Options, and General. Then set
Load Last System to True.

8-16 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 In the System View, select the Options menu, Settings,
System Options, CMS, and General. Then set Get
Latest Files to True and Work Local to False. Also, set
the CMS User Name to the one designated user.

CMS Stand-alone Client

The CMS Stand-alone client allows you to Check Out individual components of a
master configuration (.tcw file), make edits, and then Check In the component.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-17

 Opening the CMS Stand-alone Client
To open the CMS Stand-alone client
From the Start menu, select All Programs, GE ControlST, and
ToolboxST. Click Configuration Management System. The CMS –
Login dialog box displays.

Verify, or enter the IP

address for the CMS
Server where the
repository is located.

Enter the User Name

and Password, then
select the Repository
from the drop-down list.
Click OK.

Note The repositories available are those that were created using the CMS
Administrator.

The Configuration Management System window displays.

The Systems View

displays a
repository as an
item that contains
systems.

The Component
View displays all
components within
the system that is
currently selected in
the Systems View.

The Log View

displays all
messages, events,
and error
associated with the
selected
component.

8-18 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 Adding a System to a Repository
After successfully logging on, you can add systems to a repository.

To add a system to a repository

1 From the File menu, select Add System. The Add System dialog box
displays.
2 Locate and select the system to be added, then click OK. The system displays in
the Tree View.

Or

From the Tree View,

right-click the
Repository item and
select Add System.
The Add System
dialog box displays.

Locate and select the

system to be added
then click OK. The
system displays in the
Tree View.

Note When a system is added to a repository, the current folder where the system is
located becomes the working folder for that system.

Note Once a system is added, all CMS operations are enabled.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-19

 Getting the Latest Version
To get the latest version

From the Tree View,

right-click the system
item, then select Get
Latest Version. The
Recursive Get
dialog box displays.

If a component is checked
out, the Overwrite
Components dialog box
displays. Select any
components to overwrite,
then click OK.

Note A Recursive Get command retrieves a copy of the system, as well as all
configured components.

8-20 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 CMS Stand-alone Client Menus
Menu Command Use to
File
Log In Log on to the CMS server
Log Out Log off the CMS server
Add System Add a new system to the CMS Stand-alone client. Enter a name for the
system, then browse to the configuration file, for example, a .tcw file.
Note: Select the repository item to display the system in both the
Systems and the Component View; select the system item to display the
component(s) in the Component View.
Delete System Delete an existing system from the CMS Stand-alone client
Set Working Change the path to the destination folder for checking out and checking
Folder in system configuration files.

View Refresh/System Get the current system status. The status conditions include: Equal,
Repository Checked Out, Unknown, or Missing.
Note: If Missing displays in the Status column, do a Get Latest Version.
Clear Status Clear the Log View of all error and event information
Window
Source Get Latest Version Retrieve the last checked-in version of the configuration files from the
repository. Components under CMS control will always be Read-Only
until the component is Checked Out.
Attention: When you perform a Get Latest Version, all files that you
currently have checked out are overwritten.
Check In Check a file back into the repository and save changes
Check Out Check a file out of the repository to make changes
Undo Check Out Return a checked-out file to the repository without saving changes
Label Mark the current repository component with a text label. If the label is
assigned to the system component, the system and all components in
the system are assigned the same text label. The label displays in the
History screen when you select Show History. The label can be used for
specific version identification, as well as for future file retrievals.
Tools
Show Differences Display the differences between the master copy in the repository and
the local copy in the working folder
Note: From the Show History window, you can select a version and
click the Diff button to compare the selected version in the repository
with the local copy in the working folder. You can also select two
versions and click the Diff button to compare the two selected versions
in the repository.
Show History Display the versions/modifications for a selected configuration file
Note: From the Show History window, you can select a version and
click the Diff button to compare the selected version in the repository
with the local copy in the working folder. You can also select two
versions and click the Diff button to compare the two selected versions
in the repository.
Help Contents Open the help file for the Stand-alone Client
About Display the software version information

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-21

 A sample Show History dialog box is shown below.
User comments
User that made the change.
entered at check in.

Label is
additional text
to identify a
specific
version.

Sequential
version
numbers
assigned to
each change at
check in.

CMS Integrated Client

The Integrated client provides many of the Stand-alone client functions from within
the ToolboxST application. It allows you to check out individual components of a
master configuration, make edits, and then check in the component. The Integrated
client is accessed through the ToolboxST application.

Note The CMS menu item is disabled until a system is opened.

The CMS Integrated client operation is controlled by ToolboxST option settings
saved at each computer.

8-22 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 To configure CMS settings
From the ToolboxST Options menu, select Settings. The Settings dialog
box displays.

UserName is the default user name used to logon to CMS.

Get Latest Files, when set to True, gets the latest version upon logon.

Work Local, when set to True, opens the system disconnected from the CMS
server. This is the default when the ToolboxST application is installed, and opens the
system without the CMS Integrated client.

Work Local, when set to False, opens the system connected to the CMS server, and
displays the CMS LogIn dialog box.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-23

 Opening the CMS Integrated Client
To open the Integrated client
From the Start menu, select All Programs, GE ControlST, ToolboxST,
and then ToolboxST.

The CMS – LogIn dialog box displays.

Note You must connect to the correct CMS server to log on.

Note The CMS LogIn dialog box does not automatically display unless the
ToolboxST Work Local option was set to False.

8-24 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 Confirm the correct CMS
Server IP address, then
click Connect.

The Connect button

changes to display
Change Server.

Enter the User Name

and Password, then
select the Repository
from the drop-down
list and click OK.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-25

 If you clicked Cancel, you are not logged into CMS. One of three scenarios occurs,
depending upon your local ToolboxST settings.

An empty ToolboxST window displays, a local system opens, or a Read-Only

system opens.

To access a system file

Select File and Open System. Browse to the working folder you created, then
select the ToolboxST system .tcw file. The .tcw file opens in Read-Only mode.

To change the server (if not logged on)

1 From the ToolboxST CMS menu, click Connect to Server. The CMS –
Server Details dialog box displays.

Enter the IP Address

or Name of the
computer on which
the server is installed,
then click OK.

2 When the CMS – LogIn dialog box displays, enter your User Name (if not
displayed), Password, and Repository, then click OK.

8-26 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 Note If a question mark icon displays next to the system item in the ToolboxST
System Editor Tree View, perform a Get Latest Version.

CMS Menu Items

Command Use to
Connect to Connect to the correct server to log on to CMS
Server
Login Log on to CMS Server from the CMS Integrated client.
Note: You must be connected to the correct server to log on.
Logout Log off the CMS Server from the CMS Integrated client
Work Use CMS without CMS.
Disconnected Note: Any changes made while operating in this mode are NOT saved in
the CMS repository. CMS menu options are disabled while working
disconnected. This mode is for testing.
Refresh Refresh the systems and components that display
Add System to Add a new system to the repository you are working in
Repository
Add System to Add a new system to a different repository. This action is not
Different recommended.
Repository
Get Latest Retrieve the last check-ed in version of the configuration files from the
Version repository. Components under CMS control will always be Read-Only until
the component is Checked Out.
Attention: When you perform a Get Latest Version, all files that you
currently have checked out are overwritten.
Check Out Check a file out of the repository to make changes
Check In Check a file back into the repository and save changes
Undo Check Out Return a checked-out file to the repository without saving changes
Label Mark a checked-out copy of the file with identifying text. The label can be
used for future file retrievals.
Show History Display the versions/modifications for a selected configuration file
Note: From the Show History window, you can select a version and click
the Diff button to compare the selected version in the repository with the
local copy in the working folder. You can also select two versions and click
the Diff button to compare the two selected versions in the repository.
Show Differences Display the differences between the master copy in the repository and the
local copy in the working folder.
Note: From the Show History window, you can select a version and click
the Diff button to compare the selected version in the repository with the
local copy in the working folder. You can also select two versions and click
the Diff button to compare the two selected versions in the repository.

GEH-6706G ToolboxST Chapter 8 Configuration Management System (CMS) • 8-27

Troubleshooting
If any of the following issues occur, perform the Clean Get procedure below.

• Missing or Unknown status displays for systems and/or components in the

Stand-alone and/or Integrated clients
• Message box displays "The same working folder appears to be used by a
different user account…"
• Message box displays informing you of CVS issues and states “…cvs [server
aborted]: correct above errors first!”
If troubleshooting issues occur, perform a clean Get as follows:

1 Open Windows Explorer.

2 Navigate to your system working folder.
3 Delete all contents in your system working folder.
4 From the Stand-alone Client window, select Get Latest Version.

8-28 • Chapter 8 Configuration Management System (CMS) GEH-6706G ToolboxST

 Glossary of Terms

application code
Software that controls specific machines or processes.

attributes
Information, such as location, visibility, and type of data that sets something apart
from others. In signals, an attribute can be a field within a record.

bit
Binary Digit. The smallest unit of memory used to store only one piece of
information with two states, such as One/Zero or On/Off. Data requiring more than
two states, such as numerical values 000 to 999, requires multiple bits (see Word).

block
Instruction blocks contain basic control functions, which are connected together
during configuration to form the required machine or process control. Blocks can
perform math computations, sequencing, or continuous control. The ToolboxST
application receives a description of the blocks from the block libraries.

board
Printed wiring board.

Boolean
Digital statement that expresses a condition that is either True or False. In the
ToolboxST application, it is a data type for logical signals.

bus
An electrical path for transmitting and receiving data.

byte
A group of eight binary digits (bits) operated on a single unit.

collection
A group of signals found on the same network. The Trend Recorder can be
configured by adding collections.

configure
To select specific options, either by setting the location of hardware jumpers or
loading software parameters into memory.

GEH-6706G ToolboxST Glossary of Terms • 9-1

 device
A configurable component of a process control system.

Ethernet
LAN with a 10/100 MB baud collision avoidance/collision detection system used to
link one or more computers together. Basis for TCP/IP and I/O services layers that
conforms to the IEEE 802.3 standard, developed by Xerox, Digital, and Intel.

Finder
A subsystem of the ToolboxST application for searching and determining the usage
of a particular item in a configuration.

health
A term that defines whether a variable is functioning as expected.

hexadecimal (hex)
Base 16 numbering system using the digits 0-9 and letters A-F to represent the
decimal numbers 0-15. Two hex digits represent 1 byte.

I/O
Input/output interfaces that allow the flow of data into and out of a device.

initialize
To set values (addresses, counters, registers, and such) to a beginning value prior to
the rest of processing.

instance
Update an item with a new definition.

logical
A statement of a true sense, such as a Boolean.

node
In a local network, a component that is connected to other components and is capable
of communicating with other network devices. In a tree structure, a location on the
tree that can have links to one or more nodes below it.

non-volatile
The memory specially designed to store information even when the power is off.

online
Online mode provides full CPU communications, allowing data to be both read and
written. It is the state of the ToolboxST application when it is communicating with
the system for which it holds the configuration. Also, a download mode where the
device is not stopped and then restarted.

9-2 • Glossary of Terms GEH-6706G ToolboxST

 physical
Refers to devices at the electronic or machine level in contrast with logical. Logical
implies a higher view than the physical. Users relate to data logically by data element
name; however, the actual fields of data are physically located in sectors on a disk.

Resources
Also known as groups. Resources are systems (devices, machines, or work stations
where work is performed) or areas where several tasks are carried out. Resource
configuration plays an important role in the CIMPLICITY system by routing alarms
to specific users and filtering the data users receive.

runtime
See product code.

ToolboxST
A Windows-based software package used to configure controllers.

trend
A time-based plot to show the history of values.

Trender
A subsystem of the ToolboxST application that monitors and graphs signal values
from a controller.

validate
Makes certain that items or devices do not contain errors and verifies that the
configuration is ready to be built into application code.

variable
The basic unit for variable information. Variables are the placeholders for memory
locations in the toolbox’s different platforms.

word
A unit of information composed of characters, bits, or bytes. It is treated as an entity,
and can be stored in one location. Also, a measurement of memory length, usually 32
bits in length, but can also be 4, 8, or 16 bits long.

GEH-6706G ToolboxST Glossary of Terms • 9-3

Index

A F
alarm classes • 13 find methods • 2
alarm scanner • 44
G
C
global parameters
capture buffer • 88 adding • 50
CMS
accessing CMS administrator tool • 8 I
configuring • 7 implementation profile • 9
creating user accounts • 4 installation • 2
installing • 3
CMS recommendations • 15 L
CMS stand-alone client
licensing • 11
menus • 19
opening • 17 N
CMS troubleshooting • 26
CMS working folder network adapters • 29, 1
repository • 11 P
system • 13
command line arguments • 5 page compression • 95, 5
Component InfoView • 6 Produced Pages • 92
components property editor • 5
grouping • 4
moving and copying • 4 R
configuring referenced devices • 98, 8
alarms tab • 42 replace options • 4
OPC AE Server tab • 75 routing • 76
OPC DA Server tab • 62
consumed devices • 24 S
D sampling
triggered • 86
data grids security
copying • 9 passwords • 18
editing • 8 Viewing Protection Status • 19
organizing • 8 Status tab • 2
download wizard • 3 summary view • 4
system editor
E
configuration files • 8
editing Produced Pages • 93, 4 opening and creating systems • 1
EGD saving systems • 7
configuration • 91, 2 system information editor
configuration server • 44 alarm classes • 13
configuration server interaction • 45 format specifications • 26
configuration server reports • 105 HMI resources • 28
diagnostics • 100, 12 measurement systems • 28
packet logging • 101 System Requirements • 1
Ethernet • 91, 28
T
tab
Alarms • 42
Ethernet Global Data • 91
General • 22
HMI Config • 47
OPC AE Server • 75
OPC DA Server • 62
Recorder • 82
time card • 26
Trender
adding traces • 3
capture buffer trends • 7
concepts • 10
cursors • 10
events • 11
exporting to a file • 16
hiding traces • 15
live trends • 7
obtaining data • 9
printing graphs • 16
trace colors • 14
Trender concepts • 10
Trender window features
data toolbar • 3
Trender toolbar • 3
trip log • 87
U
UPD
installing • 12
reinstalling • 12
g GE Energy
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA

1 540 387 7000

www.geenergy.com