GE Energy

ToolboxST™ Guide
for WorkstationST™
GEH-6706B

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.

© 2006 General Electric Company, USA. All rights reserved.

CIMPLICITY is a registered trademark of GE Fanuc Automation North America, Inc.

ControlST, Mark VIe, ToolboxST, and WorkstationST are registered trademarks of
General Electric Company, USA.
Ethernet is a registered trademark of Xerox Corporation.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
 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 ToolboxST 1-1

System Requirements ................................................................................................................................1-1
Installation.................................................................................................................................................1-2
Command Line Arguments .......................................................................................................................1-4
Licensing ...................................................................................................................................................1-8
Installing the UPD..........................................................................................................................1-8
Reinstalling UPD ...........................................................................................................................1-9
Acronyms and Abbreviations ..................................................................................................................1-10

Chapter 2 System Configuration 2-1

System Editor ............................................................................................................................................2-1
Opening and Creating Systems ......................................................................................................2-1
Components ...................................................................................................................................2-3
Grouping Components ...................................................................................................................2-4
Moving and Copying Components ................................................................................................2-4
Configuring External Devices........................................................................................................2-5
Saving Systems ..............................................................................................................................2-5
Configuration Files ........................................................................................................................2-6
Menu Reference .............................................................................................................................2-9
System Information Editor ......................................................................................................................2-11
Alarm Classes ..............................................................................................................................2-11
Format Specifications...................................................................................................................2-13
Measurement Systems..................................................................................................................2-15
HMI Resources ............................................................................................................................2-15
System Database (SDB) ..........................................................................................................................2-16
EGD Configuration Server......................................................................................................................2-17
Working Online with the EGD Configuration Server..................................................................2-18
ToolboxST/EGD Configuration Server Interaction .....................................................................2-19
Viewing Differences ....................................................................................................................2-19
Configuring an External EGD Device .........................................................................................2-20

Chapter 3 WorkstationST Component Editor 3-1

Summary View..........................................................................................................................................3-2
Property Editor ..........................................................................................................................................3-2
Component InfoView ................................................................................................................................3-3
Security .....................................................................................................................................................3-4
Passwords.......................................................................................................................................3-4
Password Caching ..........................................................................................................................3-5
Viewing Protection Status..............................................................................................................3-6
Protected Objects ...........................................................................................................................3-7
Data Grids .................................................................................................................................................3-8
Editing Data ...................................................................................................................................3-8
Organizing Columns ......................................................................................................................3-9
Copying and Moving Data ...........................................................................................................3-10
General Tab .............................................................................................................................................3-11
Consumed Devices.......................................................................................................................3-13
Features ........................................................................................................................................3-14
Timecard ......................................................................................................................................3-14
Configuring NTP..........................................................................................................................3-15
Network Adapters ........................................................................................................................3-16

GEH-6706B ToolboxST Contents • i

 Scheduled Tasks...........................................................................................................................3-17
Alarms Tab ..............................................................................................................................................3-18
Configuring the Alarms Tab.........................................................................................................3-18
Alarm Scanner..............................................................................................................................3-21
External OPC AE Servers ............................................................................................................3-22
HMI Config Tab ......................................................................................................................................3-23
WorkstationST Status Monitor.....................................................................................................3-23
Adding an HMI Feature ...............................................................................................................3-24
HMI Configuration.......................................................................................................................3-24
Adding Global Parameters ...........................................................................................................3-25
Editing Global Parameters ...........................................................................................................3-26
Deleting Global Parameters..........................................................................................................3-26
OPC DA Server Tab................................................................................................................................3-27
Configuring the OPC DA Server Tab ..........................................................................................3-27
Features ........................................................................................................................................3-29
Test OPC Client ...........................................................................................................................3-30
OPC AE Server Tab ................................................................................................................................3-33
Routing.........................................................................................................................................3-33
Server Attributes ..........................................................................................................................3-33
Variable Translations ...................................................................................................................3-34
State Translations .........................................................................................................................3-34
Data Update Rates........................................................................................................................3-35
Configuring the OPC AE Server ..................................................................................................3-35
Diagnostic Alarm Severity ...........................................................................................................3-36
Recorder Tab ...........................................................................................................................................3-39
Collections....................................................................................................................................3-40
Adding a Collection .....................................................................................................................3-40
Live Data......................................................................................................................................3-41
Trip Log .......................................................................................................................................3-43
Capture Buffer..............................................................................................................................3-44
Deleting a Collection....................................................................................................................3-45
Adding a Variable ........................................................................................................................3-46
Deleting a Variable.......................................................................................................................3-47
Refreshing a Collection................................................................................................................3-47
Ethernet Global Data (EGD) Tab ............................................................................................................3-48
EGD Configuration ......................................................................................................................3-48
Produced Pages ............................................................................................................................3-48
Editing Produced Pages................................................................................................................3-49
Page Compression ........................................................................................................................3-50
Variables ......................................................................................................................................3-51
Editing Exchange Signatures and Configuration Time ................................................................3-52
Referenced Devices......................................................................................................................3-53
EGD Diagnostics..........................................................................................................................3-55
EGD Packet Logging ...................................................................................................................3-56
EGD Configuration Server Reports .............................................................................................3-60

Chapter 4 Working Online With WorkstationST 4-1

Introduction ...............................................................................................................................................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

ii • Contents GEH-6706B ToolboxST

 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-4
Capture Buffer Trends....................................................................................................................6-4
Static File Trends ...........................................................................................................................6-5
Obtaining Data ...............................................................................................................................6-5
Trender Concepts ......................................................................................................................................6-6
Chapters .........................................................................................................................................6-6
Cursors ...........................................................................................................................................6-6
Value ScreenTips ...........................................................................................................................6-7
Events.............................................................................................................................................6-7
Working With Trender Data......................................................................................................................6-8
Graph View Options ......................................................................................................................6-8
Grid Lines ......................................................................................................................................6-8
Sample Markers .............................................................................................................................6-9
Time Axis.....................................................................................................................................6-10
Traces...........................................................................................................................................6-10
Auto-Range Trace ........................................................................................................................6-10
Manual Range Adjustment...........................................................................................................6-11
Trace Colors.................................................................................................................................6-11
Hiding Traces...............................................................................................................................6-11
Statistical Calculations .................................................................................................................6-12
Exchanging Trender Data........................................................................................................................6-12
Exporting to a File........................................................................................................................6-12
Printing Graphs ............................................................................................................................6-13
Notes .......................................................................................................................................................6-14

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
Menus......................................................................................................................................................7-14
File Menu .....................................................................................................................................7-14
Edit Menu.....................................................................................................................................7-14
View Menu...................................................................................................................................7-14
Device Menu ................................................................................................................................7-15
Help Menu ...................................................................................................................................7-15

GEH-6706B ToolboxST Contents • iii

Chapter 8 Configuration Management System (CMS) 8-1
Accessing the CMS Administrator Tool....................................................................................................8-1
Repository Menu .......................................................................................................................................8-4
Selecting a Repository....................................................................................................................8-5
Creating a Repository.....................................................................................................................8-6
Deleting a Repository.....................................................................................................................8-6
Backing Up a Repository ...............................................................................................................8-7
Restoring a Repository ...................................................................................................................8-7
Users Menu................................................................................................................................................8-9
Adding a User ................................................................................................................................8-9
Deleting a User.............................................................................................................................8-10
Editing a User...............................................................................................................................8-10
Tools Menu..............................................................................................................................................8-11
Starting the Server........................................................................................................................8-11
Stopping the Server ......................................................................................................................8-11
Adjusting the Settings ..................................................................................................................8-12
CMS Client Interface...............................................................................................................................8-13
File Menu ................................................................................................................................................8-15
Connecting to the Server ..............................................................................................................8-15
Adding a System ..........................................................................................................................8-15
Deleting a System ........................................................................................................................8-15
Setting Working Folder................................................................................................................8-15
View Menu ..............................................................................................................................................8-16
Refreshing System View..............................................................................................................8-16
Clearing Status Window...............................................................................................................8-16
Source Menu............................................................................................................................................8-16
Retrieving a Configuration...........................................................................................................8-16
Modifying a Configuration...........................................................................................................8-17
Labeling a Configuration .............................................................................................................8-18
Tools Menu..............................................................................................................................................8-18
Showing History...........................................................................................................................8-18

Chapter 9 Reference 9-1

Menus ........................................................................................................................................................9-1
File Menu .......................................................................................................................................9-1
Edit Menu.......................................................................................................................................9-1
View Menu.....................................................................................................................................9-1
Device Menu ..................................................................................................................................9-2
Help Menu......................................................................................................................................9-2

Glossary of Terms G-1

Index I-1

iv • Contents GEH-6706B ToolboxST

 CHAPT\S CHAPTERER 1

Chapter 1 About ToolboxST

™ ™
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 are minimum hardware and operating system requirements needed to
run the ToolboxST application.
Processor 1 GHz Pentium III
Operating System ® ®
Microsoft Windows 2000
Memory 1024 megabytes (MB) RAM
Hard drive 20 gigabytes (GB)
Monitor XGA display (1024 x 768 x 64K colors)
Drive CD-ROM or DVD-ROM drive
Network ®
Ethernet network adapter

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

sales representative.

GEH-6706B ToolboxST Chapter 1 About ToolboxST • 1-1

Installation
To install the software
1 Place the CD in the CD-ROM drive. The installation starts automatically.

Note If the installation does not start automatically, use Windows Explorer to
navigate to your CD-ROM drive and run GEControlST Install.exe.

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. Enter information for
this dialog box as appropriate.
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 will be installed.
6 Click Next. The Select Features dialog box displays and allows you to select
which features to install or not install. All components will be installed by
default.

To select components not

to install, click the icon to
the left of the component
name and select the red X.

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

1-2 • Chapter 1 About ToolboxST GEH-6706B 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 Click Change to and or

GE ControlST-Vxx.xx.xx, Remove to uninstall
where Vxx.xx.xx is the features from the
component version. installation.

You can install multiple versions of the ToolboxST application. If a new version is
included, the desktop and Start menu update to reflect the most recently installed
version.

The Add/Remove Programs option lists all installed versions. Once you install a
newer version, you can remove previous versions of the product from your computer
unless you need to retain them for compatibility.

Note Always install new versions of the ToolboxST application before removing
older versions to preserve your personal settings.

GEH-6706B ToolboxST Chapter 1 About ToolboxST • 1-3

Command Line Arguments
ToolboxST 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 ToolboxST is already opened, starting it again with the /variable option
sends a message to the already running ToolboxST to cause it to navigate to the
appropriate location.

EMT

The EMT opens a ToolboxST system 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>

1-4 • Chapter 1 About ToolboxST GEH-6706B ToolboxST

 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).

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 control 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 system 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 system is opened.

GEH-6706B ToolboxST Chapter 1 About ToolboxST • 1-5

 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.

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.

1-6 • Chapter 1 About ToolboxST GEH-6706B ToolboxST

 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
will open the Mark VIe component, then navigate
to the specified CALC block in the software.

-NoSplash

If the text –NoSplash is contained in an argument, the splash screen will 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 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

GEH-6706B ToolboxST Chapter 1 About ToolboxST • 1-7

 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.

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).
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 will not be associated with the correct drivers.You
can correct this after the application is installed with the Reinstalling UPD
procedure.

1-8 • Chapter 1 About ToolboxST GEH-6706B 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.
6 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.

GEH-6706B ToolboxST Chapter 1 About ToolboxST • 1-9

Acronyms and Abbreviations
EGD Ethernet Global Data, a control network and communication
protocol
EU Engineering Units
HMI ®
Human-Machine Interface, usually a computer with CIMPLICITY
software
NVRAM Non-volatile Random Access Memory
® OLE (Object Linking and Embedding) process control server
OPC
SDB System Database
SOE Sequence of Events, a record of high-speed contact closures
TMR Triple modular redundant, uses three sets of controllers and I/O
UDH Unit Data Highway, links the controllers to the HMI servers
UDP User Datagram Protocol, a connectionless protocol that runs on top
of IP networks
UPD USB Protective Device
USB Universal Serial Bus, connections for computer and peripherals
xml eXtensible Markup Language (a file format)

1-10 • Chapter 1 About ToolboxST GEH-6706B ToolboxST

 CHAPTER 2

Chapter 2 System Configuration

System Editor
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.

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.

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

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

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

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

A list of common components and the icon that represents them in the Tree View is
as follows:

Icon Component

System

Group of Components

Printer

Library Container

Network
Trender Window
External Device (not associated with an application)

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.
To add a component
In the Tree View, right-click a parent component (either a system or a group),
select Insert New, then select the desired component type.
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.
To open the editor for a component
In the Tree View, select a component. Then, from the Edit menu, select
Selected Component.
Or,

In the Tree View or Summary View, double-click a component.

To import an existing library container
In the Tree View, right-click a parent component (either a system or a group),
select Insert Existing, then select Library Container. Select the Library
.xml file for the component to be imported and click Open.

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

 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.)

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

 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 will automatically open 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. If you do
not save your work your changes will be 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.)

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

 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

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.

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

 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.

While .xml files can be opened and read in a text editor, do not
modify them. The .xml files modified using a text editor do not
work with the ToolboxST 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.

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

 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 open the Settings dialog box
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 a Tree View on the left side of the
dialog box. Each category contains one or more settings that display in the Property
Editor on the right side of the dialog box.

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.

AutoBackup, when set to True, makes a backup copy of all configuration (.xml)
files when configuration changes are saved. The backup files are automatically
named using the format Backup of (original name).xml and are stored in the same
location as the original file.

Compress When Saving, when set to True, compresses most configuration

(.xml) files to save space. Device.xml files are not compressed even if this option is
set to True.

Maximum Build Errors helps to trace certain configuration problems, which can
cause a very large number of error messages to be generated during a build
operation. This option controls how many such errors can occur before the build
operation is stopped.

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

 Menu Reference
File Menu
New System creates a new system.

Open System opens a previously created system.

Close System closes the current system.

Save System saves changes to the current system (but not to any other
component editors).
Save System As saves the current system to a new location or name.
Archive System opens the Archive System dialog box.
Recent Files lists the eight most recently accessed systems.

Exit closes the ToolboxST application and all component editors.

Edit Menu
Delete removes the item currently selected in the Tree View.

Insert New adds a new component to the system.

Cut cuts the selected item in the Tree View.
Copy copies the selected item in the Tree View.
Paste pastes the selected item in the Tree View into the Summary View.
Insert Existing adds an existing component from a folder on disk.
System Information displays the System Information Editor.
Selected Component displays the Component Editor for the item currently
selected in the Tree View.

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

 View Menu
By Type automatically organizes the Tree View by component type.
By Group enables manual organization of the Tree View with group
components.
Track keeps selections in the Tree View and Summary View synchronized.
Memory Usage displays the total allocated memory.
EGD Diagnostics provides access to several Ethernet Global Data (EGD)
diagnostic tools.
EGD Management Tool opens the Ethernet Global Data (EGD)
Management Tool (EMT).
View Online Statistics provides a view of EGD exchange status from the
selected device. Only EGD Class 2 or higher devices that respond to EGD
Command Message Protocol (CMP) will have this diagnostic window.
™
WorkstationST Capture Live UDP Packets provides an EGD window
that is only enabled when you select a WorkstationST component with an OPC
DA Server configured. The feature 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 Configuration Server
View Differences opens a configuration view window.
Work Offline allows you to work offline.

Options Menu
Settings displays a dialog box with system settings.

Window Menu
Cascade arranges open Component Editor windows in a layered style.

Tile arranges open Component Editor windows in a grid style.

Close All closes all open Component Editor windows.

Help Menu
Contents displays the online product documentation.
Release Notes displays up-to-date information about your version of the
ToolboxST application.
Other Documents displays a list of related documents.
Send Problem Report lets you send problems and suggestions to the
ToolboxST team.
About displays version and copyright information.

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

 System Information Editor
The System Information Editor edits alarm classes and format specifications
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.

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-6706B ToolboxST Chapter 2 System Configuration • 2-11

 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 (0 to 99 where 0 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.

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.

Active Severity is required by OPC AE clients (1 to 1000 where 1000 is the

highest severity).

Normal Severity is required by OPC AE clients (1 to 1000 where 1000 is the

highest severity).

2-12 • Chapter 2 System Configuration GEH-6706B 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 min
( fs1max − fs1min )
fs 2

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 οc − fs οCmin ) ∗ ( fs οFmax − fs οFmin )

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

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

Val ο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-6706B ToolboxST Chapter 2 System Configuration • 2-13

 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-14 • Chapter 2 System Configuration GEH-6706B 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
A resource is a way for an HMI (Human-Machine Interface), to organize and tailor
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-6706B ToolboxST Chapter 2 System Configuration • 2-15

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.

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.)
2 A dialog box displays confirming the destination SDB Host and Path. Click OK.
When it is complete, the results display on the Log tab of the InfoView.

2-16 • Chapter 2 System Configuration GEH-6706B 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 files for each EGD
producer device. The EGD Configuration Server also maintains a
MasterSymbolTable.xml file that contains format specifications, alarm classes, and
other system-level information.

The .xml files are stored in folders for each producer ID. The protocol used to get
and put these .xml files 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. ToolboxST uses the EGD Configuration Server if it
has been enabled in the System Editor.

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

 The EGD Configuration Server properties are as follows:

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

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
system'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.

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 ToolboxST default to open,
build, or save components. You can select Work Offline from the View 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 any
component saved when offline, will result in a difference between the EGD
Configuration server and the ToolboxST system.

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

 ToolboxST/EGD Configuration Server Interaction
When ToolboxST is online, and the EGD Configuration Server is enabled,
ToolboxST 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.

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.

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

 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.

Send 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 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.

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.

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

 CHAPTER 3

Chapter 3 WorkstationST Component

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

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.

Tree View lists all major

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

Property Editor
provides an easy and
consistent means to edit
the item selected in the
Tree or Summary View

Component InfoView
displays specific feedback
information of 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.

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

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.

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

allows you to quickly Double-click on the
resize the Tree View double bar to view the
and Property Editor Property Editor in a
within their shared view. separate detached
window.
The List by Category
button allows you to The Alphabetical List
view the list of properties button allows you to
organized by category. view the list of properties
arranged alphabetically
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.

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

 Component InfoView
The color on theStatus
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 occured.

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.

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

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 three different kinds 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.
• View Design allows you to view the internal design of a protected object. For
example, this protects the internal design of a library block. The purpose of this
right is to protect intellectual property from unauthorized persons.
• 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 on it. 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.

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

 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 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 or a Device). A cached password remains until the component is closed.

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.

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

 Viewing Protection Status
The protection status for an object displays in the Property Editor for that object.
The following example shows the protection for a user block library.

From the Property

Editor, expand the
Protection item to
display that all three
access rights are
available for Libraries
Lib1.

To view the design

of blocks in this
library, you must
know the View
Design password.

There are four possible status indications for each access right:
No password has been set on this object
and none is required
A password has been set on this object
and has not been entered
A password has been set on this object,
but has already been entered
A password has been set on this object’s
parent, but has not been entered

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

 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 will 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 will initially be 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 will not propagate to
instances of that block.

GEH-6706B 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.
same value for multiple rows Then, while pressing the CTRL 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-6706B ToolboxST

 Organizing Columns
The columns of a data grid can be customized. You can select the columns that
display, their order from left to right, their 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 will sort in ascending order. To sort
in descending order, click the column header again.
Reset columns to the original configuration Right-click any column header and select Default Column Organization.
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 Move the selected
data grid. column up or down
in the column order.

Remove selected
columns from the
data grid. Remove all columns
from the data grid.

GEH-6706B 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-6706B ToolboxST

 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.

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

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

Repository Path can be edited if the EGD Configuration Server is enabled. The
EGD Configuration Server keeps all configuration files at this location. If this entry
is blank, the EGD Configuration Server's EgdCfgServer.exe.config file in the
installation folder can have an entry to determine the path to the repository. If both
the entry is blank and the EgdCfgServer.exe.config file entry is not present, the
configuration files will reside in a subfolder of the EGD Configuration Server's
installation folder.

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 Mark VIe 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.

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.

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.

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

 Consumed Devices
The devices listed are ones from which this WorkstationST will obtain information.
They can be edited in the Summary View by toggling the referenced column value or
by using the property grid’s Devices property editor.

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

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

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

Timecard selects the type

of timecard installed in the
WorkstationST computer.

Time Code selects the time

code format supplied by the
satellite receiver into the
timecard's time code input.

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

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

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

Configuration Option
selects the supported NTP
configuration option to be
started on the target
WorkstationST computer.

NTP Operating Mode selects

the NTP operating mode to be
started on the target
WorkstationST computer.

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.

NTP Operation Mode selects the NTP operating mode to start on the target
WorkstationST computer.

Primary Time Reference displays the name of the WorkstationST that this
WorkstationSt is using as its primary time reference.

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

 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).

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. (This property is
usually unavailable.)

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.

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.)

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

 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.

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

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 System Editor, double-click a WorkstationST component to
display the Component Editor.

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

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

3 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-6706B ToolboxST Chapter 3 WorkstationST Component Editor • 3-19

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

Disk Category

CIMPLICITY Alarm If True, sends alarms to the CIMPLICITY alarm

Manager Interface manager, if False, disables the sending of alarms.
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

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

Historical Category

Historical alarm path The path used to hold the historical alarm data files
written by the Alarm Server.
Historical D03 Alarms If True, the Alarm server writes legacy-style D03 alarm
enabled files into the historical alarm path. The file extension is
.d03. The default value is False.
Historical If True, the Alarm Server writes the WorkstationST style
WorkstationST alarms of alarm data into the Historical alarm path. The file
enabled extension used is .bin. The default value is True.

Historical If True, the Alarm Server writes alarm data files in .csv
WorkstationST Text format, including headers. The file extension is .txt. The
Alarms Enabled default value is False.

Live Alarm Viewer Category

Enable Live Alarm If True, enables the toolbar on the WorkstationST Alarm
Viewer Toolbar Viewer. The toolbar allows acknowledging, resetting,
locking, and unlocking of live alarms within the system.

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
Configuration alarm data is received and 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.

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

 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-6706B ToolboxST Chapter 3 WorkstationST Component Editor • 3-21

 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 Server If True, the alarm server uses this configuration to
process alarm/events from the external 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.

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

 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.

HMI Config Tab

As a feature of WorkstationST Service, the Human-Machine Interface (HMI)
imports component data into a defined CIMPLICITY project.

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).

WorkstationST Status Monitor

Data importing is initiated from the WorkstationST Status Monitor, which runs in the
background.
To open the WorkstationST Status Monitor
1 Double-click the WorkstationST Status Monitor Tray icon or right-click
and select Open detailed status.
2 When the Status Monitor opens, right-click the HMI feature and select Start
Selected Feature(s).

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

 Adding an HMI Feature
To add an HMI feature
1 In the Tree View, select Features.
2 In the Outline View, set the Enabled property for the HMI feature to True.
The HMI Config tab displays.

HMI Configuration

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

 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.

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.

Adding Global Parameters

To add a Global Parameter
In the Tree View, right-click either Global System Parameters or Global
Project Parameters and select Add. The new parameter displays in the
Outline View.

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

 Editing Global Parameters
To edit a Global Parameter
1 In the Tree View, select either Global System Parameters or Global
Project Parameters.
2 In the Outline View, select the parameter to edit.
3 In the Property Editor, edit the Name and/or Value of the parameter.

Deleting Global Parameters

To delete a Global Parameter
1 In the Tree View, select either Global System Parameters or Global
Project Parameters.
2 In the Outline View, select the parameter(s) to delete.
3 Right-click the desired parameter, then select Delete Selected Row(s).

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

 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.

Configuring the OPC DA Server Tab

To configure the OPC DA Server tab
1 From the System Editor, double-click a WorkstationST component to
display the Component Editor.

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

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

3 In the Summary View, enable the OPC DA Server by selecting True. The
OPC DA Server tab displays, and the OPC DA Server configuration form also
displays in the Summary View.

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

 Features
The OPC DA Server features can be configured on the OPC DA Server tab.

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, MarkVI, and MarkVIe
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.

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

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

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

 To add a server connection
1 From the OPC DA client Tree View, right-click on 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 on the created connection. The Add OPC
Client Group dialog box displays.

2 Enter a group name and click OK.

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

 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. The server must be able to access
the client computer to return data values. Remember, many times OPC servers are
running as the System user (not the Administrator). 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.

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

 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.

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.

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

 Variable Translations
Example 1

In the table below, the device 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
Device = 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 device 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
Device = 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

The OPC AE Server implements and acknowledges Alarms, Diagnostics and Holds
as condition-related states. Events and SOEs are simple events, and cannot be
acknowledged from any external OPC AE client.

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

 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.

Configuring the OPC AE Server

The ToolboxST software 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.

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

 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 Component 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.

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

 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.

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

 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.

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

 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.

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

 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.

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

 Live Data
The Live Data collection collects data samples continuously during and/or after an
event.

Continuous Sampling

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 hours, that the files are maintained on disk.

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

 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.

Triggered Sampling

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

 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.

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.

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

 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.

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.

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

 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.

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.

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

 Adding a Variable

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.

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

 Deleting a Variable

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.

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

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.

EGD Configuration
To configure EGD for a WorkstationST
1 From the System Editor, double-click on a WorkstationST component to
display the Component Editor.
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.

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-48 • Chapter 3 WorkstationST Component Editor GEH-6706B 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.

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.

Destination IP Address controls the IP address that receives the exchanges when
Mode is set to Unicast or Multicast.

Exchanges indicate the number of exchanges in the selected page. It is updated

after a build.

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.

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

 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.

Timeout Multiplier gets or sets the Timeout Multiplier for all produced exchanges
within this page. The exchange period scaled by this multiplier yields the timeout
period for all exchanges in this page. If any variable on an exchange is written to (by
whatever source produces the data) within this timeout, the exchange is marked as
healthy and will remain healthy. The default is a multiplier of 0. If set to a value
larger than 0, the exchange will begin life un-healthy and will transition healthy
when any variable is written. The exchange will remain healthy as long as any
variable is written before the timeout expires. If a page has multiple exchanges, each
exchange requires a write of one of its variables to remain healthy. Setting this
multiplier to zero, means each exchange is always healthy.

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.

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.

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

 Variables
To add a variable to an EGD page
1 From the Component Editor, select the EGD tab.
2 From the Tree View, right-click the desired page, then select Add Variable to
display the Variable Browser.

Select one or more

variables from the
Variable Browser,
then click OK.

The Summary View updates to display

the new variables. The Exchange IDs and
Locations are assigned during the build.

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.

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

 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.

To edit exchange signatures and configuration time

1 From the EGD tab, 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.

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

 4 Make any desired changes to the signatures and configuration time, then click
OK to close the dialog box.

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, then click OK.

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

 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.

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.

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

 EGD Diagnostics
The EGD protocol includes a Command Message Protocol (CMP) to obtain the
status of a Class 2 or higher EGD device. MarkVIe is a Class 3 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 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.

Status columns 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.

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

 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

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.

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

 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.

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

 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.

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

 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.

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

 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

The EGD Configuration Server tab can be enabled on the System Editor with the
root node selected. Refer to Chapter 2, System Configuration, the section System
Editor. When enabled, the Produced Pages item will have two additional context
menu items, Compare and UnConsumed Data.

The Compare command compares the component's EGD-produced data

configuration with the EGD configuration server’s content. The UnConsumed Data
command generates a report showing variables produced by this component that are
not listed in any other device’s consumed data file.

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.

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

 CHAPTER 4

Chapter 4 Working Online With

WorkstationST

Introduction
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-6706B 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 will then expand 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-6706B 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 WorkstationST Download 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 Workstation Download Wizard opens.
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.

GEH-6706B ToolboxST Chapter 4 Working Online With WorkstationST • 4-3

 Select this checkbox to
continue downloading if errors
occur (if an error occurs during
the download of a particular
target, no further downloads
are attempted for that target).

Click Start to begin the

download process.

Displays the overall

progress of the
download.

Displays the progress

of the current file
download.

4-4 • Chapter 4 Working Online With WorkstationST GEH-6706B ToolboxST

 4 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-6706B ToolboxST Chapter 4 Working Online With WorkstationST • 4-5

Notes

4-6 • Chapter 4 Working Online With WorkstationST GEH-6706B 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 the text to Selects a type of search to Displays a shortcut

search for in this perform. (Refer to the menu of available
Click to begin the
Select this box to box. section, Find Methods) wildcards.
search process.
distinguish between
upper and lower case
characters while
searching. Click to display
added options for
Select to include replacing text.
variable descriptions
in the search.
Searches every
component from the
Select to include libraries System Editor, even
in the search if the scope those without open
is set to Entire system or component editors.
Open Components and
a library editor is open. Searches all
components from
Select to include items
the System Editor
in block diagrams (the
with open
as text comments) in
Searches inside the Searches inside the currently component editors.
the search. Select to keep
Finder open current component. (The selected item (for example, a
between searches. name of the component software program.) If no
will display next to the searchable item is selected when
Option button.) the Finder is opened, this option
is disabled.

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-6706B 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-6706B 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-6706B 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.

Enter the text to be Replaces the currently Navigate to the

substituted for the displayed occurrence next occurrence
Find text in this box. of the Find text with the of the Find text.
Replace With text.

Select to keep Finder Replaces all occurrences of

open between the Find text with the Replace
searches. With text automatically.

5-4 • Chapter 5 Finder GEH-6706B 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 in the
Trender. A Trender window is 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 new Trender window or open an existing Trender
window
1 If the Trender application is not already open, select the Windows Start
button, Programs, GE ControlST, ToolboxST, and then select Trender.
2 From the File menu, select New to create a new Trender window or select
Open and locate an existing trend file.

To create or open a Trender window from the System Editor

1 From ToolboxST, navigate to the System Editor.
2 A list of available components displays in the Tree View. Double-click a
Trender window to open it.
3 To add a new Trender window, right-click a container (either the system item or
a group) and select Insert New, Tool, Trender).

To create or open a Trender window from a Component Editor

1 From ToolboxST, navigate to the Component Editor for the component that
contains the variables you would like to monitor.
2 From the View menu, select Trenders. A list of available Trender windows
displays.
3 Double-click an existing Trender window to open it or click Add, enter a name,
and then click OK to create a new Trender window.

GEH-6706B ToolboxST Chapter 6 Trender • 6-1

 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
observing 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.

Property Editor
allows you to change
settings that affect the
capture and display of
data.

Data Toolbar
contains commands
that manipulate the
current data.

Traces tab Sources tab User Note tab Events tab lists Auxiliary View Mode Indicator
displays traces displays sources allows you to save all events that contains tabs that displays the
currently being where data is comments, have occurred display current mode
monitored by the collected. instructions, and during the information about (Live or Replay).
Trender window. notes about the current Chapter. the current data.
current Chapter.

6-2 • Chapter 6 Trender GEH-6706B 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-6706B ToolboxST Chapter 6 Trender • 6-3

 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 you would like to add the trace to 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 Variable Browser
for the current data source will display, which you can then 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 may 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.) The Select Variables wizard page displays.
8 Click the Add button to display the Variable Browser, then select one or
more variables to monitor. When you are finished, click OK in the Variable
Browser, then click Finish in the wizard. The newly created traces display in
the Trace 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.

6-4 • Chapter 6 Trender GEH-6706B ToolboxST

 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 Variable Browser. 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 Variable Browser, then
click Finish in the wizard. The newly created traces display on the Trace tab.

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.

GEH-6706B ToolboxST Chapter 6 Trender • 6-5

 To retrieve data from a capture buffer

On the Data toolbar, select the Upload button.

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-6 • Chapter 6 Trender GEH-6706B 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-6706B ToolboxST Chapter 6 Trender • 6-7

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-8 • Chapter 6 Trender GEH-6706B 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-6706B ToolboxST Chapter 6 Trender • 6-9

 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-10 • Chapter 6 Trender GEH-6706B 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.
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.
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.

GEH-6706B ToolboxST Chapter 6 Trender • 6-11

 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.

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, which are 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.

6-12 • Chapter 6 Trender GEH-6706B ToolboxST

 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
added to the output. Selects the 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-6706B ToolboxST Chapter 6 Trender • 6-13

Notes

6-14 • Chapter 6 Trender GEH-6706B 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 components (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 device.
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 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 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-6706B 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:

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

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

Wire Speed is the speed of the connected network.

Network Name is the name of the connected network.

Subnet Mask is the subnet mask associated with the connected network.

7-2 • Chapter 7 EGD Editor for External Devices GEH-6706B 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.

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-6706B 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.

Under Produced
Pages, 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:

Ethernet 0, if selected, broadcasts EGD on Ethernet 0. (If more than one Ethernet
Adapter has been configured for EGD, additional Ethernet properties displays.)

Mode can be set to Broadcast, Unicast, or Multicast, depending on the modes

supported by the device's EGD implementation profile.

Exchanges indicate the number of exchanges in the selected page. It is updated

after selecting the Build command.

Allow Editing when False, a variable's exchange ID and offset for variables on a
manual page cannot be edited. A page compress will also be disabled. This prevents
you from inadvertently editing a page with manual selected as Layout mode.

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.

7-4 • Chapter 7 EGD Editor for External Devices GEH-6706B ToolboxST

 Note The Skew property will not be visible if it is not supported in the
implementation profile configuration. (The skew property is measured in
nanoseconds.)

Destination IP Address sets the IP address to which the exchanges on this page
are unicast or multicast. (If the Mode property is set to Broadcast, this property is
not available.)

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.
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-6706B 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-6706B 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

3 From the EGD tab, select a Produced Page in the Tree View.
4 Right-click an exchange in the Summary View, then select Edit Exchange
Signatures and Configuration Time.

5 Review the warning about manual Exchange Signature editing, then click
OK.
6 Make any desired changes to the signatures and configuration time, then click
OK to close the dialog box.

GEH-6706B 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-6706B 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.

The following properties are available when editing an Implementation Profile:

Configuration Support configures the operations supported by the device.

Accepts Deletes indicates device support for HTTP deletes.

Multiple Producer IDs indicates device support for multiple producer IDs.

Accepts Puts indicates device support for HTTP Put commands.

Zip Content indicates device support for zipped transfers.

Data Types allows you to configure supported data types. (Clicking the ellipsis
button will open an editor window.)

Double Word Alignment indicates that the offset of a DWORD length variable
must be evenly divisible by this number.

Word Alignment is set to True if the device requires that all WORD length
variables be aligned on an even boundary.

Broadcast is set to True if the device supports broadcast destinations for EGD data
or command packets and False otherwise.

GEH-6706B ToolboxST Chapter 7 EGD Editor for External Devices • 7-9

 Masked Write is set to True if the device supports the MaskedWrite command and
False otherwise.

Max Coherent Data 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 returns the maximum number of exchanges supported by the

device. It is optional and is initialized to 0.

Max String returns the maximum size string supported by the device. If the
attribute is not present then the device has no set maximum size for strings. It is
optional and is initialized to 0.

Multicast is set to True if the device supports multicast destinations for EGD data
or command packets and False otherwise.

Skew is a Boolean value representing the capability of the producer to support the
skewing of produced exchanges with respect to time.

Unicast is a Boolean value that is set to True if the device supports unicast
destinations for EGD data or command packets. Otherwise, it is set to False.

Device Class is 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 Class Name is name of the class of device to which this device belongs.

7-10 • Chapter 7 EGD Editor for External Devices GEH-6706B 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-6706B 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

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.

7-12 • Chapter 7 EGD Editor for External Devices GEH-6706B ToolboxST

 EGD Configuration Server Tab
The EGD Configuration Server tab 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 under the root tree node. If the server is enabled,
this tab displays information from that server.

Note The EMT provides a detailed view of the configuration server contents.

G1
G2

EGD Configuration Server Contents Sample

The tab control contains a toolbar with two buttons:

The Filter Toggle button defaults to a filtered state. It displays nodes that
have the same name but have a different Producer ID as the open component.

The Delete button deletes the selected node or nodes. If the nodes 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. 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-6706B ToolboxST Chapter 7 EGD Editor for External Devices • 7-13

Menus
File Menu
Save updates 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 allows you to transfer produced data, consumed data,
symbols, implementation profiles, and GUI device EGD configuration files to
and from a variety of file formats.
Print outputs the summary grid view with the column selection, order, and
width currently visible in the view.
Close closes the currently open device.

Edit Menu
Edit Menu
Undo returns the editor to the state it was in before the last action was
performed.
Redo performs an action again after an undo command.
Cut moves the currently selected portion of the data grid to the clipboard.
Copy transfers a duplicate of the currently selected portion of the data grid to
the clipboard.
Paste transfers the contents of the clipboard into the data grid.
Delete deletes the currently selected item.
Find opens the Finder dialog box. For more information, refer to Chapter,
Finder.

View Menu
Go Back returns to the view that immediately precedes the current view in the
history.
Go Forward returns to the view that immediately follows the current view in
the history.

EGD Management Tool.

7-14 • Chapter 7 EGD Editor for External Devices GEH-6706B ToolboxST

 Device Menu
Bind and Build refreshes 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 SDB command stores the current EGD configuration to the
System Database (SDB). It is only available if the system has an SDB enabled
and configured.
Online sends CMP messages to EGD Class 2 or higher devices to view live
values from the device.

Help Menu
Contents opens this help document.
Release Notes opens the release notes for the current version of the
application.
About shows version and copyright information about the application.

GEH-6706B ToolboxST Chapter 7 EGD Editor for External Devices • 7-15

Notes

7-16 • Chapter 7 EGD Editor for External Devices GEH-6706B ToolboxST

 CHAPTER 8

Chapter 8 Configuration
Management System (CMS)

The CMS Administrator tool allows you to perform the following administrator tasks
on the CMS server:

• Create, backup, and restore repositories

• Add, edit, and delete users in a repository
To install the CMS Administrator Tool, select the CMS server option during
installation.

Accessing the CMS Administrator Tool

To access the Administrator Tool
From the Start menu, select All Programs, GE Control ST, and CMS
Server. Click Administrator Tool.

Note To run the Administrator tool, you must have administrative permissions on
your computer.

To logon to the CMS server

Enter your name and password, then click OK.

Enter a valid user name

and password for the
Domain/Workgroup that
you have selected.

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-1

 The CMS Administrator window displays the selection window shown below.

You can either create a new repository or select an existing repository.

To create a new repository, select the Create a new Repository option and click
OK.

8-2 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 Enter the folder and the name of the repository and click OK.

To select an existing repository, select the Select an existing Repository option.

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-3

 Select an existing repository and click Open.

Main menu

User List

Permissions

Repository Menu

Select displays the Select a Repository dialog box.

Create allows a repository to be created.

Delete displays the Delete a Repository dialog box.

Backup allows a repository to be backed up.

Restore ends the component editing session and returns to the main System Editor.

The user who creates the repository becomes the default administrator.

8-4 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 Selecting a Repository
To select a repository
1 From the Repository menu, click Select. The Select a Repository dialog
box displays.

2 From the drop-down list, select a repository, then click Open. The CMS
Administrator window displays with all users.

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-5

 Creating a Repository
To create a repository
From the Repository menu, click Create. The Create New Repository
dialog box displays.

Enter the folder path and the name of the repository you would like to create and
click OK.

Deleting a Repository
To delete a repository
1 From the Repository menu, click Delete. The Delete Repository dialog
box displays.

2 From the drop-down list, select the repository to be deleted, then click OK.

8-6 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 Backing Up a Repository
To back up a repository
1 From the Repository menu, click Backup. The Repository Backup dialog
box displays.

2 From the drop-down list, select the repository to be backed up.

3 Click the Browse button to specify the name of the backup file, then click OK.

Restoring a Repository
To restore a repository
1 From the Repository menu, click Restore. The Restore Repository dialog
box displays.

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-7

 2 Click the first Browse button to navigate to the file in which the repository is
backed up.
3 Click the second Browse button to navigate to the destination of the restored
repository, then click OK.

8-8 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 Users Menu

Add displays the Add User dialog box.

Delete allows a user to be deleted.

Edit allows user permissions to be changed.

Adding a User
To add a user
1 From the Users menu, select Add or right-click the User list and select Add
User. The Add User dialog box displays.

2 Enter the User ID.

3 Select the User can modify systems check box, then click OK.
To set the read-only permission
In the Add User dialog box, clear the User can modify systems and User
is an administrator for this repository check boxes, if selected, then click
OK.
The Delete option allows you to delete a user from a repository.

Note You must be an administrator to open or delete a repository.

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-9

 Deleting a User
To delete a user
1 Highlight the user to be deleted.
2 From the Users menu, select Delete, or right-click the User list and select
Delete. The CMS Administrator confirmation window displays.

3 Click Yes to delete the user.

Editing a User
To edit a user's permissions
1 Highlight the user to be edited.
2 From the Users menu, select Edit, or right-click the User list and select Edit.
The Edit User dialog box displays.

The following permissions are available:

• Administrator allows you to modify systems, as well as perform operations

on repositories such as delete, select, and backup.
• Modify systems allows full access to systems in the specified repository.
• Read-only allows you to view the system only.

8-10 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 Tools Menu
Starting the Server
To start the CMS server
From the Tools menu, select Server. The CMS Server dialog box displays.

Click the Start

Server button.

The status of the server changes to Running, and the button displays Stop Server.

Stopping the Server

To stop the CMS server
Repeat Step 1 in Start CMS Server procedure.

Click the Stop Server

button. The server status
will change to Stopped
and the button will display
Start Server.

Note Stopping the server will disable all repository operations.

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-11

 Adjusting the Settings
To adjust the user settings
1 From the Tools menu, select Settings. The CMS Settings dialog box
displays.

2 Select the appropriate user type, then click OK.

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 list of repositories

that would be backed
up would be displayed
in the list box.

Specify the backup

location using the
Browse button.

Click OK to back up
the repositories.

Once all the repositories have been backed up, the Administrator Tool must be
restarted. The administrator who restores this repository becomes the default
administrator.

8-12 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 CMS Client Interface
The CMS client interface allows you to check out a master ToolboxST configuration
stored on a CMS server, make changes, then check the configuration back in. Each
configuration change is saved. Changes can also be labelled for significant events,
such as software releases, then retrieved using those labels.
To use the CMS client interface
1 From the Start menu, select All Programs, GE ControlST, and
ToolboxST. Click Configuration Management System.

2 When the Server Details dialog box displays, type the IP address of the
machine on which the server is installed.

A LogIn window displays:

3 Type your User Name, Password, and the name of the Repository, then
click OK. A WorkingFolder dialog box displays:

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-13

 4 Type the name of the working folder, or click Browse… to locate and select
the working folder. Click OK. The Configuration Management System
window displays:

The System View

displays the repository
as an item that contains
systems.

The Device View

displays all devices
within the system
selected in the System
View.

The Log View displays

all messages, events,
and errors associated
with the selected device.

8-14 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 File Menu
Connecting to the Server
To connect to the CMS server
1 From the File menu, click Connect To Server.

2 The Server Details window displays again. Re-enter the IP address, then when
the LogIn window displays, repeat the logon steps.

Adding a System
A system must be added to begin version control. The working folder must be set,
and you must have modify permission.
To add a system
From the File menu, select Add System, or in the System View, right-click
the repository, then select Add System.

Deleting a System
You must have modify permission to delete a system. This command deletes the
system, but not the system folder. A system folder can only be deleted by an
administrator.
To delete a system
From the File menu, select Delete System, or in the System View, right-
click the repository, then select Delete System.

Setting Working Folder

This menu option allows you to set or to change a working folder for the repository.
To set the working folder
From the File menu, select Set Working Folder or in the System View,
right-click a repository, then select Set Working Folder.

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-15

View Menu
Refreshing System View
When a system or device is selected, use this option to update the repository status
and refresh the System View.
To refresh the System View
From the View menu, select To refresh the System ViewRefresh Tree.
The System View refreshes.

Clearing Status Window

This menu option allows you to clear the Log View of all event/error information.
To clear the status window
From the View Menu, select Clear Status Window. The Log View
becomes blank.

Source Menu
Retrieving a Configuration
To retrieve a system or device configuration
1 From the System View, select a system, or from the Device View, select a
device.
2 From the Source menu, select Get Latest Version, or from the selected
system or device, right-click to select Get Latest Version.

The most recent configuration, in read-only mode, is placed in the working folder
you specified.

8-16 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 Modifying a Configuration
To modify a system or device configuration
1 From the Source menu, select Check Out. This removes the read-only mode
from the configuration so changes can be made. When a device or system is
checked out, your user ID displays in the device list in the User column:

2 From the Source menu, select Check In to save the changes. The CheckIn
dialog box displays.

3 If desired, enter a comment in the Comments text field, then click OK.
To revert your changes back to the previous version
From the Source menu, select Undo Checkout.

Click Yes to revert back to the previous version.

GEH-6706B ToolboxST Chapter 8 Configuration Management System (CMS) • 8-17

 Labeling a Configuration
You can mark a copy of the configuration being modified with a comment(s).
To label a system or device configuration
From the Source menu, select Label. This label can be used for retrieving the
configuration at a later date.

Tools Menu
Showing History
A historical record of all system or device operations is available for viewing.
To view CMS history
From the Tools menu, select Show History. The History window displays.

This column displays

the version number of
the system or device.

This column displays

the login name of the
user who made the
change.

This column displays

when the change was
made.

This column displays a

comment entered when the
system or device was
checked in.

8-18 • Chapter 8 Configuration Management System (CMS) GEH-6706B ToolboxST

 CHAPTER 9

Chapter 9 Reference

Menus
File Menu
Save saves changes to the current component.

Print creates a paper copy dependent on selected focus.

Close ends the component editing session and returns to the main
System Editor.

Edit Menu
Undo returns the component to the state it was in before the last action
was performed.
Redo performs an action again after an undo command.

Cut moves the currently selected item to the clipboard.

Copy places the currently selected item on the clipboard.

Paste places the contents of the clipboard into the currently selected item.

Delete removes the currently selected item.

Find opens the Finder tool.

View Menu
Go Back returns to the view that immediately preceded the current view in
the history.
Go Forward returns to the view that immediately follows the current view
in the history.
Global Variables displays all global variables, and allows grid viewing,
sorting, and editing.
Trenders display a list of Trender windows associated with the
component.
Watch Windows displays a list of Watch Windows associated with the
component.
Test OPC Client opens an OPC client window that connects to any OPC
DA Server to verify communication.
EGD Management Tool opens the EGD Management Tool.
WorkstationST Alarm Viewer opens the Alarm Viewer (this only
displays if an Alarm Viewer was installed).

GEH-6706B ToolboxST Chapter 9 Reference • 9-1

 Device Menu
Online connects to or disconnects from a controller.

Build converts the current configuration into binary files that can be downloaded
to a controller.
Download opens the download wizard to download application configuration.
Put Device to SDB stores the component configuration to a System Database
(SDB).

Help Menu
Runtime Release Notes opens the Release Notes Viewer for the selected item
(WorkstationST Features, OPC DA Server, or EGD Configuration Server.
Release Notes opens the Release Notes Viewer.
About displays version and copyright information.

9-2 • Chapter 9 Reference GEH-6706B 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-6706B ToolboxST Glossary of Terms • G-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.

G-2 • Glossary of Terms GEH-6706B 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 pcode.

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-6706B ToolboxST Glossary of Terms • G-3

Notes

G-4 • Glossary of Terms GEH-6706B ToolboxST

 Index

A G
acronyms and abbreviations 1-10 global parameters
alarm classes 2-11 adding 3-25
alarm scanner 3-21 deleting 3-26
editing 3-26
C
I
capture buffer 3-44
command line arguments 1-4 implementation profile 7-9
Component InfoView 3-3 installation 1-2
components
grouping 2-4 L
moving and copying 2-4 licensing 1-8
Configuration Management System
administrator tool 8-1 M
client interface 8-13
Menus
Tools menu 8-11
Device 7-15, 9-2
User menu 8-9
Edit 2-9, 7-14, 9-1
configuring
File 2-9, 7-14, 8-15, 9-1
alarms tab 3-18
Help 2-10, 7-15, 9-2
OPC AE Server tab 3-33
Options 2-10
OPC DA Server tab 3-27
View 2-10, 7-14, 8-16, 9-1
consumed devices 3-13
Window 2-10
D N
data grids
network adapters 3-16, 7-1
copying 3-10
editing 3-8 P
organizing 3-9
download wizard 4-3 page compression 3-50, 7-5
Produced Pages 3-48
E property editor 3-2
editing Produced Pages 3-49, 7-4 R
EGD
configuration 3-48, 7-3 referenced devices 3-53, 7-8
configuration server 2-17 replace options 5-4
configuration server interaction 2-19 Repository menu
configuration server reports 3-60 backing up 8-7
diagnostics 3-55, 7-12 deleting 8-6
packet logging 3-56 restoring 8-7
Ethernet 3-48, 9-4 selecting 8-5
routing 3-33
F
S
File menu
adding 8-15 sampling
connecting 8-15 continious 3-41
deleting 8-15 triggered 3-42
setting 8-15 security
find methods 5-2

GEH-6706B ToolboxST Index • I-1

 passwords 3-4
Viewing Protection Status 3-6 U
Source menu UPD
labeling 8-18 installing 1-8
modifying 8-17 reinstalling 1-9
retrieving 8-16 users menu
Status tab 4-2 adding 8-9
summary view 3-2 deleting 8-10
system editor editing 8-10
components 2-3
configuration files 2-6 V
opening and creating systems 2-1
View menu
saving systems 2-5
clearing status window 8-16
system information editor
refreshing system view 8-16
alarm classes 2-11
format specifications 2-13
HMI resources 2-15
measurement systems 2-15
System Requirements 1-1
T
tab
Alarms 3-18
Ethernet Global Data 3-48
General 3-11
HMI Config 3-23
OPC AE Server 3-33
OPC DA Server 3-27
Recorder 3-39
time card 3-14
Tools menu
adjusting 8-12
starting 8-11
stopping 8-11
Trender
adding traces 6-3
capture buffer trends 6-4
concepts 6-6
cursors 6-6
events 6-7
exporting to a file 6-12
hiding traces 6-11
live trends 6-4
obtaining data 6-5
printing graphs 6-13
trace colors 6-11
Trender concepts 6-6
Trender window features
data toolbar 6-3
Trender toolbar 6-3
trip log 3-43

I-2 • Index GEH-6706B ToolboxST

GE Energy
1501 Roanoke Blvd.
Salem, VA 24153-6492 USA

1 540 387 7000

www.geenergy.com

GEH-6706B
Revised 060920
Issued 050915